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