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