lustre/include/obd.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) 2007, 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
  32 #ifndef __OBD_H
  33 #define __OBD_H
  34
  35 #include <linux/fs.h>
  36 #include <linux/posix_acl.h>
  37 #include <linux/kobject.h>
  38 #include <linux/spinlock.h>
  39 #include <linux/sysfs.h>
  40 #include <linux/xarray.h>
  41
  42 #include <uapi/linux/lustre/lustre_idl.h>
  43 #include <lustre_lib.h>
  44 #ifdef HAVE_SERVER_SUPPORT
  45 # include <lu_target.h>
  46 # include <obd_target.h>
  47 # include <lustre_quota.h>
  48 #endif
  49 #include <lu_ref.h>
  50 #include <lustre_export.h>
  51 #include <lustre_fid.h>
  52 #include <lustre_fld.h>
  53 #include <lustre_handles.h>
  54 #include <lustre_intent.h>
  55 #include <lvfs.h>
  56
  57 #define MAX_OBD_DEVICES 8192
  58
  59 struct osc_async_rc {
  60         int     ar_rc;
  61         int     ar_force_sync;
  62         __u64   ar_min_xid;
  63 };
  64
  65 struct lov_oinfo {                 /* per-stripe data structure */
  66         struct ost_id   loi_oi;    /* object ID/Sequence on the target OST */
  67         int loi_ost_idx;           /* OST stripe index in lov_tgt_desc->tgts */
  68         int loi_ost_gen;           /* generation of this loi_ost_idx */
  69
  70         unsigned long loi_kms_valid:1;
  71         __u64 loi_kms;             /* known minimum size */
  72         struct ost_lvb loi_lvb;
  73         struct osc_async_rc     loi_ar;
  74 };
  75
  76 void lov_fix_ea_for_replay(void *lovea);
  77
  78 static inline void loi_kms_set(struct lov_oinfo *oinfo, __u64 kms)
  79 {
  80         oinfo->loi_kms = kms;
  81         oinfo->loi_kms_valid = 1;
  82 }
  83
  84 struct lov_stripe_md;
  85 struct obd_info;
  86
  87 typedef int (*obd_enqueue_update_f)(void *cookie, int rc);
  88
  89 /* obd info for a particular level (lov, osc). */
  90 struct obd_info {
  91         /* OBD_STATFS_* flags */
  92         __u64                   oi_flags;
  93         struct obd_device      *oi_obd;
  94         struct lu_tgt_desc     *oi_tgt;
  95         /* statfs data specific for every OSC, if needed at all. */
  96         struct obd_statfs      *oi_osfs;
  97         /* An update callback which is called to update some data on upper
  98          * level. E.g. it is used for update lsm->lsm_oinfo at every received
  99          * request in osc level for enqueue requests. It is also possible to
 100          * update some caller data from LOV layer if needed. */
 101         obd_enqueue_update_f    oi_cb_up;
 102 };
 103
 104 struct obd_type {
 105         const struct obd_ops    *typ_dt_ops;
 106         const struct md_ops     *typ_md_ops;
 107         struct proc_dir_entry   *typ_procroot;
 108         struct dentry           *typ_debugfs_entry;
 109 #ifdef HAVE_SERVER_SUPPORT
 110         bool                     typ_sym_filter;
 111 #endif
 112         atomic_t                 typ_refcnt;
 113         struct lu_device_type   *typ_lu;
 114         struct kobject           typ_kobj;
 115 };
 116 #define typ_name typ_kobj.name
 117 #define OBD_LU_TYPE_SETUP ((void *)0x01UL)
 118
 119 struct brw_page {
 120         u64              off;
 121         struct page     *pg;
 122         u32              count;
 123         u32              flag;
 124         /* used for encryption: difference with offset in clear text page */
 125         u16              bp_off_diff;
 126         /* used for encryption: difference with count in clear text page */
 127         u16              bp_count_diff;
 128         u32              bp_padding;
 129 };
 130
 131 struct timeout_item {
 132         enum timeout_event ti_event;
 133         time64_t           ti_timeout;
 134         timeout_cb_t       ti_cb;
 135         void              *ti_cb_data;
 136         struct list_head   ti_obd_list;
 137         struct list_head   ti_chain;
 138 };
 139
 140 #define OBD_MAX_RIF_DEFAULT     8
 141 #define OBD_MAX_RIF_MAX         512
 142 #define OSC_MAX_RIF_MAX         256
 143 #define OSC_MAX_DIRTY_DEFAULT   2000     /* Arbitrary large value */
 144 #define OSC_MAX_DIRTY_MB_MAX    2048     /* arbitrary, but < MAX_LONG bytes */
 145 #define OSC_DEFAULT_RESENDS     10
 146
 147 /* possible values for lut_sync_lock_cancel */
 148 enum tgt_sync_lock_cancel {
 149         SYNC_LOCK_CANCEL_NEVER    = 0,
 150         SYNC_LOCK_CANCEL_BLOCKING = 1,
 151         SYNC_LOCK_CANCEL_ALWAYS   = 2,
 152 };
 153
 154 /*
 155  * Limit reply buffer size for striping data to one x86_64 page. This
 156  * value is chosen to fit the striping data for common use cases while
 157  * staying well below the limit at which the buffer must be backed by
 158  * vmalloc(). Excessive use of vmalloc() may cause spinlock contention
 159  * on the MDS.
 160  */
 161 #define OBD_MAX_DEFAULT_EA_SIZE 4096
 162
 163 /*
 164  * Lustre can handle larger xattrs internally, but we must respect the Linux
 165  * VFS limitation or tools like tar cannot interact with Lustre volumes
 166  * correctly.
 167  */
 168 #define OBD_MAX_EA_SIZE         XATTR_SIZE_MAX
 169
 170
 171 enum obd_cl_sem_lock_class {
 172         OBD_CLI_SEM_NORMAL,
 173         OBD_CLI_SEM_MGC,
 174         OBD_CLI_SEM_MDCOSC,
 175 };
 176
 177 struct obd_import;
 178 struct client_obd {
 179         struct rw_semaphore      cl_sem;
 180         struct obd_uuid          cl_target_uuid;
 181         struct obd_import       *cl_import; /* ptlrpc connection state */
 182         size_t                   cl_conn_count;
 183
 184         /* Cache maximum and default values for easize. This is
 185          * strictly a performance optimization to minimize calls to
 186          * obd_size_diskmd(). The default values are used to calculate the
 187          * initial size of a request buffer. The ptlrpc layer will resize the
 188          * buffer as needed to accommodate a larger reply from the
 189          * server. The default values should be small enough to avoid wasted
 190          * memory and excessive use of vmalloc(), yet large enough to avoid
 191          * reallocating the buffer in the common use case. */
 192
 193         /* Default EA size for striping attributes. It is initialized at
 194          * mount-time based on the default stripe width of the filesystem,
 195          * then it tracks the largest observed EA size advertised by
 196          * the MDT, up to a maximum value of OBD_MAX_DEFAULT_EA_SIZE. */
 197         __u32                    cl_default_mds_easize;
 198
 199         /* Maximum possible EA size computed at mount-time based on
 200          * the number of OSTs in the filesystem. May be increased at
 201          * run-time if a larger observed size is advertised by the MDT. */
 202         __u32                    cl_max_mds_easize;
 203
 204         /* Data-on-MDT specific value to set larger reply buffer for possible
 205          * data read along with open/stat requests. By default it tries to use
 206          * unused space in reply buffer.
 207          * This value is used to ensure that reply buffer has at least as
 208          * much free space as value indicates. That free space is gained from
 209          * LOV EA buffer which is small for DoM files and on big systems can
 210          * provide up to 32KB of extra space in reply buffer.
 211          * Default value is 8K now.
 212          */
 213         __u32                    cl_dom_min_inline_repsize;
 214
 215         unsigned int             cl_checksum:1, /* 0 = disabled, 1 = enabled */
 216                                  cl_checksum_dump:1, /* same */
 217                                  cl_ocd_grant_param:1,
 218                                  cl_lsom_update:1; /* send LSOM updates */
 219         enum lustre_sec_part     cl_sp_me;
 220         enum lustre_sec_part     cl_sp_to;
 221         struct sptlrpc_flavor    cl_flvr_mgc; /* fixed flavor of mgc->mgs */
 222
 223         /* the grant values are protected by loi_list_lock below */
 224         unsigned long            cl_dirty_pages;      /* all _dirty_ in pages */
 225         unsigned long            cl_dirty_max_pages;  /* allowed w/o rpc */
 226         unsigned long            cl_avail_grant;   /* bytes of credit for ost */
 227         unsigned long            cl_lost_grant;    /* lost credits (trunc) */
 228         /* grant consumed for dirty pages */
 229         unsigned long            cl_dirty_grant;
 230
 231         /* since we allocate grant by blocks, we don't know how many grant will
 232          * be used to add a page into cache. As a solution, we reserve maximum
 233          * grant before trying to dirty a page and unreserve the rest.
 234          * See osc_{reserve|unreserve}_grant for details. */
 235         long                    cl_reserved_grant;
 236         wait_queue_head_t       cl_cache_waiters; /* waiting for cache/grant */
 237         time64_t                cl_next_shrink_grant;   /* seconds */
 238         struct list_head        cl_grant_chain;
 239         time64_t                cl_grant_shrink_interval; /* seconds */
 240
 241         int                     cl_root_squash; /* if root squash enabled*/
 242
 243         /* A chunk is an optimal size used by osc_extent to determine
 244          * the extent size. A chunk is max(PAGE_SIZE, OST block size) */
 245         int                     cl_chunkbits;
 246         /* extent insertion metadata overhead to be accounted in grant,
 247          * in bytes */
 248         unsigned int            cl_grant_extent_tax;
 249         /* maximum extent size, in number of pages */
 250         unsigned int            cl_max_extent_pages;
 251
 252         /* keep track of objects that have lois that contain pages which
 253          * have been queued for async brw.  this lock also protects the
 254          * lists of osc_client_pages that hang off of the loi */
 255         /*
 256          * ->cl_loi_list_lock protects consistency of
 257          * ->cl_loi_{ready,read,write}_list. ->ap_make_ready() and
 258          * ->ap_completion() call-backs are executed under this lock. As we
 259          * cannot guarantee that these call-backs never block on all platforms
 260          * (as a matter of fact they do block on Mac OS X), type of
 261          * ->cl_loi_list_lock is platform dependent: it's a spin-lock on Linux
 262          * and blocking mutex on Mac OS X. (Alternative is to make this lock
 263          * blocking everywhere, but we don't want to slow down fast-path of
 264          * our main platform.)
 265          *
 266          * NB by Jinshan: though field names are still _loi_, but actually
 267          * osc_object{}s are in the list.
 268          */
 269         spinlock_t              cl_loi_list_lock;
 270         struct list_head        cl_loi_ready_list;
 271         struct list_head        cl_loi_hp_ready_list;
 272         struct list_head        cl_loi_write_list;
 273         struct list_head        cl_loi_read_list;
 274         __u32                   cl_r_in_flight;
 275         __u32                   cl_w_in_flight;
 276         /* just a sum of the loi/lop pending numbers to be exported by /proc */
 277         atomic_t                cl_pending_w_pages;
 278         atomic_t                cl_pending_r_pages;
 279         u32                     cl_max_pages_per_rpc;
 280         u32                     cl_max_rpcs_in_flight;
 281         u32                     cl_max_short_io_bytes;
 282         ktime_t                 cl_stats_init;
 283         struct obd_histogram    cl_read_rpc_hist;
 284         struct obd_histogram    cl_write_rpc_hist;
 285         struct obd_histogram    cl_read_page_hist;
 286         struct obd_histogram    cl_write_page_hist;
 287         struct obd_histogram    cl_read_offset_hist;
 288         struct obd_histogram    cl_write_offset_hist;
 289
 290         /** LRU for osc caching pages */
 291         struct cl_client_cache  *cl_cache;
 292         /** member of cl_cache->ccc_lru */
 293         struct list_head         cl_lru_osc;
 294         /** # of available LRU slots left in the per-OSC cache.
 295          * Available LRU slots are shared by all OSCs of the same file system,
 296          * therefore this is a pointer to cl_client_cache::ccc_lru_left. */
 297         atomic_long_t           *cl_lru_left;
 298         /** # of busy LRU pages. A page is considered busy if it's in writeback
 299          * queue, or in transfer. Busy pages can't be discarded so they are not
 300          * in LRU cache. */
 301         atomic_long_t            cl_lru_busy;
 302         /** # of LRU pages in the cache for this client_obd */
 303         atomic_long_t            cl_lru_in_list;
 304         /** # of threads are shrinking LRU cache. To avoid contention, it's not
 305          * allowed to have multiple threads shrinking LRU cache. */
 306         atomic_t                 cl_lru_shrinkers;
 307         /** The time when this LRU cache was last used. */
 308         time64_t                 cl_lru_last_used;
 309         /** stats: how many reclaims have happened for this client_obd.
 310          * reclaim and shrink - shrink is async, voluntarily rebalancing;
 311          * reclaim is sync, initiated by IO thread when the LRU slots are
 312          * in shortage. */
 313         __u64                    cl_lru_reclaim;
 314         /** List of LRU pages for this client_obd */
 315         struct list_head         cl_lru_list;
 316         /** Lock for LRU page list */
 317         spinlock_t               cl_lru_list_lock;
 318         /** # of unstable pages in this client_obd.
 319          * An unstable page is a page state that WRITE RPC has finished but
 320          * the transaction has NOT yet committed. */
 321         atomic_long_t            cl_unstable_count;
 322         /** Link to osc_shrinker_list */
 323         struct list_head         cl_shrink_list;
 324
 325         /* number of in flight destroy rpcs is limited to max_rpcs_in_flight */
 326         atomic_t                 cl_destroy_in_flight;
 327         wait_queue_head_t        cl_destroy_waitq;
 328
 329         /* modify rpcs in flight
 330          * currently used for metadata only */
 331         __u16                    cl_max_mod_rpcs_in_flight;
 332         __u16                    cl_mod_rpcs_in_flight;
 333         __u16                    cl_close_rpcs_in_flight;
 334         wait_queue_head_t        cl_mod_rpcs_waitq;
 335         unsigned long           *cl_mod_tag_bitmap;
 336         ktime_t                  cl_mod_rpcs_init;
 337         struct obd_histogram     cl_mod_rpcs_hist;
 338
 339         /* mgc datastruct */
 340         struct mutex              cl_mgc_mutex;
 341         struct local_oid_storage *cl_mgc_los;
 342         struct dt_object         *cl_mgc_configs_dir;
 343         struct obd_export        *cl_mgc_mgsexp;
 344         atomic_t                  cl_mgc_refcount;
 345         /* in-flight control list and total RPCs counter */
 346         struct list_head         cl_flight_waiters;
 347         __u32                    cl_rpcs_in_flight;
 348
 349         /* supported checksum types that are worked out at connect time */
 350         __u32                    cl_supp_cksum_types;
 351         /* checksum algorithm to be used */
 352         enum cksum_types         cl_cksum_type;
 353         /* preferred checksum algorithm to be used */
 354         enum cksum_types         cl_preferred_cksum_type;
 355
 356         /* also protected by the poorly named _loi_list_lock lock above */
 357         struct osc_async_rc      cl_ar;
 358
 359         /* sequence manager */
 360         struct lu_client_seq    *cl_seq;
 361         struct rw_semaphore      cl_seq_rwsem;
 362
 363         atomic_t                 cl_resends; /* resend count */
 364
 365         /* ptlrpc work for writeback in ptlrpcd context */
 366         void                    *cl_writeback_work;
 367         void                    *cl_lru_work;
 368         struct mutex              cl_quota_mutex;
 369         /* hash tables for osc_quota_info */
 370         struct cfs_hash         *cl_quota_hash[LL_MAXQUOTAS];
 371         /* the xid of the request updating the hash tables */
 372         __u64                    cl_quota_last_xid;
 373         /* Links to the global list of registered changelog devices */
 374         struct list_head         cl_chg_dev_linkage;
 375 };
 376 #define obd2cli_tgt(obd) ((char *)(obd)->u.cli.cl_target_uuid.uuid)
 377
 378 struct obd_id_info {
 379         u32      idx;
 380         u64     *data;
 381 };
 382
 383 struct echo_client_obd {
 384         struct obd_export      *ec_exp; /* the local connection to osc/lov */
 385         spinlock_t              ec_lock;
 386         struct list_head        ec_objects;
 387         struct list_head        ec_locks;
 388         __u64                   ec_unique;
 389 };
 390
 391 /* allow statfs data caching for 1 second */
 392 #define OBD_STATFS_CACHE_SECONDS 1
 393 /* arbitrary maximum. larger would be useless, allows catching bogus input */
 394 #define OBD_STATFS_CACHE_MAX_AGE 3600 /* seconds */
 395
 396 #define lov_tgt_desc lu_tgt_desc
 397
 398 struct lov_md_tgt_desc {
 399         struct obd_device *lmtd_mdc;
 400         __u32              lmtd_index;
 401 };
 402
 403 struct lov_obd {
 404         struct lov_desc         desc;
 405         struct lov_tgt_desc   **lov_tgts;               /* sparse array */
 406         struct lu_tgt_pool      lov_packed;             /* all OSTs in a packed
 407                                                            array */
 408         struct mutex            lov_lock;
 409         struct obd_connect_data lov_ocd;
 410         atomic_t                lov_refcount;
 411         __u32                   lov_death_row;  /* tgts scheduled to be deleted */
 412         __u32                   lov_tgt_size;   /* size of tgts array */
 413         int                     lov_connects;
 414         int                     lov_pool_count;
 415         struct rhashtable       lov_pools_hash_body; /* used for key access */
 416         struct list_head        lov_pool_list;  /* used for sequential access */
 417         struct proc_dir_entry  *lov_pool_proc_entry;
 418         enum lustre_sec_part    lov_sp_me;
 419
 420         /* Cached LRU and unstable data from upper layer */
 421         struct cl_client_cache *lov_cache;
 422
 423         struct rw_semaphore     lov_notify_lock;
 424         /* Data-on-MDT: MDC array */
 425         struct lov_md_tgt_desc  *lov_mdc_tgts;
 426
 427         struct kobject          *lov_tgts_kobj;
 428 };
 429
 430 #define lmv_tgt_desc lu_tgt_desc
 431
 432 struct lmv_obd {
 433         struct lu_client_fld    lmv_fld;
 434         spinlock_t              lmv_lock;
 435
 436         int                     connected;
 437         int                     max_easize;
 438         int                     max_def_easize;
 439         u32                     lmv_statfs_start;
 440
 441         struct lu_tgt_descs     lmv_mdt_descs;
 442
 443         struct obd_connect_data conn_data;
 444         struct kobject          *lmv_tgts_kobj;
 445         void                    *lmv_cache;
 446
 447         __u32                   lmv_qos_rr_index;
 448 };
 449
 450 #define lmv_mdt_count   lmv_mdt_descs.ltd_lmv_desc.ld_tgt_count
 451 #define lmv_qos         lmv_mdt_descs.ltd_qos
 452
 453 /* Minimum sector size is 512 */
 454 #define MAX_GUARD_NUMBER (PAGE_SIZE / 512)
 455
 456 struct niobuf_local {
 457         __u64           lnb_file_offset;
 458         __u32           lnb_page_offset;
 459         __u32           lnb_len;
 460         __u32           lnb_flags;
 461         int             lnb_rc;
 462         struct page     *lnb_page;
 463         void            *lnb_data;
 464         __u16           lnb_guards[MAX_GUARD_NUMBER];
 465         __u16           lnb_guard_rpc:1;
 466         __u16           lnb_guard_disk:1;
 467         /* separate unlock for read path to allow shared access */
 468         __u16           lnb_locked:1;
 469 };
 470
 471 struct tgt_thread_big_cache {
 472         struct niobuf_local     local[PTLRPC_MAX_BRW_PAGES];
 473 };
 474
 475 #define LUSTRE_FLD_NAME         "fld"
 476 #define LUSTRE_SEQ_NAME         "seq"
 477
 478 #define LUSTRE_MDD_NAME         "mdd"
 479 #define LUSTRE_OSD_LDISKFS_NAME "osd-ldiskfs"
 480 #define LUSTRE_OSD_ZFS_NAME     "osd-zfs"
 481 #define LUSTRE_VVP_NAME         "vvp"
 482 #define LUSTRE_LMV_NAME         "lmv"
 483 #define LUSTRE_SLP_NAME         "slp"
 484 #define LUSTRE_LOD_NAME         "lod"
 485 #define LUSTRE_OSP_NAME         "osp"
 486 #define LUSTRE_LWP_NAME         "lwp"
 487
 488 /* obd device type names */
 489  /* FIXME all the references to LUSTRE_MDS_NAME should be swapped with LUSTRE_MDT_NAME */
 490 #define LUSTRE_MDS_NAME         "mds"
 491 #define LUSTRE_MDT_NAME         "mdt"
 492 #define LUSTRE_MDC_NAME         "mdc"
 493 #define LUSTRE_OSS_NAME         "ost"       /* FIXME change name to oss */
 494 #define LUSTRE_OST_NAME         "obdfilter" /* FIXME change name to ost */
 495 #define LUSTRE_OSC_NAME         "osc"
 496 #define LUSTRE_LOV_NAME         "lov"
 497 #define LUSTRE_MGS_NAME         "mgs"
 498 #define LUSTRE_MGC_NAME         "mgc"
 499
 500 #define LUSTRE_ECHO_NAME        "obdecho"
 501 #define LUSTRE_ECHO_CLIENT_NAME "echo_client"
 502 #define LUSTRE_QMT_NAME         "qmt"
 503
 504 /* Constant obd names (post-rename) */
 505 #define LUSTRE_MDS_OBDNAME "MDS"
 506 #define LUSTRE_OSS_OBDNAME "OSS"
 507 #define LUSTRE_MGS_OBDNAME "MGS"
 508 #define LUSTRE_MGC_OBDNAME "MGC"
 509
 510 static inline int is_lwp_on_mdt(char *name)
 511 {
 512         char   *ptr;
 513
 514         ptr = strrchr(name, '-');
 515         if (ptr == NULL) {
 516                 CERROR("%s is not a obdname\n", name);
 517                 return 0;
 518         }
 519
 520         /* LWP name on MDT is fsname-MDTxxxx-lwp-MDTxxxx */
 521
 522         if (strncmp(ptr + 1, "MDT", 3) != 0)
 523                 return 0;
 524
 525         while (*(--ptr) != '-' && ptr != name);
 526
 527         if (ptr == name)
 528                 return 0;
 529
 530         if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
 531                 return 0;
 532
 533         return 1;
 534 }
 535
 536 static inline int is_lwp_on_ost(char *name)
 537 {
 538         char   *ptr;
 539
 540         ptr = strrchr(name, '-');
 541         if (ptr == NULL) {
 542                 CERROR("%s is not a obdname\n", name);
 543                 return 0;
 544         }
 545
 546         /* LWP name on OST is fsname-MDTxxxx-lwp-OSTxxxx */
 547
 548         if (strncmp(ptr + 1, "OST", 3) != 0)
 549                 return 0;
 550
 551         while (*(--ptr) != '-' && ptr != name);
 552
 553         if (ptr == name)
 554                 return 0;
 555
 556         if (strncmp(ptr + 1, LUSTRE_LWP_NAME, strlen(LUSTRE_LWP_NAME)) != 0)
 557                 return 0;
 558
 559         return 1;
 560 }
 561
 562 /*
 563  * Events signalled through obd_notify() upcall-chain.
 564  */
 565 enum obd_notify_event {
 566         /* Device connect start */
 567         OBD_NOTIFY_CONNECT,
 568         /* Device activated */
 569         OBD_NOTIFY_ACTIVE,
 570         /* Device deactivated */
 571         OBD_NOTIFY_INACTIVE,
 572         /* Connect data for import were changed */
 573         OBD_NOTIFY_OCD,
 574         /* Administratively deactivate/activate event */
 575         OBD_NOTIFY_DEACTIVATE,
 576         OBD_NOTIFY_ACTIVATE
 577 };
 578
 579 /*
 580  * Data structure used to pass obd_notify()-event to non-obd listeners (llite
 581  * being main example).
 582  */
 583 struct obd_notify_upcall {
 584         int (*onu_upcall)(struct obd_device *host, struct obd_device *watched,
 585                           enum obd_notify_event ev, void *owner);
 586         /* Opaque datum supplied by upper layer listener */
 587         void *onu_owner;
 588 };
 589
 590 struct target_recovery_data {
 591         svc_handler_t           trd_recovery_handler;
 592         pid_t                   trd_processing_task;
 593         struct completion       trd_starting;
 594         struct completion       trd_finishing;
 595 };
 596
 597 struct obd_llog_group {
 598         struct llog_ctxt   *olg_ctxts[LLOG_MAX_CTXTS];
 599         wait_queue_head_t  olg_waitq;
 600         spinlock_t         olg_lock;
 601 };
 602
 603 /* corresponds to one of the obd's */
 604 #define OBD_DEVICE_MAGIC        0XAB5CD6EF
 605
 606 struct obd_device {
 607         struct obd_type                 *obd_type;
 608         __u32                            obd_magic; /* OBD_DEVICE_MAGIC */
 609         int                              obd_minor; /* device number: lctl dl */
 610         struct lu_device                *obd_lu_dev;
 611
 612         /* common and UUID name of this device */
 613         struct obd_uuid                  obd_uuid;
 614         char                             obd_name[MAX_OBD_NAME];
 615
 616         /* bitfield modification is protected by obd_dev_lock */
 617         unsigned long
 618                 obd_attached:1,         /* finished attach */
 619                 obd_set_up:1,           /* finished setup */
 620                 obd_recovering:1,       /* there are recoverable clients */
 621                 obd_abort_recovery:1,   /* recovery expired */
 622                 obd_abort_recov_mdt:1,  /* only abort recovery between MDTs */
 623                 obd_version_recov:1,    /* obd uses version checking */
 624                 obd_replayable:1,       /* recovery enabled; inform clients */
 625                 obd_no_recov:1,         /* fail instead of retry messages */
 626                 obd_stopping:1,         /* started cleanup */
 627                 obd_starting:1,         /* started setup */
 628                 obd_force:1,            /* cleanup with > 0 obd refcount */
 629                 obd_fail:1,             /* cleanup with failover */
 630                 obd_no_conn:1,          /* deny new connections */
 631                 obd_inactive:1,         /* device active/inactive
 632                                          * (for /proc/status only!!) */
 633                 obd_no_ir:1,            /* no imperative recovery. */
 634                 obd_process_conf:1,     /* device is processing mgs config */
 635                 obd_checksum_dump:1,    /* dump pages upon cksum error */
 636                 obd_dynamic_nids:1,     /* Allow dynamic NIDs on device */
 637                 obd_read_only:1;        /* device is read-only */
 638 #ifdef HAVE_SERVER_SUPPORT
 639         /* no committed-transno notification */
 640         unsigned long                   obd_no_transno:1;
 641 #endif
 642
 643         /* use separate field as it is set in interrupt to don't mess with
 644          * protection of other bits using _bh lock */
 645         unsigned long obd_recovery_expired:1;
 646         /* uuid-export hash body */
 647         struct rhashtable               obd_uuid_hash;
 648         /* nid-export hash body */
 649         struct rhltable                 obd_nid_hash;
 650         /* nid stats body */
 651         struct cfs_hash             *obd_nid_stats_hash;
 652         /* client_generation-export hash body */
 653         struct cfs_hash             *obd_gen_hash;
 654         struct list_head        obd_nid_stats;
 655         struct list_head        obd_exports;
 656         struct list_head        obd_unlinked_exports;
 657         struct list_head        obd_delayed_exports;
 658         struct list_head        obd_lwp_list;
 659         atomic_t                obd_refcount;
 660         int                     obd_num_exports;
 661         int                     obd_grant_check_threshold;
 662         spinlock_t              obd_nid_lock;
 663         struct ldlm_namespace  *obd_namespace;
 664         struct ptlrpc_client    obd_ldlm_client; /* XXX OST/MDS only */
 665         /* a spinlock is OK for what we do now, may need a semaphore later */
 666         spinlock_t              obd_dev_lock; /* protect OBD bitfield above */
 667         spinlock_t              obd_osfs_lock;
 668         struct obd_statfs       obd_osfs;       /* locked by obd_osfs_lock */
 669         time64_t                obd_osfs_age;
 670         __u64                   obd_last_committed;
 671         struct mutex            obd_dev_mutex;
 672         struct lvfs_run_ctxt    obd_lvfs_ctxt;
 673         struct obd_llog_group   obd_olg;        /* default llog group */
 674         struct obd_device       *obd_observer;
 675         struct rw_semaphore     obd_observer_link_sem;
 676         struct obd_notify_upcall obd_upcall;
 677         struct obd_export       *obd_self_export;
 678         struct obd_export       *obd_lwp_export;
 679         /* list of exports in LRU order, for ping evictor, with obd_dev_lock */
 680         struct list_head        obd_exports_timed;
 681         time64_t                obd_eviction_timer;     /* for ping evictor */
 682
 683         atomic_t                obd_max_recoverable_clients;
 684         atomic_t                obd_connected_clients;
 685         int                     obd_stale_clients;
 686         /* this lock protects all recovery list_heads, timer and
 687          * obd_next_recovery_transno value */
 688         spinlock_t              obd_recovery_task_lock;
 689         __u64                   obd_next_recovery_transno;
 690         int                     obd_replayed_requests;
 691         int                     obd_requests_queued_for_recovery;
 692         wait_queue_head_t       obd_next_transno_waitq;
 693         /* protected by obd_recovery_task_lock */
 694         struct hrtimer          obd_recovery_timer;
 695         /* seconds */
 696         time64_t                obd_recovery_start;
 697         /* seconds, for lprocfs_status */
 698         time64_t                obd_recovery_end;
 699         /* To tell timeouts from time stamps Lustre uses timeout_t
 700          * instead of time64_t.
 701          */
 702         timeout_t                       obd_recovery_time_hard;
 703         timeout_t                       obd_recovery_timeout;
 704         int                             obd_recovery_ir_factor;
 705
 706         /* new recovery stuff from CMD2 */
 707         int                             obd_replayed_locks;
 708         atomic_t                        obd_req_replay_clients;
 709         atomic_t                        obd_lock_replay_clients;
 710         struct target_recovery_data     obd_recovery_data;
 711
 712         /* all lists are protected by obd_recovery_task_lock */
 713         struct list_head                obd_req_replay_queue;
 714         struct list_head                obd_lock_replay_queue;
 715         struct list_head                obd_final_req_queue;
 716
 717         union {
 718 #ifdef HAVE_SERVER_SUPPORT
 719                 struct obd_device_target obt;
 720                 struct filter_obd filter;
 721                 struct ost_obd ost;
 722                 struct echo_obd echo;
 723 #endif
 724                 struct client_obd cli;
 725                 struct echo_client_obd echo_client;
 726                 struct lov_obd lov;
 727                 struct lmv_obd lmv;
 728         } u;
 729
 730         /* Fields used by LProcFS */
 731         struct lprocfs_stats            *obd_stats;
 732
 733         struct lprocfs_stats            *obd_md_stats;
 734
 735         struct dentry                   *obd_debugfs_entry;
 736         struct proc_dir_entry   *obd_proc_entry;
 737         struct proc_dir_entry   *obd_proc_exports_entry;
 738         struct dentry                   *obd_svc_debugfs_entry;
 739         struct lprocfs_stats    *obd_svc_stats;
 740         const struct attribute         **obd_attrs;
 741         struct lprocfs_vars     *obd_vars;
 742         struct ldebugfs_vars    *obd_debugfs_vars;
 743         atomic_t                obd_evict_inprogress;
 744         wait_queue_head_t       obd_evict_inprogress_waitq;
 745         struct list_head        obd_evict_list; /* protected with pet_lock */
 746
 747         /**
 748          * LDLM pool part. Save last calculated SLV and Limit.
 749          */
 750         rwlock_t                        obd_pool_lock;
 751         __u64                           obd_pool_slv;
 752         int                             obd_pool_limit;
 753
 754         int                             obd_conn_inprogress;
 755
 756         /**
 757          * List of outstanding class_incref()'s fo this OBD. For debugging. */
 758         struct lu_ref                   obd_reference;
 759
 760         struct kset                     obd_kset; /* sysfs object collection */
 761         struct kobj_type                obd_ktype;
 762         struct completion               obd_kobj_unregister;
 763 };
 764
 765 int obd_uuid_add(struct obd_device *obd, struct obd_export *export);
 766 void obd_uuid_del(struct obd_device *obd, struct obd_export *export);
 767 #ifdef HAVE_SERVER_SUPPORT
 768 struct obd_export *obd_uuid_lookup(struct obd_device *obd,
 769                                    struct obd_uuid *uuid);
 770
 771 int obd_nid_export_for_each(struct obd_device *obd, struct lnet_nid *nid,
 772                             int cb(struct obd_export *exp, void *data),
 773                             void *data);
 774 int obd_nid_add(struct obd_device *obd, struct obd_export *exp);
 775 void obd_nid_del(struct obd_device *obd, struct obd_export *exp);
 776 #endif
 777
 778 /* get/set_info keys */
 779 #define KEY_ASYNC               "async"
 780 #define KEY_CHANGELOG_CLEAR     "changelog_clear"
 781 #define KEY_FID2PATH            "fid2path"
 782 #define KEY_CHECKSUM            "checksum"
 783 #define KEY_CLEAR_FS            "clear_fs"
 784 #define KEY_CONN_DATA           "conn_data"
 785 #define KEY_EVICT_BY_NID        "evict_by_nid"
 786 #define KEY_FIEMAP              "fiemap"
 787 #define KEY_FLUSH_CTX           "flush_ctx"
 788 #define KEY_GRANT_SHRINK        "grant_shrink"
 789 #define KEY_HSM_COPYTOOL_SEND   "hsm_send"
 790 #define KEY_INIT_RECOV_BACKUP   "init_recov_bk"
 791 #define KEY_INTERMDS            "inter_mds"
 792 #define KEY_LAST_ID             "last_id"
 793 #define KEY_LAST_FID            "last_fid"
 794 #define KEY_MAX_EASIZE          "max_easize"
 795 #define KEY_DEFAULT_EASIZE      "default_easize"
 796 #define KEY_MGSSEC              "mgssec"
 797 #define KEY_READ_ONLY           "read-only"
 798 #define KEY_REGISTER_TARGET     "register_target"
 799 #define KEY_SET_FS              "set_fs"
 800 #define KEY_TGT_COUNT           "tgt_count"
 801 /*      KEY_SET_INFO in lustre_idl.h */
 802 #define KEY_SPTLRPC_CONF        "sptlrpc_conf"
 803
 804 #define KEY_CACHE_LRU_SHRINK    "cache_lru_shrink"
 805 #define KEY_OSP_CONNECTED       "osp_connected"
 806
 807 /* Flags for op_xvalid */
 808 enum op_xvalid {
 809         OP_XVALID_CTIME_SET     = BIT(0),       /* 0x0001 */
 810         OP_XVALID_BLOCKS        = BIT(1),       /* 0x0002 */
 811         OP_XVALID_OWNEROVERRIDE = BIT(2),       /* 0x0004 */
 812         OP_XVALID_FLAGS         = BIT(3),       /* 0x0008 */
 813         OP_XVALID_PROJID        = BIT(4),       /* 0x0010 */
 814         OP_XVALID_LAZYSIZE      = BIT(5),       /* 0x0020 */
 815         OP_XVALID_LAZYBLOCKS    = BIT(6),       /* 0x0040 */
 816 };
 817
 818 struct lu_context;
 819
 820 static inline int it_to_lock_mode(struct lookup_intent *it)
 821 {
 822         /* CREAT needs to be tested before open (both could be set) */
 823         if (it->it_op & IT_CREAT)
 824                 return LCK_CW;
 825         else if (it->it_op & (IT_GETATTR | IT_OPEN | IT_LOOKUP))
 826                 return LCK_CR;
 827         else if (it->it_op & IT_LAYOUT)
 828                 return (it->it_flags & FMODE_WRITE) ? LCK_EX : LCK_CR;
 829         else if (it->it_op &  IT_READDIR)
 830                 return LCK_PR;
 831         else if (it->it_op &  IT_GETXATTR)
 832                 return LCK_PR;
 833
 834         LASSERTF(0, "Invalid it_op: %d\n", it->it_op);
 835         return -EINVAL;
 836 }
 837
 838 enum md_op_flags {
 839         MF_MDC_CANCEL_FID1      = BIT(0),
 840         MF_MDC_CANCEL_FID2      = BIT(1),
 841         MF_MDC_CANCEL_FID3      = BIT(2),
 842         MF_MDC_CANCEL_FID4      = BIT(3),
 843         MF_GET_MDT_IDX          = BIT(4),
 844         MF_GETATTR_BY_FID       = BIT(5),
 845         MF_QOS_MKDIR            = BIT(6),
 846         MF_RR_MKDIR             = BIT(7),
 847         MF_OPNAME_KMALLOCED     = BIT(8),
 848 };
 849
 850 enum md_cli_flags {
 851         CLI_SET_MEA     = BIT(0),
 852         CLI_RM_ENTRY    = BIT(1),
 853         CLI_HASH64      = BIT(2),
 854         CLI_API32       = BIT(3),
 855         CLI_MIGRATE     = BIT(4),
 856         CLI_DIRTY_DATA  = BIT(5),
 857         CLI_NO_SLOT     = BIT(6),
 858 };
 859
 860 enum md_op_code {
 861         LUSTRE_OPC_MKDIR = 1,
 862         LUSTRE_OPC_SYMLINK,
 863         LUSTRE_OPC_MKNOD,
 864         LUSTRE_OPC_CREATE,
 865         LUSTRE_OPC_ANY,
 866         LUSTRE_OPC_LOOKUP,
 867         LUSTRE_OPC_OPEN,
 868 };
 869
 870 /**
 871  * GETXATTR is not included as only a couple of fields in the reply body
 872  * is filled, but not FID which is needed for common intent handling in
 873  * mdc_finish_intent_lock()
 874  */
 875 static inline bool it_has_reply_body(const struct lookup_intent *it)
 876 {
 877         return it->it_op & (IT_OPEN | IT_LOOKUP | IT_GETATTR);
 878 }
 879
 880 struct md_op_data {
 881         struct lu_fid           op_fid1; /* operation fid1 (usualy parent) */
 882         struct lu_fid           op_fid2; /* operation fid2 (usualy child) */
 883         struct lu_fid           op_fid3; /* 2 extra fids to find conflicting */
 884         struct lu_fid           op_fid4; /* to the operation locks. */
 885         u32                     op_mds;  /* what mds server open will go to */
 886         __u32                   op_mode;
 887         enum md_op_code         op_code;
 888         struct lustre_handle    op_open_handle;
 889         s64                     op_mod_time;
 890         const char              *op_name;
 891         size_t                  op_namelen;
 892         struct rw_semaphore     *op_mea1_sem;
 893         struct rw_semaphore     *op_mea2_sem;
 894         struct lmv_stripe_md    *op_mea1;
 895         struct lmv_stripe_md    *op_mea2;
 896         struct lmv_stripe_md    *op_default_mea1;       /* default LMV */
 897         __u32                   op_suppgids[2];
 898         __u32                   op_fsuid;
 899         __u32                   op_fsgid;
 900         kernel_cap_t            op_cap;
 901         void                    *op_data;
 902         size_t                  op_data_size;
 903
 904         /* iattr fields and blocks. */
 905         struct iattr            op_attr;
 906         enum op_xvalid          op_xvalid;      /* eXtra validity flags */
 907         loff_t                  op_attr_blocks;
 908         u64                     op_valid;       /* OBD_MD_* */
 909         unsigned int            op_attr_flags;  /* LUSTRE_{SYNC,..}_FL */
 910
 911         enum md_op_flags        op_flags;
 912
 913         /* Various operation flags. */
 914         enum mds_op_bias        op_bias;
 915
 916         /* used to transfer info between the stacks of MD client
 917          * see enum op_cli_flags */
 918         enum md_cli_flags       op_cli_flags;
 919
 920         /* File object data version for HSM release, on client */
 921         __u64                   op_data_version;
 922         struct lustre_handle    op_lease_handle;
 923
 924         /* File security context, for creates/metadata ops */
 925         const char             *op_file_secctx_name;
 926         __u32                   op_file_secctx_name_size;
 927         void                   *op_file_secctx;
 928         __u32                   op_file_secctx_size;
 929
 930         /* File encryption context, for creates/metadata ops */
 931         void                   *op_file_encctx;
 932         __u32                   op_file_encctx_size;
 933
 934         __u32                   op_projid;
 935
 936         union {
 937                 /* Used by readdir */
 938                 unsigned int    op_max_pages;
 939                 /* mkdir */
 940                 unsigned short  op_dir_depth;
 941         };
 942
 943         __u16                   op_mirror_id;
 944
 945         /*
 946          * used to access dir that is changing layout: if it's set, access
 947          * dir by new layout, otherwise old layout.
 948          * By default it's not set, because new files are created under new
 949          * layout, if we can't find file with name under both old and new
 950          * layout, we are sure file with name doesn't exist, but in reverse
 951          * order there may be a race with creation by others.
 952          */
 953         bool                    op_new_layout;
 954         /* used to access dir with bash hash */
 955         __u32                   op_stripe_index;
 956         /* Archive ID for PCC attach */
 957         __u32                   op_archive_id;
 958 };
 959
 960 struct md_readdir_info {
 961         int (*mr_blocking_ast)(struct ldlm_lock *lock,
 962                                struct ldlm_lock_desc *desc,
 963                                void *data, int flag);
 964         /* if striped directory is partially read, the result is stored here */
 965         int mr_partial_readdir_rc;
 966 };
 967
 968 struct md_op_item;
 969 typedef int (*md_op_item_cb_t)(struct md_op_item *item, int rc);
 970
 971 struct md_op_item {
 972         struct md_op_data                mop_data;
 973         struct lookup_intent             mop_it;
 974         struct lustre_handle             mop_lockh;
 975         struct ldlm_enqueue_info         mop_einfo;
 976         md_op_item_cb_t                  mop_cb;
 977         void                            *mop_cbdata;
 978         struct inode                    *mop_dir;
 979         struct req_capsule              *mop_pill;
 980         struct work_struct               mop_work;
 981 };
 982
 983 struct obd_ops {
 984         struct module *o_owner;
 985         int (*o_iocontrol)(unsigned int cmd, struct obd_export *exp, int len,
 986                            void *karg, void __user *uarg);
 987         int (*o_get_info)(const struct lu_env *env, struct obd_export *,
 988                           __u32 keylen, void *key, __u32 *vallen, void *val);
 989         int (*o_set_info_async)(const struct lu_env *, struct obd_export *,
 990                                 __u32 keylen, void *key,
 991                                 __u32 vallen, void *val,
 992                                 struct ptlrpc_request_set *set);
 993         int (*o_setup) (struct obd_device *obd, struct lustre_cfg *cfg);
 994         int (*o_precleanup)(struct obd_device *obd);
 995         int (*o_cleanup)(struct obd_device *obd);
 996         int (*o_process_config)(struct obd_device *obd, size_t len, void *data);
 997         int (*o_postrecov)(struct obd_device *obd);
 998         int (*o_add_conn)(struct obd_import *imp, struct obd_uuid *uuid,
 999                           int priority);
1000         int (*o_del_conn)(struct obd_import *imp, struct obd_uuid *uuid);
1001         /* connect to the target device with given connection
1002          * data. @ocd->ocd_connect_flags is modified to reflect flags actually
1003          * granted by the target, which are guaranteed to be a subset of flags
1004          * asked for. If @ocd == NULL, use default parameters. */
1005         int (*o_connect)(const struct lu_env *env,
1006                          struct obd_export **exp, struct obd_device *src,
1007                          struct obd_uuid *cluuid, struct obd_connect_data *ocd,
1008                          void *localdata);
1009         int (*o_reconnect)(const struct lu_env *env,
1010                            struct obd_export *exp, struct obd_device *src,
1011                            struct obd_uuid *cluuid,
1012                            struct obd_connect_data *ocd,
1013                            void *localdata);
1014         int (*o_disconnect)(struct obd_export *exp);
1015
1016         /* Initialize/finalize fids infrastructure. */
1017         int (*o_fid_init)(struct obd_device *obd,
1018                           struct obd_export *exp, enum lu_cli_type type);
1019         int (*o_fid_fini)(struct obd_device *obd);
1020
1021         /* Allocate new fid according to passed @hint. */
1022         int (*o_fid_alloc)(const struct lu_env *env, struct obd_export *exp,
1023                            struct lu_fid *fid, struct md_op_data *op_data);
1024
1025         /*
1026          * Object with @fid is getting deleted, we may want to do something
1027          * about this.
1028          */
1029         int (*o_statfs)(const struct lu_env *, struct obd_export *exp,
1030                         struct obd_statfs *osfs, time64_t max_age, __u32 flags);
1031         int (*o_statfs_async)(struct obd_export *exp, struct obd_info *oinfo,
1032                               time64_t max_age, struct ptlrpc_request_set *set);
1033         int (*o_create)(const struct lu_env *env, struct obd_export *exp,
1034                         struct obdo *oa);
1035         int (*o_destroy)(const struct lu_env *env, struct obd_export *exp,
1036                          struct obdo *oa);
1037         int (*o_setattr)(const struct lu_env *, struct obd_export *exp,
1038                          struct obdo *oa);
1039         int (*o_getattr)(const struct lu_env *env, struct obd_export *exp,
1040                          struct obdo *oa);
1041         int (*o_preprw)(const struct lu_env *env, int cmd,
1042                         struct obd_export *exp, struct obdo *oa, int objcount,
1043                         struct obd_ioobj *obj, struct niobuf_remote *remote,
1044                         int *nr_pages, struct niobuf_local *local);
1045         int (*o_commitrw)(const struct lu_env *env, int cmd,
1046                           struct obd_export *exp, struct obdo *oa,
1047                           int objcount, struct obd_ioobj *obj,
1048                           struct niobuf_remote *remote, int pages,
1049                           struct niobuf_local *local, int rc, int nob,
1050                           ktime_t kstart);
1051         int (*o_init_export)(struct obd_export *exp);
1052         int (*o_destroy_export)(struct obd_export *exp);
1053
1054         int (*o_import_event)(struct obd_device *, struct obd_import *,
1055                               enum obd_import_event);
1056
1057         int (*o_notify)(struct obd_device *obd, struct obd_device *watched,
1058                         enum obd_notify_event ev);
1059
1060         int (*o_health_check)(const struct lu_env *env, struct obd_device *);
1061         struct obd_uuid *(*o_get_uuid) (struct obd_export *exp);
1062
1063         /* quota methods */
1064         int (*o_quotactl)(struct obd_device *, struct obd_export *,
1065                           struct obd_quotactl *);
1066
1067         /* pools methods */
1068         int (*o_pool_new)(struct obd_device *obd, char *poolname);
1069         int (*o_pool_del)(struct obd_device *obd, char *poolname);
1070         int (*o_pool_add)(struct obd_device *obd, char *poolname,
1071                           char *ostname);
1072         int (*o_pool_rem)(struct obd_device *obd, char *poolname,
1073                           char *ostname);
1074 };
1075
1076 /* lmv structures */
1077 struct lustre_md {
1078         struct mdt_body         *body;
1079         struct lu_buf            layout;
1080         union {
1081                 struct lmv_stripe_md    *lmv;
1082                 struct lmv_foreign_md   *lfm;
1083         };
1084         struct lmv_stripe_md    *default_lmv;
1085 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1086         struct posix_acl        *posix_acl;
1087 #endif
1088 };
1089
1090 #ifdef CONFIG_LUSTRE_FS_POSIX_ACL
1091 static inline void lmd_clear_acl(struct lustre_md *md)
1092 {
1093         if (md->posix_acl) {
1094                 posix_acl_release(md->posix_acl);
1095                 md->posix_acl = NULL;
1096         }
1097 }
1098
1099 #define OBD_CONNECT_ACL_FLAGS  \
1100         (OBD_CONNECT_ACL | OBD_CONNECT_UMASK | OBD_CONNECT_LARGE_ACL)
1101 #else
1102 static inline void lmd_clear_acl(struct lustre_md *md)
1103 {
1104 }
1105
1106 #define OBD_CONNECT_ACL_FLAGS  (0)
1107 #endif
1108
1109 struct md_open_data {
1110         struct obd_client_handle        *mod_och;
1111         struct ptlrpc_request           *mod_open_req;
1112         struct ptlrpc_request           *mod_close_req;
1113         atomic_t                         mod_refcount;
1114         bool                             mod_is_create;
1115 };
1116
1117 struct obd_client_handle {
1118         struct lustre_handle     och_open_handle;
1119         struct lu_fid            och_fid;
1120         struct md_open_data     *och_mod;
1121         struct lustre_handle     och_lease_handle; /* open lock for lease */
1122         __u32                    och_magic;
1123         int                      och_flags;
1124 };
1125
1126 #define OBD_CLIENT_HANDLE_MAGIC 0xd15ea5ed
1127
1128 struct lookup_intent;
1129 struct cl_attr;
1130
1131 struct md_ops {
1132         int (*m_close)(struct obd_export *, struct md_op_data *,
1133                        struct md_open_data *, struct ptlrpc_request **);
1134
1135         int (*m_create)(struct obd_export *, struct md_op_data *,
1136                         const void *, size_t, umode_t, uid_t, gid_t,
1137                         kernel_cap_t, __u64, struct ptlrpc_request **);
1138
1139         int (*m_enqueue)(struct obd_export *, struct ldlm_enqueue_info *,
1140                          const union ldlm_policy_data *, struct md_op_data *,
1141                          struct lustre_handle *, __u64);
1142
1143         int (*m_getattr)(struct obd_export *, struct md_op_data *,
1144                          struct ptlrpc_request **);
1145
1146         int (*m_intent_lock)(struct obd_export *, struct md_op_data *,
1147                              struct lookup_intent *,
1148                              struct ptlrpc_request **,
1149                              ldlm_blocking_callback, __u64);
1150
1151         int (*m_link)(struct obd_export *, struct md_op_data *,
1152                       struct ptlrpc_request **);
1153
1154         int (*m_rename)(struct obd_export *, struct md_op_data *,
1155                         const char *, size_t, const char *, size_t,
1156                         struct ptlrpc_request **);
1157
1158         int (*m_setattr)(struct obd_export *, struct md_op_data *, void *,
1159                          size_t , struct ptlrpc_request **);
1160
1161         int (*m_fsync)(struct obd_export *, const struct lu_fid *,
1162                        struct ptlrpc_request **);
1163
1164         int (*m_read_page)(struct obd_export *, struct md_op_data *,
1165                            struct md_readdir_info *mrinfo, __u64 hash_offset,
1166                            struct page **ppage);
1167
1168         int (*m_unlink)(struct obd_export *, struct md_op_data *,
1169                         struct ptlrpc_request **);
1170
1171         int (*m_setxattr)(struct obd_export *, const struct lu_fid *,
1172                           u64, const char *, const void *, size_t, unsigned int,
1173                           u32, struct ptlrpc_request **);
1174
1175         int (*m_getxattr)(struct obd_export *, const struct lu_fid *,
1176                           u64, const char *, size_t, struct ptlrpc_request **);
1177
1178         int (*m_intent_getattr_async)(struct obd_export *,
1179                                       struct md_op_item *);
1180
1181         int (*m_revalidate_lock)(struct obd_export *, struct lookup_intent *,
1182                                  struct lu_fid *, __u64 *bits);
1183
1184         int (*m_file_resync)(struct obd_export *, struct md_op_data *);
1185
1186         int (*m_get_root)(struct obd_export *, const char *, struct lu_fid *);
1187         int (*m_null_inode)(struct obd_export *, const struct lu_fid *);
1188
1189         int (*m_getattr_name)(struct obd_export *, struct md_op_data *,
1190                               struct ptlrpc_request **);
1191
1192         int (*m_init_ea_size)(struct obd_export *, __u32, __u32);
1193
1194         int (*m_get_lustre_md)(struct obd_export *, struct req_capsule *,
1195                                struct obd_export *, struct obd_export *,
1196                                struct lustre_md *);
1197
1198         int (*m_free_lustre_md)(struct obd_export *, struct lustre_md *);
1199
1200         int (*m_merge_attr)(struct obd_export *,
1201                             const struct lmv_stripe_md *lsm,
1202                             struct cl_attr *attr, ldlm_blocking_callback);
1203
1204         int (*m_set_open_replay_data)(struct obd_export *,
1205                                       struct obd_client_handle *,
1206                                       struct lookup_intent *);
1207
1208         int (*m_clear_open_replay_data)(struct obd_export *,
1209                                         struct obd_client_handle *);
1210
1211         int (*m_set_lock_data)(struct obd_export *,
1212                                const struct lustre_handle *, void *, __u64 *);
1213
1214         enum ldlm_mode (*m_lock_match)(struct obd_export *, __u64,
1215                                        const struct lu_fid *, enum ldlm_type,
1216                                        union ldlm_policy_data *, enum ldlm_mode,
1217                                        struct lustre_handle *);
1218
1219         int (*m_cancel_unused)(struct obd_export *, const struct lu_fid *,
1220                                union ldlm_policy_data *, enum ldlm_mode,
1221                                enum ldlm_cancel_flags flags, void *opaque);
1222
1223         int (*m_get_fid_from_lsm)(struct obd_export *,
1224                                   const struct lmv_stripe_md *,
1225                                   const char *name, int namelen,
1226                                   struct lu_fid *fid);
1227         int (*m_unpackmd)(struct obd_export *exp, struct lmv_stripe_md **plsm,
1228                           const union lmv_mds_md *lmv, size_t lmv_size);
1229         int (*m_rmfid)(struct obd_export *exp, struct fid_array *fa, int *rcs,
1230                        struct ptlrpc_request_set *set);
1231 };
1232
1233 static inline struct md_open_data *obd_mod_alloc(void)
1234 {
1235         struct md_open_data *mod;
1236         OBD_ALLOC_PTR(mod);
1237         if (mod == NULL)
1238                 return NULL;
1239         atomic_set(&mod->mod_refcount, 1);
1240         return mod;
1241 }
1242
1243 #define obd_mod_get(mod) atomic_inc(&(mod)->mod_refcount)
1244 #define obd_mod_put(mod)                                          \
1245 ({                                                                \
1246         if (atomic_dec_and_test(&(mod)->mod_refcount)) {          \
1247                 if ((mod)->mod_open_req)                          \
1248                         ptlrpc_req_finished((mod)->mod_open_req); \
1249                 OBD_FREE_PTR(mod);                                \
1250         }                                                         \
1251 })
1252
1253 void obdo_from_inode(struct obdo *dst, struct inode *src, u64 valid);
1254 void obdo_set_parent_fid(struct obdo *dst, const struct lu_fid *parent);
1255 void obdo_set_o_projid(struct obdo *dst, u32 projid);
1256
1257 /* return 1 if client should be resend request */
1258 static inline int client_should_resend(int resend, struct client_obd *cli)
1259 {
1260         return atomic_read(&cli->cl_resends) ?
1261                atomic_read(&cli->cl_resends) > resend : 1;
1262 }
1263
1264 /**
1265  * Return device name for this device
1266  *
1267  * XXX: lu_device is declared before obd_device, while a pointer pointing
1268  * back to obd_device in lu_device, so this helper function defines here
1269  * instead of in lu_object.h
1270  */
1271 static inline const char *lu_dev_name(const struct lu_device *lu_dev)
1272 {
1273         return lu_dev->ld_obd->obd_name;
1274 }
1275
1276 static inline bool filename_is_volatile(const char *name, size_t namelen,
1277                                         int *idx)
1278 {
1279         const char      *start;
1280         char            *end;
1281
1282         if (strncmp(name, LUSTRE_VOLATILE_HDR, LUSTRE_VOLATILE_HDR_LEN) != 0)
1283                 return false;
1284
1285         /* caller does not care of idx */
1286         if (idx == NULL)
1287                 return true;
1288
1289         /* volatile file, the MDT can be set from name */
1290         /* name format is LUSTRE_VOLATILE_HDR:[idx]: */
1291         /* if no MDT is specified, use std way */
1292         if (namelen < LUSTRE_VOLATILE_HDR_LEN + 2)
1293                 goto bad_format;
1294         /* test for no MDT idx case */
1295         if ((*(name + LUSTRE_VOLATILE_HDR_LEN) == ':') &&
1296             (*(name + LUSTRE_VOLATILE_HDR_LEN + 1) == ':')) {
1297                 *idx = -1;
1298                 return true;
1299         }
1300         /* we have an idx, read it */
1301         start = name + LUSTRE_VOLATILE_HDR_LEN + 1;
1302         *idx = simple_strtoul(start, &end, 16);
1303         /* error cases:
1304          * no digit, no trailing :, negative value
1305          */
1306         if (((*idx == 0) && (end == start)) ||
1307             (*end != ':') || (*idx < 0))
1308                 goto bad_format;
1309
1310         return true;
1311 bad_format:
1312         /* bad format of mdt idx, we cannot return an error
1313          * to caller so we use hash algo */
1314         CERROR("Bad volatile file name format: %s\n",
1315                name + LUSTRE_VOLATILE_HDR_LEN);
1316         return false;
1317 }
1318
1319 static inline int cli_brw_size(struct obd_device *obd)
1320 {
1321         LASSERT(obd != NULL);
1322         return obd->u.cli.cl_max_pages_per_rpc << PAGE_SHIFT;
1323 }
1324
1325 /*
1326  * When RPC size or the max RPCs in flight is increased, the max dirty pages
1327  * of the client should be increased accordingly to avoid sending fragmented
1328  * RPCs over the network when the client runs out of the maximum dirty space
1329  * when so many RPCs are being generated.
1330  */
1331 static inline void client_adjust_max_dirty(struct client_obd *cli)
1332 {
1333          /* initializing */
1334         if (cli->cl_dirty_max_pages <= 0) {
1335                 cli->cl_dirty_max_pages =
1336                         (OSC_MAX_DIRTY_DEFAULT * 1024 * 1024) >> PAGE_SHIFT;
1337         } else {
1338                 unsigned long dirty_max = cli->cl_max_rpcs_in_flight *
1339                                           cli->cl_max_pages_per_rpc;
1340
1341                 if (dirty_max > cli->cl_dirty_max_pages)
1342                         cli->cl_dirty_max_pages = dirty_max;
1343         }
1344
1345         if (cli->cl_dirty_max_pages > cfs_totalram_pages() / 8)
1346                 cli->cl_dirty_max_pages = cfs_totalram_pages() / 8;
1347
1348         /* This value is exported to userspace through the max_dirty_mb
1349          * parameter.  So we round up the number of pages to make it a round
1350          * number of MBs. */
1351         cli->cl_dirty_max_pages = round_up(cli->cl_dirty_max_pages,
1352                                            1 << (20 - PAGE_SHIFT));
1353 }
1354
1355 /* Must be used for page cache pages only,
1356  * not safe otherwise (e.g. direct IO pages)
1357  */
1358 static inline struct inode *page2inode(struct page *page)
1359 {
1360         if (page->mapping) {
1361                 if (PageAnon(page))
1362                         return NULL;
1363                 else
1364                         return page->mapping->host;
1365         } else {
1366                 return NULL;
1367         }
1368 }
1369
1370 #endif /* __OBD_H */