lustre/fid/fid_lib.c

   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/fid/fid_lib.c
  35  *
  36  * Miscellaneous fid functions.
  37  *
  38  * Author: Nikita Danilov <nikita@clusterfs.com>
  39  * Author: Yury Umanets <umka@clusterfs.com>
  40  */
  41
  42 #ifndef EXPORT_SYMTAB
  43 # define EXPORT_SYMTAB
  44 #endif
  45 #define DEBUG_SUBSYSTEM S_FID
  46
  47 #ifdef __KERNEL__
  48 # include <libcfs/libcfs.h>
  49 # include <linux/module.h>
  50 #else /* __KERNEL__ */
  51 # include <liblustre.h>
  52 #endif
  53
  54 #include <obd.h>
  55 #include <lu_object.h>
  56 #include <lustre_fid.h>
  57
  58 /**
  59  * A cluster-wide range from which fid-sequences are granted to servers and
  60  * then clients.
  61  *
  62  * Fid namespace:
  63  * <pre>
  64  * Normal FID:        seq:64 [2^33,2^64-1]      oid:32          ver:32
  65  * IGIF      :        0:32, ino:32              gen:32          0:32
  66  * IDIF      :        0:31, 1:1, ost-index:16,  objd:48         0:32
  67  * </pre>
  68  *
  69  * The first 0x400 sequences of normal FID are reserved for special purpose.
  70  * FID_SEQ_START + 1 is for local file id generation.
  71  * FID_SEQ_START + 2 is for .lustre directory and its objects
  72  */
  73 const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE = {
  74         FID_SEQ_NORMAL,
  75         (__u64)~0ULL
  76 };
  77 EXPORT_SYMBOL(LUSTRE_SEQ_SPACE_RANGE);
  78
  79 /* Zero range, used for init and other purposes. */
  80 const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE = {
  81         0,
  82         0
  83 };
  84 EXPORT_SYMBOL(LUSTRE_SEQ_ZERO_RANGE);
  85
  86 /* Lustre Big Fs Lock fid. */
  87 const struct lu_fid LUSTRE_BFL_FID = { .f_seq = FID_SEQ_SPECIAL,
  88                                        .f_oid = FID_OID_SPECIAL_BFL,
  89                                        .f_ver = 0x0000000000000000 };
  90 EXPORT_SYMBOL(LUSTRE_BFL_FID);
  91
  92 /** Special fid for ".lustre" directory */
  93 const struct lu_fid LU_DOT_LUSTRE_FID = { .f_seq = FID_SEQ_DOT_LUSTRE,
  94                                           .f_oid = FID_OID_DOT_LUSTRE,
  95                                           .f_ver = 0x0000000000000000 };
  96 EXPORT_SYMBOL(LU_DOT_LUSTRE_FID);
  97
  98 /** Special fid for "fid" special object in .lustre */
  99 const struct lu_fid LU_OBF_FID = { .f_seq = FID_SEQ_DOT_LUSTRE,
 100                                    .f_oid = FID_OID_DOT_LUSTRE_OBF,
 101                                    .f_ver = 0x0000000000000000 };
 102 EXPORT_SYMBOL(LU_OBF_FID);