Whamcloud - gitweb
LU-1347 build: remove the vim/emacs modelines
[fs/lustre-release.git] / lustre / mdt / mdt_identity.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, Whamcloud, Inc.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * lustre/mdt/mdt_identity.c
37  *
38  * Author: Lai Siyao <lsy@clusterfs.com>
39  * Author: Fan Yong <fanyong@clusterfs.com>
40  */
41
42 #ifndef EXPORT_SYMTAB
43 #define EXPORT_SYMTAB
44 #endif
45 #define DEBUG_SUBSYSTEM S_MDS
46
47 #ifndef AUTOCONF_INCLUDED
48 #include <linux/config.h>
49 #endif
50 #include <linux/module.h>
51 #include <linux/kernel.h>
52 #include <linux/mm.h>
53 #include <linux/kmod.h>
54 #include <linux/string.h>
55 #include <linux/stat.h>
56 #include <linux/errno.h>
57 #include <linux/version.h>
58 #include <linux/unistd.h>
59 #include <asm/system.h>
60 #include <asm/uaccess.h>
61 #include <linux/fs.h>
62 #include <linux/stat.h>
63 #include <asm/uaccess.h>
64 #include <linux/slab.h>
65
66 #include <libcfs/libcfs.h>
67 #include <libcfs/lucache.h>
68 #include <obd.h>
69 #include <obd_class.h>
70 #include <obd_support.h>
71 #include <lustre_net.h>
72 #include <lustre_import.h>
73 #include <lustre_dlm.h>
74 #include <lustre_lib.h>
75
76 #include "mdt_internal.h"
77
78 static void mdt_identity_entry_init(struct upcall_cache_entry *entry,
79                                     void *unused)
80 {
81         entry->u.identity.mi_uc_entry = entry;
82 }
83
84 static void mdt_identity_entry_free(struct upcall_cache *cache,
85                                     struct upcall_cache_entry *entry)
86 {
87         struct md_identity *identity = &entry->u.identity;
88
89         if (identity->mi_ginfo) {
90                 cfs_put_group_info(identity->mi_ginfo);
91                 identity->mi_ginfo = NULL;
92         }
93
94         if (identity->mi_nperms) {
95                 LASSERT(identity->mi_perms);
96                 OBD_FREE(identity->mi_perms,
97                          identity->mi_nperms * sizeof(struct md_perm));
98                 identity->mi_nperms = 0;
99         }
100 }
101
102 static int mdt_identity_do_upcall(struct upcall_cache *cache,
103                                   struct upcall_cache_entry *entry)
104 {
105         char keystr[16];
106         char *argv[] = {
107                   [0] = cache->uc_upcall,
108                   [1] = cache->uc_name,
109                   [2] = keystr,
110                   [3] = NULL
111         };
112         char *envp[] = {
113                   [0] = "HOME=/",
114                   [1] = "PATH=/sbin:/usr/sbin",
115                   [2] = NULL
116         };
117         struct timeval start, end;
118         int rc;
119         ENTRY;
120
121         /* There is race condition:
122          * "uc_upcall" was changed just after "is_identity_get_disabled" check.
123          */
124         cfs_read_lock(&cache->uc_upcall_rwlock);
125         CDEBUG(D_INFO, "The upcall is: '%s'\n", cache->uc_upcall);
126
127         if (unlikely(!strcmp(cache->uc_upcall, "NONE"))) {
128                 CERROR("no upcall set\n");
129                 GOTO(out, rc = -EREMCHG);
130         }
131
132         argv[0] = cache->uc_upcall;
133         snprintf(keystr, sizeof(keystr), LPU64, entry->ue_key);
134
135         cfs_gettimeofday(&start);
136         rc = USERMODEHELPER(argv[0], argv, envp);
137         cfs_gettimeofday(&end);
138         if (rc < 0) {
139                 CERROR("%s: error invoking upcall %s %s %s: rc %d; "
140                        "check /proc/fs/lustre/mdt/%s/identity_upcall, "
141                        "time %ldus\n",
142                        cache->uc_name, argv[0], argv[1], argv[2], rc,
143                        cache->uc_name, cfs_timeval_sub(&end, &start, NULL));
144         } else {
145                 CDEBUG(D_HA, "%s: invoked upcall %s %s %s, time %ldus\n",
146                        cache->uc_name, argv[0], argv[1], argv[2],
147                        cfs_timeval_sub(&end, &start, NULL));
148                 rc = 0;
149         }
150         EXIT;
151 out:
152         cfs_read_unlock(&cache->uc_upcall_rwlock);
153         return rc;
154 }
155
156 static int mdt_identity_parse_downcall(struct upcall_cache *cache,
157                                        struct upcall_cache_entry *entry,
158                                        void *args)
159 {
160         struct md_identity *identity = &entry->u.identity;
161         struct identity_downcall_data *data = args;
162         cfs_group_info_t *ginfo = NULL;
163         struct md_perm *perms = NULL;
164         int size, i;
165         ENTRY;
166
167         LASSERT(data);
168         if (data->idd_ngroups > NGROUPS_MAX)
169                 RETURN(-E2BIG);
170
171         if (data->idd_ngroups > 0) {
172                 ginfo = cfs_groups_alloc(data->idd_ngroups);
173                 if (!ginfo) {
174                         CERROR("failed to alloc %d groups\n", data->idd_ngroups);
175                         RETURN(-ENOMEM);
176                 }
177
178                 lustre_groups_from_list(ginfo, data->idd_groups);
179                 lustre_groups_sort(ginfo);
180         }
181
182         if (data->idd_nperms) {
183                 size = data->idd_nperms * sizeof(*perms);
184                 OBD_ALLOC(perms, size);
185                 if (!perms) {
186                         CERROR("failed to alloc %d permissions\n",
187                                data->idd_nperms);
188                         if (ginfo != NULL)
189                                 cfs_put_group_info(ginfo);
190                         RETURN(-ENOMEM);
191                 }
192
193                 for (i = 0; i < data->idd_nperms; i++) {
194                         perms[i].mp_nid = data->idd_perms[i].pdd_nid;
195                         perms[i].mp_perm = data->idd_perms[i].pdd_perm;
196                 }
197         }
198
199         identity->mi_uid = data->idd_uid;
200         identity->mi_gid = data->idd_gid;
201         identity->mi_ginfo = ginfo;
202         identity->mi_nperms = data->idd_nperms;
203         identity->mi_perms = perms;
204
205         CDEBUG(D_OTHER, "parse mdt identity@%p: %d:%d, ngroups %u, nperms %u\n",
206                identity, identity->mi_uid, identity->mi_gid,
207                data->idd_ngroups, data->idd_nperms);
208
209         RETURN(0);
210 }
211
212 struct md_identity *mdt_identity_get(struct upcall_cache *cache, __u32 uid)
213 {
214         struct upcall_cache_entry *entry;
215
216         if (!cache)
217                 return ERR_PTR(-ENOENT);
218
219         entry = upcall_cache_get_entry(cache, (__u64)uid, NULL);
220         if (IS_ERR(entry))
221                 return ERR_PTR(PTR_ERR(entry));
222         else if (unlikely(!entry))
223                 return ERR_PTR(-ENOENT);
224         else
225                 return &entry->u.identity;
226 }
227
228 void mdt_identity_put(struct upcall_cache *cache, struct md_identity *identity)
229 {
230         if (!cache)
231                 return;
232
233         LASSERT(identity);
234         upcall_cache_put_entry(cache, identity->mi_uc_entry);
235 }
236
237 struct upcall_cache_ops mdt_identity_upcall_cache_ops = {
238         .init_entry     = mdt_identity_entry_init,
239         .free_entry     = mdt_identity_entry_free,
240         .do_upcall      = mdt_identity_do_upcall,
241         .parse_downcall = mdt_identity_parse_downcall,
242 };
243
244 void mdt_flush_identity(struct upcall_cache *cache, int uid)
245 {
246         if (uid < 0)
247                 upcall_cache_flush_idle(cache);
248         else
249                 upcall_cache_flush_one(cache, (__u64)uid, NULL);
250 }
251
252 /*
253  * If there is LNET_NID_ANY in perm[i].mp_nid,
254  * it must be perm[0].mp_nid, and act as default perm.
255  */
256 __u32 mdt_identity_get_perm(struct md_identity *identity,
257                             __u32 is_rmtclient, lnet_nid_t nid)
258 {
259         struct md_perm *perm;
260         int i;
261
262         if (!identity) {
263                 LASSERT(is_rmtclient == 0);
264                 return CFS_SETGRP_PERM;
265         }
266
267         perm = identity->mi_perms;
268         /* check exactly matched nid first */
269         for (i = identity->mi_nperms - 1; i > 0; i--) {
270                 if (perm[i].mp_nid != nid)
271                         continue;
272                 return perm[i].mp_perm;
273         }
274
275         /* check LNET_NID_ANY then */
276         if ((identity->mi_nperms > 0) &&
277             ((perm[0].mp_nid == nid) || (perm[0].mp_nid == LNET_NID_ANY)))
278                 return perm[0].mp_perm;
279
280         /* return default last */
281         return is_rmtclient ? 0 : CFS_SETGRP_PERM;
282 }
283
284 int mdt_pack_remote_perm(struct mdt_thread_info *info, struct mdt_object *o,
285                          void *buf)
286 {
287         struct md_ucred         *uc = mdt_ucred(info);
288         struct md_object        *next = mdt_object_child(o);
289         struct mdt_remote_perm  *perm = buf;
290
291         ENTRY;
292
293         /* remote client request always pack ptlrpc_user_desc! */
294         LASSERT(perm);
295
296         if (!exp_connect_rmtclient(info->mti_exp))
297                 RETURN(-EBADE);
298
299         if ((uc->mu_valid != UCRED_OLD) && (uc->mu_valid != UCRED_NEW))
300                 RETURN(-EINVAL);
301
302         perm->rp_uid = uc->mu_o_uid;
303         perm->rp_gid = uc->mu_o_gid;
304         perm->rp_fsuid = uc->mu_o_fsuid;
305         perm->rp_fsgid = uc->mu_o_fsgid;
306
307         perm->rp_access_perm = 0;
308         if (mo_permission(info->mti_env, NULL, next, NULL, MAY_READ) == 0)
309                 perm->rp_access_perm |= MAY_READ;
310         if (mo_permission(info->mti_env, NULL, next, NULL, MAY_WRITE) == 0)
311                 perm->rp_access_perm |= MAY_WRITE;
312         if (mo_permission(info->mti_env, NULL, next, NULL, MAY_EXEC) == 0)
313                 perm->rp_access_perm |= MAY_EXEC;
314
315         RETURN(0);
316 }