Whamcloud - gitweb
Updated content to point to valid wiki page.
[fs/lustre-release.git] / lustre / ptlrpc / sec_null.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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/ptlrpc/sec_null.c
37  *
38  * Author: Eric Mei <ericm@clusterfs.com>
39  */
40
41 #ifndef EXPORT_SYMTAB
42 # define EXPORT_SYMTAB
43 #endif
44 #define DEBUG_SUBSYSTEM S_SEC
45
46 #ifndef __KERNEL__
47 #include <liblustre.h>
48 #endif
49
50 #include <obd_support.h>
51 #include <obd_cksum.h>
52 #include <obd_class.h>
53 #include <lustre_net.h>
54 #include <lustre_sec.h>
55
56 static struct ptlrpc_sec_policy null_policy;
57 static struct ptlrpc_sec        null_sec;
58 static struct ptlrpc_cli_ctx    null_cli_ctx;
59 static struct ptlrpc_svc_ctx    null_svc_ctx;
60
61 /*
62  * we can temporarily use the topmost 8-bits of lm_secflvr to identify
63  * the source sec part.
64  */
65 static inline
66 void null_encode_sec_part(struct lustre_msg *msg, enum lustre_sec_part sp)
67 {
68         msg->lm_secflvr |= (((__u32) sp) & 0xFF) << 24;
69 }
70
71 static inline
72 enum lustre_sec_part null_decode_sec_part(struct lustre_msg *msg)
73 {
74         return (msg->lm_secflvr >> 24) & 0xFF;
75 }
76
77 static int null_ctx_refresh(struct ptlrpc_cli_ctx *ctx)
78 {
79         /* should never reach here */
80         LBUG();
81         return 0;
82 }
83
84 static
85 int null_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
86 {
87         req->rq_reqbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
88
89         if (!req->rq_import->imp_dlm_fake) {
90                 struct obd_device *obd = req->rq_import->imp_obd;
91                 null_encode_sec_part(req->rq_reqbuf,
92                                      obd->u.cli.cl_sp_me);
93         }
94         req->rq_reqdata_len = req->rq_reqlen;
95         return 0;
96 }
97
98 static
99 int null_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
100 {
101         __u32   cksums, cksumc;
102
103         LASSERT(req->rq_repdata);
104
105         req->rq_repmsg = req->rq_repdata;
106         req->rq_replen = req->rq_repdata_len;
107
108         if (req->rq_early) {
109                 cksums = lustre_msg_get_cksum(req->rq_repdata);
110                 cksumc = lustre_msg_calc_cksum(req->rq_repmsg);
111                 if (cksumc != cksums) {
112                         CWARN("early reply checksum mismatch: %08x != %08x\n",
113                               cksumc, cksums);
114                         return -EINVAL;
115                 }
116         }
117
118         return 0;
119 }
120
121 static
122 struct ptlrpc_sec *null_create_sec(struct obd_import *imp,
123                                    struct ptlrpc_svc_ctx *svc_ctx,
124                                    struct sptlrpc_flavor *sf)
125 {
126         LASSERT(SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
127
128         /* general layer has take a module reference for us, because we never
129          * really destroy the sec, simply release the reference here.
130          */
131         sptlrpc_policy_put(&null_policy);
132         return &null_sec;
133 }
134
135 static
136 void null_destroy_sec(struct ptlrpc_sec *sec)
137 {
138         LASSERT(sec == &null_sec);
139 }
140
141 static
142 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
143                                        struct vfs_cred *vcred,
144                                        int create, int remove_dead)
145 {
146         atomic_inc(&null_cli_ctx.cc_refcount);
147         return &null_cli_ctx;
148 }
149
150 static
151 int null_flush_ctx_cache(struct ptlrpc_sec *sec,
152                          uid_t uid,
153                          int grace, int force)
154 {
155         return 0;
156 }
157
158 static
159 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
160                       struct ptlrpc_request *req,
161                       int msgsize)
162 {
163         if (!req->rq_reqbuf) {
164                 int alloc_size = size_roundup_power2(msgsize);
165
166                 LASSERT(!req->rq_pool);
167                 OBD_ALLOC(req->rq_reqbuf, alloc_size);
168                 if (!req->rq_reqbuf)
169                         return -ENOMEM;
170
171                 req->rq_reqbuf_len = alloc_size;
172         } else {
173                 LASSERT(req->rq_pool);
174                 LASSERT(req->rq_reqbuf_len >= msgsize);
175                 memset(req->rq_reqbuf, 0, msgsize);
176         }
177
178         req->rq_reqmsg = req->rq_reqbuf;
179         return 0;
180 }
181
182 static
183 void null_free_reqbuf(struct ptlrpc_sec *sec,
184                       struct ptlrpc_request *req)
185 {
186         if (!req->rq_pool) {
187                 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
188                          "req %p: reqmsg %p is not reqbuf %p in null sec\n",
189                          req, req->rq_reqmsg, req->rq_reqbuf);
190                 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
191                          "req %p: reqlen %d should smaller than buflen %d\n",
192                          req, req->rq_reqlen, req->rq_reqbuf_len);
193
194                 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
195                 req->rq_reqmsg = req->rq_reqbuf = NULL;
196                 req->rq_reqbuf_len = 0;
197         }
198
199         req->rq_reqmsg = NULL;
200 }
201
202 static
203 int null_alloc_repbuf(struct ptlrpc_sec *sec,
204                       struct ptlrpc_request *req,
205                       int msgsize)
206 {
207         /* add space for early replied */
208         msgsize += lustre_msg_early_size();
209
210         msgsize = size_roundup_power2(msgsize);
211
212         OBD_ALLOC(req->rq_repbuf, msgsize);
213         if (!req->rq_repbuf)
214                 return -ENOMEM;
215
216         req->rq_repbuf_len = msgsize;
217         return 0;
218 }
219
220 static
221 void null_free_repbuf(struct ptlrpc_sec *sec,
222                       struct ptlrpc_request *req)
223 {
224         LASSERT(req->rq_repbuf);
225
226         OBD_FREE(req->rq_repbuf, req->rq_repbuf_len);
227         req->rq_repbuf = NULL;
228         req->rq_repbuf_len = 0;
229
230         req->rq_repmsg = NULL;
231 }
232
233 static
234 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
235                         struct ptlrpc_request *req,
236                         int segment, int newsize)
237 {
238         struct lustre_msg      *newbuf;
239         struct lustre_msg      *oldbuf = req->rq_reqmsg;
240         int                     oldsize, newmsg_size, alloc_size;
241
242         LASSERT(req->rq_reqbuf);
243         LASSERT(req->rq_reqbuf == req->rq_reqmsg);
244         LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
245         LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
246
247         /* compute new message size */
248         oldsize = req->rq_reqbuf->lm_buflens[segment];
249         req->rq_reqbuf->lm_buflens[segment] = newsize;
250         newmsg_size = lustre_packed_msg_size(oldbuf);
251         req->rq_reqbuf->lm_buflens[segment] = oldsize;
252
253         /* request from pool should always have enough buffer */
254         LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
255
256         if (req->rq_reqbuf_len < newmsg_size) {
257                 alloc_size = size_roundup_power2(newmsg_size);
258
259                 OBD_ALLOC(newbuf, alloc_size);
260                 if (newbuf == NULL)
261                         return -ENOMEM;
262
263                 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
264
265                 OBD_FREE(req->rq_reqbuf, req->rq_reqbuf_len);
266                 req->rq_reqbuf = req->rq_reqmsg = newbuf;
267                 req->rq_reqbuf_len = alloc_size;
268         }
269
270         _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
271         req->rq_reqlen = newmsg_size;
272
273         return 0;
274 }
275
276 static struct ptlrpc_svc_ctx null_svc_ctx = {
277         .sc_refcount    = ATOMIC_INIT(1),
278         .sc_policy      = &null_policy,
279 };
280
281 static
282 int null_accept(struct ptlrpc_request *req)
283 {
284         LASSERT(SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) ==
285                 SPTLRPC_POLICY_NULL);
286
287         if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
288                 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
289                 return SECSVC_DROP;
290         }
291
292         req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
293
294         req->rq_reqmsg = req->rq_reqbuf;
295         req->rq_reqlen = req->rq_reqdata_len;
296
297         req->rq_svc_ctx = &null_svc_ctx;
298         atomic_inc(&req->rq_svc_ctx->sc_refcount);
299
300         return SECSVC_OK;
301 }
302
303 static
304 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
305 {
306         struct ptlrpc_reply_state *rs;
307         int rs_size = sizeof(*rs) + msgsize;
308
309         LASSERT(msgsize % 8 == 0);
310
311         rs = req->rq_reply_state;
312
313         if (rs) {
314                 /* pre-allocated */
315                 LASSERT(rs->rs_size >= rs_size);
316         } else {
317                 OBD_ALLOC(rs, rs_size);
318                 if (rs == NULL)
319                         return -ENOMEM;
320
321                 rs->rs_size = rs_size;
322         }
323
324         rs->rs_svc_ctx = req->rq_svc_ctx;
325         atomic_inc(&req->rq_svc_ctx->sc_refcount);
326
327         rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
328         rs->rs_repbuf_len = rs_size - sizeof(*rs);
329         rs->rs_msg = rs->rs_repbuf;
330
331         req->rq_reply_state = rs;
332         return 0;
333 }
334
335 static
336 void null_free_rs(struct ptlrpc_reply_state *rs)
337 {
338         LASSERT(atomic_read(&rs->rs_svc_ctx->sc_refcount) > 1);
339         atomic_dec(&rs->rs_svc_ctx->sc_refcount);
340
341         if (!rs->rs_prealloc)
342                 OBD_FREE(rs, rs->rs_size);
343 }
344
345 static
346 int null_authorize(struct ptlrpc_request *req)
347 {
348         struct ptlrpc_reply_state *rs = req->rq_reply_state;
349
350         LASSERT(rs);
351
352         rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
353         rs->rs_repdata_len = req->rq_replen;
354
355         if (likely(req->rq_packed_final)) {
356                 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
357                         req->rq_reply_off = lustre_msg_early_size();
358                 else
359                         req->rq_reply_off = 0;
360         } else {
361                 lustre_msg_set_cksum(rs->rs_repbuf,
362                                      lustre_msg_calc_cksum(rs->rs_repbuf));
363                 req->rq_reply_off = 0;
364         }
365
366         return 0;
367 }
368
369 static struct ptlrpc_ctx_ops null_ctx_ops = {
370         .refresh                = null_ctx_refresh,
371         .sign                   = null_ctx_sign,
372         .verify                 = null_ctx_verify,
373 };
374
375 static struct ptlrpc_sec_cops null_sec_cops = {
376         .create_sec             = null_create_sec,
377         .destroy_sec            = null_destroy_sec,
378         .lookup_ctx             = null_lookup_ctx,
379         .flush_ctx_cache        = null_flush_ctx_cache,
380         .alloc_reqbuf           = null_alloc_reqbuf,
381         .alloc_repbuf           = null_alloc_repbuf,
382         .free_reqbuf            = null_free_reqbuf,
383         .free_repbuf            = null_free_repbuf,
384         .enlarge_reqbuf         = null_enlarge_reqbuf,
385 };
386
387 static struct ptlrpc_sec_sops null_sec_sops = {
388         .accept                 = null_accept,
389         .alloc_rs               = null_alloc_rs,
390         .authorize              = null_authorize,
391         .free_rs                = null_free_rs,
392 };
393
394 static struct ptlrpc_sec_policy null_policy = {
395         .sp_owner               = THIS_MODULE,
396         .sp_name                = "sec.null",
397         .sp_policy              = SPTLRPC_POLICY_NULL,
398         .sp_cops                = &null_sec_cops,
399         .sp_sops                = &null_sec_sops,
400 };
401
402 static void null_init_internal(void)
403 {
404         static HLIST_HEAD(__list);
405
406         null_sec.ps_policy = &null_policy;
407         atomic_set(&null_sec.ps_refcount, 1);     /* always busy */
408         null_sec.ps_id = -1;
409         null_sec.ps_import = NULL;
410         null_sec.ps_flvr.sf_rpc = SPTLRPC_FLVR_NULL;
411         null_sec.ps_flvr.sf_flags = 0;
412         null_sec.ps_part = LUSTRE_SP_ANY;
413         null_sec.ps_dying = 0;
414         spin_lock_init(&null_sec.ps_lock);
415         atomic_set(&null_sec.ps_nctx, 1);         /* for "null_cli_ctx" */
416         CFS_INIT_LIST_HEAD(&null_sec.ps_gc_list);
417         null_sec.ps_gc_interval = 0;
418         null_sec.ps_gc_next = 0;
419
420         hlist_add_head(&null_cli_ctx.cc_cache, &__list);
421         atomic_set(&null_cli_ctx.cc_refcount, 1);    /* for hash */
422         null_cli_ctx.cc_sec = &null_sec;
423         null_cli_ctx.cc_ops = &null_ctx_ops;
424         null_cli_ctx.cc_expire = 0;
425         null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
426                                 PTLRPC_CTX_UPTODATE;
427         null_cli_ctx.cc_vcred.vc_uid = 0;
428         spin_lock_init(&null_cli_ctx.cc_lock);
429         CFS_INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
430         CFS_INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
431 }
432
433 int sptlrpc_null_init(void)
434 {
435         int rc;
436
437         null_init_internal();
438
439         rc = sptlrpc_register_policy(&null_policy);
440         if (rc)
441                 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
442
443         return rc;
444 }
445
446 void sptlrpc_null_fini(void)
447 {
448         int rc;
449
450         rc = sptlrpc_unregister_policy(&null_policy);
451         if (rc)
452                 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,rc);
453 }