linux/include/linux/nfs_fs_sb.h
<<
>>
Prefs
   1#ifndef _NFS_FS_SB
   2#define _NFS_FS_SB
   3
   4#include <linux/list.h>
   5#include <linux/backing-dev.h>
   6#include <linux/idr.h>
   7#include <linux/wait.h>
   8#include <linux/nfs_xdr.h>
   9#include <linux/sunrpc/xprt.h>
  10
  11#include <linux/atomic.h>
  12
  13struct nfs4_session;
  14struct nfs_iostats;
  15struct nlm_host;
  16struct nfs4_sequence_args;
  17struct nfs4_sequence_res;
  18struct nfs_server;
  19struct nfs4_minor_version_ops;
  20struct nfs41_server_scope;
  21struct nfs41_impl_id;
  22
  23/*
  24 * The nfs_client identifies our client state to the server.
  25 */
  26struct nfs_client {
  27        atomic_t                cl_count;
  28        atomic_t                cl_mds_count;
  29        int                     cl_cons_state;  /* current construction state (-ve: init error) */
  30#define NFS_CS_READY            0               /* ready to be used */
  31#define NFS_CS_INITING          1               /* busy initialising */
  32#define NFS_CS_SESSION_INITING  2               /* busy initialising  session */
  33        unsigned long           cl_res_state;   /* NFS resources state */
  34#define NFS_CS_CALLBACK         1               /* - callback started */
  35#define NFS_CS_IDMAP            2               /* - idmap started */
  36#define NFS_CS_RENEWD           3               /* - renewd started */
  37#define NFS_CS_STOP_RENEW       4               /* no more state to renew */
  38#define NFS_CS_CHECK_LEASE_TIME 5               /* need to check lease time */
  39        unsigned long           cl_flags;       /* behavior switches */
  40#define NFS_CS_NORESVPORT       0               /* - use ephemeral src port */
  41#define NFS_CS_DISCRTRY         1               /* - disconnect on RPC retry */
  42#define NFS_CS_MIGRATION        2               /* - transparent state migr */
  43#define NFS_CS_INFINITE_SLOTS   3               /* - don't limit TCP slots */
  44#define NFS_CS_NO_RETRANS_TIMEOUT       4       /* - Disable retransmit timeouts */
  45        struct sockaddr_storage cl_addr;        /* server identifier */
  46        size_t                  cl_addrlen;
  47        char *                  cl_hostname;    /* hostname of server */
  48        char *                  cl_acceptor;    /* GSSAPI acceptor name */
  49        struct list_head        cl_share_link;  /* link in global client list */
  50        struct list_head        cl_superblocks; /* List of nfs_server structs */
  51
  52        struct rpc_clnt *       cl_rpcclient;
  53        const struct nfs_rpc_ops *rpc_ops;      /* NFS protocol vector */
  54        int                     cl_proto;       /* Network transport protocol */
  55        struct nfs_subversion * cl_nfs_mod;     /* pointer to nfs version module */
  56
  57        u32                     cl_minorversion;/* NFSv4 minorversion */
  58        struct rpc_cred         *cl_machine_cred;
  59
  60#if IS_ENABLED(CONFIG_NFS_V4)
  61        struct list_head        cl_ds_clients; /* auth flavor data servers */
  62        u64                     cl_clientid;    /* constant */
  63        nfs4_verifier           cl_confirm;     /* Clientid verifier */
  64        unsigned long           cl_state;
  65
  66        spinlock_t              cl_lock;
  67
  68        unsigned long           cl_lease_time;
  69        unsigned long           cl_last_renewal;
  70        struct delayed_work     cl_renewd;
  71
  72        struct rpc_wait_queue   cl_rpcwaitq;
  73
  74        /* idmapper */
  75        struct idmap *          cl_idmap;
  76
  77        /* Client owner identifier */
  78        const char *            cl_owner_id;
  79
  80        u32                     cl_cb_ident;    /* v4.0 callback identifier */
  81        const struct nfs4_minor_version_ops *cl_mvops;
  82        unsigned long           cl_mig_gen;
  83
  84        /* NFSv4.0 transport blocking */
  85        struct nfs4_slot_table  *cl_slot_tbl;
  86
  87        /* The sequence id to use for the next CREATE_SESSION */
  88        u32                     cl_seqid;
  89        /* The flags used for obtaining the clientid during EXCHANGE_ID */
  90        u32                     cl_exchange_flags;
  91        struct nfs4_session     *cl_session;    /* shared session */
  92        bool                    cl_preserve_clid;
  93        struct nfs41_server_owner *cl_serverowner;
  94        struct nfs41_server_scope *cl_serverscope;
  95        struct nfs41_impl_id    *cl_implid;
  96        /* nfs 4.1+ state protection modes: */
  97        unsigned long           cl_sp4_flags;
  98#define NFS_SP4_MACH_CRED_MINIMAL  1    /* Minimal sp4_mach_cred - state ops
  99                                         * must use machine cred */
 100#define NFS_SP4_MACH_CRED_CLEANUP  2    /* CLOSE and LOCKU */
 101#define NFS_SP4_MACH_CRED_SECINFO  3    /* SECINFO and SECINFO_NO_NAME */
 102#define NFS_SP4_MACH_CRED_STATEID  4    /* TEST_STATEID and FREE_STATEID */
 103#define NFS_SP4_MACH_CRED_WRITE    5    /* WRITE */
 104#define NFS_SP4_MACH_CRED_COMMIT   6    /* COMMIT */
 105#define NFS_SP4_MACH_CRED_PNFS_CLEANUP  7 /* LAYOUTRETURN */
 106#endif /* CONFIG_NFS_V4 */
 107
 108        /* Our own IP address, as a null-terminated string.
 109         * This is used to generate the mv0 callback address.
 110         */
 111        char                    cl_ipaddr[48];
 112
 113#ifdef CONFIG_NFS_FSCACHE
 114        struct fscache_cookie   *fscache;       /* client index cache cookie */
 115#endif
 116
 117        struct net              *cl_net;
 118};
 119
 120/*
 121 * NFS client parameters stored in the superblock.
 122 */
 123struct nfs_server {
 124        struct nfs_client *     nfs_client;     /* shared client and NFS4 state */
 125        struct list_head        client_link;    /* List of other nfs_server structs
 126                                                 * that share the same client
 127                                                 */
 128        struct list_head        master_link;    /* link in master servers list */
 129        struct rpc_clnt *       client;         /* RPC client handle */
 130        struct rpc_clnt *       client_acl;     /* ACL RPC client handle */
 131        struct nlm_host         *nlm_host;      /* NLM client handle */
 132        struct nfs_iostats __percpu *io_stats;  /* I/O statistics */
 133        struct backing_dev_info backing_dev_info;
 134        atomic_long_t           writeback;      /* number of writeback pages */
 135        int                     flags;          /* various flags */
 136        unsigned int            caps;           /* server capabilities */
 137        unsigned int            rsize;          /* read size */
 138        unsigned int            rpages;         /* read size (in pages) */
 139        unsigned int            wsize;          /* write size */
 140        unsigned int            wpages;         /* write size (in pages) */
 141        unsigned int            wtmult;         /* server disk block size */
 142        unsigned int            dtsize;         /* readdir size */
 143        unsigned short          port;           /* "port=" setting */
 144        unsigned int            bsize;          /* server block size */
 145        unsigned int            acregmin;       /* attr cache timeouts */
 146        unsigned int            acregmax;
 147        unsigned int            acdirmin;
 148        unsigned int            acdirmax;
 149        unsigned int            namelen;
 150        unsigned int            options;        /* extra options enabled by mount */
 151        unsigned int            clone_blksize;  /* granularity of a CLONE operation */
 152#define NFS_OPTION_FSCACHE      0x00000001      /* - local caching enabled */
 153#define NFS_OPTION_MIGRATION    0x00000002      /* - NFSv4 migration enabled */
 154
 155        struct nfs_fsid         fsid;
 156        __u64                   maxfilesize;    /* maximum file size */
 157        struct timespec         time_delta;     /* smallest time granularity */
 158        unsigned long           mount_time;     /* when this fs was mounted */
 159        struct super_block      *super;         /* VFS super block */
 160        dev_t                   s_dev;          /* superblock dev numbers */
 161        struct nfs_auth_info    auth_info;      /* parsed auth flavors */
 162
 163#ifdef CONFIG_NFS_FSCACHE
 164        struct nfs_fscache_key  *fscache_key;   /* unique key for superblock */
 165        struct fscache_cookie   *fscache;       /* superblock cookie */
 166#endif
 167
 168        u32                     pnfs_blksize;   /* layout_blksize attr */
 169#if IS_ENABLED(CONFIG_NFS_V4)
 170        u32                     attr_bitmask[3];/* V4 bitmask representing the set
 171                                                   of attributes supported on this
 172                                                   filesystem */
 173        u32                     attr_bitmask_nl[3];
 174                                                /* V4 bitmask representing the
 175                                                   set of attributes supported
 176                                                   on this filesystem excluding
 177                                                   the label support bit. */
 178        u32                     exclcreat_bitmask[3];
 179                                                /* V4 bitmask representing the
 180                                                   set of attributes supported
 181                                                   on this filesystem for the
 182                                                   exclusive create. */
 183        u32                     cache_consistency_bitmask[3];
 184                                                /* V4 bitmask representing the subset
 185                                                   of change attribute, size, ctime
 186                                                   and mtime attributes supported by
 187                                                   the server */
 188        u32                     acl_bitmask;    /* V4 bitmask representing the ACEs
 189                                                   that are supported on this
 190                                                   filesystem */
 191        u32                     fh_expire_type; /* V4 bitmask representing file
 192                                                   handle volatility type for
 193                                                   this filesystem */
 194        struct pnfs_layoutdriver_type  *pnfs_curr_ld; /* Active layout driver */
 195        struct rpc_wait_queue   roc_rpcwaitq;
 196        void                    *pnfs_ld_data;  /* per mount point data */
 197
 198        /* the following fields are protected by nfs_client->cl_lock */
 199        struct rb_root          state_owners;
 200#endif
 201        struct ida              openowner_id;
 202        struct ida              lockowner_id;
 203        struct list_head        state_owners_lru;
 204        struct list_head        layouts;
 205        struct list_head        delegations;
 206
 207        unsigned long           mig_gen;
 208        unsigned long           mig_status;
 209#define NFS_MIG_IN_TRANSITION           (1)
 210#define NFS_MIG_FAILED                  (2)
 211
 212        void (*destroy)(struct nfs_server *);
 213
 214        atomic_t active; /* Keep trace of any activity to this server */
 215
 216        /* mountd-related mount options */
 217        struct sockaddr_storage mountd_address;
 218        size_t                  mountd_addrlen;
 219        u32                     mountd_version;
 220        unsigned short          mountd_port;
 221        unsigned short          mountd_protocol;
 222};
 223
 224/* Server capabilities */
 225#define NFS_CAP_READDIRPLUS     (1U << 0)
 226#define NFS_CAP_HARDLINKS       (1U << 1)
 227#define NFS_CAP_SYMLINKS        (1U << 2)
 228#define NFS_CAP_ACLS            (1U << 3)
 229#define NFS_CAP_ATOMIC_OPEN     (1U << 4)
 230/* #define NFS_CAP_CHANGE_ATTR  (1U << 5) */
 231#define NFS_CAP_FILEID          (1U << 6)
 232#define NFS_CAP_MODE            (1U << 7)
 233#define NFS_CAP_NLINK           (1U << 8)
 234#define NFS_CAP_OWNER           (1U << 9)
 235#define NFS_CAP_OWNER_GROUP     (1U << 10)
 236#define NFS_CAP_ATIME           (1U << 11)
 237#define NFS_CAP_CTIME           (1U << 12)
 238#define NFS_CAP_MTIME           (1U << 13)
 239#define NFS_CAP_POSIX_LOCK      (1U << 14)
 240#define NFS_CAP_UIDGID_NOMAP    (1U << 15)
 241#define NFS_CAP_STATEID_NFSV41  (1U << 16)
 242#define NFS_CAP_ATOMIC_OPEN_V1  (1U << 17)
 243#define NFS_CAP_SECURITY_LABEL  (1U << 18)
 244#define NFS_CAP_SEEK            (1U << 19)
 245#define NFS_CAP_ALLOCATE        (1U << 20)
 246#define NFS_CAP_DEALLOCATE      (1U << 21)
 247#define NFS_CAP_LAYOUTSTATS     (1U << 22)
 248#define NFS_CAP_CLONE           (1U << 23)
 249#define NFS_CAP_COPY            (1U << 24)
 250
 251#endif
 252