Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / drivers / staging / lustre / lustre / include / lustre_export.h
diff --git a/kernel/drivers/staging/lustre/lustre/include/lustre_export.h b/kernel/drivers/staging/lustre/lustre/include/lustre_export.h
new file mode 100644 (file)
index 0000000..9c06a49
--- /dev/null
@@ -0,0 +1,406 @@
+/*
+ * GPL HEADER START
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 only,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License version 2 for more details (a copy is included
+ * in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; If not, see
+ * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ *
+ * GPL HEADER END
+ */
+/*
+ * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Use is subject to license terms.
+ *
+ * Copyright (c) 2011, 2012, 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"
+
+struct mds_client_data;
+struct mdt_client_data;
+struct mds_idmap_table;
+struct mdt_idmap_table;
+
+/**
+ * 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;
+};
+
+/**
+ * MDT-specific export data
+ */
+struct mdt_export_data {
+       struct tg_export_data   med_ted;
+       /** List of all files opened by client on this MDT */
+       struct list_head                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;
+};
+
+/* In-memory access to client data from OST struct */
+/** Filter (oss-side) specific import data */
+struct filter_export_data {
+       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 */
+       int                     fed_mod_count;/* items in fed_writing list */
+       long                   fed_pending;  /* bytes just being written */
+       __u32                 fed_group;
+       __u8                   fed_pagesize; /* log2 of client page size */
+};
+
+struct mgs_export_data {
+       struct list_head                med_clients;    /* mgc fs client via this exp */
+       spinlock_t              med_lock;       /* protect med_clients */
+};
+
+/**
+ * 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;
+       struct obd_device       *nid_obd;
+       struct proc_dir_entry   *nid_proc;
+       struct lprocfs_stats    *nid_stats;
+       struct lprocfs_stats    *nid_ldlm_stats;
+       atomic_t             nid_exp_ref_count; /* for obd_nid_stats_hash
+                                                          exp_nid_stats */
+};
+
+#define nidstat_getref(nidstat)                                                \
+do {                                                                      \
+       atomic_inc(&(nidstat)->nid_exp_ref_count);                       \
+} while (0)
+
+#define nidstat_putref(nidstat)                                                \
+do {                                                                      \
+       atomic_dec(&(nidstat)->nid_exp_ref_count);                       \
+       LASSERTF(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;
+       /**
+        * 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
+        */
+       atomic_t              exp_rpc_count; /* RPC references */
+       atomic_t              exp_cb_count; /* Commit callback references */
+       /** Number of queued replay requests to be processes */
+       atomic_t                  exp_replay_count;
+       atomic_t              exp_locks_count; /** Lock references */
+#if LUSTRE_TRACKS_LOCK_EXP_REFS
+       struct list_head                exp_locks_list;
+       spinlock_t                exp_locks_list_guard;
+#endif
+       /** UUID of client connected to this export */
+       struct obd_uuid    exp_client_uuid;
+       /** To link all exports on an obd device */
+       struct list_head                exp_obd_chain;
+       struct hlist_node         exp_uuid_hash; /** uuid-export hash*/
+       struct hlist_node         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
+        */
+       struct list_head                exp_obd_chain_timed;
+       /** Obd device of this export */
+       struct obd_device       *exp_obd;
+       /**
+        * "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;
+       /** Active connection */
+       struct ptlrpc_connection *exp_connection;
+       /** Connection count value from last successful reconnect rpc */
+       __u32                exp_conn_cnt;
+       /** Hash list of all ldlm locks granted on this export */
+       struct cfs_hash        *exp_lock_hash;
+       /**
+        * Hash list for Posix lock deadlock detection, added with
+        * ldlm_lock::l_exp_flock_hash.
+        */
+       struct cfs_hash        *exp_flock_hash;
+       struct list_head                exp_outstanding_replies;
+       struct list_head                exp_uncommitted_replies;
+       spinlock_t                exp_uncommitted_replies_lock;
+       /** Last committed transno for this export */
+       __u64                exp_last_committed;
+       /** When was last request received */
+       unsigned long           exp_last_request_time;
+       /** On replay all requests waiting for replay are linked here */
+       struct list_head                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? */
+                                 /* 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 */
+       unsigned long           exp_flvr_expire[2];   /* seconds */
+
+       /** protects exp_hp_rpcs */
+       spinlock_t                exp_rpc_lock;
+       struct list_head                  exp_hp_rpcs;  /* (potential) HP RPCs */
+
+       /** blocking dlm lock list, protected by exp_bl_list_lock */
+       struct list_head                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, long age)
+{
+       LASSERT(exp->exp_delayed);
+       return time_before(cfs_time_add(exp->exp_last_request_time, age),
+                          get_seconds());
+}
+
+static inline int exp_connect_cancelset(struct obd_export *exp)
+{
+       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_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)
+{
+       struct obd_connect_data *ocd;
+
+       LASSERT(imp != NULL);
+       ocd = &imp->imp_connect_data;
+       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;
+}
+
+static inline __u64 exp_connect_ibits(struct obd_export *exp)
+{
+       struct obd_connect_data *ocd;
+
+       ocd = &exp->exp_connect_data;
+       return ocd->ocd_ibits_known;
+}
+
+static inline bool imp_connect_disp_stripe(struct obd_import *imp)
+{
+       struct obd_connect_data *ocd;
+
+       LASSERT(imp != NULL);
+       ocd = &imp->imp_connect_data;
+       return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
+}
+
+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 */