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.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * lustre/include/lustre_capa.h
36 * Author: Lai Siyao <lsy@clusterfs.com>
39 #ifndef __LINUX_CAPA_H_
40 #define __LINUX_CAPA_H_
42 /** \defgroup capa capa
51 #include <linux/crypto.h>
53 #include <lustre/lustre_idl.h>
55 #define CAPA_TIMEOUT 1800 /* sec, == 30 min */
56 #define CAPA_KEY_TIMEOUT (24 * 60 * 60) /* sec, == 1 days */
58 struct capa_hmac_alg {
64 #define DEF_CAPA_HMAC_ALG(name, type, len, keylen) \
65 [CAPA_HMAC_ALG_ ## type] = { \
68 .ha_keylen = keylen, \
73 cfs_list_t lli_list; /* link to lli_oss_capas */
77 cfs_hlist_node_t c_hash; /* link to capa hash */
81 cfs_list_t c_list; /* link to capa_list */
83 struct lustre_capa c_capa; /* capa */
84 cfs_atomic_t c_refc; /* ref count */
85 cfs_time_t c_expiry; /* jiffies */
86 cfs_spinlock_t c_lock; /* protect capa content */
90 struct client_capa cli;
91 struct target_capa tgt;
101 static inline struct lu_fid *capa_fid(struct lustre_capa *capa)
103 return &capa->lc_fid;
106 static inline __u64 capa_opc(struct lustre_capa *capa)
111 static inline __u64 capa_uid(struct lustre_capa *capa)
116 static inline __u64 capa_gid(struct lustre_capa *capa)
121 static inline __u32 capa_flags(struct lustre_capa *capa)
123 return capa->lc_flags & 0xffffff;
126 static inline __u32 capa_alg(struct lustre_capa *capa)
128 return (capa->lc_flags >> 24);
131 static inline __u32 capa_keyid(struct lustre_capa *capa)
133 return capa->lc_keyid;
136 static inline __u64 capa_key_seq(struct lustre_capa_key *key)
141 static inline __u32 capa_key_keyid(struct lustre_capa_key *key)
143 return key->lk_keyid;
146 static inline __u32 capa_timeout(struct lustre_capa *capa)
148 return capa->lc_timeout;
151 static inline __u32 capa_expiry(struct lustre_capa *capa)
153 return capa->lc_expiry;
156 void _debug_capa(struct lustre_capa *, struct libcfs_debug_msg_data *,
157 const char *fmt, ... );
158 #define DEBUG_CAPA(level, capa, fmt, args...) \
160 if (((level) & D_CANTMASK) != 0 || \
161 ((libcfs_debug & (level)) != 0 && \
162 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) { \
163 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
164 _debug_capa((capa), &msgdata, fmt, ##args); \
168 #define DEBUG_CAPA_KEY(level, k, fmt, args...) \
170 CDEBUG(level, fmt " capability key@%p seq "LPU64" keyid %u\n", \
171 ##args, k, capa_key_seq(k), capa_key_keyid(k)); \
174 typedef int (* renew_capa_cb_t)(struct obd_capa *, struct lustre_capa *);
176 /* obdclass/capa.c */
177 extern cfs_list_t capa_list[];
178 extern cfs_spinlock_t capa_lock;
179 extern int capa_count[];
180 extern cfs_mem_cache_t *capa_cachep;
182 cfs_hlist_head_t *init_capa_hash(void);
183 void cleanup_capa_hash(cfs_hlist_head_t *hash);
185 struct obd_capa *capa_add(cfs_hlist_head_t *hash,
186 struct lustre_capa *capa);
187 struct obd_capa *capa_lookup(cfs_hlist_head_t *hash,
188 struct lustre_capa *capa, int alive);
190 int capa_hmac(__u8 *hmac, struct lustre_capa *capa, __u8 *key);
191 int capa_encrypt_id(__u32 *d, __u32 *s, __u8 *key, int keylen);
192 int capa_decrypt_id(__u32 *d, __u32 *s, __u8 *key, int keylen);
193 void capa_cpy(void *dst, struct obd_capa *ocapa);
194 static inline struct obd_capa *alloc_capa(int site)
197 struct obd_capa *ocapa;
199 if (unlikely(site != CAPA_SITE_CLIENT && site != CAPA_SITE_SERVER))
200 return ERR_PTR(-EINVAL);
202 OBD_SLAB_ALLOC_PTR(ocapa, capa_cachep);
203 if (unlikely(!ocapa))
204 return ERR_PTR(-ENOMEM);
206 CFS_INIT_LIST_HEAD(&ocapa->c_list);
207 cfs_atomic_set(&ocapa->c_refc, 1);
208 cfs_spin_lock_init(&ocapa->c_lock);
209 ocapa->c_site = site;
210 if (ocapa->c_site == CAPA_SITE_CLIENT)
211 CFS_INIT_LIST_HEAD(&ocapa->u.cli.lli_list);
213 CFS_INIT_HLIST_NODE(&ocapa->u.tgt.c_hash);
217 return ERR_PTR(-EOPNOTSUPP);
221 static inline struct obd_capa *capa_get(struct obd_capa *ocapa)
226 cfs_atomic_inc(&ocapa->c_refc);
230 static inline void capa_put(struct obd_capa *ocapa)
235 if (cfs_atomic_read(&ocapa->c_refc) == 0) {
236 DEBUG_CAPA(D_ERROR, &ocapa->c_capa, "refc is 0 for");
240 if (cfs_atomic_dec_and_test(&ocapa->c_refc)) {
241 LASSERT(cfs_list_empty(&ocapa->c_list));
242 if (ocapa->c_site == CAPA_SITE_CLIENT) {
243 LASSERT(cfs_list_empty(&ocapa->u.cli.lli_list));
245 cfs_hlist_node_t *hnode;
247 hnode = &ocapa->u.tgt.c_hash;
248 LASSERT(!hnode->next && !hnode->pprev);
250 OBD_SLAB_FREE(ocapa, capa_cachep, sizeof(*ocapa));
254 static inline int open_flags_to_accmode(int flags)
258 if ((mode + 1) & O_ACCMODE)
266 static inline __u64 capa_open_opc(int mode)
268 return mode & FMODE_WRITE ? CAPA_OPC_OSS_WRITE : CAPA_OPC_OSS_READ;
271 static inline void set_capa_expiry(struct obd_capa *ocapa)
273 cfs_time_t expiry = cfs_time_sub((cfs_time_t)ocapa->c_capa.lc_expiry,
274 cfs_time_current_sec());
275 ocapa->c_expiry = cfs_time_add(cfs_time_current(),
276 cfs_time_seconds(expiry));
279 static inline int capa_is_expired_sec(struct lustre_capa *capa)
281 return (capa->lc_expiry - cfs_time_current_sec() <= 0);
284 static inline int capa_is_expired(struct obd_capa *ocapa)
286 return cfs_time_beforeq(ocapa->c_expiry, cfs_time_current());
289 static inline int capa_opc_supported(struct lustre_capa *capa, __u64 opc)
291 return (capa_opc(capa) & opc) == opc;
294 struct filter_capa_key {
296 struct lustre_capa_key k_key;
305 #define BYPASS_CAPA (struct lustre_capa *)ERR_PTR(-ENOENT)
309 #endif /* __LINUX_CAPA_H_ */