lustre/include/lustre_fid.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  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  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 /** \defgroup fid fid
  45  *
  46  * @{
  47  */
  48
  49 /*
  50  * struct lu_fid
  51  */
  52 #include <libcfs/libcfs.h>
  53 #include <lustre/lustre_idl.h>
  54 #include <lustre_req_layout.h>
  55 #include <lustre_mdt.h>
  56
  57
  58 struct lu_site;
  59 struct lu_context;
  60
  61 /* Whole sequences space range and zero range definitions */
  62 extern const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE;
  63 extern const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE;
  64 extern const struct lu_fid LUSTRE_BFL_FID;
  65 extern const struct lu_fid LU_OBF_FID;
  66 extern const struct lu_fid LU_DOT_LUSTRE_FID;
  67
  68 enum {
  69         /*
  70          * This is how may FIDs may be allocated in one sequence(128k)
  71          */
  72         LUSTRE_SEQ_MAX_WIDTH = 0x0000000000020000ULL,
  73
  74         /*
  75          * How many sequences to allocate to a client at once.
  76          */
  77         LUSTRE_SEQ_META_WIDTH = 0x0000000000000001ULL,
  78
  79          /*
  80           * seq allocation pool size.
  81           */
  82         LUSTRE_SEQ_BATCH_WIDTH = LUSTRE_SEQ_META_WIDTH * 1000,
  83
  84         /*
  85          * This is how many sequences may be in one super-sequence allocated to
  86          * MDTs.
  87          */
  88         LUSTRE_SEQ_SUPER_WIDTH = ((1ULL << 30ULL) * LUSTRE_SEQ_META_WIDTH)
  89 };
  90
  91 enum {
  92         /** 2^6 FIDs for OI containers */
  93         OSD_OI_FID_OID_BITS     = 6,
  94         /** reserve enough FIDs in case we want more in the future */
  95         OSD_OI_FID_OID_BITS_MAX = 10,
  96 };
  97
  98 /** special OID for local objects */
  99 enum local_oid {
 100         /** \see fld_mod_init */
 101         FLD_INDEX_OID           = 3UL,
 102         /** \see fid_mod_init */
 103         FID_SEQ_CTL_OID         = 4UL,
 104         FID_SEQ_SRV_OID         = 5UL,
 105         /** \see mdd_mod_init */
 106         MDD_ROOT_INDEX_OID      = 6UL,
 107         MDD_ORPHAN_OID          = 7UL,
 108         MDD_LOV_OBJ_OID         = 8UL,
 109         MDD_CAPA_KEYS_OID       = 9UL,
 110         /** \see mdt_mod_init */
 111         MDT_LAST_RECV_OID       = 11UL,
 112         OSD_FS_ROOT_OID         = 13UL,
 113         ACCT_USER_OID           = 15UL,
 114         ACCT_GROUP_OID          = 16UL,
 115         OFD_LAST_RECV_OID       = 19UL,
 116         OFD_GROUP0_LAST_OID     = 20UL,
 117         OFD_GROUP4K_LAST_OID    = 20UL+4096,
 118         OFD_LAST_GROUP_OID      = 4117UL,
 119         LLOG_CATALOGS_OID       = 4118UL,
 120         MGS_CONFIGS_OID         = 4119UL,
 121         OFD_HEALTH_CHECK_OID    = 4120UL,
 122 };
 123
 124 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
 125 {
 126         fid->f_seq = FID_SEQ_LOCAL_FILE;
 127         fid->f_oid = oid;
 128         fid->f_ver = 0;
 129 }
 130
 131 enum lu_mgr_type {
 132         LUSTRE_SEQ_SERVER,
 133         LUSTRE_SEQ_CONTROLLER
 134 };
 135
 136 enum lu_cli_type {
 137         LUSTRE_SEQ_METADATA,
 138         LUSTRE_SEQ_DATA
 139 };
 140
 141 struct lu_server_seq;
 142
 143 /* Client sequence manager interface. */
 144 struct lu_client_seq {
 145         /* Sequence-controller export. */
 146         struct obd_export      *lcs_exp;
 147         cfs_mutex_t             lcs_mutex;
 148
 149         /*
 150          * Range of allowed for allocation sequeces. When using lu_client_seq on
 151          * clients, this contains meta-sequence range. And for servers this
 152          * contains super-sequence range.
 153          */
 154         struct lu_seq_range         lcs_space;
 155
 156         /* Seq related proc */
 157         cfs_proc_dir_entry_t   *lcs_proc_dir;
 158
 159         /* This holds last allocated fid in last obtained seq */
 160         struct lu_fid           lcs_fid;
 161
 162         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 163         enum lu_cli_type        lcs_type;
 164
 165         /*
 166          * Service uuid, passed from MDT + seq name to form unique seq name to
 167          * use it with procfs.
 168          */
 169         char                    lcs_name[80];
 170
 171         /*
 172          * Sequence width, that is how many objects may be allocated in one
 173          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 174          */
 175         __u64                   lcs_width;
 176
 177         /* Seq-server for direct talking */
 178         struct lu_server_seq   *lcs_srv;
 179
 180         /* wait queue for fid allocation and update indicator */
 181         cfs_waitq_t             lcs_waitq;
 182         int                     lcs_update;
 183 };
 184
 185 /* server sequence manager interface */
 186 struct lu_server_seq {
 187         /* Available sequences space */
 188         struct lu_seq_range         lss_space;
 189
 190         /* keeps highwater in lsr_end for seq allocation algorithm */
 191         struct lu_seq_range         lss_lowater_set;
 192         struct lu_seq_range         lss_hiwater_set;
 193
 194         /*
 195          * Device for server side seq manager needs (saving sequences to backing
 196          * store).
 197          */
 198         struct dt_device       *lss_dev;
 199
 200         /* /seq file object device */
 201         struct dt_object       *lss_obj;
 202
 203         /* Seq related proc */
 204         cfs_proc_dir_entry_t   *lss_proc_dir;
 205
 206         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
 207         enum lu_mgr_type       lss_type;
 208
 209         /* Client interafce to request controller */
 210         struct lu_client_seq   *lss_cli;
 211
 212         /* Mutex for protecting allocation */
 213         cfs_mutex_t             lss_mutex;
 214
 215         /*
 216          * Service uuid, passed from MDT + seq name to form unique seq name to
 217          * use it with procfs.
 218          */
 219         char                    lss_name[80];
 220
 221         /*
 222          * Allocation chunks for super and meta sequences. Default values are
 223          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
 224          */
 225         __u64                   lss_width;
 226
 227         /*
 228          * minimum lss_alloc_set size that should be allocated from
 229          * lss_space
 230          */
 231         __u64                   lss_set_width;
 232
 233         /* sync is needed for update operation */
 234         __u32                   lss_need_sync;
 235         /**
 236          * Pointer to site object, required to access site fld.
 237          */
 238         struct md_site         *lss_site;
 239 };
 240
 241 int seq_query(struct com_thread_info *info);
 242
 243 /* Server methods */
 244 int seq_server_init(struct lu_server_seq *seq,
 245                     struct dt_device *dev,
 246                     const char *prefix,
 247                     enum lu_mgr_type type,
 248                     struct md_site *ls,
 249                     const struct lu_env *env);
 250
 251 void seq_server_fini(struct lu_server_seq *seq,
 252                      const struct lu_env *env);
 253
 254 int seq_server_alloc_super(struct lu_server_seq *seq,
 255                            struct lu_seq_range *out,
 256                            const struct lu_env *env);
 257
 258 int seq_server_alloc_meta(struct lu_server_seq *seq,
 259                           struct lu_seq_range *out,
 260                           const struct lu_env *env);
 261
 262 int seq_server_set_cli(struct lu_server_seq *seq,
 263                        struct lu_client_seq *cli,
 264                        const struct lu_env *env);
 265
 266 /* Client methods */
 267 int seq_client_init(struct lu_client_seq *seq,
 268                     struct obd_export *exp,
 269                     enum lu_cli_type type,
 270                     const char *prefix,
 271                     struct lu_server_seq *srv);
 272
 273 void seq_client_fini(struct lu_client_seq *seq);
 274
 275 void seq_client_flush(struct lu_client_seq *seq);
 276
 277 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
 278                          struct lu_fid *fid);
 279 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
 280                        seqno_t *seqnr);
 281
 282 /* Fids common stuff */
 283 int fid_is_local(const struct lu_env *env,
 284                  struct lu_site *site, const struct lu_fid *fid);
 285
 286 /* fid locking */
 287
 288 struct ldlm_namespace;
 289
 290 /*
 291  * Build (DLM) resource name from FID.
 292  *
 293  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
 294  * but was moved into name[1] along with the OID to avoid consuming the
 295  * renaming name[2,3] fields that need to be used for the quota identifier.
 296  */
 297 static inline struct ldlm_res_id *
 298 fid_build_reg_res_name(const struct lu_fid *f,
 299                        struct ldlm_res_id *name)
 300 {
 301         memset(name, 0, sizeof *name);
 302         name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
 303         name->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(f);
 304         return name;
 305 }
 306
 307 /*
 308  * Return true if resource is for object identified by fid.
 309  */
 310 static inline int fid_res_name_eq(const struct lu_fid *f,
 311                                   const struct ldlm_res_id *name)
 312 {
 313         return name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
 314                name->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(f);
 315 }
 316
 317
 318 static inline struct ldlm_res_id *
 319 fid_build_pdo_res_name(const struct lu_fid *f,
 320                        unsigned int hash,
 321                        struct ldlm_res_id *name)
 322 {
 323         fid_build_reg_res_name(f, name);
 324         name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 325         return name;
 326 }
 327
 328
 329 /**
 330  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
 331  * For non-IGIF FIDs this starts just over 2^32, and continues without
 332  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
 333  * into the range where there may not be many OID values in use, to minimize
 334  * the risk of conflict.
 335  *
 336  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
 337  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
 338  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
 339  */
 340 static inline __u64 fid_flatten(const struct lu_fid *fid)
 341 {
 342         __u64 ino;
 343         __u64 seq;
 344
 345         if (fid_is_igif(fid)) {
 346                 ino = lu_igif_ino(fid);
 347                 RETURN(ino);
 348         }
 349
 350         seq = fid_seq(fid);
 351
 352         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
 353
 354         RETURN(ino ? ino : fid_oid(fid));
 355 }
 356
 357 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
 358 {
 359         /* all objects with same id and different versions will belong to same
 360          * collisions list. */
 361         return cfs_hash_long(fid_flatten(f), bits);
 362 }
 363
 364 /**
 365  * map fid to 32 bit value for ino on 32bit systems. */
 366 static inline __u32 fid_flatten32(const struct lu_fid *fid)
 367 {
 368         __u32 ino;
 369         __u64 seq;
 370
 371         if (fid_is_igif(fid)) {
 372                 ino = lu_igif_ino(fid);
 373                 RETURN(ino);
 374         }
 375
 376         seq = fid_seq(fid) - FID_SEQ_START;
 377
 378         /* Map the high bits of the OID into higher bits of the inode number so
 379          * that inodes generated at about the same time have a reduced chance
 380          * of collisions. This will give a period of 2^12 = 1024 unique clients
 381          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
 382          * (from OID), or up to 128M inodes without collisions for new files. */
 383         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
 384                (seq >> (64 - (40-8)) & 0xffffff00) +
 385                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
 386
 387         RETURN(ino ? ino : fid_oid(fid));
 388 }
 389
 390 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 391 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 392
 393 /* Range common stuff */
 394 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 395 {
 396         dst->lsr_start = cpu_to_le64(src->lsr_start);
 397         dst->lsr_end = cpu_to_le64(src->lsr_end);
 398         dst->lsr_index = cpu_to_le32(src->lsr_index);
 399         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
 400 }
 401
 402 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 403 {
 404         dst->lsr_start = le64_to_cpu(src->lsr_start);
 405         dst->lsr_end = le64_to_cpu(src->lsr_end);
 406         dst->lsr_index = le32_to_cpu(src->lsr_index);
 407         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
 408 }
 409
 410 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 411 {
 412         dst->lsr_start = cpu_to_be64(src->lsr_start);
 413         dst->lsr_end = cpu_to_be64(src->lsr_end);
 414         dst->lsr_index = cpu_to_be32(src->lsr_index);
 415         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
 416 }
 417
 418 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 419 {
 420         dst->lsr_start = be64_to_cpu(src->lsr_start);
 421         dst->lsr_end = be64_to_cpu(src->lsr_end);
 422         dst->lsr_index = be32_to_cpu(src->lsr_index);
 423         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
 424 }
 425
 426 /** @} fid */
 427
 428 #endif /* __LINUX_FID_H */