4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (C) 2013, Trustees of Indiana University
25 * Copyright (c) 2017, Intel Corporation.
27 * Author: Joshua Walgenbach <jjw@iu.edu>
30 #ifndef _LUSTRE_NODEMAP_H
31 #define _LUSTRE_NODEMAP_H
33 #include <uapi/linux/lustre/lustre_idl.h>
35 #define LUSTRE_NODEMAP_NAME "nodemap"
37 #define LUSTRE_NODEMAP_DEFAULT_ID 0
39 /** enums containing the types of ids contained in a nodemap
40 * kept so other modules (mgs, mdt, etc) can define the type
44 enum nodemap_id_type {
50 enum nodemap_tree_type {
55 enum nodemap_mapping_modes {
56 NODEMAP_MAP_BOTH_LEGACY = 0x0, /* for compatibility */
57 NODEMAP_MAP_UID = 0x01,
58 NODEMAP_MAP_GID = 0x02,
59 NODEMAP_MAP_BOTH = 0x03, /* for compatibility */
60 NODEMAP_MAP_PROJID = 0x04,
61 NODEMAP_MAP_ALL = NODEMAP_MAP_UID |
67 char npe_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
68 struct proc_dir_entry *npe_proc_entry;
69 struct list_head npe_list_member;
72 /** The nodemap id 0 will be the default nodemap. It will have a configuration
73 * set by the MGS, but no ranges will be allowed as all NIDs that do not map
74 * will be added to the default nodemap
78 /* human readable ID */
79 char nm_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
80 /* flags to govern nodemap behavior */
81 bool nmf_trust_client_ids:1,
83 nmf_allow_root_access:1,
85 nmf_forbid_encryption:1,
87 /* bitmap for mapping type */
88 enum nodemap_mapping_modes
90 /* unique ID set by MGS */
92 /* nodemap ref counter */
94 /* UID to squash unmapped UIDs */
96 /* GID to squash unmapped GIDs */
98 /* PROJID to squash unmapped PROJIDs */
99 projid_t nm_squash_projid;
101 struct list_head nm_ranges;
102 /* lock for idmap red/black trees */
103 struct rw_semaphore nm_idmap_lock;
104 /* UID map keyed by local UID */
105 struct rb_root nm_fs_to_client_uidmap;
106 /* UID map keyed by remote UID */
107 struct rb_root nm_client_to_fs_uidmap;
108 /* GID map keyed by local UID */
109 struct rb_root nm_fs_to_client_gidmap;
110 /* GID map keyed by remote UID */
111 struct rb_root nm_client_to_fs_gidmap;
112 /* PROJID map keyed by local UID */
113 struct rb_root nm_fs_to_client_projidmap;
114 /* PROJID map keyed by remote UID */
115 struct rb_root nm_client_to_fs_projidmap;
116 /* attached client members of this nodemap */
117 struct mutex nm_member_list_lock;
118 struct list_head nm_member_list;
119 /* access by nodemap name */
120 struct hlist_node nm_hash;
121 struct nodemap_pde *nm_pde_data;
122 /* fileset the nodes of this nodemap are restricted to */
123 char nm_fileset[PATH_MAX+1];
124 /* information about the expected SELinux policy on the nodes */
125 char nm_sepol[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
127 /* used when loading/unloading nodemaps */
128 struct list_head nm_list;
131 /* Store handles to local MGC storage to save config locally. In future
132 * versions of nodemap, mgc will receive the config directly and so this might
135 struct nm_config_file {
136 struct local_oid_storage *ncf_los;
137 struct dt_object *ncf_obj;
138 struct list_head ncf_list;
141 void nodemap_activate(const bool value);
142 int nodemap_add(const char *nodemap_name);
143 int nodemap_del(const char *nodemap_name);
144 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp);
145 void nodemap_del_member(struct obd_export *exp);
146 int nodemap_parse_range(const char *range_string, lnet_nid_t range[2]);
147 int nodemap_parse_idmap(char *idmap_string, __u32 idmap[2]);
148 int nodemap_add_range(const char *name, const lnet_nid_t nid[2]);
149 int nodemap_del_range(const char *name, const lnet_nid_t nid[2]);
150 int nodemap_set_allow_root(const char *name, bool allow_root);
151 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids);
152 int nodemap_set_deny_unknown(const char *name, bool deny_unknown);
153 int nodemap_set_mapping_mode(const char *name,
154 enum nodemap_mapping_modes map_mode);
155 int nodemap_set_squash_uid(const char *name, uid_t uid);
156 int nodemap_set_squash_gid(const char *name, gid_t gid);
157 int nodemap_set_squash_projid(const char *name, projid_t projid);
158 int nodemap_set_audit_mode(const char *name, bool enable_audit);
159 int nodemap_set_forbid_encryption(const char *name, bool forbid_encryption);
160 int nodemap_set_readonly_mount(const char *name, bool readonly_mount);
161 bool nodemap_can_setquota(struct lu_nodemap *nodemap, __u32 qc_type, __u32 id);
162 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
164 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
166 int nodemap_set_fileset(const char *name, const char *fileset);
167 char *nodemap_get_fileset(const struct lu_nodemap *nodemap);
168 int nodemap_set_sepol(const char *name, const char *sepol);
169 const char *nodemap_get_sepol(const struct lu_nodemap *nodemap);
170 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
171 enum nodemap_id_type id_type,
172 enum nodemap_tree_type tree_type, __u32 id);
173 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
174 enum nodemap_tree_type tree_type);
175 #ifdef HAVE_SERVER_SUPPORT
176 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len);
178 #define nodemap_test_nid(nid, name_buf, name_len) do {} while(0)
180 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
181 __u32 client_id, __u32 *fs_id);
183 struct nm_config_file *nm_config_file_register_mgs(const struct lu_env *env,
184 struct dt_object *obj,
185 struct local_oid_storage *los);
187 struct nm_config_file *nm_config_file_register_tgt(const struct lu_env *env,
188 struct dt_device *dev,
189 struct local_oid_storage *los);
190 void nm_config_file_deregister_mgs(const struct lu_env *env,
191 struct nm_config_file *ncf);
192 void nm_config_file_deregister_tgt(const struct lu_env *env,
193 struct nm_config_file *ncf);
194 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp);
195 void nodemap_putref(struct lu_nodemap *nodemap);
197 #ifdef HAVE_SERVER_SUPPORT
199 struct nodemap_range_tree {
200 struct interval_tree_root nmrt_range_interval_root;
201 unsigned int nmrt_range_highest_id;
204 struct nodemap_config {
205 /* Highest numerical lu_nodemap.nm_id defined */
206 unsigned int nmc_nodemap_highest_id;
208 /* Simple flag to determine if nodemaps are active */
209 bool nmc_nodemap_is_active;
211 /* Pointer to default nodemap as it is needed more often */
212 struct lu_nodemap *nmc_default_nodemap;
215 * Lock required to access the range tree.
217 struct rw_semaphore nmc_range_tree_lock;
218 struct nodemap_range_tree nmc_range_tree;
221 * Hash keyed on nodemap name containing all
224 struct cfs_hash *nmc_nodemap_hash;
227 struct nodemap_config *nodemap_config_alloc(void);
228 void nodemap_config_dealloc(struct nodemap_config *config);
229 void nodemap_config_set_active_mgc(struct nodemap_config *config);
231 int nodemap_process_idx_pages(struct nodemap_config *config, union lu_page *lip,
232 struct lu_nodemap **recent_nodemap);
234 #else /* disable nodemap processing in MGC of non-servers */
235 static inline int nodemap_process_idx_pages(void *config,
237 struct lu_nodemap **recent_nodemap)
239 #endif /* HAVE_SERVER_SUPPORT */
241 int nodemap_get_config_req(struct obd_device *mgs_obd,
242 struct ptlrpc_request *req);
243 #endif /* _LUSTRE_NODEMAP_H */