lustre/include/lustre_export.h

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36 /** \defgroup obd_export PortalRPC export definitions
  37  *
  38  * @{
  39  */
  40
  41 #ifndef __EXPORT_H
  42 #define __EXPORT_H
  43
  44 /** \defgroup export export
  45  *
  46  * @{
  47  */
  48
  49 #include <lprocfs_status.h>
  50 #include <lustre/lustre_idl.h>
  51 #include <lustre_dlm.h>
  52
  53 struct mds_client_data;
  54 struct mdt_client_data;
  55 struct mds_idmap_table;
  56 struct mdt_idmap_table;
  57
  58 /**
  59  * Target-specific export data
  60  */
  61 struct tg_export_data {
  62         /** Protects ted_lcd, ted_reply_* and
  63          * ted_release_* fields below */
  64         struct mutex            ted_lcd_lock;
  65         /** Per-client data for each export */
  66         struct lsd_client_data  *ted_lcd;
  67         /** Offset of record in last_rcvd file */
  68         loff_t                  ted_lr_off;
  69         /** Client index in last_rcvd file */
  70         int                     ted_lr_idx;
  71
  72         /** nodemap this export is a member of */
  73         struct lu_nodemap       *ted_nodemap;
  74         struct list_head        ted_nodemap_member;
  75
  76         /* Every reply data fields below are
  77          * protected by ted_lcd_lock */
  78         /** List of reply data */
  79         struct list_head        ted_reply_list;
  80         int                     ted_reply_cnt;
  81         /** Reply data with highest transno is retained */
  82         struct tg_reply_data    *ted_reply_last;
  83         /* Statistics */
  84         int                     ted_reply_max; /* high water mark */
  85         int                     ted_release_xid;
  86         int                     ted_release_tag;
  87 };
  88
  89 /**
  90  * MDT-specific export data
  91  */
  92 struct mdt_export_data {
  93         struct tg_export_data   med_ted;
  94         /** List of all files opened by client on this MDT */
  95         struct list_head        med_open_head;
  96         spinlock_t              med_open_lock; /* med_open_head, mfd_list */
  97         struct mutex            med_idmap_mutex;
  98         struct lustre_idmap_table *med_idmap;
  99 };
 100
 101 struct ec_export_data { /* echo client */
 102         struct list_head        eced_locks;
 103 };
 104
 105 /* In-memory access to client data from OST struct */
 106 /** Filter (oss-side) specific import data */
 107 struct filter_export_data {
 108         struct tg_export_data   fed_ted;
 109         spinlock_t              fed_lock;       /**< protects fed_mod_list */
 110         __u64                   fed_lastid_gen;
 111         long                    fed_dirty;    /* in bytes */
 112         long                    fed_grant;    /* in bytes */
 113         struct list_head        fed_mod_list; /* files being modified */
 114         long                    fed_pending;  /* bytes just being written */
 115         /* count of SOFT_SYNC RPCs, which will be reset after
 116          * ofd_soft_sync_limit number of RPCs, and trigger a sync. */
 117         atomic_t                fed_soft_sync_count;
 118         int                     fed_mod_count;/* items in fed_writing list */
 119         __u32                   fed_group;
 120         __u8                    fed_pagesize; /* log2 of client page size */
 121 };
 122
 123 struct mgs_export_data {
 124         struct list_head        med_clients;    /* mgc fs client via this exp */
 125         spinlock_t              med_lock;       /* protect med_clients */
 126 };
 127
 128 /**
 129  * per-NID statistics structure.
 130  * It tracks access patterns to this export on a per-client-NID basis
 131  */
 132 struct nid_stat {
 133         lnet_nid_t               nid;
 134         struct hlist_node        nid_hash;
 135         struct list_head         nid_list;
 136         struct obd_device       *nid_obd;
 137         struct proc_dir_entry   *nid_proc;
 138         struct lprocfs_stats    *nid_stats;
 139         struct lprocfs_stats    *nid_ldlm_stats;
 140         atomic_t                 nid_exp_ref_count; /* for obd_nid_stats_hash
 141                                                        exp_nid_stats */
 142 };
 143
 144 #define nidstat_getref(nidstat)                                                \
 145 do {                                                                           \
 146         atomic_inc(&(nidstat)->nid_exp_ref_count);                         \
 147 } while(0)
 148
 149 #define nidstat_putref(nidstat)                                                \
 150 do {                                                                           \
 151         atomic_dec(&(nidstat)->nid_exp_ref_count);                         \
 152         LASSERTF(atomic_read(&(nidstat)->nid_exp_ref_count) >= 0,          \
 153                  "stat %p nid_exp_ref_count < 0\n", nidstat);                  \
 154 } while(0)
 155
 156 enum obd_option {
 157         OBD_OPT_FORCE =         0x0001,
 158         OBD_OPT_FAILOVER =      0x0002,
 159         OBD_OPT_ABORT_RECOV =   0x0004,
 160 };
 161
 162 /**
 163  * Export structure. Represents target-side of connection in portals.
 164  * Also used in Lustre to connect between layers on the same node when
 165  * there is no network-connection in-between.
 166  * For every connected client there is an export structure on the server
 167  * attached to the same obd device.
 168  */
 169 struct obd_export {
 170         /**
 171          * Export handle, it's id is provided to client on connect
 172          * Subsequent client RPCs contain this handle id to identify
 173          * what export they are talking to.
 174          */
 175         struct portals_handle   exp_handle;
 176         atomic_t                exp_refcount;
 177         /**
 178          * Set of counters below is to track where export references are
 179          * kept. The exp_rpc_count is used for reconnect handling also,
 180          * the cb_count and locks_count are for debug purposes only for now.
 181          * The sum of them should be less than exp_refcount by 3
 182          */
 183         atomic_t                exp_rpc_count; /* RPC references */
 184         atomic_t                exp_cb_count; /* Commit callback references */
 185         /** Number of queued replay requests to be processes */
 186         atomic_t                exp_replay_count;
 187         atomic_t                exp_locks_count; /** Lock references */
 188 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 189         struct list_head        exp_locks_list;
 190         spinlock_t              exp_locks_list_guard;
 191 #endif
 192         /** UUID of client connected to this export */
 193         struct obd_uuid         exp_client_uuid;
 194         /** To link all exports on an obd device */
 195         struct list_head        exp_obd_chain;
 196         struct hlist_node       exp_uuid_hash;  /** uuid-export hash*/
 197         struct hlist_node       exp_nid_hash;   /** nid-export hash */
 198         struct hlist_node       exp_gen_hash;   /** last_rcvd clt gen hash */
 199         /**
 200          * All exports eligible for ping evictor are linked into a list
 201          * through this field in "most time since last request on this export"
 202          * order
 203          * protected by obd_dev_lock
 204          */
 205         struct list_head        exp_obd_chain_timed;
 206         /** Obd device of this export */
 207         struct obd_device      *exp_obd;
 208         /**
 209          * "reverse" import to send requests (e.g. from ldlm) back to client
 210          * exp_lock protect its change
 211          */
 212         struct obd_import        *exp_imp_reverse;
 213         struct nid_stat          *exp_nid_stats;
 214         /** Active connetion */
 215         struct ptlrpc_connection *exp_connection;
 216         /** Connection count value from last successful reconnect rpc */
 217         __u32                     exp_conn_cnt;
 218         /** Hash list of all ldlm locks granted on this export */
 219         struct cfs_hash          *exp_lock_hash;
 220         /**
 221          * Hash list for Posix lock deadlock detection, added with
 222          * ldlm_lock::l_exp_flock_hash.
 223          */
 224         struct cfs_hash        *exp_flock_hash;
 225         struct list_head        exp_outstanding_replies;
 226         struct list_head        exp_uncommitted_replies;
 227         spinlock_t              exp_uncommitted_replies_lock;
 228         /** Last committed transno for this export */
 229         __u64                   exp_last_committed;
 230         /** When was last request received */
 231         cfs_time_t              exp_last_request_time;
 232         /** On replay all requests waiting for replay are linked here */
 233         struct list_head        exp_req_replay_queue;
 234         /**
 235          * protects exp_flags, exp_outstanding_replies and the change
 236          * of exp_imp_reverse
 237          */
 238         spinlock_t                exp_lock;
 239         /** Compatibility flags for this export are embedded into
 240          *  exp_connect_data */
 241         struct obd_connect_data   exp_connect_data;
 242         enum obd_option           exp_flags;
 243         unsigned long             exp_failed:1,
 244                                   exp_in_recovery:1,
 245                                   exp_disconnected:1,
 246                                   exp_connecting:1,
 247                                   /** VBR: export missed recovery */
 248                                   exp_delayed:1,
 249                                   /** VBR: failed version checking */
 250                                   exp_vbr_failed:1,
 251                                   exp_req_replay_needed:1,
 252                                   exp_lock_replay_needed:1,
 253                                   exp_need_sync:1,
 254                                   exp_flvr_changed:1,
 255                                   exp_flvr_adapt:1,
 256                                   exp_libclient:1, /* liblustre client? */
 257                                   /* if to swap nidtbl entries for 2.2 clients.
 258                                    * Only used by the MGS to fix LU-1644. */
 259                                   exp_need_mne_swab:1;
 260         /* also protected by exp_lock */
 261         enum lustre_sec_part      exp_sp_peer;
 262         struct sptlrpc_flavor     exp_flvr;             /* current */
 263         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
 264         cfs_time_t                exp_flvr_expire[2];   /* seconds */
 265
 266         /** protects exp_hp_rpcs */
 267         spinlock_t              exp_rpc_lock;
 268         struct list_head        exp_hp_rpcs;    /* (potential) HP RPCs */
 269         struct list_head        exp_reg_rpcs;  /* RPC being handled */
 270
 271         /** blocking dlm lock list, protected by exp_bl_list_lock */
 272         struct list_head        exp_bl_list;
 273         spinlock_t              exp_bl_list_lock;
 274
 275         /** Target specific data */
 276         union {
 277                 struct tg_export_data     eu_target_data;
 278                 struct mdt_export_data    eu_mdt_data;
 279                 struct filter_export_data eu_filter_data;
 280                 struct ec_export_data     eu_ec_data;
 281                 struct mgs_export_data    eu_mgs_data;
 282         } u;
 283
 284         struct adaptive_timeout    exp_bl_lock_at;
 285
 286         /** highest XID received by export client that has no
 287          * unreceived lower-numbered XID
 288          */
 289         __u64                     exp_last_xid;
 290 };
 291
 292 #define exp_target_data u.eu_target_data
 293 #define exp_mdt_data    u.eu_mdt_data
 294 #define exp_filter_data u.eu_filter_data
 295 #define exp_ec_data     u.eu_ec_data
 296
 297 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
 298 {
 299         return &exp->exp_connect_data.ocd_connect_flags;
 300 }
 301
 302 static inline __u64 exp_connect_flags(struct obd_export *exp)
 303 {
 304         return *exp_connect_flags_ptr(exp);
 305 }
 306
 307 static inline int exp_max_brw_size(struct obd_export *exp)
 308 {
 309         LASSERT(exp != NULL);
 310         if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
 311                 return exp->exp_connect_data.ocd_brw_size;
 312
 313         return ONE_MB_BRW_SIZE;
 314 }
 315
 316 static inline int exp_connect_multibulk(struct obd_export *exp)
 317 {
 318         return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
 319 }
 320
 321 static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
 322 {
 323         LASSERT(exp->exp_delayed);
 324         return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
 325                                cfs_time_current_sec());
 326 }
 327
 328 static inline int exp_connect_cancelset(struct obd_export *exp)
 329 {
 330         LASSERT(exp != NULL);
 331         return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
 332 }
 333
 334 static inline int exp_connect_lru_resize(struct obd_export *exp)
 335 {
 336         LASSERT(exp != NULL);
 337         return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
 338 }
 339
 340 static inline int exp_connect_rmtclient(struct obd_export *exp)
 341 {
 342         LASSERT(exp != NULL);
 343         return !!(exp_connect_flags(exp) & OBD_CONNECT_RMT_CLIENT);
 344 }
 345
 346 static inline int client_is_remote(struct obd_export *exp)
 347 {
 348         struct obd_import *imp = class_exp2cliimp(exp);
 349
 350         return !!(imp->imp_connect_data.ocd_connect_flags &
 351                   OBD_CONNECT_RMT_CLIENT);
 352 }
 353
 354 static inline int exp_connect_vbr(struct obd_export *exp)
 355 {
 356         LASSERT(exp != NULL);
 357         LASSERT(exp->exp_connection);
 358         return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
 359 }
 360
 361 static inline int exp_connect_umask(struct obd_export *exp)
 362 {
 363         return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
 364 }
 365
 366 static inline int imp_connect_lru_resize(struct obd_import *imp)
 367 {
 368         struct obd_connect_data *ocd;
 369
 370         LASSERT(imp != NULL);
 371         ocd = &imp->imp_connect_data;
 372         return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
 373 }
 374
 375 static inline int exp_connect_layout(struct obd_export *exp)
 376 {
 377         return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
 378 }
 379
 380 static inline bool exp_connect_lvb_type(struct obd_export *exp)
 381 {
 382         LASSERT(exp != NULL);
 383         if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
 384                 return true;
 385         else
 386                 return false;
 387 }
 388
 389 static inline bool imp_connect_lvb_type(struct obd_import *imp)
 390 {
 391         struct obd_connect_data *ocd;
 392
 393         LASSERT(imp != NULL);
 394         ocd = &imp->imp_connect_data;
 395         if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
 396                 return true;
 397         else
 398                 return false;
 399 }
 400
 401 static inline bool imp_connect_disp_stripe(struct obd_import *imp)
 402 {
 403         struct obd_connect_data *ocd;
 404
 405         LASSERT(imp != NULL);
 406         ocd = &imp->imp_connect_data;
 407         return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
 408 }
 409
 410 static inline __u64 exp_connect_ibits(struct obd_export *exp)
 411 {
 412         struct obd_connect_data *ocd;
 413
 414         ocd = &exp->exp_connect_data;
 415         return ocd->ocd_ibits_known;
 416 }
 417
 418 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 419 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
 420
 421 #define KKUC_CT_DATA_MAGIC      0x092013cea
 422 struct kkuc_ct_data {
 423         __u32           kcd_magic;
 424         struct obd_uuid kcd_uuid;
 425         __u32           kcd_archive;
 426 };
 427
 428 /** @} export */
 429
 430 #endif /* __EXPORT_H */
 431 /** @} obd_export */