lustre/include/lustre_fid.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/include/lustre_fid.h
  37  *
  38  * Author: Yury Umanets <umka@clusterfs.com>
  39  */
  40
  41 #ifndef __LINUX_FID_H
  42 #define __LINUX_FID_H
  43
  44 /*
  45  * struct lu_fid
  46  */
  47 #include <lustre/lustre_idl.h>
  48 #include <lustre_req_layout.h>
  49 #include <lustre_mdt.h>
  50
  51 #include <libcfs/libcfs.h>
  52
  53 struct lu_site;
  54 struct lu_context;
  55
  56 /* Whole sequences space range and zero range definitions */
  57 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
  58 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
  59 extern const struct lu_fid LUSTRE_BFL_FID;
  60 extern const struct lu_fid LU_OBF_FID;
  61 extern const struct lu_fid LU_DOT_LUSTRE_FID;
  62
  63 enum {
  64         /*
  65          * This is how may FIDs may be allocated in one sequence. 16384 for
  66          * now.
  67          */
  68         LUSTRE_SEQ_MAX_WIDTH = 0x0000000000000400ULL,
  69
  70         /*
  71          * How many sequences may be allocate for meta-sequence (this is 128
  72          * sequences).
  73          */
  74         /* changed to 16 to avoid overflow in test11 */
  75         LUSTRE_SEQ_META_WIDTH = 0x0000000000000010ULL,
  76
  77         /*
  78          * This is how many sequences may be in one super-sequence allocated to
  79          * MDTs.
  80          */
  81         LUSTRE_SEQ_SUPER_WIDTH = (LUSTRE_SEQ_META_WIDTH * LUSTRE_SEQ_META_WIDTH)
  82 };
  83
  84 /** special fid seq: used for local object create. */
  85 #define FID_SEQ_LOCAL_FILE      (FID_SEQ_START + 1)
  86
  87 /** special fid seq: used for .lustre objects. */
  88 #define LU_DOT_LUSTRE_SEQ       (FID_SEQ_START + 0x02ULL)
  89
  90 /** special OID for local objects */
  91 enum {
  92         /** \see osd_oi_index_create */
  93         OSD_OI_FID_SMALL_OID    = 1UL,
  94         OSD_OI_FID_OTHER_OID    = 2UL,
  95         /** \see fld_mod_init */
  96         FLD_INDEX_OID           = 3UL,
  97         /** \see fid_mod_init */
  98         FID_SEQ_CTL_OID         = 4UL,
  99         FID_SEQ_SRV_OID         = 5UL,
 100         /** \see mdd_mod_init */
 101         MDD_ROOT_INDEX_OID      = 6UL,
 102         MDD_ORPHAN_OID          = 7UL,
 103         MDD_LOV_OBJ_OID         = 8UL,
 104         MDD_CAPA_KEYS_OID       = 9UL,
 105         MDD_OBJECTS_OID         = 10UL,
 106         /** \see mdt_mod_init */
 107         MDT_LAST_RECV_OID       = 11UL,
 108         /** \see osd_mod_init */
 109         OSD_REM_OBJ_DIR_OID     = 12UL,
 110 };
 111
 112 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
 113 {
 114         fid->f_seq = FID_SEQ_LOCAL_FILE;
 115         fid->f_oid = oid;
 116         fid->f_ver = 0;
 117 }
 118
 119 enum lu_mgr_type {
 120         LUSTRE_SEQ_SERVER,
 121         LUSTRE_SEQ_CONTROLLER
 122 };
 123
 124 enum lu_cli_type {
 125         LUSTRE_SEQ_METADATA,
 126         LUSTRE_SEQ_DATA
 127 };
 128
 129 struct lu_server_seq;
 130
 131 /* Client sequence manager interface. */
 132 struct lu_client_seq {
 133         /* Sequence-controller export. */
 134         struct obd_export      *lcs_exp;
 135         struct semaphore        lcs_sem;
 136
 137         /*
 138          * Range of allowed for allocation sequeces. When using lu_client_seq on
 139          * clients, this contains meta-sequence range. And for servers this
 140          * contains super-sequence range.
 141          */
 142         struct lu_seq_range         lcs_space;
 143
 144         /* Seq related proc */
 145         cfs_proc_dir_entry_t   *lcs_proc_dir;
 146
 147         /* This holds last allocated fid in last obtained seq */
 148         struct lu_fid           lcs_fid;
 149
 150         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 151         enum lu_cli_type        lcs_type;
 152
 153         /*
 154          * Service uuid, passed from MDT + seq name to form unique seq name to
 155          * use it with procfs.
 156          */
 157         char                    lcs_name[80];
 158
 159         /*
 160          * Sequence width, that is how many objects may be allocated in one
 161          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 162          */
 163         __u64                   lcs_width;
 164
 165         /* Seq-server for direct talking */
 166         struct lu_server_seq   *lcs_srv;
 167 };
 168
 169 /* server sequence manager interface */
 170 struct lu_server_seq {
 171         /* Available sequences space */
 172         struct lu_seq_range         lss_space;
 173
 174         /*
 175          * Device for server side seq manager needs (saving sequences to backing
 176          * store).
 177          */
 178         struct dt_device       *lss_dev;
 179
 180         /* /seq file object device */
 181         struct dt_object       *lss_obj;
 182
 183         /* Seq related proc */
 184         cfs_proc_dir_entry_t   *lss_proc_dir;
 185
 186         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
 187         enum lu_mgr_type       lss_type;
 188
 189         /* Client interafce to request controller */
 190         struct lu_client_seq   *lss_cli;
 191
 192         /* Semaphore for protecting allocation */
 193         struct semaphore        lss_sem;
 194
 195         /*
 196          * Service uuid, passed from MDT + seq name to form unique seq name to
 197          * use it with procfs.
 198          */
 199         char                    lss_name[80];
 200
 201         /*
 202          * Allocation chunks for super and meta sequences. Default values are
 203          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
 204          */
 205         __u64                   lss_width;
 206
 207         /**
 208          * Pointer to site object, required to access site fld.
 209          */
 210         struct md_site         *lss_site;
 211 };
 212
 213 int seq_query(struct com_thread_info *info);
 214
 215 /* Server methods */
 216 int seq_server_init(struct lu_server_seq *seq,
 217                     struct dt_device *dev,
 218                     const char *prefix,
 219                     enum lu_mgr_type type,
 220                     struct md_site *ls,
 221                     const struct lu_env *env);
 222
 223 void seq_server_fini(struct lu_server_seq *seq,
 224                      const struct lu_env *env);
 225
 226 int seq_server_alloc_super(struct lu_server_seq *seq,
 227                            struct lu_seq_range *in,
 228                            struct lu_seq_range *out,
 229                            const struct lu_env *env);
 230
 231 int seq_server_alloc_meta(struct lu_server_seq *seq,
 232                           struct lu_seq_range *in,
 233                           struct lu_seq_range *out,
 234                           const struct lu_env *env);
 235
 236 int seq_server_set_cli(struct lu_server_seq *seq,
 237                        struct lu_client_seq *cli,
 238                        const struct lu_env *env);
 239
 240 /* Client methods */
 241 int seq_client_init(struct lu_client_seq *seq,
 242                     struct obd_export *exp,
 243                     enum lu_cli_type type,
 244                     const char *prefix,
 245                     struct lu_server_seq *srv);
 246
 247 void seq_client_fini(struct lu_client_seq *seq);
 248
 249 void seq_client_flush(struct lu_client_seq *seq);
 250
 251 int seq_client_alloc_fid(struct lu_client_seq *seq,
 252                          struct lu_fid *fid);
 253
 254 /* Fids common stuff */
 255 int fid_is_local(const struct lu_env *env,
 256                  struct lu_site *site, const struct lu_fid *fid);
 257
 258 /* fid locking */
 259
 260 struct ldlm_namespace;
 261
 262 enum {
 263         LUSTRE_RES_ID_SEQ_OFF = 0,
 264         LUSTRE_RES_ID_OID_OFF = 1,
 265         LUSTRE_RES_ID_VER_OFF = 2,
 266         LUSTRE_RES_ID_HSH_OFF = 3
 267 };
 268
 269 /*
 270  * Build (DLM) resource name from fid.
 271  */
 272 static inline struct ldlm_res_id *
 273 fid_build_reg_res_name(const struct lu_fid *f,
 274                        struct ldlm_res_id *name)
 275 {
 276         memset(name, 0, sizeof *name);
 277         name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
 278         name->name[LUSTRE_RES_ID_OID_OFF] = fid_oid(f);
 279         name->name[LUSTRE_RES_ID_VER_OFF] = fid_ver(f);
 280         return name;
 281 }
 282
 283 /*
 284  * Return true if resource is for object identified by fid.
 285  */
 286 static inline int fid_res_name_eq(const struct lu_fid *f,
 287                                   const struct ldlm_res_id *name)
 288 {
 289         return
 290                 name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
 291                 name->name[LUSTRE_RES_ID_OID_OFF] == fid_oid(f) &&
 292                 name->name[LUSTRE_RES_ID_VER_OFF] == fid_ver(f);
 293 }
 294
 295
 296 static inline struct ldlm_res_id *
 297 fid_build_pdo_res_name(const struct lu_fid *f,
 298                        unsigned int hash,
 299                        struct ldlm_res_id *name)
 300 {
 301         fid_build_reg_res_name(f, name);
 302         name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 303         return name;
 304 }
 305
 306 static inline __u64 fid_flatten(const struct lu_fid *fid)
 307 {
 308         return (fid_seq(fid) - 1) * LUSTRE_SEQ_MAX_WIDTH + fid_oid(fid);
 309 }
 310
 311 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 312 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 313
 314 /* Range common stuff */
 315 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 316 {
 317         dst->lsr_start = cpu_to_le64(src->lsr_start);
 318         dst->lsr_end = cpu_to_le64(src->lsr_end);
 319         dst->lsr_mdt = cpu_to_le32(src->lsr_mdt);
 320 }
 321
 322 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 323 {
 324         dst->lsr_start = le64_to_cpu(src->lsr_start);
 325         dst->lsr_end = le64_to_cpu(src->lsr_end);
 326         dst->lsr_mdt = le32_to_cpu(src->lsr_mdt);
 327 }
 328
 329 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 330 {
 331         dst->lsr_start = cpu_to_be64(src->lsr_start);
 332         dst->lsr_end = cpu_to_be64(src->lsr_end);
 333         dst->lsr_mdt = cpu_to_be32(src->lsr_mdt);
 334 }
 335
 336 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 337 {
 338         dst->lsr_start = be64_to_cpu(src->lsr_start);
 339         dst->lsr_end = be64_to_cpu(src->lsr_end);
 340         dst->lsr_mdt = be32_to_cpu(src->lsr_mdt);
 341 }
 342
 343 #endif /* __LINUX_FID_H */