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