lustre/include/lustre_capa.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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
  19  *
  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
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  */
  30 /*
  31  * This file is part of Lustre, http://www.lustre.org/
  32  * Lustre is a trademark of Sun Microsystems, Inc.
  33  *
  34  * lustre/include/lustre_capa.h
  35  *
  36  * Author: Lai Siyao <lsy@clusterfs.com>
  37  */
  38
  39 #ifndef __LINUX_CAPA_H_
  40 #define __LINUX_CAPA_H_
  41
  42 /** \defgroup capa capa
  43  *
  44  * @{
  45  */
  46
  47 /*
  48  * capability
  49  */
  50 #ifdef __KERNEL__
  51 #include <linux/crypto.h>
  52 #endif
  53 #include <lustre/lustre_idl.h>
  54
  55 #define CAPA_TIMEOUT 1800                /* sec, == 30 min */
  56 #define CAPA_KEY_TIMEOUT (24 * 60 * 60)  /* sec, == 1 days */
  57
  58 struct capa_hmac_alg {
  59         const char     *ha_name;
  60         int             ha_len;
  61         int             ha_keylen;
  62 };
  63
  64 #define DEF_CAPA_HMAC_ALG(name, type, len, keylen)      \
  65 [CAPA_HMAC_ALG_ ## type] = {                            \
  66         .ha_name         = name,                        \
  67         .ha_len          = len,                         \
  68         .ha_keylen       = keylen,                      \
  69 }
  70
  71 struct client_capa {
  72         struct inode             *inode;
  73         cfs_list_t                lli_list;     /* link to lli_oss_capas */
  74 };
  75
  76 struct target_capa {
  77         cfs_hlist_node_t          c_hash;       /* link to capa hash */
  78 };
  79
  80 struct obd_capa {
  81         cfs_list_t                c_list;       /* link to capa_list */
  82
  83         struct lustre_capa        c_capa;       /* capa */
  84         cfs_atomic_t              c_refc;       /* ref count */
  85         cfs_time_t                c_expiry;     /* jiffies */
  86         spinlock_t              c_lock; /* protect capa content */
  87         int                     c_site;
  88
  89         union {
  90                 struct client_capa      cli;
  91                 struct target_capa      tgt;
  92         } u;
  93 };
  94
  95 enum {
  96         CAPA_SITE_CLIENT = 0,
  97         CAPA_SITE_SERVER,
  98         CAPA_SITE_MAX
  99 };
 100
 101 static inline struct lu_fid *capa_fid(struct lustre_capa *capa)
 102 {
 103         return &capa->lc_fid;
 104 }
 105
 106 static inline __u64 capa_opc(struct lustre_capa *capa)
 107 {
 108         return capa->lc_opc;
 109 }
 110
 111 static inline __u64 capa_uid(struct lustre_capa *capa)
 112 {
 113         return capa->lc_uid;
 114 }
 115
 116 static inline __u64 capa_gid(struct lustre_capa *capa)
 117 {
 118         return capa->lc_gid;
 119 }
 120
 121 static inline __u32 capa_flags(struct lustre_capa *capa)
 122 {
 123         return capa->lc_flags & 0xffffff;
 124 }
 125
 126 static inline __u32 capa_alg(struct lustre_capa *capa)
 127 {
 128         return (capa->lc_flags >> 24);
 129 }
 130
 131 static inline __u32 capa_keyid(struct lustre_capa *capa)
 132 {
 133         return capa->lc_keyid;
 134 }
 135
 136 static inline __u64 capa_key_seq(struct lustre_capa_key *key)
 137 {
 138         return key->lk_seq;
 139 }
 140
 141 static inline __u32 capa_key_keyid(struct lustre_capa_key *key)
 142 {
 143         return key->lk_keyid;
 144 }
 145
 146 static inline __u32 capa_timeout(struct lustre_capa *capa)
 147 {
 148         return capa->lc_timeout;
 149 }
 150
 151 static inline __u32 capa_expiry(struct lustre_capa *capa)
 152 {
 153         return capa->lc_expiry;
 154 }
 155
 156 void _debug_capa(struct lustre_capa *, struct libcfs_debug_msg_data *,
 157                  const char *fmt, ... );
 158 #define DEBUG_CAPA(level, capa, fmt, args...)                                  \
 159 do {                                                                           \
 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);                    \
 165         }                                                                      \
 166 } while (0)
 167
 168 #define DEBUG_CAPA_KEY(level, k, fmt, args...)                                 \
 169 do {                                                                           \
 170 CDEBUG(level, fmt " capability key@%p seq "LPU64" keyid %u\n",                 \
 171        ##args, k, capa_key_seq(k), capa_key_keyid(k));                         \
 172 } while (0)
 173
 174 typedef int (* renew_capa_cb_t)(struct obd_capa *, struct lustre_capa *);
 175
 176 /* obdclass/capa.c */
 177 extern cfs_list_t capa_list[];
 178 extern spinlock_t capa_lock;
 179 extern int capa_count[];
 180 extern cfs_mem_cache_t *capa_cachep;
 181
 182 cfs_hlist_head_t *init_capa_hash(void);
 183 void cleanup_capa_hash(cfs_hlist_head_t *hash);
 184
 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);
 189
 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)
 195 {
 196 #ifdef __KERNEL__
 197         struct obd_capa *ocapa;
 198
 199         if (unlikely(site != CAPA_SITE_CLIENT && site != CAPA_SITE_SERVER))
 200                 return ERR_PTR(-EINVAL);
 201
 202         OBD_SLAB_ALLOC_PTR(ocapa, capa_cachep);
 203         if (unlikely(!ocapa))
 204                 return ERR_PTR(-ENOMEM);
 205
 206         CFS_INIT_LIST_HEAD(&ocapa->c_list);
 207         cfs_atomic_set(&ocapa->c_refc, 1);
 208         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);
 212         else
 213                 CFS_INIT_HLIST_NODE(&ocapa->u.tgt.c_hash);
 214
 215         return ocapa;
 216 #else
 217         return ERR_PTR(-EOPNOTSUPP);
 218 #endif
 219 }
 220
 221 static inline struct obd_capa *capa_get(struct obd_capa *ocapa)
 222 {
 223         if (!ocapa)
 224                 return NULL;
 225
 226         cfs_atomic_inc(&ocapa->c_refc);
 227         return ocapa;
 228 }
 229
 230 static inline void capa_put(struct obd_capa *ocapa)
 231 {
 232         if (!ocapa)
 233                 return;
 234
 235         if (cfs_atomic_read(&ocapa->c_refc) == 0) {
 236                 DEBUG_CAPA(D_ERROR, &ocapa->c_capa, "refc is 0 for");
 237                 LBUG();
 238         }
 239
 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));
 244                 } else {
 245                         cfs_hlist_node_t *hnode;
 246
 247                         hnode = &ocapa->u.tgt.c_hash;
 248                         LASSERT(!hnode->next && !hnode->pprev);
 249                 }
 250                 OBD_SLAB_FREE(ocapa, capa_cachep, sizeof(*ocapa));
 251         }
 252 }
 253
 254 static inline int open_flags_to_accmode(int flags)
 255 {
 256         int mode = flags;
 257
 258         if ((mode + 1) & O_ACCMODE)
 259                 mode++;
 260         if (mode & O_TRUNC)
 261                 mode |= 2;
 262
 263         return mode;
 264 }
 265
 266 static inline __u64 capa_open_opc(int mode)
 267 {
 268         return mode & FMODE_WRITE ? CAPA_OPC_OSS_WRITE : CAPA_OPC_OSS_READ;
 269 }
 270
 271 static inline void set_capa_expiry(struct obd_capa *ocapa)
 272 {
 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));
 277 }
 278
 279 static inline int capa_is_expired_sec(struct lustre_capa *capa)
 280 {
 281         return (capa->lc_expiry - cfs_time_current_sec() <= 0);
 282 }
 283
 284 static inline int capa_is_expired(struct obd_capa *ocapa)
 285 {
 286         return cfs_time_beforeq(ocapa->c_expiry, cfs_time_current());
 287 }
 288
 289 static inline int capa_opc_supported(struct lustre_capa *capa, __u64 opc)
 290 {
 291         return (capa_opc(capa) & opc) == opc;
 292 }
 293
 294 struct filter_capa_key {
 295         cfs_list_t              k_list;
 296         struct lustre_capa_key  k_key;
 297 };
 298
 299 enum {
 300         LC_ID_NONE      = 0,
 301         LC_ID_PLAIN     = 1,
 302         LC_ID_CONVERT   = 2
 303 };
 304
 305 #define BYPASS_CAPA (struct lustre_capa *)ERR_PTR(-ENOENT)
 306
 307 /** @} capa */
 308
 309 #endif /* __LINUX_CAPA_H_ */