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, 2015, 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         /**
  73          * ted_nodemap_lock is used to ensure that the nodemap is not destroyed
  74          * between the time that ted_nodemap is checked for NULL, and a
  75          * reference is taken. Modifications to ted_nodemap require that the
  76          * active_config_lock and the nodemap(s)'s nm_member_list_lock be
  77          * taken, as well as ted_nodemap_lock, so the export can be properly
  78          * added to or removed from the nodemap's member list. When an export
  79          * is added to a nodemap, a reference on that nodemap must be taken.
  80          * That reference can be put only after ted_nodemap no longer refers to
  81          * it.
  82          */
  83         spinlock_t              ted_nodemap_lock;
  84         struct lu_nodemap       *ted_nodemap;
  85         struct list_head        ted_nodemap_member;
  86
  87         /* Every reply data fields below are
  88          * protected by ted_lcd_lock */
  89         /** List of reply data */
  90         struct list_head        ted_reply_list;
  91         int                     ted_reply_cnt;
  92         /** Reply data with highest transno is retained */
  93         struct tg_reply_data    *ted_reply_last;
  94         /* Statistics */
  95         int                     ted_reply_max; /* high water mark */
  96         int                     ted_release_xid;
  97         int                     ted_release_tag;
  98 };
  99
 100 /**
 101  * MDT-specific export data
 102  */
 103 struct mdt_export_data {
 104         struct tg_export_data   med_ted;
 105         /** List of all files opened by client on this MDT */
 106         struct list_head        med_open_head;
 107         spinlock_t              med_open_lock; /* med_open_head, mfd_list */
 108         struct mutex            med_idmap_mutex;
 109         struct lustre_idmap_table *med_idmap;
 110 };
 111
 112 struct ec_export_data { /* echo client */
 113         struct list_head        eced_locks;
 114 };
 115
 116 /* In-memory access to client data from OST struct */
 117 /** Filter (oss-side) specific import data */
 118 struct filter_export_data {
 119         struct tg_export_data   fed_ted;
 120         spinlock_t              fed_lock;       /**< protects fed_mod_list */
 121         __u64                   fed_lastid_gen;
 122         long                    fed_dirty;    /* in bytes */
 123         long                    fed_grant;    /* in bytes */
 124         struct list_head        fed_mod_list; /* files being modified */
 125         long                    fed_pending;  /* bytes just being written */
 126         /* count of SOFT_SYNC RPCs, which will be reset after
 127          * ofd_soft_sync_limit number of RPCs, and trigger a sync. */
 128         atomic_t                fed_soft_sync_count;
 129         int                     fed_mod_count;/* items in fed_writing list */
 130         __u32                   fed_group;
 131         __u8                    fed_pagebits; /* log2 of client page size */
 132 };
 133
 134 struct mgs_export_data {
 135         struct list_head        med_clients;    /* mgc fs client via this exp */
 136         spinlock_t              med_lock;       /* protect med_clients */
 137 };
 138
 139 /**
 140  * per-NID statistics structure.
 141  * It tracks access patterns to this export on a per-client-NID basis
 142  */
 143 struct nid_stat {
 144         lnet_nid_t               nid;
 145         struct hlist_node        nid_hash;
 146         struct list_head         nid_list;
 147         struct obd_device       *nid_obd;
 148         struct proc_dir_entry   *nid_proc;
 149         struct lprocfs_stats    *nid_stats;
 150         struct lprocfs_stats    *nid_ldlm_stats;
 151         atomic_t                 nid_exp_ref_count; /* for obd_nid_stats_hash
 152                                                        exp_nid_stats */
 153 };
 154
 155 #define nidstat_getref(nidstat)                                                \
 156 do {                                                                           \
 157         atomic_inc(&(nidstat)->nid_exp_ref_count);                         \
 158 } while(0)
 159
 160 #define nidstat_putref(nidstat)                                                \
 161 do {                                                                           \
 162         atomic_dec(&(nidstat)->nid_exp_ref_count);                         \
 163         LASSERTF(atomic_read(&(nidstat)->nid_exp_ref_count) >= 0,          \
 164                  "stat %p nid_exp_ref_count < 0\n", nidstat);                  \
 165 } while(0)
 166
 167 enum obd_option {
 168         OBD_OPT_FORCE =         0x0001,
 169         OBD_OPT_FAILOVER =      0x0002,
 170         OBD_OPT_ABORT_RECOV =   0x0004,
 171 };
 172
 173 /**
 174  * Export structure. Represents target-side of connection in portals.
 175  * Also used in Lustre to connect between layers on the same node when
 176  * there is no network-connection in-between.
 177  * For every connected client there is an export structure on the server
 178  * attached to the same obd device.
 179  */
 180 struct obd_export {
 181         /**
 182          * Export handle, it's id is provided to client on connect
 183          * Subsequent client RPCs contain this handle id to identify
 184          * what export they are talking to.
 185          */
 186         struct portals_handle   exp_handle;
 187         atomic_t                exp_refcount;
 188         /**
 189          * Set of counters below is to track where export references are
 190          * kept. The exp_rpc_count is used for reconnect handling also,
 191          * the cb_count and locks_count are for debug purposes only for now.
 192          * The sum of them should be less than exp_refcount by 3
 193          */
 194         atomic_t                exp_rpc_count; /* RPC references */
 195         atomic_t                exp_cb_count; /* Commit callback references */
 196         /** Number of queued replay requests to be processes */
 197         atomic_t                exp_replay_count;
 198         atomic_t                exp_locks_count; /** Lock references */
 199 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 200         struct list_head        exp_locks_list;
 201         spinlock_t              exp_locks_list_guard;
 202 #endif
 203         /** UUID of client connected to this export */
 204         struct obd_uuid         exp_client_uuid;
 205         /** To link all exports on an obd device */
 206         struct list_head        exp_obd_chain;
 207         /* Unlinked export list */
 208         struct list_head        exp_stale_list;
 209         struct hlist_node       exp_uuid_hash;  /** uuid-export hash*/
 210         struct hlist_node       exp_nid_hash;   /** nid-export hash */
 211         struct hlist_node       exp_gen_hash;   /** last_rcvd clt gen hash */
 212         /**
 213          * All exports eligible for ping evictor are linked into a list
 214          * through this field in "most time since last request on this export"
 215          * order
 216          * protected by obd_dev_lock
 217          */
 218         struct list_head        exp_obd_chain_timed;
 219         /** Obd device of this export */
 220         struct obd_device      *exp_obd;
 221         /**
 222          * "reverse" import to send requests (e.g. from ldlm) back to client
 223          * exp_lock protect its change
 224          */
 225         struct obd_import        *exp_imp_reverse;
 226         struct nid_stat          *exp_nid_stats;
 227         /** Active connetion */
 228         struct ptlrpc_connection *exp_connection;
 229         /** Connection count value from last successful reconnect rpc */
 230         __u32                     exp_conn_cnt;
 231         /** Hash list of all ldlm locks granted on this export */
 232         struct cfs_hash          *exp_lock_hash;
 233         /**
 234          * Hash list for Posix lock deadlock detection, added with
 235          * ldlm_lock::l_exp_flock_hash.
 236          */
 237         struct cfs_hash        *exp_flock_hash;
 238         struct list_head        exp_outstanding_replies;
 239         struct list_head        exp_uncommitted_replies;
 240         spinlock_t              exp_uncommitted_replies_lock;
 241         /** Last committed transno for this export */
 242         __u64                   exp_last_committed;
 243         /** When was last request received */
 244         cfs_time_t              exp_last_request_time;
 245         /** On replay all requests waiting for replay are linked here */
 246         struct list_head        exp_req_replay_queue;
 247         /**
 248          * protects exp_flags, exp_outstanding_replies and the change
 249          * of exp_imp_reverse
 250          */
 251         spinlock_t                exp_lock;
 252         /** Compatibility flags for this export are embedded into
 253          *  exp_connect_data */
 254         struct obd_connect_data   exp_connect_data;
 255         enum obd_option           exp_flags;
 256         unsigned long             exp_failed:1,
 257                                   exp_in_recovery:1,
 258                                   exp_disconnected:1,
 259                                   exp_connecting:1,
 260                                   /** VBR: export missed recovery */
 261                                   exp_delayed:1,
 262                                   /** VBR: failed version checking */
 263                                   exp_vbr_failed:1,
 264                                   exp_req_replay_needed:1,
 265                                   exp_lock_replay_needed:1,
 266                                   exp_need_sync:1,
 267                                   exp_flvr_changed:1,
 268                                   exp_flvr_adapt:1,
 269                                   exp_libclient:1, /* liblustre client? */
 270                                   /* if to swap nidtbl entries for 2.2 clients.
 271                                    * Only used by the MGS to fix LU-1644. */
 272                                   exp_need_mne_swab:1;
 273         /* also protected by exp_lock */
 274         enum lustre_sec_part      exp_sp_peer;
 275         struct sptlrpc_flavor     exp_flvr;             /* current */
 276         struct sptlrpc_flavor     exp_flvr_old[2];      /* about-to-expire */
 277         cfs_time_t                exp_flvr_expire[2];   /* seconds */
 278
 279         /** protects exp_hp_rpcs */
 280         spinlock_t              exp_rpc_lock;
 281         struct list_head        exp_hp_rpcs;    /* (potential) HP RPCs */
 282         struct list_head        exp_reg_rpcs;  /* RPC being handled */
 283
 284         /** blocking dlm lock list, protected by exp_bl_list_lock */
 285         struct list_head        exp_bl_list;
 286         spinlock_t              exp_bl_list_lock;
 287
 288         /** Target specific data */
 289         union {
 290                 struct tg_export_data     eu_target_data;
 291                 struct mdt_export_data    eu_mdt_data;
 292                 struct filter_export_data eu_filter_data;
 293                 struct ec_export_data     eu_ec_data;
 294                 struct mgs_export_data    eu_mgs_data;
 295         } u;
 296
 297         struct adaptive_timeout    exp_bl_lock_at;
 298
 299         /** highest XID received by export client that has no
 300          * unreceived lower-numbered XID
 301          */
 302         __u64                     exp_last_xid;
 303 };
 304
 305 #define exp_target_data u.eu_target_data
 306 #define exp_mdt_data    u.eu_mdt_data
 307 #define exp_filter_data u.eu_filter_data
 308 #define exp_ec_data     u.eu_ec_data
 309
 310 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
 311 {
 312         return &exp->exp_connect_data.ocd_connect_flags;
 313 }
 314
 315 static inline __u64 exp_connect_flags(struct obd_export *exp)
 316 {
 317         return *exp_connect_flags_ptr(exp);
 318 }
 319
 320 static inline int exp_max_brw_size(struct obd_export *exp)
 321 {
 322         LASSERT(exp != NULL);
 323         if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
 324                 return exp->exp_connect_data.ocd_brw_size;
 325
 326         return ONE_MB_BRW_SIZE;
 327 }
 328
 329 static inline int exp_connect_multibulk(struct obd_export *exp)
 330 {
 331         return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
 332 }
 333
 334 static inline int exp_expired(struct obd_export *exp, cfs_duration_t age)
 335 {
 336         LASSERT(exp->exp_delayed);
 337         return cfs_time_before(cfs_time_add(exp->exp_last_request_time, age),
 338                                cfs_time_current_sec());
 339 }
 340
 341 static inline int exp_connect_cancelset(struct obd_export *exp)
 342 {
 343         LASSERT(exp != NULL);
 344         return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
 345 }
 346
 347 static inline int exp_connect_lru_resize(struct obd_export *exp)
 348 {
 349         LASSERT(exp != NULL);
 350         return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
 351 }
 352
 353 static inline int exp_connect_rmtclient(struct obd_export *exp)
 354 {
 355         LASSERT(exp != NULL);
 356         return !!(exp_connect_flags(exp) & OBD_CONNECT_RMT_CLIENT);
 357 }
 358
 359 static inline int client_is_remote(struct obd_export *exp)
 360 {
 361         struct obd_import *imp = class_exp2cliimp(exp);
 362
 363         return !!(imp->imp_connect_data.ocd_connect_flags &
 364                   OBD_CONNECT_RMT_CLIENT);
 365 }
 366
 367 static inline int exp_connect_vbr(struct obd_export *exp)
 368 {
 369         LASSERT(exp != NULL);
 370         LASSERT(exp->exp_connection);
 371         return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
 372 }
 373
 374 static inline int exp_connect_umask(struct obd_export *exp)
 375 {
 376         return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
 377 }
 378
 379 static inline int imp_connect_lru_resize(struct obd_import *imp)
 380 {
 381         struct obd_connect_data *ocd;
 382
 383         LASSERT(imp != NULL);
 384         ocd = &imp->imp_connect_data;
 385         return !!(ocd->ocd_connect_flags & OBD_CONNECT_LRU_RESIZE);
 386 }
 387
 388 static inline int exp_connect_layout(struct obd_export *exp)
 389 {
 390         return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
 391 }
 392
 393 static inline bool exp_connect_lvb_type(struct obd_export *exp)
 394 {
 395         LASSERT(exp != NULL);
 396         if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
 397                 return true;
 398         else
 399                 return false;
 400 }
 401
 402 static inline bool imp_connect_lvb_type(struct obd_import *imp)
 403 {
 404         struct obd_connect_data *ocd;
 405
 406         LASSERT(imp != NULL);
 407         ocd = &imp->imp_connect_data;
 408         if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
 409                 return true;
 410         else
 411                 return false;
 412 }
 413
 414 static inline bool imp_connect_disp_stripe(struct obd_import *imp)
 415 {
 416         struct obd_connect_data *ocd;
 417
 418         LASSERT(imp != NULL);
 419         ocd = &imp->imp_connect_data;
 420         return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
 421 }
 422
 423 static inline __u64 exp_connect_ibits(struct obd_export *exp)
 424 {
 425         struct obd_connect_data *ocd;
 426
 427         ocd = &exp->exp_connect_data;
 428         return ocd->ocd_ibits_known;
 429 }
 430
 431 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 432 extern struct obd_device *class_conn2obd(struct lustre_handle *conn);
 433
 434 #define KKUC_CT_DATA_MAGIC      0x092013cea
 435 struct kkuc_ct_data {
 436         __u32           kcd_magic;
 437         struct obd_uuid kcd_uuid;
 438         __u32           kcd_archive;
 439 };
 440
 441 /** @} export */
 442
 443 #endif /* __EXPORT_H */
 444 /** @} obd_export */