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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2014, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/fid/fid_lib.c
  33  *
  34  * Miscellaneous fid functions.
  35  *
  36  * Author: Nikita Danilov <nikita@clusterfs.com>
  37  * Author: Yury Umanets <umka@clusterfs.com>
  38  */
  39
  40 #define DEBUG_SUBSYSTEM S_FID
  41
  42 #include <libcfs/libcfs.h>
  43 #include <linux/module.h>
  44 #include <lustre_fid.h>
  45
  46 /**
  47  * A cluster-wide range from which fid-sequences are granted to servers and
  48  * then clients.
  49  *
  50  * Fid namespace:
  51  * <pre>
  52  * Normal FID:        seq:64 [2^33,2^64-1]      oid:32          ver:32
  53  * IGIF      :        0:32, ino:32              gen:32          0:32
  54  * IDIF      :        0:31, 1:1, ost-index:16,  objd:48         0:32
  55  * </pre>
  56  *
  57  * The first 0x400 sequences of normal FID are reserved for special purpose.
  58  * FID_SEQ_START + 1 is for local file id generation.
  59  * FID_SEQ_START + 2 is for .lustre directory and its objects
  60  */
  61 const struct lu_seq_range LUSTRE_SEQ_SPACE_RANGE = {
  62         .lsr_start      = FID_SEQ_NORMAL,
  63         .lsr_end        = (__u64)~0ULL,
  64 };
  65
  66 /* Zero range, used for init and other purposes. */
  67 const struct lu_seq_range LUSTRE_SEQ_ZERO_RANGE = {
  68         .lsr_start = 0,
  69 };
  70
  71 /* Lustre Big Fs Lock fid. */
  72 const struct lu_fid LUSTRE_BFL_FID = { .f_seq = FID_SEQ_SPECIAL,
  73                                        .f_oid = FID_OID_SPECIAL_BFL,
  74                                        .f_ver = 0x0000000000000000 };
  75 EXPORT_SYMBOL(LUSTRE_BFL_FID);
  76
  77 /** Special fid for ".lustre" directory */
  78 const struct lu_fid LU_DOT_LUSTRE_FID = { .f_seq = FID_SEQ_DOT_LUSTRE,
  79                                           .f_oid = FID_OID_DOT_LUSTRE,
  80                                           .f_ver = 0x0000000000000000 };
  81 EXPORT_SYMBOL(LU_DOT_LUSTRE_FID);
  82
  83 /** Special fid for "fid" special object in .lustre */
  84 const struct lu_fid LU_OBF_FID = { .f_seq = FID_SEQ_DOT_LUSTRE,
  85                                    .f_oid = FID_OID_DOT_LUSTRE_OBF,
  86                                    .f_ver = 0x0000000000000000 };
  87 EXPORT_SYMBOL(LU_OBF_FID);
  88
  89 /** Special fid for "lost+found" special object in .lustre */
  90 const struct lu_fid LU_LPF_FID = { .f_seq = FID_SEQ_DOT_LUSTRE,
  91                                    .f_oid = FID_OID_DOT_LUSTRE_LPF,
  92                                    .f_ver = 0x0000000000000000 };
  93 EXPORT_SYMBOL(LU_LPF_FID);
  94
  95 /** "/lost+found" - special FID for ldiskfs backend, invislbe to client. */
  96 const struct lu_fid LU_BACKEND_LPF_FID = { .f_seq = FID_SEQ_LOCAL_FILE,
  97                                            .f_oid = OSD_LPF_OID,
  98                                            .f_ver = 0x0000000000000000 };
  99 EXPORT_SYMBOL(LU_BACKEND_LPF_FID);