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