Whamcloud - gitweb
LU-1330 obdclass: add obd_target.h
[fs/lustre-release.git] / lustre / include / lustre_export.h
index 387bf9e..ad49db6 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) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ *
+ * Copyright (c) 2011, 2013, Intel Corporation.
  */
 /*
  * This file is part of Lustre, http://www.lustre.org/
  * Lustre is a trademark of Sun Microsystems, Inc.
  */
+/** \defgroup obd_export PortalRPC export definitions
+ *
+ * @{
+ */
 
 #ifndef __EXPORT_H
 #define __EXPORT_H
 
+/** \defgroup export export
+ *
+ * @{
+ */
+
+#include <lprocfs_status.h>
 #include <lustre/lustre_idl.h>
 #include <lustre_dlm.h>
-#include <lprocfs_status.h>
 
-/* Data stored per client in the last_rcvd file.  In le32 order. */
 struct mds_client_data;
 struct mdt_client_data;
 struct mds_idmap_table;
 struct mdt_idmap_table;
 
-struct mdt_export_data {
-        struct list_head        med_open_head;
-        spinlock_t              med_open_lock; /* lock med_open_head, mfd_list*/
-        struct semaphore        med_lcd_lock;
-        struct lsd_client_data *med_lcd;
-        __u64                   med_ibits_known;
-        loff_t                  med_lr_off;
-        int                     med_lr_idx;
-        unsigned int            med_rmtclient:1; /* remote client? */
-        struct semaphore           med_idmap_sem;
-        struct lustre_idmap_table *med_idmap;
-};
-
-struct osc_creator {
-        spinlock_t              oscc_lock;
-        struct list_head        oscc_list;
-        struct obd_device       *oscc_obd;
-        obd_id                  oscc_last_id;//last available pre-created object
-        obd_id                  oscc_next_id;// what object id to give out next
-        int                     oscc_grow_count;
-        /**
-         * Limit oscc_grow_count value, can be changed via proc fs
-         */
-        int                     oscc_max_grow_count;
-        struct obdo             oscc_oa;
-        int                     oscc_flags;
-        cfs_waitq_t             oscc_waitq; /* creating procs wait on this */
+/**
+ * Target-specific export data
+ */
+struct tg_export_data {
+       /** Protects led_lcd below */
+       struct mutex            ted_lcd_lock;
+       /** Per-client data for each export */
+       struct lsd_client_data  *ted_lcd;
+       /** Offset of record in last_rcvd file */
+       loff_t                  ted_lr_off;
+       /** Client index in last_rcvd file */
+       int                     ted_lr_idx;
 };
 
-struct ldlm_export_data {
-        struct list_head       led_held_locks; /* protected by led_lock */
-        spinlock_t             led_lock;
+/**
+ * MDT-specific export data
+ */
+struct mdt_export_data {
+       struct tg_export_data   med_ted;
+       /** List of all files opened by client on this MDT */
+       cfs_list_t              med_open_head;
+       spinlock_t              med_open_lock; /* med_open_head, mfd_list */
+       /** Bitmask of all ibit locks this MDT understands */
+       __u64                   med_ibits_known;
+       struct mutex            med_idmap_mutex;
+       struct lustre_idmap_table *med_idmap;
 };
 
 struct ec_export_data { /* echo client */
-        struct list_head eced_locks;
+        cfs_list_t eced_locks;
 };
 
 /* In-memory access to client data from OST struct */
+/** Filter (oss-side) specific import data */
 struct filter_export_data {
-        spinlock_t                 fed_lock;      /* protects fed_open_head */
-        struct lsd_client_data    *fed_lcd;
-        loff_t                     fed_lr_off;
-        int                        fed_lr_idx;
+       struct tg_export_data   fed_ted;
+       spinlock_t              fed_lock;       /**< protects fed_mod_list */
         long                       fed_dirty;    /* in bytes */
         long                       fed_grant;    /* in bytes */
-        struct list_head           fed_mod_list; /* files being modified */
+        cfs_list_t                 fed_mod_list; /* files being modified */
         int                        fed_mod_count;/* items in fed_writing list */
         long                       fed_pending;  /* bytes just being written */
         __u32                      fed_group;
-        struct brw_stats           fed_brw_stats;
+       __u8                       fed_pagesize; /* log2 of client page size */
+};
+
+struct mgs_export_data {
+       cfs_list_t              med_clients;    /* mgc fs client via this exp */
+       spinlock_t              med_lock;       /* protect med_clients */
 };
 
-typedef struct nid_stat {
+/**
+ * per-NID statistics structure.
+ * It tracks access patterns to this export on a per-client-NID basis
+ */
+struct nid_stat {
         lnet_nid_t               nid;
-        struct hlist_node        nid_hash;
-        struct list_head         nid_list;
+        cfs_hlist_node_t         nid_hash;
+        cfs_list_t               nid_list;
         struct obd_device       *nid_obd;
         struct proc_dir_entry   *nid_proc;
         struct lprocfs_stats    *nid_stats;
-        struct brw_stats        *nid_brw_stats;
-        int                      nid_exp_ref_count;
-}nid_stat_t;
+        struct lprocfs_stats    *nid_ldlm_stats;
+        cfs_atomic_t             nid_exp_ref_count; /* for obd_nid_stats_hash
+                                                           exp_nid_stats */
+};
+
+#define nidstat_getref(nidstat)                                                \
+do {                                                                           \
+        cfs_atomic_inc(&(nidstat)->nid_exp_ref_count);                         \
+} while(0)
+
+#define nidstat_putref(nidstat)                                                \
+do {                                                                           \
+        cfs_atomic_dec(&(nidstat)->nid_exp_ref_count);                         \
+        LASSERTF(cfs_atomic_read(&(nidstat)->nid_exp_ref_count) >= 0,          \
+                 "stat %p nid_exp_ref_count < 0\n", nidstat);                  \
+} while(0)
+
+enum obd_option {
+        OBD_OPT_FORCE =         0x0001,
+        OBD_OPT_FAILOVER =      0x0002,
+        OBD_OPT_ABORT_RECOV =   0x0004,
+};
 
+/**
+ * Export structure. Represents target-side of connection in portals.
+ * Also used in Lustre to connect between layers on the same node when
+ * there is no network-connection in-between.
+ * For every connected client there is an export structure on the server
+ * attached to the same obd device.
+ */
 struct obd_export {
+        /**
+         * Export handle, it's id is provided to client on connect
+         * Subsequent client RPCs contain this handle id to identify
+         * what export they are talking to.
+         */
         struct portals_handle     exp_handle;
-        atomic_t                  exp_refcount;
-        atomic_t                  exp_rpc_count;
+        cfs_atomic_t              exp_refcount;
+        /**
+         * Set of counters below is to track where export references are
+         * kept. The exp_rpc_count is used for reconnect handling also,
+         * the cb_count and locks_count are for debug purposes only for now.
+         * The sum of them should be less than exp_refcount by 3
+         */
+        cfs_atomic_t              exp_rpc_count; /* RPC references */
+        cfs_atomic_t              exp_cb_count; /* Commit callback references */
+       /** Number of queued replay requests to be processes */
+       cfs_atomic_t              exp_replay_count;
+        cfs_atomic_t              exp_locks_count; /** Lock references */
+#if LUSTRE_TRACKS_LOCK_EXP_REFS
+        cfs_list_t                exp_locks_list;
+       spinlock_t                exp_locks_list_guard;
+#endif
+        /** UUID of client connected to this export */
         struct obd_uuid           exp_client_uuid;
-        struct list_head          exp_obd_chain;
-        struct hlist_node         exp_uuid_hash; /* uuid-export hash*/
-        struct hlist_node         exp_nid_hash; /* nid-export hash */
-        /* exp_obd_chain_timed fo ping evictor, protected by obd_dev_lock */
-        struct list_head          exp_obd_chain_timed;
+        /** To link all exports on an obd device */
+        cfs_list_t                exp_obd_chain;
+        cfs_hlist_node_t          exp_uuid_hash; /** uuid-export hash*/
+        cfs_hlist_node_t          exp_nid_hash; /** nid-export hash */
+        /**
+         * All exports eligible for ping evictor are linked into a list
+         * through this field in "most time since last request on this export"
+         * order
+         * protected by obd_dev_lock
+         */
+        cfs_list_t                exp_obd_chain_timed;
+        /** Obd device of this export */
         struct obd_device        *exp_obd;
-        struct obd_import        *exp_imp_reverse; /* to make RPCs backwards */
+       /**
+        * "reverse" import to send requests (e.g. from ldlm) back to client
+        * exp_lock protect its change
+        */
+        struct obd_import        *exp_imp_reverse;
         struct nid_stat          *exp_nid_stats;
         struct lprocfs_stats     *exp_md_stats;
-        struct lprocfs_stats     *exp_ldlm_stats;
+        /** Active connetion */
         struct ptlrpc_connection *exp_connection;
+        /** Connection count value from last succesful reconnect rpc */
         __u32                     exp_conn_cnt;
-        struct ldlm_export_data   exp_ldlm_data;
-        struct list_head          exp_outstanding_replies;
-        time_t                    exp_last_request_time;
-        struct list_head          exp_req_replay_queue;
-        spinlock_t                exp_lock; /* protects flags int below */
-        /* ^ protects exp_outstanding_replies too */
-        __u64                     exp_connect_flags;
-        int                       exp_flags;
+        /** Hash list of all ldlm locks granted on this export */
+        cfs_hash_t               *exp_lock_hash;
+        /**
+        * Hash list for Posix lock deadlock detection, added with
+        * ldlm_lock::l_exp_flock_hash.
+         */
+       cfs_hash_t               *exp_flock_hash;
+        cfs_list_t                exp_outstanding_replies;
+        cfs_list_t                exp_uncommitted_replies;
+       spinlock_t                exp_uncommitted_replies_lock;
+        /** Last committed transno for this export */
+        __u64                     exp_last_committed;
+        /** When was last request received */
+        cfs_time_t                exp_last_request_time;
+        /** On replay all requests waiting for replay are linked here */
+        cfs_list_t                exp_req_replay_queue;
+       /**
+        * protects exp_flags, exp_outstanding_replies and the change
+        * of exp_imp_reverse
+        */
+       spinlock_t                exp_lock;
+       /** Compatibility flags for this export are embedded into
+        *  exp_connect_data */
+       struct obd_connect_data   exp_connect_data;
+        enum obd_option           exp_flags;
         unsigned long             exp_failed:1,
                                   exp_in_recovery:1,
                                   exp_disconnected:1,
                                   exp_connecting:1,
+                                  /** VBR: export missed recovery */
+                                  exp_delayed:1,
+                                  /** VBR: failed version checking */
+                                  exp_vbr_failed:1,
                                   exp_req_replay_needed:1,
                                   exp_lock_replay_needed:1,
                                   exp_need_sync:1,
                                   exp_flvr_changed:1,
                                   exp_flvr_adapt:1,
-                                  exp_libclient:1; /* liblustre client? */
+                                  exp_libclient:1, /* liblustre client? */
+                                  /* client timed out and tried to reconnect,
+                                   * but couldn't because of active rpcs */
+                                 exp_abort_active_req:1,
+                                 /* if to swap nidtbl entries for 2.2 clients.
+                                  * Only used by the MGS to fix LU-1644. */
+                                 exp_need_mne_swab:1;
         /* also protected by exp_lock */
         enum lustre_sec_part      exp_sp_peer;
         struct sptlrpc_flavor     exp_flvr;             /* current */
         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
         cfs_time_t                exp_flvr_expire[2];   /* seconds */
 
+        /** protects exp_hp_rpcs */
+       spinlock_t                exp_rpc_lock;
+       cfs_list_t                exp_hp_rpcs;  /* (potential) HP RPCs */
+
+        /** blocking dlm lock list, protected by exp_bl_list_lock */
+        cfs_list_t                exp_bl_list;
+       spinlock_t                exp_bl_list_lock;
+
+        /** Target specific data */
         union {
+                struct tg_export_data     eu_target_data;
                 struct mdt_export_data    eu_mdt_data;
                 struct filter_export_data eu_filter_data;
                 struct ec_export_data     eu_ec_data;
+                struct mgs_export_data    eu_mgs_data;
         } u;
 };
 
+#define exp_target_data u.eu_target_data
 #define exp_mdt_data    u.eu_mdt_data
 #define exp_filter_data u.eu_filter_data
 #define exp_ec_data     u.eu_ec_data
 
+static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
+{
+       return &exp->exp_connect_data.ocd_connect_flags;
+}
+
+static inline __u64 exp_connect_flags(struct obd_export *exp)
+{
+       return *exp_connect_flags_ptr(exp);
+}
+
+static inline int exp_max_brw_size(struct obd_export *exp)
+{
+       LASSERT(exp != NULL);
+       if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
+               return exp->exp_connect_data.ocd_brw_size;
+
+       return ONE_MB_BRW_SIZE;
+}
+
+static inline int exp_connect_multibulk(struct obd_export *exp)
+{
+       return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
+}
+
+static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
+{
+        LASSERT(exp->exp_delayed);
+        return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
+                               cfs_time_current_sec());
+}
+
 static inline int exp_connect_cancelset(struct obd_export *exp)
 {
-        LASSERT(exp != NULL);
-        return !!(exp->exp_connect_flags & OBD_CONNECT_CANCELSET);
+       LASSERT(exp != NULL);
+       return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
 }
 
 static inline int exp_connect_lru_resize(struct obd_export *exp)
 {
-        LASSERT(exp != NULL);
-        return !!(exp->exp_connect_flags & OBD_CONNECT_LRU_RESIZE);
+       LASSERT(exp != NULL);
+       return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
+}
+
+static inline int exp_connect_rmtclient(struct obd_export *exp)
+{
+       LASSERT(exp != NULL);
+       return !!(exp_connect_flags(exp) & OBD_CONNECT_RMT_CLIENT);
+}
+
+static inline int client_is_remote(struct obd_export *exp)
+{
+        struct obd_import *imp = class_exp2cliimp(exp);
+
+        return !!(imp->imp_connect_data.ocd_connect_flags &
+                  OBD_CONNECT_RMT_CLIENT);
+}
+
+static inline int exp_connect_vbr(struct obd_export *exp)
+{
+       LASSERT(exp != NULL);
+       LASSERT(exp->exp_connection);
+       return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
+}
+
+static inline int exp_connect_som(struct obd_export *exp)
+{
+       LASSERT(exp != NULL);
+       return !!(exp_connect_flags(exp) & OBD_CONNECT_SOM);
+}
+
+static inline int exp_connect_umask(struct obd_export *exp)
+{
+       return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
 }
 
 static inline int imp_connect_lru_resize(struct obd_import *imp)
@@ -184,7 +354,36 @@ static inline int imp_connect_lru_resize(struct obd_import *imp)
         return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
 }
 
+static inline int exp_connect_layout(struct obd_export *exp)
+{
+       return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
+}
+
+static inline bool exp_connect_lvb_type(struct obd_export *exp)
+{
+       LASSERT(exp != NULL);
+       if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
+               return true;
+       else
+               return false;
+}
+
+static inline bool imp_connect_lvb_type(struct obd_import *imp)
+{
+       struct obd_connect_data *ocd;
+
+       LASSERT(imp != NULL);
+       ocd = &imp->imp_connect_data;
+       if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
+               return true;
+       else
+               return false;
+}
+
 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
 
+/** @} export */
+
 #endif /* __EXPORT_H */
+/** @} obd_export */