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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
32 * lustre/ptlrpc/sec_null.c
34 * Author: Eric Mei <ericm@clusterfs.com>
37 #define DEBUG_SUBSYSTEM S_SEC
40 #include <obd_support.h>
41 #include <obd_cksum.h>
42 #include <obd_class.h>
43 #include <lustre_net.h>
44 #include <lustre_sec.h>
46 #include "ptlrpc_internal.h"
48 static struct ptlrpc_sec_policy null_policy;
49 static struct ptlrpc_sec null_sec;
50 static struct ptlrpc_cli_ctx null_cli_ctx;
51 static struct ptlrpc_svc_ctx null_svc_ctx;
54 * we can temporarily use the topmost 8-bits of lm_secflvr to identify
55 * the source sec part.
58 void null_encode_sec_part(struct lustre_msg *msg, enum lustre_sec_part sp)
60 msg->lm_secflvr |= (((__u32) sp) & 0xFF) << 24;
64 enum lustre_sec_part null_decode_sec_part(struct lustre_msg *msg)
66 return (msg->lm_secflvr >> 24) & 0xFF;
69 static int null_ctx_refresh(struct ptlrpc_cli_ctx *ctx)
71 /* should never reach here */
77 int null_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
79 req->rq_reqbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
81 if (!req->rq_import->imp_dlm_fake) {
82 struct obd_device *obd = req->rq_import->imp_obd;
83 null_encode_sec_part(req->rq_reqbuf,
86 req->rq_reqdata_len = req->rq_reqlen;
91 int null_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
95 LASSERT(req->rq_repdata);
97 req->rq_repmsg = req->rq_repdata;
98 req->rq_replen = req->rq_repdata_len;
101 cksums = lustre_msg_get_cksum(req->rq_repdata);
102 cksumc = lustre_msg_calc_cksum(req->rq_repmsg);
104 if (cksumc != cksums) {
106 "early reply checksum mismatch: %08x != %08x\n",
116 struct ptlrpc_sec *null_create_sec(struct obd_import *imp,
117 struct ptlrpc_svc_ctx *svc_ctx,
118 struct sptlrpc_flavor *sf)
120 LASSERT(SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
122 /* general layer has take a module reference for us, because we never
123 * really destroy the sec, simply release the reference here.
125 sptlrpc_policy_put(&null_policy);
130 void null_destroy_sec(struct ptlrpc_sec *sec)
132 LASSERT(sec == &null_sec);
136 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
137 struct vfs_cred *vcred,
138 int create, int remove_dead)
140 atomic_inc(&null_cli_ctx.cc_refcount);
141 return &null_cli_ctx;
145 int null_flush_ctx_cache(struct ptlrpc_sec *sec,
147 int grace, int force)
153 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
154 struct ptlrpc_request *req,
157 if (!req->rq_reqbuf) {
158 int alloc_size = size_roundup_power2(msgsize);
160 LASSERT(!req->rq_pool);
161 OBD_ALLOC_LARGE(req->rq_reqbuf, alloc_size);
165 req->rq_reqbuf_len = alloc_size;
167 LASSERT(req->rq_pool);
168 LASSERT(req->rq_reqbuf_len >= msgsize);
169 memset(req->rq_reqbuf, 0, msgsize);
172 req->rq_reqmsg = req->rq_reqbuf;
177 void null_free_reqbuf(struct ptlrpc_sec *sec,
178 struct ptlrpc_request *req)
181 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
182 "req %p: reqmsg %p is not reqbuf %p in null sec\n",
183 req, req->rq_reqmsg, req->rq_reqbuf);
184 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
185 "req %p: reqlen %d should smaller than buflen %d\n",
186 req, req->rq_reqlen, req->rq_reqbuf_len);
188 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
189 req->rq_reqbuf = NULL;
190 req->rq_reqbuf_len = 0;
195 int null_alloc_repbuf(struct ptlrpc_sec *sec,
196 struct ptlrpc_request *req,
199 /* add space for early replied */
200 msgsize += lustre_msg_early_size();
202 msgsize = size_roundup_power2(msgsize);
204 OBD_ALLOC_LARGE(req->rq_repbuf, msgsize);
208 req->rq_repbuf_len = msgsize;
213 void null_free_repbuf(struct ptlrpc_sec *sec,
214 struct ptlrpc_request *req)
216 LASSERT(req->rq_repbuf);
218 OBD_FREE_LARGE(req->rq_repbuf, req->rq_repbuf_len);
219 req->rq_repbuf = NULL;
220 req->rq_repbuf_len = 0;
224 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
225 struct ptlrpc_request *req,
226 int segment, int newsize)
228 struct lustre_msg *newbuf;
229 struct lustre_msg *oldbuf = req->rq_reqmsg;
230 int oldsize, newmsg_size, alloc_size;
232 LASSERT(req->rq_reqbuf);
233 LASSERT(req->rq_reqbuf == req->rq_reqmsg);
234 LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
235 LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
237 /* compute new message size */
238 oldsize = req->rq_reqbuf->lm_buflens[segment];
239 req->rq_reqbuf->lm_buflens[segment] = newsize;
240 newmsg_size = lustre_packed_msg_size(oldbuf);
241 req->rq_reqbuf->lm_buflens[segment] = oldsize;
243 /* request from pool should always have enough buffer */
244 LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
246 if (req->rq_reqbuf_len < newmsg_size) {
247 alloc_size = size_roundup_power2(newmsg_size);
249 OBD_ALLOC_LARGE(newbuf, alloc_size);
253 /* Must lock this, so that otherwise unprotected change of
254 * rq_reqmsg is not racing with parallel processing of
255 * imp_replay_list traversing threads. See LU-3333
256 * This is a bandaid at best, we really need to deal with this
257 * in request enlarging code before unpacking that's already
260 spin_lock(&req->rq_import->imp_lock);
261 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
263 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
264 req->rq_reqbuf = req->rq_reqmsg = newbuf;
265 req->rq_reqbuf_len = alloc_size;
268 spin_unlock(&req->rq_import->imp_lock);
271 _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
272 req->rq_reqlen = newmsg_size;
277 static struct ptlrpc_svc_ctx null_svc_ctx = {
278 .sc_refcount = ATOMIC_INIT(1),
279 .sc_policy = &null_policy,
283 int null_accept(struct ptlrpc_request *req)
285 LASSERT(SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) ==
286 SPTLRPC_POLICY_NULL);
288 if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
289 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
293 req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
295 req->rq_reqmsg = req->rq_reqbuf;
296 req->rq_reqlen = req->rq_reqdata_len;
298 req->rq_svc_ctx = &null_svc_ctx;
299 atomic_inc(&req->rq_svc_ctx->sc_refcount);
305 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
307 struct ptlrpc_reply_state *rs;
308 int rs_size = sizeof(*rs) + msgsize;
310 LASSERT(msgsize % 8 == 0);
312 rs = req->rq_reply_state;
316 LASSERT(rs->rs_size >= rs_size);
318 OBD_ALLOC_LARGE(rs, rs_size);
322 rs->rs_size = rs_size;
325 rs->rs_svc_ctx = req->rq_svc_ctx;
326 atomic_inc(&req->rq_svc_ctx->sc_refcount);
328 rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
329 rs->rs_repbuf_len = rs_size - sizeof(*rs);
330 rs->rs_msg = rs->rs_repbuf;
332 req->rq_reply_state = rs;
337 void null_free_rs(struct ptlrpc_reply_state *rs)
339 LASSERT_ATOMIC_GT(&rs->rs_svc_ctx->sc_refcount, 1);
340 atomic_dec(&rs->rs_svc_ctx->sc_refcount);
342 if (!rs->rs_prealloc)
343 OBD_FREE_LARGE(rs, rs->rs_size);
347 int null_authorize(struct ptlrpc_request *req)
349 struct ptlrpc_reply_state *rs = req->rq_reply_state;
353 rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
354 rs->rs_repdata_len = req->rq_replen;
356 if (likely(req->rq_packed_final)) {
357 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
358 req->rq_reply_off = lustre_msg_early_size();
360 req->rq_reply_off = 0;
364 cksum = lustre_msg_calc_cksum(rs->rs_repbuf);
365 lustre_msg_set_cksum(rs->rs_repbuf, cksum);
366 req->rq_reply_off = 0;
372 static struct ptlrpc_ctx_ops null_ctx_ops = {
373 .refresh = null_ctx_refresh,
374 .sign = null_ctx_sign,
375 .verify = null_ctx_verify,
378 static struct ptlrpc_sec_cops null_sec_cops = {
379 .create_sec = null_create_sec,
380 .destroy_sec = null_destroy_sec,
381 .lookup_ctx = null_lookup_ctx,
382 .flush_ctx_cache = null_flush_ctx_cache,
383 .alloc_reqbuf = null_alloc_reqbuf,
384 .alloc_repbuf = null_alloc_repbuf,
385 .free_reqbuf = null_free_reqbuf,
386 .free_repbuf = null_free_repbuf,
387 .enlarge_reqbuf = null_enlarge_reqbuf,
390 static struct ptlrpc_sec_sops null_sec_sops = {
391 .accept = null_accept,
392 .alloc_rs = null_alloc_rs,
393 .authorize = null_authorize,
394 .free_rs = null_free_rs,
397 static struct ptlrpc_sec_policy null_policy = {
398 .sp_owner = THIS_MODULE,
399 .sp_name = "sec.null",
400 .sp_policy = SPTLRPC_POLICY_NULL,
401 .sp_cops = &null_sec_cops,
402 .sp_sops = &null_sec_sops,
405 static void null_init_internal(void)
407 static HLIST_HEAD(__list);
409 null_sec.ps_policy = &null_policy;
410 atomic_set(&null_sec.ps_refcount, 1); /* always busy */
412 null_sec.ps_import = NULL;
413 null_sec.ps_flvr.sf_rpc = SPTLRPC_FLVR_NULL;
414 null_sec.ps_flvr.sf_flags = 0;
415 null_sec.ps_part = LUSTRE_SP_ANY;
416 null_sec.ps_dying = 0;
417 spin_lock_init(&null_sec.ps_lock);
418 atomic_set(&null_sec.ps_nctx, 1); /* for "null_cli_ctx" */
419 INIT_LIST_HEAD(&null_sec.ps_gc_list);
420 null_sec.ps_gc_interval = 0;
421 null_sec.ps_gc_next = 0;
423 hlist_add_head(&null_cli_ctx.cc_cache, &__list);
424 atomic_set(&null_cli_ctx.cc_refcount, 1); /* for hash */
425 null_cli_ctx.cc_sec = &null_sec;
426 null_cli_ctx.cc_ops = &null_ctx_ops;
427 null_cli_ctx.cc_expire = 0;
428 null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
430 null_cli_ctx.cc_vcred.vc_uid = 0;
431 spin_lock_init(&null_cli_ctx.cc_lock);
432 INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
433 INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
436 int sptlrpc_null_init(void)
440 null_init_internal();
442 rc = sptlrpc_register_policy(&null_policy);
444 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
449 void sptlrpc_null_fini(void)
453 rc = sptlrpc_unregister_policy(&null_policy);
455 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,rc);