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