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 static struct ptlrpc_sec_policy null_policy;
51 static struct ptlrpc_sec null_sec;
52 static struct ptlrpc_cli_ctx null_cli_ctx;
53 static struct ptlrpc_svc_ctx null_svc_ctx;
56 * we can temporarily use the topmost 8-bits of lm_secflvr to identify
57 * the source sec part.
60 void null_encode_sec_part(struct lustre_msg *msg, enum lustre_sec_part sp)
62 msg->lm_secflvr |= (((__u32) sp) & 0xFF) << 24;
66 enum lustre_sec_part null_decode_sec_part(struct lustre_msg *msg)
68 return (msg->lm_secflvr >> 24) & 0xFF;
71 static int null_ctx_refresh(struct ptlrpc_cli_ctx *ctx)
73 /* should never reach here */
79 int null_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
81 req->rq_reqbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
83 if (!req->rq_import->imp_dlm_fake) {
84 struct obd_device *obd = req->rq_import->imp_obd;
85 null_encode_sec_part(req->rq_reqbuf,
88 req->rq_reqdata_len = req->rq_reqlen;
93 int null_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
97 LASSERT(req->rq_repdata);
99 req->rq_repmsg = req->rq_repdata;
100 req->rq_replen = req->rq_repdata_len;
103 cksums = lustre_msg_get_cksum(req->rq_repdata);
104 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 53, 0)
105 if (lustre_msghdr_get_flags(req->rq_reqmsg) &
106 MSGHDR_CKSUM_INCOMPAT18)
107 cksumc = lustre_msg_calc_cksum(req->rq_repmsg, 0);
109 cksumc = lustre_msg_calc_cksum(req->rq_repmsg, 1);
111 cksumc = lustre_msg_calc_cksum(req->rq_repmsg);
113 if (cksumc != cksums) {
115 "early reply checksum mismatch: %08x != %08x\n",
125 struct ptlrpc_sec *null_create_sec(struct obd_import *imp,
126 struct ptlrpc_svc_ctx *svc_ctx,
127 struct sptlrpc_flavor *sf)
129 LASSERT(SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
131 /* general layer has take a module reference for us, because we never
132 * really destroy the sec, simply release the reference here.
134 sptlrpc_policy_put(&null_policy);
139 void null_destroy_sec(struct ptlrpc_sec *sec)
141 LASSERT(sec == &null_sec);
145 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
146 struct vfs_cred *vcred,
147 int create, int remove_dead)
149 atomic_inc(&null_cli_ctx.cc_refcount);
150 return &null_cli_ctx;
154 int null_flush_ctx_cache(struct ptlrpc_sec *sec,
156 int grace, int force)
162 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
163 struct ptlrpc_request *req,
166 if (!req->rq_reqbuf) {
167 int alloc_size = size_roundup_power2(msgsize);
169 LASSERT(!req->rq_pool);
170 OBD_ALLOC_LARGE(req->rq_reqbuf, alloc_size);
174 req->rq_reqbuf_len = alloc_size;
176 LASSERT(req->rq_pool);
177 LASSERT(req->rq_reqbuf_len >= msgsize);
178 memset(req->rq_reqbuf, 0, msgsize);
181 req->rq_reqmsg = req->rq_reqbuf;
186 void null_free_reqbuf(struct ptlrpc_sec *sec,
187 struct ptlrpc_request *req)
190 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
191 "req %p: reqmsg %p is not reqbuf %p in null sec\n",
192 req, req->rq_reqmsg, req->rq_reqbuf);
193 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
194 "req %p: reqlen %d should smaller than buflen %d\n",
195 req, req->rq_reqlen, req->rq_reqbuf_len);
197 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
198 req->rq_reqbuf = NULL;
199 req->rq_reqbuf_len = 0;
204 int null_alloc_repbuf(struct ptlrpc_sec *sec,
205 struct ptlrpc_request *req,
208 /* add space for early replied */
209 msgsize += lustre_msg_early_size();
211 msgsize = size_roundup_power2(msgsize);
213 OBD_ALLOC_LARGE(req->rq_repbuf, msgsize);
217 req->rq_repbuf_len = msgsize;
222 void null_free_repbuf(struct ptlrpc_sec *sec,
223 struct ptlrpc_request *req)
225 LASSERT(req->rq_repbuf);
227 OBD_FREE_LARGE(req->rq_repbuf, req->rq_repbuf_len);
228 req->rq_repbuf = NULL;
229 req->rq_repbuf_len = 0;
233 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
234 struct ptlrpc_request *req,
235 int segment, int newsize)
237 struct lustre_msg *newbuf;
238 struct lustre_msg *oldbuf = req->rq_reqmsg;
239 int oldsize, newmsg_size, alloc_size;
241 LASSERT(req->rq_reqbuf);
242 LASSERT(req->rq_reqbuf == req->rq_reqmsg);
243 LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
244 LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
246 /* compute new message size */
247 oldsize = req->rq_reqbuf->lm_buflens[segment];
248 req->rq_reqbuf->lm_buflens[segment] = newsize;
249 newmsg_size = lustre_packed_msg_size(oldbuf);
250 req->rq_reqbuf->lm_buflens[segment] = oldsize;
252 /* request from pool should always have enough buffer */
253 LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
255 if (req->rq_reqbuf_len < newmsg_size) {
256 alloc_size = size_roundup_power2(newmsg_size);
258 OBD_ALLOC_LARGE(newbuf, alloc_size);
262 /* Must lock this, so that otherwise unprotected change of
263 * rq_reqmsg is not racing with parallel processing of
264 * imp_replay_list traversing threads. See LU-3333
265 * This is a bandaid at best, we really need to deal with this
266 * in request enlarging code before unpacking that's already
269 spin_lock(&req->rq_import->imp_lock);
270 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
272 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
273 req->rq_reqbuf = req->rq_reqmsg = newbuf;
274 req->rq_reqbuf_len = alloc_size;
277 spin_unlock(&req->rq_import->imp_lock);
280 _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
281 req->rq_reqlen = newmsg_size;
286 static struct ptlrpc_svc_ctx null_svc_ctx = {
287 .sc_refcount = ATOMIC_INIT(1),
288 .sc_policy = &null_policy,
292 int null_accept(struct ptlrpc_request *req)
294 LASSERT(SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) ==
295 SPTLRPC_POLICY_NULL);
297 if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
298 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
302 req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
304 req->rq_reqmsg = req->rq_reqbuf;
305 req->rq_reqlen = req->rq_reqdata_len;
307 req->rq_svc_ctx = &null_svc_ctx;
308 atomic_inc(&req->rq_svc_ctx->sc_refcount);
314 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
316 struct ptlrpc_reply_state *rs;
317 int rs_size = sizeof(*rs) + msgsize;
319 LASSERT(msgsize % 8 == 0);
321 rs = req->rq_reply_state;
325 LASSERT(rs->rs_size >= rs_size);
327 OBD_ALLOC_LARGE(rs, rs_size);
331 rs->rs_size = rs_size;
334 rs->rs_svc_ctx = req->rq_svc_ctx;
335 atomic_inc(&req->rq_svc_ctx->sc_refcount);
337 rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
338 rs->rs_repbuf_len = rs_size - sizeof(*rs);
339 rs->rs_msg = rs->rs_repbuf;
341 req->rq_reply_state = rs;
346 void null_free_rs(struct ptlrpc_reply_state *rs)
348 LASSERT_ATOMIC_GT(&rs->rs_svc_ctx->sc_refcount, 1);
349 atomic_dec(&rs->rs_svc_ctx->sc_refcount);
351 if (!rs->rs_prealloc)
352 OBD_FREE_LARGE(rs, rs->rs_size);
356 int null_authorize(struct ptlrpc_request *req)
358 struct ptlrpc_reply_state *rs = req->rq_reply_state;
362 rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
363 rs->rs_repdata_len = req->rq_replen;
365 if (likely(req->rq_packed_final)) {
366 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
367 req->rq_reply_off = lustre_msg_early_size();
369 req->rq_reply_off = 0;
373 #if LUSTRE_VERSION_CODE < OBD_OCD_VERSION(2, 7, 53, 0)
374 if (lustre_msghdr_get_flags(req->rq_reqmsg) &
375 MSGHDR_CKSUM_INCOMPAT18)
376 cksum = lustre_msg_calc_cksum(rs->rs_repbuf, 0);
378 cksum = lustre_msg_calc_cksum(rs->rs_repbuf, 1);
380 cksum = lustre_msg_calc_cksum(rs->rs_repbuf);
382 lustre_msg_set_cksum(rs->rs_repbuf, cksum);
383 req->rq_reply_off = 0;
389 static struct ptlrpc_ctx_ops null_ctx_ops = {
390 .refresh = null_ctx_refresh,
391 .sign = null_ctx_sign,
392 .verify = null_ctx_verify,
395 static struct ptlrpc_sec_cops null_sec_cops = {
396 .create_sec = null_create_sec,
397 .destroy_sec = null_destroy_sec,
398 .lookup_ctx = null_lookup_ctx,
399 .flush_ctx_cache = null_flush_ctx_cache,
400 .alloc_reqbuf = null_alloc_reqbuf,
401 .alloc_repbuf = null_alloc_repbuf,
402 .free_reqbuf = null_free_reqbuf,
403 .free_repbuf = null_free_repbuf,
404 .enlarge_reqbuf = null_enlarge_reqbuf,
407 static struct ptlrpc_sec_sops null_sec_sops = {
408 .accept = null_accept,
409 .alloc_rs = null_alloc_rs,
410 .authorize = null_authorize,
411 .free_rs = null_free_rs,
414 static struct ptlrpc_sec_policy null_policy = {
415 .sp_owner = THIS_MODULE,
416 .sp_name = "sec.null",
417 .sp_policy = SPTLRPC_POLICY_NULL,
418 .sp_cops = &null_sec_cops,
419 .sp_sops = &null_sec_sops,
422 static void null_init_internal(void)
424 static HLIST_HEAD(__list);
426 null_sec.ps_policy = &null_policy;
427 atomic_set(&null_sec.ps_refcount, 1); /* always busy */
429 null_sec.ps_import = NULL;
430 null_sec.ps_flvr.sf_rpc = SPTLRPC_FLVR_NULL;
431 null_sec.ps_flvr.sf_flags = 0;
432 null_sec.ps_part = LUSTRE_SP_ANY;
433 null_sec.ps_dying = 0;
434 spin_lock_init(&null_sec.ps_lock);
435 atomic_set(&null_sec.ps_nctx, 1); /* for "null_cli_ctx" */
436 INIT_LIST_HEAD(&null_sec.ps_gc_list);
437 null_sec.ps_gc_interval = 0;
438 null_sec.ps_gc_next = 0;
440 hlist_add_head(&null_cli_ctx.cc_cache, &__list);
441 atomic_set(&null_cli_ctx.cc_refcount, 1); /* for hash */
442 null_cli_ctx.cc_sec = &null_sec;
443 null_cli_ctx.cc_ops = &null_ctx_ops;
444 null_cli_ctx.cc_expire = 0;
445 null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
447 null_cli_ctx.cc_vcred.vc_uid = 0;
448 spin_lock_init(&null_cli_ctx.cc_lock);
449 INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
450 INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
453 int sptlrpc_null_init(void)
457 null_init_internal();
459 rc = sptlrpc_register_policy(&null_policy);
461 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
466 void sptlrpc_null_fini(void)
470 rc = sptlrpc_unregister_policy(&null_policy);
472 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,rc);