1 /* 2 * Hodge-podge collection of knfsd-related stuff. 3 * I will sort this out later. 4 * 5 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de> 6 */ 7 8 #ifndef LINUX_NFSD_NFSD_H 9 #define LINUX_NFSD_NFSD_H 10 11 #include <linux/types.h> 12 #include <linux/mount.h> 13 14 #include <linux/nfs.h> 15 #include <linux/nfs2.h> 16 #include <linux/nfs3.h> 17 #include <linux/nfs4.h> 18 #include <linux/sunrpc/msg_prot.h> 19 20 #include <linux/nfsd/debug.h> 21 #include <linux/nfsd/export.h> 22 #include <linux/nfsd/stats.h> 23 24 /* 25 * nfsd version 26 */ 27 #define NFSD_SUPPORTED_MINOR_VERSION 1 28 /* 29 * Maximum blocksizes supported by daemon under various circumstances. 30 */ 31 #define NFSSVC_MAXBLKSIZE RPCSVC_MAXPAYLOAD 32 /* NFSv2 is limited by the protocol specification, see RFC 1094 */ 33 #define NFSSVC_MAXBLKSIZE_V2 (8*1024) 34 35 36 /* 37 * Largest number of bytes we need to allocate for an NFS 38 * call or reply. Used to control buffer sizes. We use 39 * the length of v3 WRITE, READDIR and READDIR replies 40 * which are an RPC header, up to 26 XDR units of reply 41 * data, and some page data. 42 * 43 * Note that accuracy here doesn't matter too much as the 44 * size is rounded up to a page size when allocating space. 45 */ 46 #define NFSD_BUFSIZE ((RPC_MAX_HEADER_WITH_AUTH+26)*XDR_UNIT + NFSSVC_MAXBLKSIZE) 47 48 struct readdir_cd { 49 __be32 err; /* 0, nfserr, or nfserr_eof */ 50 }; 51 52 53 extern struct svc_program nfsd_program; 54 extern struct svc_version nfsd_version2, nfsd_version3, 55 nfsd_version4; 56 extern u32 nfsd_supported_minorversion; 57 extern struct mutex nfsd_mutex; 58 extern struct svc_serv *nfsd_serv; 59 extern spinlock_t nfsd_drc_lock; 60 extern unsigned int nfsd_drc_max_mem; 61 extern unsigned int nfsd_drc_mem_used; 62 63 extern const struct seq_operations nfs_exports_op; 64 65 /* 66 * Function prototypes. 67 */ 68 int nfsd_svc(int nrservs); 69 int nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp); 70 71 int nfsd_nrthreads(void); 72 int nfsd_nrpools(void); 73 int nfsd_get_nrthreads(int n, int *); 74 int nfsd_set_nrthreads(int n, int *); 75 int nfsd_pool_stats_open(struct inode *, struct file *); 76 int nfsd_pool_stats_release(struct inode *, struct file *); 77 78 static inline void nfsd_destroy(struct net *net) 79 { 80 int destroy = (nfsd_serv->sv_nrthreads == 1); 81 82 if (destroy) 83 svc_shutdown_net(nfsd_serv, net); 84 svc_destroy(nfsd_serv); 85 if (destroy) 86 nfsd_serv = NULL; 87 } 88 89 #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL) 90 #ifdef CONFIG_NFSD_V2_ACL 91 extern struct svc_version nfsd_acl_version2; 92 #else 93 #define nfsd_acl_version2 NULL 94 #endif 95 #ifdef CONFIG_NFSD_V3_ACL 96 extern struct svc_version nfsd_acl_version3; 97 #else 98 #define nfsd_acl_version3 NULL 99 #endif 100 #endif 101 102 enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL }; 103 int nfsd_vers(int vers, enum vers_op change); 104 int nfsd_minorversion(u32 minorversion, enum vers_op change); 105 void nfsd_reset_versions(void); 106 int nfsd_create_serv(void); 107 108 extern int nfsd_max_blksize; 109 110 static inline int nfsd_v4client(struct svc_rqst *rq) 111 { 112 return rq->rq_prog == NFS_PROGRAM && rq->rq_vers == 4; 113 } 114 115 /* 116 * NFSv4 State 117 */ 118 #ifdef CONFIG_NFSD_V4 119 extern unsigned int max_delegations; 120 void nfs4_state_init(void); 121 int nfsd4_init_slabs(void); 122 void nfsd4_free_slabs(void); 123 int nfs4_state_start(void); 124 void nfs4_state_shutdown(void); 125 void nfs4_reset_lease(time_t leasetime); 126 int nfs4_reset_recoverydir(char *recdir); 127 char * nfs4_recoverydir(void); 128 #else 129 static inline void nfs4_state_init(void) { } 130 static inline int nfsd4_init_slabs(void) { return 0; } 131 static inline void nfsd4_free_slabs(void) { } 132 static inline int nfs4_state_start(void) { return 0; } 133 static inline void nfs4_state_shutdown(void) { } 134 static inline void nfs4_reset_lease(time_t leasetime) { } 135 static inline int nfs4_reset_recoverydir(char *recdir) { return 0; } 136 static inline char * nfs4_recoverydir(void) {return NULL; } 137 #endif 138 139 /* 140 * lockd binding 141 */ 142 void nfsd_lockd_init(void); 143 void nfsd_lockd_shutdown(void); 144 145 146 /* 147 * These macros provide pre-xdr'ed values for faster operation. 148 */ 149 #define nfs_ok cpu_to_be32(NFS_OK) 150 #define nfserr_perm cpu_to_be32(NFSERR_PERM) 151 #define nfserr_noent cpu_to_be32(NFSERR_NOENT) 152 #define nfserr_io cpu_to_be32(NFSERR_IO) 153 #define nfserr_nxio cpu_to_be32(NFSERR_NXIO) 154 #define nfserr_eagain cpu_to_be32(NFSERR_EAGAIN) 155 #define nfserr_acces cpu_to_be32(NFSERR_ACCES) 156 #define nfserr_exist cpu_to_be32(NFSERR_EXIST) 157 #define nfserr_xdev cpu_to_be32(NFSERR_XDEV) 158 #define nfserr_nodev cpu_to_be32(NFSERR_NODEV) 159 #define nfserr_notdir cpu_to_be32(NFSERR_NOTDIR) 160 #define nfserr_isdir cpu_to_be32(NFSERR_ISDIR) 161 #define nfserr_inval cpu_to_be32(NFSERR_INVAL) 162 #define nfserr_fbig cpu_to_be32(NFSERR_FBIG) 163 #define nfserr_nospc cpu_to_be32(NFSERR_NOSPC) 164 #define nfserr_rofs cpu_to_be32(NFSERR_ROFS) 165 #define nfserr_mlink cpu_to_be32(NFSERR_MLINK) 166 #define nfserr_opnotsupp cpu_to_be32(NFSERR_OPNOTSUPP) 167 #define nfserr_nametoolong cpu_to_be32(NFSERR_NAMETOOLONG) 168 #define nfserr_notempty cpu_to_be32(NFSERR_NOTEMPTY) 169 #define nfserr_dquot cpu_to_be32(NFSERR_DQUOT) 170 #define nfserr_stale cpu_to_be32(NFSERR_STALE) 171 #define nfserr_remote cpu_to_be32(NFSERR_REMOTE) 172 #define nfserr_wflush cpu_to_be32(NFSERR_WFLUSH) 173 #define nfserr_badhandle cpu_to_be32(NFSERR_BADHANDLE) 174 #define nfserr_notsync cpu_to_be32(NFSERR_NOT_SYNC) 175 #define nfserr_badcookie cpu_to_be32(NFSERR_BAD_COOKIE) 176 #define nfserr_notsupp cpu_to_be32(NFSERR_NOTSUPP) 177 #define nfserr_toosmall cpu_to_be32(NFSERR_TOOSMALL) 178 #define nfserr_serverfault cpu_to_be32(NFSERR_SERVERFAULT) 179 #define nfserr_badtype cpu_to_be32(NFSERR_BADTYPE) 180 #define nfserr_jukebox cpu_to_be32(NFSERR_JUKEBOX) 181 #define nfserr_denied cpu_to_be32(NFSERR_DENIED) 182 #define nfserr_deadlock cpu_to_be32(NFSERR_DEADLOCK) 183 #define nfserr_expired cpu_to_be32(NFSERR_EXPIRED) 184 #define nfserr_bad_cookie cpu_to_be32(NFSERR_BAD_COOKIE) 185 #define nfserr_same cpu_to_be32(NFSERR_SAME) 186 #define nfserr_clid_inuse cpu_to_be32(NFSERR_CLID_INUSE) 187 #define nfserr_stale_clientid cpu_to_be32(NFSERR_STALE_CLIENTID) 188 #define nfserr_resource cpu_to_be32(NFSERR_RESOURCE) 189 #define nfserr_moved cpu_to_be32(NFSERR_MOVED) 190 #define nfserr_nofilehandle cpu_to_be32(NFSERR_NOFILEHANDLE) 191 #define nfserr_minor_vers_mismatch cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH) 192 #define nfserr_share_denied cpu_to_be32(NFSERR_SHARE_DENIED) 193 #define nfserr_stale_stateid cpu_to_be32(NFSERR_STALE_STATEID) 194 #define nfserr_old_stateid cpu_to_be32(NFSERR_OLD_STATEID) 195 #define nfserr_bad_stateid cpu_to_be32(NFSERR_BAD_STATEID) 196 #define nfserr_bad_seqid cpu_to_be32(NFSERR_BAD_SEQID) 197 #define nfserr_symlink cpu_to_be32(NFSERR_SYMLINK) 198 #define nfserr_not_same cpu_to_be32(NFSERR_NOT_SAME) 199 #define nfserr_lock_range cpu_to_be32(NFSERR_LOCK_RANGE) 200 #define nfserr_restorefh cpu_to_be32(NFSERR_RESTOREFH) 201 #define nfserr_attrnotsupp cpu_to_be32(NFSERR_ATTRNOTSUPP) 202 #define nfserr_bad_xdr cpu_to_be32(NFSERR_BAD_XDR) 203 #define nfserr_openmode cpu_to_be32(NFSERR_OPENMODE) 204 #define nfserr_badowner cpu_to_be32(NFSERR_BADOWNER) 205 #define nfserr_locks_held cpu_to_be32(NFSERR_LOCKS_HELD) 206 #define nfserr_op_illegal cpu_to_be32(NFSERR_OP_ILLEGAL) 207 #define nfserr_grace cpu_to_be32(NFSERR_GRACE) 208 #define nfserr_no_grace cpu_to_be32(NFSERR_NO_GRACE) 209 #define nfserr_reclaim_bad cpu_to_be32(NFSERR_RECLAIM_BAD) 210 #define nfserr_badname cpu_to_be32(NFSERR_BADNAME) 211 #define nfserr_cb_path_down cpu_to_be32(NFSERR_CB_PATH_DOWN) 212 #define nfserr_locked cpu_to_be32(NFSERR_LOCKED) 213 #define nfserr_wrongsec cpu_to_be32(NFSERR_WRONGSEC) 214 #define nfserr_badiomode cpu_to_be32(NFS4ERR_BADIOMODE) 215 #define nfserr_badlayout cpu_to_be32(NFS4ERR_BADLAYOUT) 216 #define nfserr_bad_session_digest cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST) 217 #define nfserr_badsession cpu_to_be32(NFS4ERR_BADSESSION) 218 #define nfserr_badslot cpu_to_be32(NFS4ERR_BADSLOT) 219 #define nfserr_complete_already cpu_to_be32(NFS4ERR_COMPLETE_ALREADY) 220 #define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION) 221 #define nfserr_deleg_already_wanted cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED) 222 #define nfserr_back_chan_busy cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY) 223 #define nfserr_layouttrylater cpu_to_be32(NFS4ERR_LAYOUTTRYLATER) 224 #define nfserr_layoutunavailable cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE) 225 #define nfserr_nomatching_layout cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT) 226 #define nfserr_recallconflict cpu_to_be32(NFS4ERR_RECALLCONFLICT) 227 #define nfserr_unknown_layouttype cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE) 228 #define nfserr_seq_misordered cpu_to_be32(NFS4ERR_SEQ_MISORDERED) 229 #define nfserr_sequence_pos cpu_to_be32(NFS4ERR_SEQUENCE_POS) 230 #define nfserr_req_too_big cpu_to_be32(NFS4ERR_REQ_TOO_BIG) 231 #define nfserr_rep_too_big cpu_to_be32(NFS4ERR_REP_TOO_BIG) 232 #define nfserr_rep_too_big_to_cache cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE) 233 #define nfserr_retry_uncached_rep cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP) 234 #define nfserr_unsafe_compound cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND) 235 #define nfserr_too_many_ops cpu_to_be32(NFS4ERR_TOO_MANY_OPS) 236 #define nfserr_op_not_in_session cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION) 237 #define nfserr_hash_alg_unsupp cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP) 238 #define nfserr_clientid_busy cpu_to_be32(NFS4ERR_CLIENTID_BUSY) 239 #define nfserr_pnfs_io_hole cpu_to_be32(NFS4ERR_PNFS_IO_HOLE) 240 #define nfserr_seq_false_retry cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY) 241 #define nfserr_bad_high_slot cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT) 242 #define nfserr_deadsession cpu_to_be32(NFS4ERR_DEADSESSION) 243 #define nfserr_encr_alg_unsupp cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP) 244 #define nfserr_pnfs_no_layout cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT) 245 #define nfserr_not_only_op cpu_to_be32(NFS4ERR_NOT_ONLY_OP) 246 #define nfserr_wrong_cred cpu_to_be32(NFS4ERR_WRONG_CRED) 247 #define nfserr_wrong_type cpu_to_be32(NFS4ERR_WRONG_TYPE) 248 #define nfserr_dirdeleg_unavail cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL) 249 #define nfserr_reject_deleg cpu_to_be32(NFS4ERR_REJECT_DELEG) 250 #define nfserr_returnconflict cpu_to_be32(NFS4ERR_RETURNCONFLICT) 251 #define nfserr_deleg_revoked cpu_to_be32(NFS4ERR_DELEG_REVOKED) 252 253 /* error codes for internal use */ 254 /* if a request fails due to kmalloc failure, it gets dropped. 255 * Client should resend eventually 256 */ 257 #define nfserr_dropit cpu_to_be32(30000) 258 /* end-of-file indicator in readdir */ 259 #define nfserr_eof cpu_to_be32(30001) 260 /* replay detected */ 261 #define nfserr_replay_me cpu_to_be32(11001) 262 /* nfs41 replay detected */ 263 #define nfserr_replay_cache cpu_to_be32(11002) 264 265 /* Check for dir entries '.' and '..' */ 266 #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.')) 267 268 /* 269 * Time of server startup 270 */ 271 extern struct timeval nfssvc_boot; 272 273 #ifdef CONFIG_NFSD_V4 274 275 extern time_t nfsd4_lease; 276 extern time_t nfsd4_grace; 277 278 /* before processing a COMPOUND operation, we have to check that there 279 * is enough space in the buffer for XDR encode to succeed. otherwise, 280 * we might process an operation with side effects, and be unable to 281 * tell the client that the operation succeeded. 282 * 283 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space 284 * needed to encode an "ordinary" _successful_ operation. (GETATTR, 285 * READ, READDIR, and READLINK have their own buffer checks.) if we 286 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE. 287 * 288 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space 289 * needed to encode an operation which has failed with NFS4ERR_RESOURCE. 290 * care is taken to ensure that we never fall below this level for any 291 * reason. 292 */ 293 #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */ 294 #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */ 295 296 #define NFSD_LAUNDROMAT_MINTIMEOUT 1 /* seconds */ 297 298 /* 299 * The following attributes are currently not supported by the NFSv4 server: 300 * ARCHIVE (deprecated anyway) 301 * HIDDEN (unlikely to be supported any time soon) 302 * MIMETYPE (unlikely to be supported any time soon) 303 * QUOTA_* (will be supported in a forthcoming patch) 304 * SYSTEM (unlikely to be supported any time soon) 305 * TIME_BACKUP (unlikely to be supported any time soon) 306 * TIME_CREATE (unlikely to be supported any time soon) 307 */ 308 #define NFSD4_SUPPORTED_ATTRS_WORD0 \ 309 (FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \ 310 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \ 311 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \ 312 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \ 313 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \ 314 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \ 315 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \ 316 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \ 317 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \ 318 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL) 319 320 #define NFSD4_SUPPORTED_ATTRS_WORD1 \ 321 (FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \ 322 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \ 323 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \ 324 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \ 325 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \ 326 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID) 327 328 #define NFSD4_SUPPORTED_ATTRS_WORD2 0 329 330 #define NFSD4_1_SUPPORTED_ATTRS_WORD0 \ 331 NFSD4_SUPPORTED_ATTRS_WORD0 332 333 #define NFSD4_1_SUPPORTED_ATTRS_WORD1 \ 334 NFSD4_SUPPORTED_ATTRS_WORD1 335 336 #define NFSD4_1_SUPPORTED_ATTRS_WORD2 \ 337 (NFSD4_SUPPORTED_ATTRS_WORD2 | FATTR4_WORD2_SUPPATTR_EXCLCREAT) 338 339 static inline u32 nfsd_suppattrs0(u32 minorversion) 340 { 341 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD0 342 : NFSD4_SUPPORTED_ATTRS_WORD0; 343 } 344 345 static inline u32 nfsd_suppattrs1(u32 minorversion) 346 { 347 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD1 348 : NFSD4_SUPPORTED_ATTRS_WORD1; 349 } 350 351 static inline u32 nfsd_suppattrs2(u32 minorversion) 352 { 353 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD2 354 : NFSD4_SUPPORTED_ATTRS_WORD2; 355 } 356 357 /* These will return ERR_INVAL if specified in GETATTR or READDIR. */ 358 #define NFSD_WRITEONLY_ATTRS_WORD1 \ 359 (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET) 360 361 /* These are the only attrs allowed in CREATE/OPEN/SETATTR. */ 362 #define NFSD_WRITEABLE_ATTRS_WORD0 \ 363 (FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL) 364 #define NFSD_WRITEABLE_ATTRS_WORD1 \ 365 (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \ 366 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET) 367 #define NFSD_WRITEABLE_ATTRS_WORD2 0 368 369 #define NFSD_SUPPATTR_EXCLCREAT_WORD0 \ 370 NFSD_WRITEABLE_ATTRS_WORD0 371 /* 372 * we currently store the exclusive create verifier in the v_{a,m}time 373 * attributes so the client can't set these at create time using EXCLUSIVE4_1 374 */ 375 #define NFSD_SUPPATTR_EXCLCREAT_WORD1 \ 376 (NFSD_WRITEABLE_ATTRS_WORD1 & \ 377 ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)) 378 #define NFSD_SUPPATTR_EXCLCREAT_WORD2 \ 379 NFSD_WRITEABLE_ATTRS_WORD2 380 381 extern int nfsd4_is_junction(struct dentry *dentry); 382 extern int register_cld_notifier(void); 383 extern void unregister_cld_notifier(void); 384 #else /* CONFIG_NFSD_V4 */ 385 static inline int nfsd4_is_junction(struct dentry *dentry) 386 { 387 return 0; 388 } 389 390 #define register_cld_notifier() 0 391 #define unregister_cld_notifier() do { } while(0) 392 393 #endif /* CONFIG_NFSD_V4 */ 394 395 #endif /* LINUX_NFSD_NFSD_H */ 396