Whamcloud - gitweb
LU-7988 hsm: run HSM coordinator once per second at most
[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.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2016, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/mdt/mdt_identity.c
33  *
34  * Author: Lai Siyao <lsy@clusterfs.com>
35  * Author: Fan Yong <fanyong@clusterfs.com>
36  */
37
38 #define DEBUG_SUBSYSTEM S_MDS
39
40 #include <linux/module.h>
41 #include <linux/kernel.h>
42 #include <linux/mm.h>
43 #include <linux/kmod.h>
44 #include <linux/string.h>
45 #include <linux/stat.h>
46 #include <linux/errno.h>
47 #include <linux/version.h>
48 #include <linux/unistd.h>
49 #include <asm/uaccess.h>
50 #include <linux/fs.h>
51 #include <linux/stat.h>
52 #include <asm/uaccess.h>
53 #include <linux/slab.h>
54
55 #include <libcfs/libcfs.h>
56 #include <obd.h>
57 #include <obd_class.h>
58 #include <obd_support.h>
59 #include <lustre_net.h>
60 #include <lustre_import.h>
61 #include <lustre_dlm.h>
62 #include <lustre_lib.h>
63
64 #include "mdt_internal.h"
65
66 static void mdt_identity_entry_init(struct upcall_cache_entry *entry,
67                                     void *unused)
68 {
69         entry->u.identity.mi_uc_entry = entry;
70 }
71
72 static void mdt_identity_entry_free(struct upcall_cache *cache,
73                                     struct upcall_cache_entry *entry)
74 {
75         struct md_identity *identity = &entry->u.identity;
76
77         if (identity->mi_ginfo) {
78                 put_group_info(identity->mi_ginfo);
79                 identity->mi_ginfo = NULL;
80         }
81
82         if (identity->mi_nperms) {
83                 LASSERT(identity->mi_perms);
84                 OBD_FREE(identity->mi_perms,
85                          identity->mi_nperms * sizeof(struct md_perm));
86                 identity->mi_nperms = 0;
87         }
88 }
89
90 static int mdt_identity_do_upcall(struct upcall_cache *cache,
91                                   struct upcall_cache_entry *entry)
92 {
93         char keystr[16];
94         char *argv[] = {
95                   [0] = cache->uc_upcall,
96                   [1] = cache->uc_name,
97                   [2] = keystr,
98                   [3] = NULL
99         };
100         char *envp[] = {
101                   [0] = "HOME=/",
102                   [1] = "PATH=/sbin:/usr/sbin",
103                   [2] = NULL
104         };
105         ktime_t start, end;
106         int rc;
107         ENTRY;
108
109         /* There is race condition:
110          * "uc_upcall" was changed just after "is_identity_get_disabled" check.
111          */
112         down_read(&cache->uc_upcall_rwsem);
113         CDEBUG(D_INFO, "The upcall is: '%s'\n", cache->uc_upcall);
114
115         if (unlikely(!strcmp(cache->uc_upcall, "NONE"))) {
116                 CERROR("no upcall set\n");
117                 GOTO(out, rc = -EREMCHG);
118         }
119
120         argv[0] = cache->uc_upcall;
121         snprintf(keystr, sizeof(keystr), "%llu", entry->ue_key);
122
123         start = ktime_get();
124         rc = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_EXEC);
125         end = ktime_get();
126         if (rc < 0) {
127                 CERROR("%s: error invoking upcall %s %s %s: rc %d; check /proc/fs/lustre/mdt/%s/identity_upcall, time %ldus\n",
128                        cache->uc_name, argv[0], argv[1], argv[2], rc,
129                        cache->uc_name, (long)ktime_us_delta(end, start));
130         } else {
131                 CDEBUG(D_HA, "%s: invoked upcall %s %s %s, time %ldus\n",
132                        cache->uc_name, argv[0], argv[1], argv[2],
133                        (long)ktime_us_delta(end, start));
134                 rc = 0;
135         }
136         EXIT;
137 out:
138         up_read(&cache->uc_upcall_rwsem);
139         return rc;
140 }
141
142 static int mdt_identity_parse_downcall(struct upcall_cache *cache,
143                                        struct upcall_cache_entry *entry,
144                                        void *args)
145 {
146         struct md_identity *identity = &entry->u.identity;
147         struct identity_downcall_data *data = args;
148         struct group_info *ginfo = NULL;
149         struct md_perm *perms = NULL;
150         int size, i;
151         ENTRY;
152
153         LASSERT(data);
154         if (data->idd_ngroups > NGROUPS_MAX)
155                 RETURN(-E2BIG);
156
157         if (data->idd_ngroups > 0) {
158                 ginfo = groups_alloc(data->idd_ngroups);
159                 if (!ginfo) {
160                         CERROR("failed to alloc %d groups\n", data->idd_ngroups);
161                         RETURN(-ENOMEM);
162                 }
163
164                 lustre_groups_from_list(ginfo, data->idd_groups);
165                 lustre_groups_sort(ginfo);
166         }
167
168         if (data->idd_nperms) {
169                 size = data->idd_nperms * sizeof(*perms);
170                 OBD_ALLOC(perms, size);
171                 if (!perms) {
172                         CERROR("failed to alloc %d permissions\n",
173                                data->idd_nperms);
174                         if (ginfo != NULL)
175                                 put_group_info(ginfo);
176                         RETURN(-ENOMEM);
177                 }
178
179                 for (i = 0; i < data->idd_nperms; i++) {
180                         perms[i].mp_nid = data->idd_perms[i].pdd_nid;
181                         perms[i].mp_perm = data->idd_perms[i].pdd_perm;
182                 }
183         }
184
185         identity->mi_uid = data->idd_uid;
186         identity->mi_gid = data->idd_gid;
187         identity->mi_ginfo = ginfo;
188         identity->mi_nperms = data->idd_nperms;
189         identity->mi_perms = perms;
190
191         CDEBUG(D_OTHER, "parse mdt identity@%p: %d:%d, ngroups %u, nperms %u\n",
192                identity, identity->mi_uid, identity->mi_gid,
193                data->idd_ngroups, data->idd_nperms);
194
195         RETURN(0);
196 }
197
198 struct md_identity *mdt_identity_get(struct upcall_cache *cache, __u32 uid)
199 {
200         struct upcall_cache_entry *entry;
201
202         if (!cache)
203                 return ERR_PTR(-ENOENT);
204
205         entry = upcall_cache_get_entry(cache, (__u64)uid, NULL);
206         if (IS_ERR(entry))
207                 return ERR_PTR(PTR_ERR(entry));
208         else if (unlikely(!entry))
209                 return ERR_PTR(-ENOENT);
210         else
211                 return &entry->u.identity;
212 }
213
214 void mdt_identity_put(struct upcall_cache *cache, struct md_identity *identity)
215 {
216         if (!cache)
217                 return;
218
219         LASSERT(identity);
220         upcall_cache_put_entry(cache, identity->mi_uc_entry);
221 }
222
223 struct upcall_cache_ops mdt_identity_upcall_cache_ops = {
224         .init_entry     = mdt_identity_entry_init,
225         .free_entry     = mdt_identity_entry_free,
226         .do_upcall      = mdt_identity_do_upcall,
227         .parse_downcall = mdt_identity_parse_downcall,
228 };
229
230 void mdt_flush_identity(struct upcall_cache *cache, int uid)
231 {
232         if (uid < 0)
233                 upcall_cache_flush_idle(cache);
234         else
235                 upcall_cache_flush_one(cache, (__u64)uid, NULL);
236 }
237
238 /*
239  * If there is LNET_NID_ANY in perm[i].mp_nid,
240  * it must be perm[0].mp_nid, and act as default perm.
241  */
242 __u32 mdt_identity_get_perm(struct md_identity *identity, lnet_nid_t nid)
243 {
244
245         struct md_perm *perm;
246         int i;
247
248         if (!identity)
249                 return CFS_SETGRP_PERM;
250
251         perm = identity->mi_perms;
252         /* check exactly matched nid first */
253         for (i = identity->mi_nperms - 1; i > 0; i--) {
254                 if (perm[i].mp_nid != nid)
255                         continue;
256                 return perm[i].mp_perm;
257         }
258
259         /* check LNET_NID_ANY then */
260         if ((identity->mi_nperms > 0) &&
261             ((perm[0].mp_nid == nid) || (perm[0].mp_nid == LNET_NID_ANY)))
262                 return perm[0].mp_perm;
263
264         /* return default last */
265         return CFS_SETGRP_PERM;
266 }