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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  */
  31 /** \defgroup obd_export PortalRPC export definitions
  32  *
  33  * @{
  34  */
  35
  36 #ifndef __EXPORT_H
  37 #define __EXPORT_H
  38
  39 /** \defgroup export export
  40  *
  41  * @{
  42  */
  43
  44 #include <linux/rhashtable.h>
  45 #include <linux/workqueue.h>
  46
  47 #include <lprocfs_status.h>
  48 #include <uapi/linux/lustre/lustre_idl.h>
  49 #include <lustre_dlm.h>
  50
  51 struct mds_client_data;
  52 struct mdt_client_data;
  53 struct mds_idmap_table;
  54 struct mdt_idmap_table;
  55
  56 /**
  57  * Target-specific export data
  58  */
  59 struct tg_export_data {
  60         /** Protects ted_lcd, ted_reply_* and
  61          * ted_release_* fields below */
  62         struct mutex            ted_lcd_lock;
  63         /** Per-client data for each export */
  64         struct lsd_client_data  *ted_lcd;
  65         /** Offset of record in last_rcvd file */
  66         loff_t                  ted_lr_off;
  67         /** Client index in last_rcvd file */
  68         int                     ted_lr_idx;
  69
  70         /**
  71          * ted_nodemap_lock is used to ensure that the nodemap is not destroyed
  72          * between the time that ted_nodemap is checked for NULL, and a
  73          * reference is taken. Modifications to ted_nodemap require that the
  74          * active_config_lock and the nodemap(s)'s nm_member_list_lock be
  75          * taken, as well as ted_nodemap_lock, so the export can be properly
  76          * added to or removed from the nodemap's member list. When an export
  77          * is added to a nodemap, a reference on that nodemap must be taken.
  78          * That reference can be put only after ted_nodemap no longer refers to
  79          * it.
  80          */
  81         spinlock_t              ted_nodemap_lock;
  82         struct lu_nodemap       *ted_nodemap;
  83         struct list_head        ted_nodemap_member;
  84
  85         /** last version of nodemap config sent to client */
  86         __u64                   ted_nodemap_version;
  87
  88         /* Every reply data fields below are
  89          * protected by ted_lcd_lock */
  90         /** List of reply data */
  91         struct list_head        ted_reply_list;
  92         int                     ted_reply_cnt;
  93         /** Reply data with highest transno is retained */
  94         struct tg_reply_data    *ted_reply_last;
  95         /* Statistics */
  96         int                     ted_reply_max; /* high water mark */
  97         int                     ted_release_xid;
  98         int                     ted_release_tag;
  99         /* grants */
 100         long                    ted_dirty;    /* in bytes */
 101         long                    ted_grant;    /* in bytes */
 102         long                    ted_pending;  /* bytes just being written */
 103         __u8                    ted_pagebits; /* log2 of client page size */
 104
 105         /**
 106          * File Modification Data (FMD) tracking
 107          */
 108         spinlock_t              ted_fmd_lock; /* protects ted_fmd_list */
 109         struct list_head        ted_fmd_list; /* FIDs being modified */
 110         int                     ted_fmd_count;/* items in ted_fmd_list */
 111 };
 112
 113 /**
 114  * MDT-specific export data
 115  */
 116 struct mdt_export_data {
 117         struct tg_export_data   med_ted;
 118         /** List of all files opened by client on this MDT */
 119         struct list_head        med_open_head;
 120         spinlock_t              med_open_lock; /* med_open_head, mfd_list */
 121 };
 122
 123 struct ec_export_data { /* echo client */
 124         struct list_head        eced_locks;
 125 };
 126
 127 /* In-memory access to client data from OST struct */
 128 /** Filter (oss-side) specific import data */
 129 struct filter_export_data {
 130         struct tg_export_data   fed_ted;
 131         __u64                   fed_lastid_gen;
 132         /* count of SOFT_SYNC RPCs, which will be reset after
 133          * ofd_soft_sync_limit number of RPCs, and trigger a sync. */
 134         atomic_t                fed_soft_sync_count;
 135         __u32                   fed_group;
 136 };
 137
 138 struct mgs_export_data {
 139         struct list_head        med_clients;    /* mgc fs client via this exp */
 140         spinlock_t              med_lock;       /* protect med_clients */
 141 };
 142
 143 /**
 144  * per-NID statistics structure.
 145  * It tracks access patterns to this export on a per-client-NID basis
 146  */
 147 struct nid_stat {
 148         lnet_nid_t               nid;
 149         struct hlist_node        nid_hash;
 150         struct list_head         nid_list;
 151         struct obd_device       *nid_obd;
 152         struct proc_dir_entry   *nid_proc;
 153         struct lprocfs_stats    *nid_stats;
 154         struct lprocfs_stats    *nid_ldlm_stats;
 155         atomic_t                 nid_exp_ref_count; /* for obd_nid_stats_hash
 156                                                        exp_nid_stats */
 157 };
 158
 159 #define nidstat_getref(nidstat)                                                \
 160 do {                                                                           \
 161         atomic_inc(&(nidstat)->nid_exp_ref_count);                         \
 162 } while(0)
 163
 164 #define nidstat_putref(nidstat)                                                \
 165 do {                                                                           \
 166         atomic_dec(&(nidstat)->nid_exp_ref_count);                         \
 167         LASSERTF(atomic_read(&(nidstat)->nid_exp_ref_count) >= 0,          \
 168                  "stat %p nid_exp_ref_count < 0\n", nidstat);                  \
 169 } while(0)
 170
 171 enum obd_option {
 172         OBD_OPT_FORCE =         0x0001,
 173         OBD_OPT_FAILOVER =      0x0002,
 174         OBD_OPT_ABORT_RECOV =   0x0004,
 175 };
 176
 177 /**
 178  * Export structure. Represents target-side of connection in portals.
 179  * Also used in Lustre to connect between layers on the same node when
 180  * there is no network-connection in-between.
 181  * For every connected client there is an export structure on the server
 182  * attached to the same obd device.
 183  */
 184 struct obd_export {
 185         /**
 186          * Export handle, it's id is provided to client on connect
 187          * Subsequent client RPCs contain this handle id to identify
 188          * what export they are talking to.
 189          */
 190         struct portals_handle   exp_handle;
 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_handle.href 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         /** work_struct for destruction of export */
 211         struct work_struct      exp_zombie_work;
 212         /* Unlinked export list */
 213         struct list_head        exp_stale_list;
 214         struct rhash_head       exp_uuid_hash;  /** uuid-export hash */
 215         struct rhlist_head      exp_nid_hash;   /** nid-export hash */
 216         struct hlist_node       exp_gen_hash;   /** last_rcvd clt gen hash */
 217         /**
 218          * All exports eligible for ping evictor are linked into a list
 219          * through this field in "most time since last request on this export"
 220          * order
 221          * protected by obd_dev_lock
 222          */
 223         struct list_head        exp_obd_chain_timed;
 224         /** Obd device of this export */
 225         struct obd_device      *exp_obd;
 226         /**
 227          * "reverse" import to send requests (e.g. from ldlm) back to client
 228          * exp_lock protect its change
 229          */
 230         struct obd_import        *exp_imp_reverse;
 231         struct nid_stat          *exp_nid_stats;
 232         /** Active connetion */
 233         struct ptlrpc_connection *exp_connection;
 234         /** Connection count value from last successful reconnect rpc */
 235         __u32                     exp_conn_cnt;
 236         /** Hash list of all ldlm locks granted on this export */
 237         struct cfs_hash          *exp_lock_hash;
 238         /**
 239          * Hash list for Posix lock deadlock detection, added with
 240          * ldlm_lock::l_exp_flock_hash.
 241          */
 242         struct cfs_hash        *exp_flock_hash;
 243         struct list_head        exp_outstanding_replies;
 244         struct list_head        exp_uncommitted_replies;
 245         spinlock_t              exp_uncommitted_replies_lock;
 246         /** Last committed transno for this export */
 247         __u64                   exp_last_committed;
 248         /** When was last request received */
 249         time64_t                exp_last_request_time;
 250         /** On replay all requests waiting for replay are linked here */
 251         struct list_head        exp_req_replay_queue;
 252         /**
 253          * protects exp_flags, exp_outstanding_replies and the change
 254          * of exp_imp_reverse
 255          */
 256         spinlock_t              exp_lock;
 257         /** Compatibility flags for this export are embedded into
 258          *  exp_connect_data */
 259         struct obd_connect_data exp_connect_data;
 260         enum obd_option         exp_flags;
 261         unsigned long           exp_failed:1,
 262                                 exp_in_recovery:1,
 263                                 exp_disconnected:1,
 264                                 exp_connecting:1,
 265                                 /** VBR: export missed recovery */
 266                                 exp_delayed:1,
 267                                 /** VBR: failed version checking */
 268                                 exp_vbr_failed:1,
 269                                 exp_req_replay_needed:1,
 270                                 exp_lock_replay_needed:1,
 271                                 exp_need_sync:1,
 272                                 exp_flvr_changed:1,
 273                                 exp_flvr_adapt:1,
 274                                 /* if to swap nidtbl entries for 2.2 clients.
 275                                  * Only used by the MGS to fix LU-1644. */
 276                                 exp_need_mne_swab:1,
 277                                 /* The export already got final replay ping
 278                                  * request. */
 279                                 exp_replay_done:1,
 280                                 /* local client with recovery disabled */
 281                                 exp_no_recovery:1,
 282                                 exp_hashed:1;
 283         /* also protected by exp_lock */
 284         enum lustre_sec_part    exp_sp_peer;
 285         struct sptlrpc_flavor   exp_flvr;               /* current */
 286         struct sptlrpc_flavor   exp_flvr_old[2];        /* about-to-expire */
 287         time64_t                exp_flvr_expire[2];     /* seconds */
 288
 289         /** protects exp_hp_rpcs */
 290         spinlock_t              exp_rpc_lock;
 291         struct list_head        exp_hp_rpcs;    /* (potential) HP RPCs */
 292         struct list_head        exp_reg_rpcs;  /* RPC being handled */
 293
 294         /** blocking dlm lock list, protected by exp_bl_list_lock */
 295         struct list_head        exp_bl_list;
 296         spinlock_t              exp_bl_list_lock;
 297
 298         /** Target specific data */
 299         union {
 300                 struct tg_export_data     eu_target_data;
 301                 struct mdt_export_data    eu_mdt_data;
 302                 struct filter_export_data eu_filter_data;
 303                 struct ec_export_data     eu_ec_data;
 304                 struct mgs_export_data    eu_mgs_data;
 305         } u;
 306
 307         struct adaptive_timeout    exp_bl_lock_at;
 308
 309         /** highest XID received by export client that has no
 310          * unreceived lower-numbered XID
 311          */
 312         __u64                   exp_last_xid;
 313         long                    *exp_used_slots;
 314 };
 315
 316 #define exp_target_data u.eu_target_data
 317 #define exp_mdt_data    u.eu_mdt_data
 318 #define exp_filter_data u.eu_filter_data
 319 #define exp_ec_data     u.eu_ec_data
 320
 321 static inline __u64 *exp_connect_flags_ptr(struct obd_export *exp)
 322 {
 323         return &exp->exp_connect_data.ocd_connect_flags;
 324 }
 325
 326 static inline __u64 exp_connect_flags(struct obd_export *exp)
 327 {
 328         return *exp_connect_flags_ptr(exp);
 329 }
 330
 331 static inline __u64 *exp_connect_flags2_ptr(struct obd_export *exp)
 332 {
 333         return &exp->exp_connect_data.ocd_connect_flags2;
 334 }
 335
 336 static inline __u64 exp_connect_flags2(struct obd_export *exp)
 337 {
 338         if (exp_connect_flags(exp) & OBD_CONNECT_FLAGS2)
 339                 return *exp_connect_flags2_ptr(exp);
 340         return 0;
 341 }
 342
 343 static inline int exp_max_brw_size(struct obd_export *exp)
 344 {
 345         LASSERT(exp != NULL);
 346         if (exp_connect_flags(exp) & OBD_CONNECT_BRW_SIZE)
 347                 return exp->exp_connect_data.ocd_brw_size;
 348
 349         return ONE_MB_BRW_SIZE;
 350 }
 351
 352 static inline int exp_connect_multibulk(struct obd_export *exp)
 353 {
 354         return exp_max_brw_size(exp) > ONE_MB_BRW_SIZE;
 355 }
 356
 357 static inline int exp_connect_cancelset(struct obd_export *exp)
 358 {
 359         LASSERT(exp != NULL);
 360         return !!(exp_connect_flags(exp) & OBD_CONNECT_CANCELSET);
 361 }
 362
 363 static inline int exp_connect_lru_resize(struct obd_export *exp)
 364 {
 365         LASSERT(exp != NULL);
 366         return !!(exp_connect_flags(exp) & OBD_CONNECT_LRU_RESIZE);
 367 }
 368
 369 static inline int exp_connect_vbr(struct obd_export *exp)
 370 {
 371         LASSERT(exp != NULL);
 372         LASSERT(exp->exp_connection);
 373         return !!(exp_connect_flags(exp) & OBD_CONNECT_VBR);
 374 }
 375
 376 static inline int exp_connect_umask(struct obd_export *exp)
 377 {
 378         return !!(exp_connect_flags(exp) & OBD_CONNECT_UMASK);
 379 }
 380
 381 static inline int imp_connect_lru_resize(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_LRU_RESIZE);
 388 }
 389
 390 static inline int exp_connect_layout(struct obd_export *exp)
 391 {
 392         return !!(exp_connect_flags(exp) & OBD_CONNECT_LAYOUTLOCK);
 393 }
 394
 395 static inline bool exp_connect_lvb_type(struct obd_export *exp)
 396 {
 397         LASSERT(exp != NULL);
 398         if (exp_connect_flags(exp) & OBD_CONNECT_LVB_TYPE)
 399                 return true;
 400         else
 401                 return false;
 402 }
 403
 404 static inline bool imp_connect_lvb_type(struct obd_import *imp)
 405 {
 406         struct obd_connect_data *ocd;
 407
 408         LASSERT(imp != NULL);
 409         ocd = &imp->imp_connect_data;
 410         if (ocd->ocd_connect_flags & OBD_CONNECT_LVB_TYPE)
 411                 return true;
 412         else
 413                 return false;
 414 }
 415
 416 static inline bool imp_connect_disp_stripe(struct obd_import *imp)
 417 {
 418         struct obd_connect_data *ocd;
 419
 420         LASSERT(imp != NULL);
 421         ocd = &imp->imp_connect_data;
 422         return ocd->ocd_connect_flags & OBD_CONNECT_DISP_STRIPE;
 423 }
 424
 425 static inline bool imp_connect_shortio(struct obd_import *imp)
 426 {
 427         struct obd_connect_data *ocd = &imp->imp_connect_data;
 428
 429         return ocd->ocd_connect_flags & OBD_CONNECT_SHORTIO;
 430 }
 431
 432 static inline __u64 exp_connect_ibits(struct obd_export *exp)
 433 {
 434         struct obd_connect_data *ocd;
 435
 436         ocd = &exp->exp_connect_data;
 437         return ocd->ocd_ibits_known;
 438 }
 439
 440 static inline int exp_connect_large_acl(struct obd_export *exp)
 441 {
 442         return !!(exp_connect_flags(exp) & OBD_CONNECT_LARGE_ACL);
 443 }
 444
 445 static inline int exp_connect_lockahead(struct obd_export *exp)
 446 {
 447         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_LOCKAHEAD);
 448 }
 449
 450 static inline int exp_connect_overstriping(struct obd_export *exp)
 451 {
 452         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_OVERSTRIPING);
 453 }
 454
 455 static inline int exp_connect_flr(struct obd_export *exp)
 456 {
 457         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_FLR);
 458 }
 459
 460 static inline int exp_connect_lock_convert(struct obd_export *exp)
 461 {
 462         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_LOCK_CONVERT);
 463 }
 464
 465 extern struct obd_export *class_conn2export(struct lustre_handle *conn);
 466
 467 static inline int exp_connect_archive_id_array(struct obd_export *exp)
 468 {
 469         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_ARCHIVE_ID_ARRAY);
 470 }
 471
 472 static inline int exp_connect_sepol(struct obd_export *exp)
 473 {
 474         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_SELINUX_POLICY);
 475 }
 476
 477 static inline int exp_connect_encrypt(struct obd_export *exp)
 478 {
 479         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_ENCRYPT);
 480 }
 481
 482 static inline int exp_connect_lseek(struct obd_export *exp)
 483 {
 484         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_LSEEK);
 485 }
 486
 487 static inline int exp_connect_dom_lvb(struct obd_export *exp)
 488 {
 489         return !!(exp_connect_flags2(exp) & OBD_CONNECT2_DOM_LVB);
 490 }
 491
 492 enum {
 493         /* archive_ids in array format */
 494         KKUC_CT_DATA_ARRAY_MAGIC        = 0x092013cea,
 495         /* archive_ids in bitmap format */
 496         KKUC_CT_DATA_BITMAP_MAGIC       = 0x082018cea,
 497 };
 498
 499
 500 struct kkuc_ct_data {
 501         __u32           kcd_magic;
 502         __u32           kcd_nr_archives;
 503         __u32           kcd_archives[0];
 504 };
 505
 506 /** @} export */
 507
 508 #endif /* __EXPORT_H */
 509 /** @} obd_export */