lustre/include/lustre_export.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
  37 #ifndef __EXPORT_H
  38 #define __EXPORT_H
  39
  40 /** \defgroup export export
  41  *
  42  * @{
  43  */
  44
  45 #include <lprocfs_status.h>
  46 #include <lustre/lustre_idl.h>
  47 #include <lustre_dlm.h>
  48
  49 struct mds_client_data;
  50 struct mdt_client_data;
  51 struct mds_idmap_table;
  52 struct mdt_idmap_table;
  53
  54 struct tg_export_data {
  55         /** Protects led_lcd below */
  56         cfs_semaphore_t         ted_lcd_lock;
  57         /** Per-client data for each export */
  58         struct lsd_client_data *ted_lcd;
  59         /** Offset of record in last_rcvd file */
  60         loff_t                  ted_lr_off;
  61         /** Client index in last_rcvd file */
  62         int                     ted_lr_idx;
  63 };
  64
  65 struct mdt_export_data {
  66         struct tg_export_data   med_ted;
  67         cfs_list_t              med_open_head;
  68         cfs_spinlock_t          med_open_lock; /* lock med_open_head, mfd_list*/
  69         __u64                   med_ibits_known;
  70         cfs_semaphore_t         med_idmap_sem;
  71         struct lustre_idmap_table *med_idmap;
  72 };
  73
  74 struct osc_creator {
  75         cfs_spinlock_t          oscc_lock;
  76         cfs_list_t              oscc_wait_create_list;
  77         struct obd_device      *oscc_obd;
  78         obd_id                  oscc_last_id;//last available pre-created object
  79         obd_id                  oscc_next_id;// what object id to give out next
  80         int                     oscc_grow_count;
  81         /**
  82          * Limit oscc_grow_count value, can be changed via proc fs
  83          */
  84         int                     oscc_max_grow_count;
  85         struct obdo             oscc_oa;
  86         int                     oscc_flags;
  87         cfs_waitq_t             oscc_waitq; /* creating procs wait on this */
  88 };
  89
  90 struct ec_export_data { /* echo client */
  91         cfs_list_t eced_locks;
  92 };
  93
  94 /* In-memory access to client data from OST struct */
  95 struct filter_export_data {
  96         struct tg_export_data      fed_ted;
  97         cfs_spinlock_t             fed_lock;     /**< protects fed_mod_list */
  98         long                       fed_dirty;    /* in bytes */
  99         long                       fed_grant;    /* in bytes */
 100         cfs_list_t                 fed_mod_list; /* files being modified */
 101         int                        fed_mod_count;/* items in fed_writing list */
 102         long                       fed_pending;  /* bytes just being written */
 103         __u32                      fed_group;
 104 };
 105
 106 typedef struct nid_stat {
 107         lnet_nid_t               nid;
 108         cfs_hlist_node_t         nid_hash;
 109         cfs_list_t               nid_list;
 110         struct obd_device       *nid_obd;
 111         struct proc_dir_entry   *nid_proc;
 112         struct lprocfs_stats    *nid_stats;
 113         struct lprocfs_stats    *nid_ldlm_stats;
 114         struct brw_stats        *nid_brw_stats;
 115         cfs_atomic_t             nid_exp_ref_count; /* for obd_nid_stats_hash
 116                                                            exp_nid_stats */
 117 }nid_stat_t;
 118
 119 #define nidstat_getref(nidstat)                                                \
 120 do {                                                                           \
 121         cfs_atomic_inc(&(nidstat)->nid_exp_ref_count);                         \
 122 } while(0)
 123
 124 #define nidstat_putref(nidstat)                                                \
 125 do {                                                                           \
 126         cfs_atomic_dec(&(nidstat)->nid_exp_ref_count);                         \
 127         LASSERTF(cfs_atomic_read(&(nidstat)->nid_exp_ref_count) >= 0,          \
 128                  "stat %p nid_exp_ref_count < 0\n", nidstat);                  \
 129 } while(0)
 130
 131 enum obd_option {
 132         OBD_OPT_FORCE =         0x0001,
 133         OBD_OPT_FAILOVER =      0x0002,
 134         OBD_OPT_ABORT_RECOV =   0x0004,
 135 };
 136
 137 struct obd_export {
 138         struct portals_handle     exp_handle;
 139         cfs_atomic_t              exp_refcount;
 140         /**
 141          * Set of counters below is to track where export references are
 142          * kept. The exp_rpc_count is used for reconnect handling also,
 143          * the cb_count and locks_count are for debug purposes only for now.
 144          * The sum of them should be less than exp_refcount by 3
 145          */
 146         cfs_atomic_t              exp_rpc_count; /* RPC references */
 147         cfs_atomic_t              exp_cb_count; /* Commit callback references */
 148         cfs_atomic_t              exp_locks_count; /** Lock references */
 149 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 150         cfs_list_t                exp_locks_list;
 151         cfs_spinlock_t            exp_locks_list_guard;
 152 #endif
 153         cfs_atomic_t              exp_replay_count;
 154         struct obd_uuid           exp_client_uuid;
 155         cfs_list_t                exp_obd_chain;
 156         cfs_hlist_node_t          exp_uuid_hash; /* uuid-export hash*/
 157         cfs_hlist_node_t          exp_nid_hash; /* nid-export hash */
 158         /* exp_obd_chain_timed fo ping evictor, protected by obd_dev_lock */
 159         cfs_list_t                exp_obd_chain_timed;
 160         struct obd_device        *exp_obd;
 161         struct obd_import        *exp_imp_reverse; /* to make RPCs backwards */
 162         struct nid_stat          *exp_nid_stats;
 163         struct lprocfs_stats     *exp_md_stats;
 164         struct ptlrpc_connection *exp_connection;
 165         __u32                     exp_conn_cnt;
 166         cfs_hash_t               *exp_lock_hash; /* existing lock hash */
 167         cfs_spinlock_t            exp_lock_hash_lock;
 168         cfs_list_t                exp_outstanding_replies;
 169         cfs_list_t                exp_uncommitted_replies;
 170         cfs_spinlock_t            exp_uncommitted_replies_lock;
 171         __u64                     exp_last_committed;
 172         cfs_time_t                exp_last_request_time;
 173         cfs_list_t                exp_req_replay_queue;
 174         cfs_spinlock_t            exp_lock; /* protects flags int below */
 175         /* ^ protects exp_outstanding_replies too */
 176         __u64                     exp_connect_flags;
 177         enum obd_option           exp_flags;
 178         unsigned long             exp_failed:1,
 179                                   exp_in_recovery:1,
 180                                   exp_disconnected:1,
 181                                   exp_connecting:1,
 182                                   /** VBR: export missed recovery */
 183                                   exp_delayed:1,
 184                                   /** VBR: failed version checking */
 185                                   exp_vbr_failed:1,
 186                                   exp_req_replay_needed:1,
 187                                   exp_lock_replay_needed:1,
 188                                   exp_need_sync:1,
 189                                   exp_flvr_changed:1,
 190                                   exp_flvr_adapt:1,
 191                                   exp_libclient:1, /* liblustre client? */
 192                                   /* client timed out and tried to reconnect,
 193                                    * but couldn't because of active rpcs */
 194                                   exp_abort_active_req:1;
 195         cfs_list_t                exp_queued_rpc;  /* RPC to be handled */
 196         /* also protected by exp_lock */
 197         enum lustre_sec_part      exp_sp_peer;
 198         struct sptlrpc_flavor     exp_flvr;             /* current */
 199         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
 200         cfs_time_t                exp_flvr_expire[2];   /* seconds */
 201
 202         union {
 203                 struct tg_export_data     eu_target_data;
 204                 struct mdt_export_data    eu_mdt_data;
 205                 struct filter_export_data eu_filter_data;
 206                 struct ec_export_data     eu_ec_data;
 207         } u;
 208 };
 209
 210 #define exp_target_data u.eu_target_data
 211 #define exp_mdt_data    u.eu_mdt_data
 212 #define exp_filter_data u.eu_filter_data
 213 #define exp_ec_data     u.eu_ec_data
 214
 215 static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
 216 {
 217         LASSERT(exp->exp_delayed);
 218         return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
 219                                cfs_time_current_sec());
 220 }
 221
 222 static inline int exp_connect_cancelset(struct obd_export *exp)
 223 {
 224         LASSERT(exp != NULL);
 225         return !!(exp->exp_connect_flags & OBD_CONNECT_CANCELSET);
 226 }
 227
 228 static inline int exp_connect_lru_resize(struct obd_export *exp)
 229 {
 230         LASSERT(exp != NULL);
 231         return !!(exp->exp_connect_flags & OBD_CONNECT_LRU_RESIZE);
 232 }
 233
 234 static inline int exp_connect_rmtclient(struct obd_export *exp)
 235 {
 236         LASSERT(exp != NULL);
 237         return !!(exp->exp_connect_flags & OBD_CONNECT_RMT_CLIENT);
 238 }
 239
 240 static inline int client_is_remote(struct obd_export *exp)
 241 {
 242         struct obd_import *imp = class_exp2cliimp(exp);
 243
 244         return !!(imp->imp_connect_data.ocd_connect_flags &
 245                   OBD_CONNECT_RMT_CLIENT);
 246 }
 247
 248 static inline int exp_connect_vbr(struct obd_export *exp)
 249 {
 250         LASSERT(exp != NULL);
 251         LASSERT(exp->exp_connection);
 252         return !!(exp->exp_connect_flags & OBD_CONNECT_VBR);
 253 }
 254
 255 static inline int exp_connect_som(struct obd_export *exp)
 256 {
 257         LASSERT(exp != NULL);
 258         return !!(exp->exp_connect_flags & OBD_CONNECT_SOM);
 259 }
 260
 261 static inline int imp_connect_lru_resize(struct obd_import *imp)
 262 {
 263         struct obd_connect_data *ocd;
 264
 265         LASSERT(imp != NULL);
 266         ocd = &imp->imp_connect_data;
 267         return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
 268 }
 269
 270 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 271 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
 272
 273 /** @} export */
 274
 275 #endif /* __EXPORT_H */