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 {
49 enum nodemap_tree_type {
54 enum nodemap_mapping_modes {
61 char npe_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
62 struct proc_dir_entry *npe_proc_entry;
63 struct list_head npe_list_member;
66 /** The nodemap id 0 will be the default nodemap. It will have a configuration
67 * set by the MGS, but no ranges will be allowed as all NIDs that do not map
68 * will be added to the default nodemap
72 /* human readable ID */
73 char nm_name[LUSTRE_NODEMAP_NAME_LENGTH + 1];
74 /* flags to govern nodemap behavior */
75 bool nmf_trust_client_ids:1,
77 nmf_allow_root_access:1,
81 /* unique ID set by MGS */
83 /* nodemap ref counter */
85 /* UID to squash unmapped UIDs */
87 /* GID to squash unmapped GIDs */
90 struct list_head nm_ranges;
91 /* lock for idmap red/black trees */
92 struct rw_semaphore nm_idmap_lock;
93 /* UID map keyed by local UID */
94 struct rb_root nm_fs_to_client_uidmap;
95 /* UID map keyed by remote UID */
96 struct rb_root nm_client_to_fs_uidmap;
97 /* GID map keyed by local UID */
98 struct rb_root nm_fs_to_client_gidmap;
99 /* GID map keyed by remote UID */
100 struct rb_root nm_client_to_fs_gidmap;
101 /* attached client members of this nodemap */
102 struct mutex nm_member_list_lock;
103 struct list_head nm_member_list;
104 /* access by nodemap name */
105 struct hlist_node nm_hash;
106 struct nodemap_pde *nm_pde_data;
107 /* fileset the nodes of this nodemap are restricted to */
108 char nm_fileset[PATH_MAX+1];
109 /* information about the expected SELinux policy on the nodes */
110 char nm_sepol[LUSTRE_NODEMAP_SEPOL_LENGTH + 1];
112 /* used when loading/unloading nodemaps */
113 struct list_head nm_list;
116 /* Store handles to local MGC storage to save config locally. In future
117 * versions of nodemap, mgc will receive the config directly and so this might
120 struct nm_config_file {
121 struct local_oid_storage *ncf_los;
122 struct dt_object *ncf_obj;
123 struct list_head ncf_list;
126 void nodemap_activate(const bool value);
127 int nodemap_add(const char *nodemap_name);
128 int nodemap_del(const char *nodemap_name);
129 int nodemap_add_member(lnet_nid_t nid, struct obd_export *exp);
130 void nodemap_del_member(struct obd_export *exp);
131 int nodemap_parse_range(const char *range_string, lnet_nid_t range[2]);
132 int nodemap_parse_idmap(char *idmap_string, __u32 idmap[2]);
133 int nodemap_add_range(const char *name, const lnet_nid_t nid[2]);
134 int nodemap_del_range(const char *name, const lnet_nid_t nid[2]);
135 int nodemap_set_allow_root(const char *name, bool allow_root);
136 int nodemap_set_trust_client_ids(const char *name, bool trust_client_ids);
137 int nodemap_set_deny_unknown(const char *name, bool deny_unknown);
138 int nodemap_set_mapping_mode(const char *name, enum nodemap_mapping_modes mode);
139 int nodemap_set_squash_uid(const char *name, uid_t uid);
140 int nodemap_set_squash_gid(const char *name, gid_t gid);
141 int nodemap_set_audit_mode(const char *name, bool enable_audit);
142 bool nodemap_can_setquota(const struct lu_nodemap *nodemap);
143 int nodemap_add_idmap(const char *name, enum nodemap_id_type id_type,
145 int nodemap_del_idmap(const char *name, enum nodemap_id_type id_type,
147 int nodemap_set_fileset(const char *name, const char *fileset);
148 char *nodemap_get_fileset(const struct lu_nodemap *nodemap);
149 int nodemap_set_sepol(const char *name, const char *sepol);
150 const char *nodemap_get_sepol(const struct lu_nodemap *nodemap);
151 __u32 nodemap_map_id(struct lu_nodemap *nodemap,
152 enum nodemap_id_type id_type,
153 enum nodemap_tree_type tree_type, __u32 id);
154 ssize_t nodemap_map_acl(struct lu_nodemap *nodemap, void *buf, size_t size,
155 enum nodemap_tree_type tree_type);
156 #ifdef HAVE_SERVER_SUPPORT
157 void nodemap_test_nid(lnet_nid_t nid, char *name_buf, size_t name_len);
159 #define nodemap_test_nid(nid, name_buf, name_len) do {} while(0)
161 int nodemap_test_id(lnet_nid_t nid, enum nodemap_id_type idtype,
162 __u32 client_id, __u32 *fs_id);
164 struct nm_config_file *nm_config_file_register_mgs(const struct lu_env *env,
165 struct dt_object *obj,
166 struct local_oid_storage *los);
168 struct nm_config_file *nm_config_file_register_tgt(const struct lu_env *env,
169 struct dt_device *dev,
170 struct local_oid_storage *los);
171 void nm_config_file_deregister_mgs(const struct lu_env *env,
172 struct nm_config_file *ncf);
173 void nm_config_file_deregister_tgt(const struct lu_env *env,
174 struct nm_config_file *ncf);
175 struct lu_nodemap *nodemap_get_from_exp(struct obd_export *exp);
176 void nodemap_putref(struct lu_nodemap *nodemap);
178 #ifdef HAVE_SERVER_SUPPORT
179 struct nodemap_range_tree {
180 struct interval_node *nmrt_range_interval_root;
181 unsigned int nmrt_range_highest_id;
184 struct nodemap_config {
185 /* Highest numerical lu_nodemap.nm_id defined */
186 unsigned int nmc_nodemap_highest_id;
188 /* Simple flag to determine if nodemaps are active */
189 bool nmc_nodemap_is_active;
191 /* Pointer to default nodemap as it is needed more often */
192 struct lu_nodemap *nmc_default_nodemap;
195 * Lock required to access the range tree.
197 struct rw_semaphore nmc_range_tree_lock;
198 struct nodemap_range_tree nmc_range_tree;
201 * Hash keyed on nodemap name containing all
204 struct cfs_hash *nmc_nodemap_hash;
207 struct nodemap_config *nodemap_config_alloc(void);
208 void nodemap_config_dealloc(struct nodemap_config *config);
209 void nodemap_config_set_active_mgc(struct nodemap_config *config);
211 int nodemap_process_idx_pages(struct nodemap_config *config, union lu_page *lip,
212 struct lu_nodemap **recent_nodemap);
214 #else /* disable nodemap processing in MGC of non-servers */
215 static inline int nodemap_process_idx_pages(void *config,
217 struct lu_nodemap **recent_nodemap)
219 #endif /* HAVE_SERVER_SUPPORT */
221 int nodemap_get_config_req(struct obd_device *mgs_obd,
222 struct ptlrpc_request *req);
223 #endif /* _LUSTRE_NODEMAP_H */