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         LFSCK_BOOKMARK_OID      = 17UL,
 116         OTABLE_IT_OID           = 18UL,
 117         OFD_LAST_RECV_OID       = 19UL,
 118         OFD_GROUP0_LAST_OID     = 20UL,
 119         OFD_GROUP4K_LAST_OID    = 20UL+4096,
 120         OFD_LAST_GROUP_OID      = 4117UL,
 121         LLOG_CATALOGS_OID       = 4118UL,
 122         MGS_CONFIGS_OID         = 4119UL,
 123         OFD_HEALTH_CHECK_OID    = 4120UL,
 124 };
 125
 126 static inline void lu_local_obj_fid(struct lu_fid *fid, __u32 oid)
 127 {
 128         fid->f_seq = FID_SEQ_LOCAL_FILE;
 129         fid->f_oid = oid;
 130         fid->f_ver = 0;
 131 }
 132
 133 static inline void lu_local_name_obj_fid(struct lu_fid *fid, __u32 oid)
 134 {
 135         fid->f_seq = FID_SEQ_LOCAL_NAME;
 136         fid->f_oid = oid;
 137         fid->f_ver = 0;
 138 }
 139
 140 static inline int fid_is_otable_it(const struct lu_fid *fid)
 141 {
 142         return unlikely(fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
 143                         fid_oid(fid) == OTABLE_IT_OID);
 144 }
 145
 146 static inline int fid_is_acct(const struct lu_fid *fid)
 147 {
 148         return fid_seq(fid) == FID_SEQ_LOCAL_FILE &&
 149                (fid_oid(fid) == ACCT_USER_OID ||
 150                 fid_oid(fid) == ACCT_GROUP_OID);
 151 }
 152
 153 static inline int fid_is_quota(const struct lu_fid *fid)
 154 {
 155         return fid_seq(fid) == FID_SEQ_QUOTA ||
 156                fid_seq(fid) == FID_SEQ_QUOTA_GLB;
 157 }
 158
 159 enum lu_mgr_type {
 160         LUSTRE_SEQ_SERVER,
 161         LUSTRE_SEQ_CONTROLLER
 162 };
 163
 164 enum lu_cli_type {
 165         LUSTRE_SEQ_METADATA,
 166         LUSTRE_SEQ_DATA
 167 };
 168
 169 struct lu_server_seq;
 170
 171 /* Client sequence manager interface. */
 172 struct lu_client_seq {
 173         /* Sequence-controller export. */
 174         struct obd_export      *lcs_exp;
 175         cfs_mutex_t             lcs_mutex;
 176
 177         /*
 178          * Range of allowed for allocation sequeces. When using lu_client_seq on
 179          * clients, this contains meta-sequence range. And for servers this
 180          * contains super-sequence range.
 181          */
 182         struct lu_seq_range         lcs_space;
 183
 184         /* Seq related proc */
 185         cfs_proc_dir_entry_t   *lcs_proc_dir;
 186
 187         /* This holds last allocated fid in last obtained seq */
 188         struct lu_fid           lcs_fid;
 189
 190         /* LUSTRE_SEQ_METADATA or LUSTRE_SEQ_DATA */
 191         enum lu_cli_type        lcs_type;
 192
 193         /*
 194          * Service uuid, passed from MDT + seq name to form unique seq name to
 195          * use it with procfs.
 196          */
 197         char                    lcs_name[80];
 198
 199         /*
 200          * Sequence width, that is how many objects may be allocated in one
 201          * sequence. Default value for it is LUSTRE_SEQ_MAX_WIDTH.
 202          */
 203         __u64                   lcs_width;
 204
 205         /* Seq-server for direct talking */
 206         struct lu_server_seq   *lcs_srv;
 207
 208         /* wait queue for fid allocation and update indicator */
 209         cfs_waitq_t             lcs_waitq;
 210         int                     lcs_update;
 211 };
 212
 213 /* server sequence manager interface */
 214 struct lu_server_seq {
 215         /* Available sequences space */
 216         struct lu_seq_range         lss_space;
 217
 218         /* keeps highwater in lsr_end for seq allocation algorithm */
 219         struct lu_seq_range         lss_lowater_set;
 220         struct lu_seq_range         lss_hiwater_set;
 221
 222         /*
 223          * Device for server side seq manager needs (saving sequences to backing
 224          * store).
 225          */
 226         struct dt_device       *lss_dev;
 227
 228         /* /seq file object device */
 229         struct dt_object       *lss_obj;
 230
 231         /* Seq related proc */
 232         cfs_proc_dir_entry_t   *lss_proc_dir;
 233
 234         /* LUSTRE_SEQ_SERVER or LUSTRE_SEQ_CONTROLLER */
 235         enum lu_mgr_type       lss_type;
 236
 237         /* Client interafce to request controller */
 238         struct lu_client_seq   *lss_cli;
 239
 240         /* Mutex for protecting allocation */
 241         cfs_mutex_t             lss_mutex;
 242
 243         /*
 244          * Service uuid, passed from MDT + seq name to form unique seq name to
 245          * use it with procfs.
 246          */
 247         char                    lss_name[80];
 248
 249         /*
 250          * Allocation chunks for super and meta sequences. Default values are
 251          * LUSTRE_SEQ_SUPER_WIDTH and LUSTRE_SEQ_META_WIDTH.
 252          */
 253         __u64                   lss_width;
 254
 255         /*
 256          * minimum lss_alloc_set size that should be allocated from
 257          * lss_space
 258          */
 259         __u64                   lss_set_width;
 260
 261         /* sync is needed for update operation */
 262         __u32                   lss_need_sync;
 263         /**
 264          * Pointer to site object, required to access site fld.
 265          */
 266         struct md_site         *lss_site;
 267 };
 268
 269 int seq_query(struct com_thread_info *info);
 270
 271 /* Server methods */
 272 int seq_server_init(struct lu_server_seq *seq,
 273                     struct dt_device *dev,
 274                     const char *prefix,
 275                     enum lu_mgr_type type,
 276                     struct md_site *ls,
 277                     const struct lu_env *env);
 278
 279 void seq_server_fini(struct lu_server_seq *seq,
 280                      const struct lu_env *env);
 281
 282 int seq_server_alloc_super(struct lu_server_seq *seq,
 283                            struct lu_seq_range *out,
 284                            const struct lu_env *env);
 285
 286 int seq_server_alloc_meta(struct lu_server_seq *seq,
 287                           struct lu_seq_range *out,
 288                           const struct lu_env *env);
 289
 290 int seq_server_set_cli(struct lu_server_seq *seq,
 291                        struct lu_client_seq *cli,
 292                        const struct lu_env *env);
 293
 294 /* Client methods */
 295 int seq_client_init(struct lu_client_seq *seq,
 296                     struct obd_export *exp,
 297                     enum lu_cli_type type,
 298                     const char *prefix,
 299                     struct lu_server_seq *srv);
 300
 301 void seq_client_fini(struct lu_client_seq *seq);
 302
 303 void seq_client_flush(struct lu_client_seq *seq);
 304
 305 int seq_client_alloc_fid(const struct lu_env *env, struct lu_client_seq *seq,
 306                          struct lu_fid *fid);
 307 int seq_client_get_seq(const struct lu_env *env, struct lu_client_seq *seq,
 308                        seqno_t *seqnr);
 309
 310 /* Fids common stuff */
 311 int fid_is_local(const struct lu_env *env,
 312                  struct lu_site *site, const struct lu_fid *fid);
 313
 314 /* fid locking */
 315
 316 struct ldlm_namespace;
 317
 318 /*
 319  * Build (DLM) resource name from FID.
 320  *
 321  * NOTE: until Lustre 1.8.7/2.1.1 the fid_ver() was packed into name[2],
 322  * but was moved into name[1] along with the OID to avoid consuming the
 323  * renaming name[2,3] fields that need to be used for the quota identifier.
 324  */
 325 static inline struct ldlm_res_id *
 326 fid_build_reg_res_name(const struct lu_fid *f,
 327                        struct ldlm_res_id *name)
 328 {
 329         memset(name, 0, sizeof *name);
 330         name->name[LUSTRE_RES_ID_SEQ_OFF] = fid_seq(f);
 331         name->name[LUSTRE_RES_ID_VER_OID_OFF] = fid_ver_oid(f);
 332         return name;
 333 }
 334
 335 /*
 336  * Build (DLM) resource identifier from global quota FID and quota ID.
 337  */
 338 static inline struct ldlm_res_id *
 339 fid_build_quota_resid(const struct lu_fid *glb_fid, union lquota_id *qid,
 340                       struct ldlm_res_id *res)
 341 {
 342         fid_build_reg_res_name(glb_fid, res);
 343         res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] = fid_seq(&qid->qid_fid);
 344         res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] = fid_ver_oid(&qid->qid_fid);
 345         return res;
 346 }
 347
 348 /*
 349  * Extract global FID and quota ID from resource name
 350  */
 351 static inline void fid_extract_quota_resid(struct ldlm_res_id *res,
 352                                            struct lu_fid *glb_fid,
 353                                            union lquota_id *qid)
 354 {
 355         glb_fid->f_seq = res->name[LUSTRE_RES_ID_SEQ_OFF];
 356         glb_fid->f_oid = (__u32)res->name[LUSTRE_RES_ID_VER_OID_OFF];
 357         glb_fid->f_ver = (__u32)(res->name[LUSTRE_RES_ID_VER_OID_OFF] >> 32);
 358
 359         qid->qid_fid.f_seq = res->name[LUSTRE_RES_ID_QUOTA_SEQ_OFF];
 360         qid->qid_fid.f_oid = (__u32)res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF];
 361         qid->qid_fid.f_ver =
 362                 (__u32)(res->name[LUSTRE_RES_ID_QUOTA_VER_OID_OFF] >> 32);
 363 }
 364
 365 /*
 366  * Return true if resource is for object identified by fid.
 367  */
 368 static inline int fid_res_name_eq(const struct lu_fid *f,
 369                                   const struct ldlm_res_id *name)
 370 {
 371         return name->name[LUSTRE_RES_ID_SEQ_OFF] == fid_seq(f) &&
 372                name->name[LUSTRE_RES_ID_VER_OID_OFF] == fid_ver_oid(f);
 373 }
 374
 375
 376 static inline struct ldlm_res_id *
 377 fid_build_pdo_res_name(const struct lu_fid *f,
 378                        unsigned int hash,
 379                        struct ldlm_res_id *name)
 380 {
 381         fid_build_reg_res_name(f, name);
 382         name->name[LUSTRE_RES_ID_HSH_OFF] = hash;
 383         return name;
 384 }
 385
 386
 387 /**
 388  * Flatten 128-bit FID values into a 64-bit value for use as an inode number.
 389  * For non-IGIF FIDs this starts just over 2^32, and continues without
 390  * conflict until 2^64, at which point we wrap the high 24 bits of the SEQ
 391  * into the range where there may not be many OID values in use, to minimize
 392  * the risk of conflict.
 393  *
 394  * Suppose LUSTRE_SEQ_MAX_WIDTH less than (1 << 24) which is currently true,
 395  * the time between re-used inode numbers is very long - 2^40 SEQ numbers,
 396  * or about 2^40 client mounts, if clients create less than 2^24 files/mount.
 397  */
 398 static inline __u64 fid_flatten(const struct lu_fid *fid)
 399 {
 400         __u64 ino;
 401         __u64 seq;
 402
 403         if (fid_is_igif(fid)) {
 404                 ino = lu_igif_ino(fid);
 405                 RETURN(ino);
 406         }
 407
 408         seq = fid_seq(fid);
 409
 410         ino = (seq << 24) + ((seq >> 24) & 0xffffff0000ULL) + fid_oid(fid);
 411
 412         RETURN(ino ? ino : fid_oid(fid));
 413 }
 414
 415 static inline __u32 fid_hash(const struct lu_fid *f, int bits)
 416 {
 417         /* all objects with same id and different versions will belong to same
 418          * collisions list. */
 419         return cfs_hash_long(fid_flatten(f), bits);
 420 }
 421
 422 /**
 423  * map fid to 32 bit value for ino on 32bit systems. */
 424 static inline __u32 fid_flatten32(const struct lu_fid *fid)
 425 {
 426         __u32 ino;
 427         __u64 seq;
 428
 429         if (fid_is_igif(fid)) {
 430                 ino = lu_igif_ino(fid);
 431                 RETURN(ino);
 432         }
 433
 434         seq = fid_seq(fid) - FID_SEQ_START;
 435
 436         /* Map the high bits of the OID into higher bits of the inode number so
 437          * that inodes generated at about the same time have a reduced chance
 438          * of collisions. This will give a period of 2^12 = 1024 unique clients
 439          * (from SEQ) and up to min(LUSTRE_SEQ_MAX_WIDTH, 2^20) = 128k objects
 440          * (from OID), or up to 128M inodes without collisions for new files. */
 441         ino = ((seq & 0x000fffffULL) << 12) + ((seq >> 8) & 0xfffff000) +
 442                (seq >> (64 - (40-8)) & 0xffffff00) +
 443                (fid_oid(fid) & 0xff000fff) + ((fid_oid(fid) & 0x00fff000) << 8);
 444
 445         RETURN(ino ? ino : fid_oid(fid));
 446 }
 447
 448 #define LUSTRE_SEQ_SRV_NAME "seq_srv"
 449 #define LUSTRE_SEQ_CTL_NAME "seq_ctl"
 450
 451 /* Range common stuff */
 452 static inline void range_cpu_to_le(struct lu_seq_range *dst, const struct lu_seq_range *src)
 453 {
 454         dst->lsr_start = cpu_to_le64(src->lsr_start);
 455         dst->lsr_end = cpu_to_le64(src->lsr_end);
 456         dst->lsr_index = cpu_to_le32(src->lsr_index);
 457         dst->lsr_flags = cpu_to_le32(src->lsr_flags);
 458 }
 459
 460 static inline void range_le_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 461 {
 462         dst->lsr_start = le64_to_cpu(src->lsr_start);
 463         dst->lsr_end = le64_to_cpu(src->lsr_end);
 464         dst->lsr_index = le32_to_cpu(src->lsr_index);
 465         dst->lsr_flags = le32_to_cpu(src->lsr_flags);
 466 }
 467
 468 static inline void range_cpu_to_be(struct lu_seq_range *dst, const struct lu_seq_range *src)
 469 {
 470         dst->lsr_start = cpu_to_be64(src->lsr_start);
 471         dst->lsr_end = cpu_to_be64(src->lsr_end);
 472         dst->lsr_index = cpu_to_be32(src->lsr_index);
 473         dst->lsr_flags = cpu_to_be32(src->lsr_flags);
 474 }
 475
 476 static inline void range_be_to_cpu(struct lu_seq_range *dst, const struct lu_seq_range *src)
 477 {
 478         dst->lsr_start = be64_to_cpu(src->lsr_start);
 479         dst->lsr_end = be64_to_cpu(src->lsr_end);
 480         dst->lsr_index = be32_to_cpu(src->lsr_index);
 481         dst->lsr_flags = be32_to_cpu(src->lsr_flags);
 482 }
 483
 484 /** @} fid */
 485
 486 #endif /* __LINUX_FID_H */