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, 2014, 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;
70 int null_ctx_sign(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
72 req->rq_reqbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
74 if (!req->rq_import->imp_dlm_fake) {
75 struct obd_device *obd = req->rq_import->imp_obd;
77 null_encode_sec_part(req->rq_reqbuf,
80 req->rq_reqdata_len = req->rq_reqlen;
85 int null_ctx_verify(struct ptlrpc_cli_ctx *ctx, struct ptlrpc_request *req)
89 LASSERT(req->rq_repdata);
91 req->rq_repmsg = req->rq_repdata;
92 req->rq_replen = req->rq_repdata_len;
95 cksums = lustre_msg_get_cksum(req->rq_repdata);
96 cksumc = lustre_msg_calc_cksum(req->rq_repmsg,
99 if (cksumc != cksums) {
101 "early reply checksum mismatch: %08x != %08x\n",
111 struct ptlrpc_sec *null_create_sec(struct obd_import *imp,
112 struct ptlrpc_svc_ctx *svc_ctx,
113 struct sptlrpc_flavor *sf)
115 LASSERT(SPTLRPC_FLVR_POLICY(sf->sf_rpc) == SPTLRPC_POLICY_NULL);
118 * general layer has take a module reference for us, because we never
119 * really destroy the sec, simply release the reference here.
121 sptlrpc_policy_put(&null_policy);
126 void null_destroy_sec(struct ptlrpc_sec *sec)
128 LASSERT(sec == &null_sec);
132 struct ptlrpc_cli_ctx *null_lookup_ctx(struct ptlrpc_sec *sec,
133 struct vfs_cred *vcred,
134 int create, int remove_dead)
136 atomic_inc(&null_cli_ctx.cc_refcount);
137 return &null_cli_ctx;
141 int null_flush_ctx_cache(struct ptlrpc_sec *sec, uid_t uid, int grace,
148 int null_alloc_reqbuf(struct ptlrpc_sec *sec,
149 struct ptlrpc_request *req,
152 if (!req->rq_reqbuf) {
153 int alloc_size = size_roundup_power2(msgsize);
155 LASSERT(!req->rq_pool);
156 OBD_ALLOC_LARGE(req->rq_reqbuf, alloc_size);
160 req->rq_reqbuf_len = alloc_size;
162 LASSERT(req->rq_pool);
163 LASSERT(req->rq_reqbuf_len >= msgsize);
164 memset(req->rq_reqbuf, 0, msgsize);
167 req->rq_reqmsg = req->rq_reqbuf;
172 void null_free_reqbuf(struct ptlrpc_sec *sec,
173 struct ptlrpc_request *req)
176 LASSERTF(req->rq_reqmsg == req->rq_reqbuf,
177 "req %p: reqmsg %p is not reqbuf %p in null sec\n",
178 req, req->rq_reqmsg, req->rq_reqbuf);
179 LASSERTF(req->rq_reqbuf_len >= req->rq_reqlen,
180 "req %p: reqlen %d should smaller than buflen %d\n",
181 req, req->rq_reqlen, req->rq_reqbuf_len);
183 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
184 req->rq_reqbuf = NULL;
185 req->rq_reqbuf_len = 0;
190 int null_alloc_repbuf(struct ptlrpc_sec *sec,
191 struct ptlrpc_request *req,
194 /* add space for early replied */
195 msgsize += lustre_msg_early_size();
197 msgsize = size_roundup_power2(msgsize);
199 OBD_ALLOC_LARGE(req->rq_repbuf, msgsize);
203 req->rq_repbuf_len = msgsize;
208 void null_free_repbuf(struct ptlrpc_sec *sec,
209 struct ptlrpc_request *req)
211 LASSERT(req->rq_repbuf);
213 OBD_FREE_LARGE(req->rq_repbuf, req->rq_repbuf_len);
214 req->rq_repbuf = NULL;
215 req->rq_repbuf_len = 0;
219 int null_enlarge_reqbuf(struct ptlrpc_sec *sec,
220 struct ptlrpc_request *req,
221 int segment, int newsize)
223 struct lustre_msg *newbuf;
224 struct lustre_msg *oldbuf = req->rq_reqmsg;
225 int oldsize, newmsg_size, alloc_size;
227 LASSERT(req->rq_reqbuf);
228 LASSERT(req->rq_reqbuf == req->rq_reqmsg);
229 LASSERT(req->rq_reqbuf_len >= req->rq_reqlen);
230 LASSERT(req->rq_reqlen == lustre_packed_msg_size(oldbuf));
232 /* compute new message size */
233 oldsize = req->rq_reqbuf->lm_buflens[segment];
234 req->rq_reqbuf->lm_buflens[segment] = newsize;
235 newmsg_size = lustre_packed_msg_size(oldbuf);
236 req->rq_reqbuf->lm_buflens[segment] = oldsize;
238 /* request from pool should always have enough buffer */
239 LASSERT(!req->rq_pool || req->rq_reqbuf_len >= newmsg_size);
241 if (req->rq_reqbuf_len < newmsg_size) {
242 alloc_size = size_roundup_power2(newmsg_size);
244 OBD_ALLOC_LARGE(newbuf, alloc_size);
249 * Must lock this, so that otherwise unprotected change of
250 * rq_reqmsg is not racing with parallel processing of
251 * imp_replay_list traversing threads. See LU-3333
252 * This is a bandaid at best, we really need to deal with this
253 * in request enlarging code before unpacking that's already
257 spin_lock(&req->rq_import->imp_lock);
258 memcpy(newbuf, req->rq_reqbuf, req->rq_reqlen);
260 OBD_FREE_LARGE(req->rq_reqbuf, req->rq_reqbuf_len);
261 req->rq_reqbuf = req->rq_reqmsg = newbuf;
262 req->rq_reqbuf_len = alloc_size;
265 spin_unlock(&req->rq_import->imp_lock);
268 _sptlrpc_enlarge_msg_inplace(req->rq_reqmsg, segment, newsize);
269 req->rq_reqlen = newmsg_size;
274 static struct ptlrpc_svc_ctx null_svc_ctx = {
275 .sc_refcount = ATOMIC_INIT(1),
276 .sc_policy = &null_policy,
280 int null_accept(struct ptlrpc_request *req)
282 LASSERT(SPTLRPC_FLVR_POLICY(req->rq_flvr.sf_rpc) ==
283 SPTLRPC_POLICY_NULL);
285 if (req->rq_flvr.sf_rpc != SPTLRPC_FLVR_NULL) {
286 CERROR("Invalid rpc flavor 0x%x\n", req->rq_flvr.sf_rpc);
290 req->rq_sp_from = null_decode_sec_part(req->rq_reqbuf);
292 req->rq_reqmsg = req->rq_reqbuf;
293 req->rq_reqlen = req->rq_reqdata_len;
295 req->rq_svc_ctx = &null_svc_ctx;
296 atomic_inc(&req->rq_svc_ctx->sc_refcount);
302 int null_alloc_rs(struct ptlrpc_request *req, int msgsize)
304 struct ptlrpc_reply_state *rs;
305 int rs_size = sizeof(*rs) + msgsize;
307 LASSERT(msgsize % 8 == 0);
309 rs = req->rq_reply_state;
313 LASSERT(rs->rs_size >= rs_size);
315 OBD_ALLOC_LARGE(rs, rs_size);
319 rs->rs_size = rs_size;
322 rs->rs_svc_ctx = req->rq_svc_ctx;
323 atomic_inc(&req->rq_svc_ctx->sc_refcount);
325 rs->rs_repbuf = (struct lustre_msg *) (rs + 1);
326 rs->rs_repbuf_len = rs_size - sizeof(*rs);
327 rs->rs_msg = rs->rs_repbuf;
329 req->rq_reply_state = rs;
334 void null_free_rs(struct ptlrpc_reply_state *rs)
336 LASSERT_ATOMIC_GT(&rs->rs_svc_ctx->sc_refcount, 1);
337 atomic_dec(&rs->rs_svc_ctx->sc_refcount);
339 if (!rs->rs_prealloc)
340 OBD_FREE_LARGE(rs, rs->rs_size);
344 int null_authorize(struct ptlrpc_request *req)
346 struct ptlrpc_reply_state *rs = req->rq_reply_state;
350 rs->rs_repbuf->lm_secflvr = SPTLRPC_FLVR_NULL;
351 rs->rs_repdata_len = req->rq_replen;
352 req->rq_reply_off = 0;
354 if (likely(req->rq_packed_final)) {
355 if (lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT)
356 req->rq_reply_off = lustre_msg_early_size();
360 cksum = lustre_msg_calc_cksum(rs->rs_repbuf,
361 MSG_PTLRPC_BODY_OFF);
362 lustre_msg_set_cksum(rs->rs_repbuf, cksum);
368 static struct ptlrpc_ctx_ops null_ctx_ops = {
369 .sign = null_ctx_sign,
370 .verify = null_ctx_verify,
373 static struct ptlrpc_sec_cops null_sec_cops = {
374 .create_sec = null_create_sec,
375 .destroy_sec = null_destroy_sec,
376 .lookup_ctx = null_lookup_ctx,
377 .flush_ctx_cache = null_flush_ctx_cache,
378 .alloc_reqbuf = null_alloc_reqbuf,
379 .alloc_repbuf = null_alloc_repbuf,
380 .free_reqbuf = null_free_reqbuf,
381 .free_repbuf = null_free_repbuf,
382 .enlarge_reqbuf = null_enlarge_reqbuf,
385 static struct ptlrpc_sec_sops null_sec_sops = {
386 .accept = null_accept,
387 .alloc_rs = null_alloc_rs,
388 .authorize = null_authorize,
389 .free_rs = null_free_rs,
392 static struct ptlrpc_sec_policy null_policy = {
393 .sp_owner = THIS_MODULE,
394 .sp_name = "sec.null",
395 .sp_policy = SPTLRPC_POLICY_NULL,
396 .sp_cops = &null_sec_cops,
397 .sp_sops = &null_sec_sops,
400 static void null_init_internal(void)
402 static HLIST_HEAD(__list);
404 null_sec.ps_policy = &null_policy;
405 atomic_set(&null_sec.ps_refcount, 1); /* always busy */
407 null_sec.ps_import = NULL;
408 null_sec.ps_flvr.sf_rpc = SPTLRPC_FLVR_NULL;
409 null_sec.ps_flvr.sf_flags = 0;
410 null_sec.ps_part = LUSTRE_SP_ANY;
411 null_sec.ps_dying = 0;
412 spin_lock_init(&null_sec.ps_lock);
413 atomic_set(&null_sec.ps_nctx, 1); /* for "null_cli_ctx" */
414 INIT_LIST_HEAD(&null_sec.ps_gc_list);
415 null_sec.ps_gc_interval = 0;
416 null_sec.ps_gc_next = 0;
418 hlist_add_head(&null_cli_ctx.cc_cache, &__list);
419 atomic_set(&null_cli_ctx.cc_refcount, 1); /* for hash */
420 null_cli_ctx.cc_sec = &null_sec;
421 null_cli_ctx.cc_ops = &null_ctx_ops;
422 null_cli_ctx.cc_expire = 0;
423 null_cli_ctx.cc_flags = PTLRPC_CTX_CACHED | PTLRPC_CTX_ETERNAL |
425 null_cli_ctx.cc_vcred.vc_uid = 0;
426 spin_lock_init(&null_cli_ctx.cc_lock);
427 INIT_LIST_HEAD(&null_cli_ctx.cc_req_list);
428 INIT_LIST_HEAD(&null_cli_ctx.cc_gc_chain);
431 int sptlrpc_null_init(void)
435 null_init_internal();
437 rc = sptlrpc_register_policy(&null_policy);
439 CERROR("failed to register %s: %d\n", null_policy.sp_name, rc);
444 void sptlrpc_null_fini(void)
448 rc = sptlrpc_unregister_policy(&null_policy);
450 CERROR("failed to unregister %s: %d\n", null_policy.sp_name,