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