lustre/osd/osd_oi.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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/osd/osd_oi.h
  37  *
  38  * OSD Object Index
  39  *
  40  * Author: Nikita Danilov <nikita@clusterfs.com>
  41  */
  42
  43 /*
  44  * Object Index (oi) service runs in the bottom layer of server stack. In
  45  * translates fid local to this service to the storage cookie that uniquely
  46  * and efficiently identifies object (inode) of the underlying file system.
  47  */
  48
  49 #ifndef _OSD_OI_H
  50 #define _OSD_OI_H
  51
  52 #if defined(__KERNEL__)
  53
  54 /* struct rw_semaphore */
  55 #include <linux/rwsem.h>
  56 #include <lu_object.h>
  57 #include <md_object.h>
  58
  59 struct lu_fid;
  60 struct osd_thread_info;
  61 struct lu_site;
  62 struct thandle;
  63
  64 struct dt_device;
  65
  66 enum {
  67         OSD_OI_FID_16,
  68         OSD_OI_FID_NR
  69 };
  70
  71 /*
  72  * Object Index (oi) instance.
  73  */
  74 struct osd_oi {
  75         /*
  76          * underlying index object, where fid->id mapping in stored.
  77          */
  78         struct dt_object *oi_dir;
  79 };
  80
  81 /*
  82  * Storage cookie. Datum uniquely identifying inode on the underlying file
  83  * system.
  84  *
  85  * XXX Currently this is ext2/ext3/ldiskfs specific thing. In the future this
  86  * should be generalized to work with other local file systems.
  87  */
  88 struct osd_inode_id {
  89         __u32 oii_ino; /* inode number */
  90         __u32 oii_gen; /* inode generation */
  91 };
  92
  93 int osd_oi_mod_init(void);
  94 int osd_oi_init(struct osd_thread_info *info,
  95                 struct osd_oi *oi,
  96                 struct dt_device *dev,
  97                 struct md_device *mdev);
  98 void osd_oi_fini(struct osd_thread_info *info, struct osd_oi *oi);
  99
 100 int  osd_oi_lookup(struct osd_thread_info *info, struct osd_oi *oi,
 101                    const struct lu_fid *fid, struct osd_inode_id *id);
 102 int  osd_oi_insert(struct osd_thread_info *info, struct osd_oi *oi,
 103                    const struct lu_fid *fid, const struct osd_inode_id *id,
 104                    struct thandle *th, int ingore_quota);
 105 int  osd_oi_delete(struct osd_thread_info *info,
 106                    struct osd_oi *oi, const struct lu_fid *fid,
 107                    struct thandle *th);
 108
 109 #endif /* __KERNEL__ */
 110 #endif /* _OSD_OI_H */