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