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 (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  */
  38 /** \defgroup obd_export PortalRPC export definitions
  39  *
  40  * @{
  41  */
  42
  43 #ifndef __EXPORT_H
  44 #define __EXPORT_H
  45
  46 /** \defgroup export export
  47  *
  48  * @{
  49  */
  50
  51 #include <lprocfs_status.h>
  52 #include <lustre/lustre_idl.h>
  53 #include <lustre_dlm.h>
  54
  55 struct mds_client_data;
  56 struct mdt_client_data;
  57 struct mds_idmap_table;
  58 struct mdt_idmap_table;
  59
  60 /**
  61  * Target-specific export data
  62  */
  63 struct tg_export_data {
  64         /** Protects led_lcd below */
  65         cfs_mutex_t             ted_lcd_lock;
  66         /** Per-client data for each export */
  67         struct lsd_client_data *ted_lcd;
  68         /** Offset of record in last_rcvd file */
  69         loff_t                  ted_lr_off;
  70         /** Client index in last_rcvd file */
  71         int                     ted_lr_idx;
  72 };
  73
  74 /**
  75  * MDT-specific export data
  76  */
  77 struct mdt_export_data {
  78         struct tg_export_data   med_ted;
  79         /** List of all files opened by client on this MDT */
  80         cfs_list_t              med_open_head;
  81         cfs_spinlock_t          med_open_lock; /* lock med_open_head, mfd_list*/
  82         /** Bitmask of all ibit locks this MDT understands */
  83         __u64                   med_ibits_known;
  84         cfs_mutex_t             med_idmap_mutex;
  85         struct lustre_idmap_table *med_idmap;
  86 };
  87
  88 struct osc_creator {
  89         cfs_spinlock_t          oscc_lock;
  90         cfs_list_t              oscc_wait_create_list;
  91         struct obd_device      *oscc_obd;
  92         obd_id                  oscc_last_id;//last available pre-created object
  93         obd_id                  oscc_next_id;// what object id to give out next
  94         int                     oscc_grow_count;
  95         /**
  96          * Limit oscc_grow_count value, can be changed via proc fs
  97          */
  98         int                     oscc_max_grow_count;
  99         struct obdo             oscc_oa;
 100         int                     oscc_flags;
 101         cfs_waitq_t             oscc_waitq; /* creating procs wait on this */
 102 };
 103
 104 struct ec_export_data { /* echo client */
 105         cfs_list_t eced_locks;
 106 };
 107
 108 /* In-memory access to client data from OST struct */
 109 /** Filter (oss-side) specific import data */
 110 struct filter_export_data {
 111         struct tg_export_data      fed_ted;
 112         cfs_spinlock_t             fed_lock;     /**< protects fed_mod_list */
 113         long                       fed_dirty;    /* in bytes */
 114         long                       fed_grant;    /* in bytes */
 115         cfs_list_t                 fed_mod_list; /* files being modified */
 116         int                        fed_mod_count;/* items in fed_writing list */
 117         long                       fed_pending;  /* bytes just being written */
 118         __u32                      fed_group;
 119 };
 120
 121 struct mgs_export_data {
 122         cfs_list_t                 med_clients; /* mgc fs client via this exp */
 123         cfs_spinlock_t             med_lock;    /* protect med_clients */
 124 };
 125
 126 /**
 127  * per-NID statistics structure.
 128  * It tracks access patterns to this export on a per-client-NID basis
 129  */
 130 typedef struct nid_stat {
 131         lnet_nid_t               nid;
 132         cfs_hlist_node_t         nid_hash;
 133         cfs_list_t               nid_list;
 134         struct obd_device       *nid_obd;
 135         struct proc_dir_entry   *nid_proc;
 136         struct lprocfs_stats    *nid_stats;
 137         struct lprocfs_stats    *nid_ldlm_stats;
 138         struct brw_stats        *nid_brw_stats;
 139         cfs_atomic_t             nid_exp_ref_count; /* for obd_nid_stats_hash
 140                                                            exp_nid_stats */
 141 }nid_stat_t;
 142
 143 #define nidstat_getref(nidstat)                                                \
 144 do {                                                                           \
 145         cfs_atomic_inc(&(nidstat)->nid_exp_ref_count);                         \
 146 } while(0)
 147
 148 #define nidstat_putref(nidstat)                                                \
 149 do {                                                                           \
 150         cfs_atomic_dec(&(nidstat)->nid_exp_ref_count);                         \
 151         LASSERTF(cfs_atomic_read(&(nidstat)->nid_exp_ref_count) >= 0,          \
 152                  "stat %p nid_exp_ref_count < 0\n", nidstat);                  \
 153 } while(0)
 154
 155 enum obd_option {
 156         OBD_OPT_FORCE =         0x0001,
 157         OBD_OPT_FAILOVER =      0x0002,
 158         OBD_OPT_ABORT_RECOV =   0x0004,
 159 };
 160
 161 /**
 162  * Export structure. Represents target-side of connection in portals.
 163  * Also used in Lustre to connect between layers on the same node when
 164  * there is no network-connection in-between.
 165  * For every connected client there is an export structure on the server
 166  * attached to the same obd device.
 167  */
 168 struct obd_export {
 169         /**
 170          * Export handle, it's id is provided to client on connect
 171          * Subsequent client RPCs contain this handle id to identify
 172          * what export they are talking to.
 173          */
 174         struct portals_handle     exp_handle;
 175         cfs_atomic_t              exp_refcount;
 176         /**
 177          * Set of counters below is to track where export references are
 178          * kept. The exp_rpc_count is used for reconnect handling also,
 179          * the cb_count and locks_count are for debug purposes only for now.
 180          * The sum of them should be less than exp_refcount by 3
 181          */
 182         cfs_atomic_t              exp_rpc_count; /* RPC references */
 183         cfs_atomic_t              exp_cb_count; /* Commit callback references */
 184         cfs_atomic_t              exp_locks_count; /** Lock references */
 185 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 186         cfs_list_t                exp_locks_list;
 187         cfs_spinlock_t            exp_locks_list_guard;
 188 #endif
 189         /** Number of queued replay requests to be processes */
 190         cfs_atomic_t              exp_replay_count;
 191         /** UUID of client connected to this export */
 192         struct obd_uuid           exp_client_uuid;
 193         /** To link all exports on an obd device */
 194         cfs_list_t                exp_obd_chain;
 195         cfs_hlist_node_t          exp_uuid_hash; /** uuid-export hash*/
 196         cfs_hlist_node_t          exp_nid_hash; /** nid-export hash */
 197         /**
 198          * All exports eligible for ping evictor are linked into a list
 199          * through this field in "most time since last request on this export"
 200          * order
 201          * protected by obd_dev_lock
 202          */
 203         cfs_list_t                exp_obd_chain_timed;
 204         /** Obd device of this export */
 205         struct obd_device        *exp_obd;
 206         /** "reverse" import to send requests (e.g. from ldlm) back to client */
 207         struct obd_import        *exp_imp_reverse;
 208         struct nid_stat          *exp_nid_stats;
 209         struct lprocfs_stats     *exp_md_stats;
 210         /** Active connetion */
 211         struct ptlrpc_connection *exp_connection;
 212         /** Connection count value from last succesful reconnect rpc */
 213         __u32                     exp_conn_cnt;
 214         /** Hash list of all ldlm locks granted on this export */
 215         cfs_hash_t               *exp_lock_hash;
 216         /** lock to protect exp_lock_hash accesses */
 217         cfs_spinlock_t            exp_lock_hash_lock;
 218         cfs_list_t                exp_outstanding_replies;
 219         cfs_list_t                exp_uncommitted_replies;
 220         cfs_spinlock_t            exp_uncommitted_replies_lock;
 221         /** Last committed transno for this export */
 222         __u64                     exp_last_committed;
 223         /** When was last request received */
 224         cfs_time_t                exp_last_request_time;
 225         /** On replay all requests waiting for replay are linked here */
 226         cfs_list_t                exp_req_replay_queue;
 227         /** protects exp_flags and exp_outstanding_replies */
 228         cfs_spinlock_t            exp_lock;
 229         /** Compatibility flags for this export */
 230         __u64                     exp_connect_flags;
 231         enum obd_option           exp_flags;
 232         unsigned long             exp_failed:1,
 233                                   exp_in_recovery:1,
 234                                   exp_disconnected:1,
 235                                   exp_connecting:1,
 236                                   /** VBR: export missed recovery */
 237                                   exp_delayed:1,
 238                                   /** VBR: failed version checking */
 239                                   exp_vbr_failed:1,
 240                                   exp_req_replay_needed:1,
 241                                   exp_lock_replay_needed:1,
 242                                   exp_need_sync:1,
 243                                   exp_flvr_changed:1,
 244                                   exp_flvr_adapt:1,
 245                                   exp_libclient:1, /* liblustre client? */
 246                                   /* client timed out and tried to reconnect,
 247                                    * but couldn't because of active rpcs */
 248                                   exp_abort_active_req:1;
 249         /* also protected by exp_lock */
 250         enum lustre_sec_part      exp_sp_peer;
 251         struct sptlrpc_flavor     exp_flvr;             /* current */
 252         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
 253         cfs_time_t                exp_flvr_expire[2];   /* seconds */
 254
 255         /** protects exp_hp_rpcs */
 256         cfs_spinlock_t            exp_rpc_lock;
 257         cfs_list_t                exp_hp_rpcs;  /* (potential) HP RPCs */
 258
 259         /** blocking dlm lock list, protected by exp_bl_list_lock */
 260         cfs_list_t                exp_bl_list;
 261         cfs_spinlock_t            exp_bl_list_lock;
 262
 263         /** Target specific data */
 264         union {
 265                 struct tg_export_data     eu_target_data;
 266                 struct mdt_export_data    eu_mdt_data;
 267                 struct filter_export_data eu_filter_data;
 268                 struct ec_export_data     eu_ec_data;
 269                 struct mgs_export_data    eu_mgs_data;
 270         } u;
 271 };
 272
 273 #define exp_target_data u.eu_target_data
 274 #define exp_mdt_data    u.eu_mdt_data
 275 #define exp_filter_data u.eu_filter_data
 276 #define exp_ec_data     u.eu_ec_data
 277
 278 static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
 279 {
 280         LASSERT(exp->exp_delayed);
 281         return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
 282                                cfs_time_current_sec());
 283 }
 284
 285 static inline int exp_connect_cancelset(struct obd_export *exp)
 286 {
 287         LASSERT(exp != NULL);
 288         return !!(exp->exp_connect_flags & OBD_CONNECT_CANCELSET);
 289 }
 290
 291 static inline int exp_connect_lru_resize(struct obd_export *exp)
 292 {
 293         LASSERT(exp != NULL);
 294         return !!(exp->exp_connect_flags & OBD_CONNECT_LRU_RESIZE);
 295 }
 296
 297 static inline int exp_connect_rmtclient(struct obd_export *exp)
 298 {
 299         LASSERT(exp != NULL);
 300         return !!(exp->exp_connect_flags & OBD_CONNECT_RMT_CLIENT);
 301 }
 302
 303 static inline int client_is_remote(struct obd_export *exp)
 304 {
 305         struct obd_import *imp = class_exp2cliimp(exp);
 306
 307         return !!(imp->imp_connect_data.ocd_connect_flags &
 308                   OBD_CONNECT_RMT_CLIENT);
 309 }
 310
 311 static inline int exp_connect_vbr(struct obd_export *exp)
 312 {
 313         LASSERT(exp != NULL);
 314         LASSERT(exp->exp_connection);
 315         return !!(exp->exp_connect_flags & OBD_CONNECT_VBR);
 316 }
 317
 318 static inline int exp_connect_som(struct obd_export *exp)
 319 {
 320         LASSERT(exp != NULL);
 321         return !!(exp->exp_connect_flags & OBD_CONNECT_SOM);
 322 }
 323
 324 static inline int imp_connect_lru_resize(struct obd_import *imp)
 325 {
 326         struct obd_connect_data *ocd;
 327
 328         LASSERT(imp != NULL);
 329         ocd = &imp->imp_connect_data;
 330         return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
 331 }
 332
 333 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 334 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
 335
 336 /** @} export */
 337
 338 #endif /* __EXPORT_H */
 339 /** @} obd_export */