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.sun.com/software/products/lustre/docs/GPLv2.pdf
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
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lustre/ptlrpc/sec_null.c
38 * Author: Eric Mei <ericm@clusterfs.com>
41 #define DEBUG_SUBSYSTEM S_SEC
44 #include <obd_support.h>
45 #include <obd_cksum.h>
46 #include <obd_class.h>
47 #include <lustre_net.h>
48 #include <lustre_sec.h>
50 #include "ptlrpc_internal.h"
52 static struct ptlrpc_sec_policy null_policy;
53 static struct ptlrpc_sec null_sec;
54 static struct ptlrpc_cli_ctx null_cli_ctx;
55 static struct ptlrpc_svc_ctx null_svc_ctx;
58 * we can temporarily use the topmost 8-bits of lm_secflvr to identify
59 * the source sec part.
62 void null_encode_sec_part(struct lustre_msg *msg, enum lustre_sec_part sp)
64 msg->lm_secflvr |= (((__u32) sp) & 0xFF) << 24;
68 enum lustre_sec_part null_decode_sec_part(struct lustre_msg *msg)
70 return (msg->lm_secflvr >> 24) & 0xFF;
73 static int null_ctx_refresh(struct ptlrpc_cli_ctx *ctx)
75 /* should never reach here */
81 int null_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
83 req->rq_reqbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
85 if (!req->rq_import->imp_dlm_fake) {
86 struct obd_device *obd = req->rq_import->imp_obd;
87 null_encode_sec_part(req->rq_reqbuf,
90 req->rq_reqdata_len = req->rq_reqlen;
95 int null_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
99 LASSERT(req->rq_repdata);
101 req->rq_repmsg = req->rq_repdata;
102 req->rq_replen = req->rq_repdata_len;
105 cksums = lustre_msg_get_cksum(req->rq_repdata);
106 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 53, 0)
107 if (lustre_msghdr_get_flags(req->rq_reqmsg) &
108 MSGHDR_CKSUM_INCOMPAT18)
109 cksumc = lustre_msg_calc_cksum(req->rq_repmsg, 0);
111 cksumc = lustre_msg_calc_cksum(req->rq_repmsg, 1);
113 cksumc = lustre_msg_calc_cksum(req->rq_repmsg);
115 if (cksumc != cksums) {
117 "early reply checksum mismatch: %08x != %08x\n",
127 struct ptlrpc_sec *null_create_sec(struct obd_import *imp,
128 struct ptlrpc_svc_ctx *svc_ctx,
129 struct sptlrpc_flavor *sf)
131 LASSERT(SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
133 /* general layer has take a module reference for us, because we never
134 * really destroy the sec, simply release the reference here.
136 sptlrpc_policy_put(&null_policy);
141 void null_destroy_sec(struct ptlrpc_sec *sec)
143 LASSERT(sec == &null_sec);
147 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
148 struct vfs_cred *vcred,
149 int create, int remove_dead)
151 atomic_inc(&null_cli_ctx.cc_refcount);
152 return &null_cli_ctx;
156 int null_flush_ctx_cache(struct ptlrpc_sec *sec,
158 int grace, int force)
164 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
165 struct ptlrpc_request *req,
168 if (!req->rq_reqbuf) {
169 int alloc_size = size_roundup_power2(msgsize);
171 LASSERT(!req->rq_pool);
172 OBD_ALLOC_LARGE(req->rq_reqbuf, alloc_size);
176 req->rq_reqbuf_len = alloc_size;
178 LASSERT(req->rq_pool);
179 LASSERT(req->rq_reqbuf_len >= msgsize);
180 memset(req->rq_reqbuf, 0, msgsize);
183 req->rq_reqmsg = req->rq_reqbuf;
188 void null_free_reqbuf(struct ptlrpc_sec *sec,
189 struct ptlrpc_request *req)
192 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
193 "req %p: reqmsg %p is not reqbuf %p in null sec\n",
194 req, req->rq_reqmsg, req->rq_reqbuf);
195 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
196 "req %p: reqlen %d should smaller than buflen %d\n",
197 req, req->rq_reqlen, req->rq_reqbuf_len);
199 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
200 req->rq_reqbuf = NULL;
201 req->rq_reqbuf_len = 0;
206 int null_alloc_repbuf(struct ptlrpc_sec *sec,
207 struct ptlrpc_request *req,
210 /* add space for early replied */
211 msgsize += lustre_msg_early_size();
213 msgsize = size_roundup_power2(msgsize);
215 OBD_ALLOC_LARGE(req->rq_repbuf, msgsize);
219 req->rq_repbuf_len = msgsize;
224 void null_free_repbuf(struct ptlrpc_sec *sec,
225 struct ptlrpc_request *req)
227 LASSERT(req->rq_repbuf);
229 OBD_FREE_LARGE(req->rq_repbuf, req->rq_repbuf_len);
230 req->rq_repbuf = NULL;
231 req->rq_repbuf_len = 0;
235 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
236 struct ptlrpc_request *req,
237 int segment, int newsize)
239 struct lustre_msg *newbuf;
240 struct lustre_msg *oldbuf = req->rq_reqmsg;
241 int oldsize, newmsg_size, alloc_size;
243 LASSERT(req->rq_reqbuf);
244 LASSERT(req->rq_reqbuf == req->rq_reqmsg);
245 LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
246 LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
248 /* compute new message size */
249 oldsize = req->rq_reqbuf->lm_buflens[segment];
250 req->rq_reqbuf->lm_buflens[segment] = newsize;
251 newmsg_size = lustre_packed_msg_size(oldbuf);
252 req->rq_reqbuf->lm_buflens[segment] = oldsize;
254 /* request from pool should always have enough buffer */
255 LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
257 if (req->rq_reqbuf_len < newmsg_size) {
258 alloc_size = size_roundup_power2(newmsg_size);
260 OBD_ALLOC_LARGE(newbuf, alloc_size);
264 /* Must lock this, so that otherwise unprotected change of
265 * rq_reqmsg is not racing with parallel processing of
266 * imp_replay_list traversing threads. See LU-3333
267 * This is a bandaid at best, we really need to deal with this
268 * in request enlarging code before unpacking that's already
271 spin_lock(&req->rq_import->imp_lock);
272 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
274 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
275 req->rq_reqbuf = req->rq_reqmsg = newbuf;
276 req->rq_reqbuf_len = alloc_size;
279 spin_unlock(&req->rq_import->imp_lock);
282 _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
283 req->rq_reqlen = newmsg_size;
288 static struct ptlrpc_svc_ctx null_svc_ctx = {
289 .sc_refcount = ATOMIC_INIT(1),
290 .sc_policy = &null_policy,
294 int null_accept(struct ptlrpc_request *req)
296 LASSERT(SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) ==
297 SPTLRPC_POLICY_NULL);
299 if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
300 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
304 req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
306 req->rq_reqmsg = req->rq_reqbuf;
307 req->rq_reqlen = req->rq_reqdata_len;
309 req->rq_svc_ctx = &null_svc_ctx;
310 atomic_inc(&req->rq_svc_ctx->sc_refcount);
316 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
318 struct ptlrpc_reply_state *rs;
319 int rs_size = sizeof(*rs) + msgsize;
321 LASSERT(msgsize % 8 == 0);
323 rs = req->rq_reply_state;
327 LASSERT(rs->rs_size >= rs_size);
329 OBD_ALLOC_LARGE(rs, rs_size);
333 rs->rs_size = rs_size;
336 rs->rs_svc_ctx = req->rq_svc_ctx;
337 atomic_inc(&req->rq_svc_ctx->sc_refcount);
339 rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
340 rs->rs_repbuf_len = rs_size - sizeof(*rs);
341 rs->rs_msg = rs->rs_repbuf;
343 req->rq_reply_state = rs;
348 void null_free_rs(struct ptlrpc_reply_state *rs)
350 LASSERT_ATOMIC_GT(&rs->rs_svc_ctx->sc_refcount, 1);
351 atomic_dec(&rs->rs_svc_ctx->sc_refcount);
353 if (!rs->rs_prealloc)
354 OBD_FREE_LARGE(rs, rs->rs_size);
358 int null_authorize(struct ptlrpc_request *req)
360 struct ptlrpc_reply_state *rs = req->rq_reply_state;
364 rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
365 rs->rs_repdata_len = req->rq_replen;
367 if (likely(req->rq_packed_final)) {
368 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
369 req->rq_reply_off = lustre_msg_early_size();
371 req->rq_reply_off = 0;
375 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 53, 0)
376 if (lustre_msghdr_get_flags(req->rq_reqmsg) &
377 MSGHDR_CKSUM_INCOMPAT18)
378 cksum = lustre_msg_calc_cksum(rs->rs_repbuf, 0);
380 cksum = lustre_msg_calc_cksum(rs->rs_repbuf, 1);
382 cksum = lustre_msg_calc_cksum(rs->rs_repbuf);
384 lustre_msg_set_cksum(rs->rs_repbuf, cksum);
385 req->rq_reply_off = 0;
391 static struct ptlrpc_ctx_ops null_ctx_ops = {
392 .refresh = null_ctx_refresh,
393 .sign = null_ctx_sign,
394 .verify = null_ctx_verify,
397 static struct ptlrpc_sec_cops null_sec_cops = {
398 .create_sec = null_create_sec,
399 .destroy_sec = null_destroy_sec,
400 .lookup_ctx = null_lookup_ctx,
401 .flush_ctx_cache = null_flush_ctx_cache,
402 .alloc_reqbuf = null_alloc_reqbuf,
403 .alloc_repbuf = null_alloc_repbuf,
404 .free_reqbuf = null_free_reqbuf,
405 .free_repbuf = null_free_repbuf,
406 .enlarge_reqbuf = null_enlarge_reqbuf,
409 static struct ptlrpc_sec_sops null_sec_sops = {
410 .accept = null_accept,
411 .alloc_rs = null_alloc_rs,
412 .authorize = null_authorize,
413 .free_rs = null_free_rs,
416 static struct ptlrpc_sec_policy null_policy = {
417 .sp_owner = THIS_MODULE,
418 .sp_name = "sec.null",
419 .sp_policy = SPTLRPC_POLICY_NULL,
420 .sp_cops = &null_sec_cops,
421 .sp_sops = &null_sec_sops,
424 static void null_init_internal(void)
426 static HLIST_HEAD(__list);
428 null_sec.ps_policy = &null_policy;
429 atomic_set(&null_sec.ps_refcount, 1); /* always busy */
431 null_sec.ps_import = NULL;
432 null_sec.ps_flvr.sf_rpc = SPTLRPC_FLVR_NULL;
433 null_sec.ps_flvr.sf_flags = 0;
434 null_sec.ps_part = LUSTRE_SP_ANY;
435 null_sec.ps_dying = 0;
436 spin_lock_init(&null_sec.ps_lock);
437 atomic_set(&null_sec.ps_nctx, 1); /* for "null_cli_ctx" */
438 INIT_LIST_HEAD(&null_sec.ps_gc_list);
439 null_sec.ps_gc_interval = 0;
440 null_sec.ps_gc_next = 0;
442 hlist_add_head(&null_cli_ctx.cc_cache, &__list);
443 atomic_set(&null_cli_ctx.cc_refcount, 1); /* for hash */
444 null_cli_ctx.cc_sec = &null_sec;
445 null_cli_ctx.cc_ops = &null_ctx_ops;
446 null_cli_ctx.cc_expire = 0;
447 null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
449 null_cli_ctx.cc_vcred.vc_uid = 0;
450 spin_lock_init(&null_cli_ctx.cc_lock);
451 INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
452 INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
455 int sptlrpc_null_init(void)
459 null_init_internal();
461 rc = sptlrpc_register_policy(&null_policy);
463 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
468 void sptlrpc_null_fini(void)
472 rc = sptlrpc_unregister_policy(&null_policy);
474 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,rc);