include/linux/nfs_fs_sb.h

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