Whamcloud - gitweb
LU-1729: lu_buf code cleaning
[fs/lustre-release.git] / lustre / include / lu_object.h
index 9c2f283..175de05 100644 (file)
@@ -1,6 +1,4 @@
-/* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
- * vim:expandtab:shiftwidth=8:tabstop=8:
- *
+/*
  * GPL HEADER START
  *
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  * GPL HEADER END
  */
 /*
- * Copyright  2008 Sun Microsystems, Inc. All rights reserved
+ * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ *
+ * Copyright (c) 2011, 2012, Whamcloud, Inc.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
 /*
  * struct lu_fid
  */
-#include <lustre/lustre_idl.h>
-
 #include <libcfs/libcfs.h>
 
+#include <lustre/lustre_idl.h>
+
 #include <lu_ref.h>
 
 struct seq_file;
@@ -156,14 +156,37 @@ struct lu_device_operations {
         int (*ldo_recovery_complete)(const struct lu_env *,
                                      struct lu_device *);
 
+        /**
+         * initialize local objects for device. this method called after layer has
+         * been initialized (after LCFG_SETUP stage) and before it starts serving
+         * user requests.
+         */
+
+        int (*ldo_prepare)(const struct lu_env *,
+                           struct lu_device *parent,
+                           struct lu_device *dev);
+
 };
 
 /**
+ * For lu_object_conf flags
+ */
+typedef enum {
+       /* This is a new object to be allocated, or the file
+        * corresponding to the object does not exists. */
+       LOC_F_NEW       = 0x00000001,
+} loc_flags_t;
+
+/**
  * Object configuration, describing particulars of object being created. On
  * server this is not used, as server objects are full identified by fid. On
  * client configuration contains struct lustre_md.
  */
 struct lu_object_conf {
+        /**
+         * Some hints for obj find and alloc.
+         */
+        loc_flags_t     loc_flags;
 };
 
 /**
@@ -247,7 +270,7 @@ struct lu_device {
          *
          * \todo XXX which means that atomic_t is probably too small.
          */
-        atomic_t                           ld_ref;
+        cfs_atomic_t                       ld_ref;
         /**
          * Pointer to device type. Never modified once set.
          */
@@ -268,6 +291,10 @@ struct lu_device {
          * A list of references to this object, for debugging.
          */
         struct lu_ref                      ld_reference;
+        /**
+         * Link the device to the site.
+         **/
+        cfs_list_t                         ld_linkage;
 };
 
 struct lu_device_type_operations;
@@ -318,7 +345,7 @@ struct lu_device_type {
          *
          * \see lu_device_types.
          */
-        struct list_head                        ldt_linkage;
+        cfs_list_t                              ldt_linkage;
 };
 
 /**
@@ -389,11 +416,11 @@ struct lu_attr {
         /** size in bytes */
         __u64          la_size;
         /** modification time in seconds since Epoch */
-        __u64          la_mtime;
+        obd_time       la_mtime;
         /** access time in seconds since Epoch */
-        __u64          la_atime;
+        obd_time       la_atime;
         /** change time in seconds since Epoch */
-        __u64          la_ctime;
+        obd_time       la_ctime;
         /** 512-byte blocks allocated to object */
         __u64          la_blocks;
         /** permission bits and file type */
@@ -435,6 +462,8 @@ enum la_valid {
         LA_NLINK  = 1 << 10,
         LA_RDEV   = 1 << 11,
         LA_BLKSIZE = 1 << 12,
+        LA_KILL_SUID = 1 << 13,
+        LA_KILL_SGID = 1 << 14,
 };
 
 /**
@@ -456,7 +485,7 @@ struct lu_object {
         /**
          * Linkage into list of all layers.
          */
-        struct list_head                   lo_linkage;
+        cfs_list_t                         lo_linkage;
         /**
          * Depth. Top level layer depth is 0.
          */
@@ -486,8 +515,8 @@ enum lu_object_header_attr {
         /**
          * UNIX file type is stored in S_IFMT bits.
          */
-        LOHA_FT_START = 1 << 12, /**< S_IFIFO */
-        LOHA_FT_END   = 1 << 15, /**< S_IFREG */
+        LOHA_FT_START = 001 << 12, /**< S_IFIFO */
+        LOHA_FT_END   = 017 << 12, /**< S_IFMT */
 };
 
 /**
@@ -506,41 +535,76 @@ struct lu_object_header {
          * Object flags from enum lu_object_header_flags. Set and checked
          * atomically.
          */
-        unsigned long       loh_flags;
+        unsigned long          loh_flags;
         /**
          * Object reference count. Protected by lu_site::ls_guard.
          */
-        atomic_t            loh_ref;
+        cfs_atomic_t           loh_ref;
         /**
          * Fid, uniquely identifying this object.
          */
-        struct lu_fid       loh_fid;
+        struct lu_fid          loh_fid;
         /**
          * Common object attributes, cached for efficiency. From enum
          * lu_object_header_attr.
          */
-        __u32               loh_attr;
+        __u32                  loh_attr;
         /**
          * Linkage into per-site hash table. Protected by lu_site::ls_guard.
          */
-        struct hlist_node   loh_hash;
+        cfs_hlist_node_t       loh_hash;
         /**
          * Linkage into per-site LRU list. Protected by lu_site::ls_guard.
          */
-        struct list_head    loh_lru;
+        cfs_list_t             loh_lru;
         /**
          * Linkage into list of layers. Never modified once set (except lately
          * during object destruction). No locking is necessary.
          */
-        struct list_head    loh_layers;
+        cfs_list_t             loh_layers;
         /**
          * A list of references to this object, for debugging.
          */
-        struct lu_ref       loh_reference;
+        struct lu_ref          loh_reference;
 };
 
 struct fld;
 
+struct lu_site_bkt_data {
+        /**
+         * number of busy object on this bucket
+         */
+        long                      lsb_busy;
+        /**
+         * LRU list, updated on each access to object. Protected by
+         * bucket lock of lu_site::ls_obj_hash.
+         *
+         * "Cold" end of LRU is lu_site::ls_lru.next. Accessed object are
+         * moved to the lu_site::ls_lru.prev (this is due to the non-existence
+         * of list_for_each_entry_safe_reverse()).
+         */
+        cfs_list_t                lsb_lru;
+        /**
+         * Wait-queue signaled when an object in this site is ultimately
+         * destroyed (lu_object_free()). It is used by lu_object_find() to
+         * wait before re-trying when object in the process of destruction is
+         * found in the hash table.
+         *
+         * \see htable_lookup().
+         */
+        cfs_waitq_t               lsb_marche_funebre;
+};
+
+enum {
+        LU_SS_CREATED         = 0,
+        LU_SS_CACHE_HIT,
+        LU_SS_CACHE_MISS,
+        LU_SS_CACHE_RACE,
+        LU_SS_CACHE_DEATH_RACE,
+        LU_SS_LRU_PURGED,
+        LU_SS_LAST_STAT
+};
+
 /**
  * lu_site is a "compartment" within which objects are unique, and LRU
  * discipline is maintained.
@@ -553,106 +617,51 @@ struct fld;
  */
 struct lu_site {
         /**
-         * Site-wide lock.
-         *
-         * lock protecting:
-         *
-         *        - lu_site::ls_hash hash table (and its linkages in objects);
-         *
-         *        - lu_site::ls_lru list (and its linkages in objects);
-         *
-         *        - 0/1 transitions of object lu_object_header::loh_ref
-         *        reference count;
-         *
-         * yes, it's heavy.
-         */
-        rwlock_t              ls_guard;
-        /**
-         * Hash-table where objects are indexed by fid.
+         * objects hash table
          */
-        struct hlist_head    *ls_hash;
+        cfs_hash_t               *ls_obj_hash;
         /**
-         * Bit-mask for hash-table size.
+         * index of bucket on hash table while purging
          */
-        int                   ls_hash_mask;
+        int                       ls_purge_start;
         /**
-         * Order of hash-table.
-         */
-        int                   ls_hash_bits;
-        /**
-         * Number of buckets in the hash-table.
-         */
-        int                   ls_hash_size;
-
-        /**
-         * LRU list, updated on each access to object. Protected by
-         * lu_site::ls_guard.
-         *
-         * "Cold" end of LRU is lu_site::ls_lru.next. Accessed object are
-         * moved to the lu_site::ls_lru.prev (this is due to the non-existence
-         * of list_for_each_entry_safe_reverse()).
+         * Top-level device for this stack.
          */
-        struct list_head      ls_lru;
+        struct lu_device         *ls_top_dev;
+       /**
+        * Bottom-level device for this stack
+        */
+       struct lu_device        *ls_bottom_dev;
         /**
-         * Total number of objects in this site. Protected by
-         * lu_site::ls_guard.
+         * Linkage into global list of sites.
          */
-        unsigned              ls_total;
+        cfs_list_t                ls_linkage;
         /**
-         * Total number of objects in this site with reference counter greater
-         * than 0. Protected by lu_site::ls_guard.
-         */
-        unsigned              ls_busy;
+         * List for lu device for this site, protected
+         * by ls_ld_lock.
+         **/
+        cfs_list_t                ls_ld_linkage;
+        cfs_spinlock_t            ls_ld_lock;
 
         /**
-         * Top-level device for this stack.
+         * lu_site stats
          */
-        struct lu_device     *ls_top_dev;
+        struct lprocfs_stats     *ls_stats;
+        struct lprocfs_stats     *ls_time_stats;
+       /**
+        * XXX: a hack! fld has to find md_site via site, remove when possible
+        */
+       struct md_site           *ld_md_site;
+};
 
-        /**
-         * Wait-queue signaled when an object in this site is ultimately
-         * destroyed (lu_object_free()). It is used by lu_object_find() to
-         * wait before re-trying when object in the process of destruction is
-         * found in the hash table.
-         *
-         * If having a single wait-queue turns out to be a problem, a
-         * wait-queue per hash-table bucket can be easily implemented.
-         *
-         * \see htable_lookup().
-         */
-        cfs_waitq_t           ls_marche_funebre;
-
-        /** statistical counters. Protected by nothing, races are accepted. */
-        struct {
-                __u32 s_created;
-                __u32 s_cache_hit;
-                __u32 s_cache_miss;
-                /**
-                 * Number of hash-table entry checks made.
-                 *
-                 *       ->s_cache_check / (->s_cache_miss + ->s_cache_hit)
-                 *
-                 * is an average number of hash slots inspected during single
-                 * lookup.
-                 */
-                __u32 s_cache_check;
-                /** Races with cache insertions. */
-                __u32 s_cache_race;
-                /**
-                 * Races with object destruction.
-                 *
-                 * \see lu_site::ls_marche_funebre.
-                 */
-                __u32 s_cache_death_race;
-                __u32 s_lru_purged;
-        } ls_stats;
+static inline struct lu_site_bkt_data *
+lu_site_bkt_from_fid(struct lu_site *site, struct lu_fid *fid)
+{
+        cfs_hash_bd_t bd;
 
-        /**
-         * Linkage into global list of sites.
-         */
-        struct list_head      ls_linkage;
-        struct lprocfs_stats *ls_time_stats;
-};
+        cfs_hash_bd_get(site->ls_obj_hash, fid, &bd);
+        return cfs_hash_bd_extra_get(site->ls_obj_hash, &bd);
+}
 
 /** \name ctors
  * Constructors/destructors.
@@ -675,6 +684,9 @@ void lu_object_fini       (struct lu_object *o);
 void lu_object_add_top    (struct lu_object_header *h, struct lu_object *o);
 void lu_object_add        (struct lu_object *before, struct lu_object *o);
 
+void lu_dev_add_linkage(struct lu_site *s, struct lu_device *d);
+void lu_dev_del_linkage(struct lu_site *s, struct lu_device *d);
+
 /**
  * Helpers to initialize and finalize device types.
  */
@@ -697,8 +709,8 @@ void lu_types_stop(void);
  */
 static inline void lu_object_get(struct lu_object *o)
 {
-        LASSERT(atomic_read(&o->lo_header->loh_ref) > 0);
-        atomic_inc(&o->lo_header->loh_ref);
+        LASSERT(cfs_atomic_read(&o->lo_header->loh_ref) > 0);
+        cfs_atomic_inc(&o->lo_header->loh_ref);
 }
 
 /**
@@ -707,10 +719,11 @@ static inline void lu_object_get(struct lu_object *o)
  */
 static inline int lu_object_is_dying(const struct lu_object_header *h)
 {
-        return test_bit(LU_OBJECT_HEARD_BANSHEE, &h->loh_flags);
+        return cfs_test_bit(LU_OBJECT_HEARD_BANSHEE, &h->loh_flags);
 }
 
 void lu_object_put(const struct lu_env *env, struct lu_object *o);
+void lu_object_put_nocache(const struct lu_env *env, struct lu_object *o);
 
 int lu_site_purge(const struct lu_env *env, struct lu_site *s, int nr);
 
@@ -739,7 +752,7 @@ struct lu_object *lu_object_find_slice(const struct lu_env *env,
  */
 static inline struct lu_object *lu_object_top(struct lu_object_header *h)
 {
-        LASSERT(!list_empty(&h->loh_layers));
+        LASSERT(!cfs_list_empty(&h->loh_layers));
         return container_of0(h->loh_layers.next, struct lu_object, lo_linkage);
 }
 
@@ -775,40 +788,23 @@ lu_object_ops(const struct lu_object *o)
 struct lu_object *lu_object_locate(struct lu_object_header *h,
                                    const struct lu_device_type *dtype);
 
-struct lu_cdebug_print_info {
-        int         lpi_subsys;
-        int         lpi_mask;
-        const char *lpi_file;
-        const char *lpi_fn;
-        int         lpi_line;
-};
-
 /**
  * Printer function emitting messages through libcfs_debug_msg().
  */
 int lu_cdebug_printer(const struct lu_env *env,
                       void *cookie, const char *format, ...);
 
-#define DECLARE_LU_CDEBUG_PRINT_INFO(var, mask) \
-        struct lu_cdebug_print_info var = {     \
-                .lpi_subsys = DEBUG_SUBSYSTEM,  \
-                .lpi_mask   = (mask),           \
-                .lpi_file   = __FILE__,         \
-                .lpi_fn     = __FUNCTION__,     \
-                .lpi_line   = __LINE__          \
-        }
-
 /**
  * Print object description followed by a user-supplied message.
  */
-#define LU_OBJECT_DEBUG(mask, env, object, format, ...)                 \
-do {                                                                    \
-        static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask);              \
-                                                                        \
-        if (cdebug_show(mask, DEBUG_SUBSYSTEM)) {                       \
-                lu_object_print(env, &__info, lu_cdebug_printer, object); \
-                CDEBUG(mask, format , ## __VA_ARGS__);                  \
-        }                                                               \
+#define LU_OBJECT_DEBUG(mask, env, object, format, ...)                   \
+do {                                                                      \
+        LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);                  \
+                                                                          \
+        if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                     \
+                lu_object_print(env, &msgdata, lu_cdebug_printer, object);\
+                CDEBUG(mask, format , ## __VA_ARGS__);                    \
+        }                                                                 \
 } while (0)
 
 /**
@@ -816,12 +812,12 @@ do {                                                                    \
  */
 #define LU_OBJECT_HEADER(mask, env, object, format, ...)                \
 do {                                                                    \
-        static DECLARE_LU_CDEBUG_PRINT_INFO(__info, mask);              \
+        LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, NULL);                \
                                                                         \
-        if (cdebug_show(mask, DEBUG_SUBSYSTEM)) {                       \
-                lu_object_header_print(env, &__info, lu_cdebug_printer, \
+        if (cfs_cdebug_show(mask, DEBUG_SUBSYSTEM)) {                   \
+                lu_object_header_print(env, &msgdata, lu_cdebug_printer,\
                                        (object)->lo_header);            \
-                lu_cdebug_printer(env, &__info, "\n");                  \
+                lu_cdebug_printer(env, &msgdata, "\n");                 \
                 CDEBUG(mask, format , ## __VA_ARGS__);                  \
         }                                                               \
 } while (0)
@@ -837,11 +833,11 @@ void lu_object_header_print(const struct lu_env *env, void *cookie,
  */
 int lu_object_invariant(const struct lu_object *o);
 
-void lu_stack_fini(const struct lu_env *env, struct lu_device *top);
 
 /**
- * Returns 1 iff object @o exists on the stable storage,
- * returns -1 iff object @o is on remote server.
+ * \retval  1 iff object \a o exists on stable storage,
+ * \retval  0 iff object \a o not exists on stable storage.
+ * \retval -1 iff object \a o is on remote server.
  */
 static inline int lu_object_exists(const struct lu_object *o)
 {
@@ -895,12 +891,18 @@ static inline void lu_object_ref_del_at(struct lu_object *o,
         lu_ref_del_at(&o->lo_header->loh_reference, link, scope, source);
 }
 
+/** input params, should be filled out by mdt */
 struct lu_rdpg {
-        /* input params, should be filled out by mdt */
-        __u64                   rp_hash;        /* hash */
-        int                     rp_count;       /* count in bytes       */
-        int                     rp_npages;      /* number of pages      */
-        struct page           **rp_pages;       /* pointers to pages    */
+        /** hash */
+        __u64                   rp_hash;
+        /** count in bytes */
+        unsigned int            rp_count;
+        /** number of pages */
+        unsigned int            rp_npages;
+        /** requested attr */
+        __u32                   rp_attrs;
+        /** pointers to pages */
+        struct page           **rp_pages;
 };
 
 enum lu_xattr_flags {
@@ -954,6 +956,7 @@ struct lu_context {
          * from enum lu_context_tag.
          */
         __u32                  lc_tags;
+       enum lu_context_state  lc_state;
         /**
          * Pointer to the home service thread. NULL for other execution
          * contexts.
@@ -964,13 +967,12 @@ struct lu_context {
          * detail.
          */
         void                 **lc_value;
-        enum lu_context_state  lc_state;
         /**
          * Linkage into a list of all remembered contexts. Only
          * `non-transient' contexts, i.e., ones created for service threads
          * are placed here.
          */
-        struct list_head       lc_remember;
+        cfs_list_t             lc_remember;
         /**
          * Version counter used to skip calls to lu_context_refill() when no
          * keys were registered.
@@ -1008,7 +1010,18 @@ enum lu_context_tag {
          * a client.
          */
         LCT_SESSION   = 1 << 4,
-
+        /**
+         * A per-request data on OSP device
+         */
+        LCT_OSP_THREAD = 1 << 5,
+        /**
+         * MGS device thread
+         */
+        LCT_MG_THREAD = 1 << 6,
+        /**
+         * Context for local operations
+         */
+        LCT_LOCAL = 1 << 7,
         /**
          * Set when at least one of keys, having values in this context has
          * non-NULL lu_context_key::lct_exit() method. This is used to
@@ -1104,11 +1117,11 @@ struct lu_context_key {
          * Internal implementation detail: number of values created for this
          * key.
          */
-        atomic_t lct_used;
+        cfs_atomic_t lct_used;
         /**
          * Internal implementation detail: module for this key.
          */
-        struct module *lct_owner;
+        cfs_module_t *lct_owner;
         /**
          * References to this key. For debugging.
          */
@@ -1238,6 +1251,14 @@ void lu_context_key_degister_many(struct lu_context_key *k, ...);
 void lu_context_key_revive_many  (struct lu_context_key *k, ...);
 void lu_context_key_quiesce_many (struct lu_context_key *k, ...);
 
+/*
+ * update/clear ctx/ses tags.
+ */
+void lu_context_tags_update(__u32 tags);
+void lu_context_tags_clear(__u32 tags);
+void lu_session_tags_update(__u32 tags);
+void lu_session_tags_clear(__u32 tags);
+
 /**
  * Environment.
  */
@@ -1255,6 +1276,7 @@ struct lu_env {
 int  lu_env_init  (struct lu_env *env, __u32 tags);
 void lu_env_fini  (struct lu_env *env);
 int  lu_env_refill(struct lu_env *env);
+int  lu_env_refill_by_tags(struct lu_env *env, __u32 ctags, __u32 stags);
 
 /** @} lu_context */
 
@@ -1268,8 +1290,8 @@ int lu_site_stats_print(const struct lu_site *s, char *page, int count);
  * Common name structure to be passed around for various name related methods.
  */
 struct lu_name {
-        char    *ln_name;
-        int      ln_namelen;
+        const char    *ln_name;
+        int            ln_namelen;
 };
 
 /**
@@ -1284,7 +1306,7 @@ struct lu_buf {
 /** null buffer */
 extern struct lu_buf LU_BUF_NULL;
 
-#define DLUBUF "(%p %z)"
+#define DLUBUF "(%p %zu)"
 #define PLUBUF(buf) (buf)->lb_buf, (buf)->lb_len
 /**
  * One-time initializers, called at obdclass module initialization, not
@@ -1319,6 +1341,11 @@ struct lu_kmem_descr {
 int  lu_kmem_init(struct lu_kmem_descr *caches);
 void lu_kmem_fini(struct lu_kmem_descr *caches);
 
-/** @} lu */
+void lu_object_assign_fid(const struct lu_env *env, struct lu_object *o,
+                         const struct lu_fid *fid);
+struct lu_object *lu_object_anon(const struct lu_env *env,
+                                struct lu_device *dev,
+                                const struct lu_object_conf *conf);
 
+/** @} lu */
 #endif /* __LUSTRE_LU_OBJECT_H */