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 int nfs4_state_start_net(struct net *net); 125 void nfs4_state_shutdown(void); 126 void nfs4_state_shutdown_net(struct net *net); 127 void nfs4_reset_lease(time_t leasetime); 128 int nfs4_reset_recoverydir(char *recdir); 129 char * nfs4_recoverydir(void); 130 #else 131 static inline void nfs4_state_init(void) { } 132 static inline int nfsd4_init_slabs(void) { return 0; } 133 static inline void nfsd4_free_slabs(void) { } 134 static inline int nfs4_state_start(void) { return 0; } 135 static inline int nfs4_state_start_net(struct net *net) { return 0; } 136 static inline void nfs4_state_shutdown(void) { } 137 static inline void nfs4_state_shutdown_net(struct net *net) { } 138 static inline void nfs4_reset_lease(time_t leasetime) { } 139 static inline int nfs4_reset_recoverydir(char *recdir) { return 0; } 140 static inline char * nfs4_recoverydir(void) {return NULL; } 141 #endif 142 143 /* 144 * lockd binding 145 */ 146 void nfsd_lockd_init(void); 147 void nfsd_lockd_shutdown(void); 148 149 150 /* 151 * These macros provide pre-xdr'ed values for faster operation. 152 */ 153 #define nfs_ok cpu_to_be32(NFS_OK) 154 #define nfserr_perm cpu_to_be32(NFSERR_PERM) 155 #define nfserr_noent cpu_to_be32(NFSERR_NOENT) 156 #define nfserr_io cpu_to_be32(NFSERR_IO) 157 #define nfserr_nxio cpu_to_be32(NFSERR_NXIO) 158 #define nfserr_eagain cpu_to_be32(NFSERR_EAGAIN) 159 #define nfserr_acces cpu_to_be32(NFSERR_ACCES) 160 #define nfserr_exist cpu_to_be32(NFSERR_EXIST) 161 #define nfserr_xdev cpu_to_be32(NFSERR_XDEV) 162 #define nfserr_nodev cpu_to_be32(NFSERR_NODEV) 163 #define nfserr_notdir cpu_to_be32(NFSERR_NOTDIR) 164 #define nfserr_isdir cpu_to_be32(NFSERR_ISDIR) 165 #define nfserr_inval cpu_to_be32(NFSERR_INVAL) 166 #define nfserr_fbig cpu_to_be32(NFSERR_FBIG) 167 #define nfserr_nospc cpu_to_be32(NFSERR_NOSPC) 168 #define nfserr_rofs cpu_to_be32(NFSERR_ROFS) 169 #define nfserr_mlink cpu_to_be32(NFSERR_MLINK) 170 #define nfserr_opnotsupp cpu_to_be32(NFSERR_OPNOTSUPP) 171 #define nfserr_nametoolong cpu_to_be32(NFSERR_NAMETOOLONG) 172 #define nfserr_notempty cpu_to_be32(NFSERR_NOTEMPTY) 173 #define nfserr_dquot cpu_to_be32(NFSERR_DQUOT) 174 #define nfserr_stale cpu_to_be32(NFSERR_STALE) 175 #define nfserr_remote cpu_to_be32(NFSERR_REMOTE) 176 #define nfserr_wflush cpu_to_be32(NFSERR_WFLUSH) 177 #define nfserr_badhandle cpu_to_be32(NFSERR_BADHANDLE) 178 #define nfserr_notsync cpu_to_be32(NFSERR_NOT_SYNC) 179 #define nfserr_badcookie cpu_to_be32(NFSERR_BAD_COOKIE) 180 #define nfserr_notsupp cpu_to_be32(NFSERR_NOTSUPP) 181 #define nfserr_toosmall cpu_to_be32(NFSERR_TOOSMALL) 182 #define nfserr_serverfault cpu_to_be32(NFSERR_SERVERFAULT) 183 #define nfserr_badtype cpu_to_be32(NFSERR_BADTYPE) 184 #define nfserr_jukebox cpu_to_be32(NFSERR_JUKEBOX) 185 #define nfserr_denied cpu_to_be32(NFSERR_DENIED) 186 #define nfserr_deadlock cpu_to_be32(NFSERR_DEADLOCK) 187 #define nfserr_expired cpu_to_be32(NFSERR_EXPIRED) 188 #define nfserr_bad_cookie cpu_to_be32(NFSERR_BAD_COOKIE) 189 #define nfserr_same cpu_to_be32(NFSERR_SAME) 190 #define nfserr_clid_inuse cpu_to_be32(NFSERR_CLID_INUSE) 191 #define nfserr_stale_clientid cpu_to_be32(NFSERR_STALE_CLIENTID) 192 #define nfserr_resource cpu_to_be32(NFSERR_RESOURCE) 193 #define nfserr_moved cpu_to_be32(NFSERR_MOVED) 194 #define nfserr_nofilehandle cpu_to_be32(NFSERR_NOFILEHANDLE) 195 #define nfserr_minor_vers_mismatch cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH) 196 #define nfserr_share_denied cpu_to_be32(NFSERR_SHARE_DENIED) 197 #define nfserr_stale_stateid cpu_to_be32(NFSERR_STALE_STATEID) 198 #define nfserr_old_stateid cpu_to_be32(NFSERR_OLD_STATEID) 199 #define nfserr_bad_stateid cpu_to_be32(NFSERR_BAD_STATEID) 200 #define nfserr_bad_seqid cpu_to_be32(NFSERR_BAD_SEQID) 201 #define nfserr_symlink cpu_to_be32(NFSERR_SYMLINK) 202 #define nfserr_not_same cpu_to_be32(NFSERR_NOT_SAME) 203 #define nfserr_lock_range cpu_to_be32(NFSERR_LOCK_RANGE) 204 #define nfserr_restorefh cpu_to_be32(NFSERR_RESTOREFH) 205 #define nfserr_attrnotsupp cpu_to_be32(NFSERR_ATTRNOTSUPP) 206 #define nfserr_bad_xdr cpu_to_be32(NFSERR_BAD_XDR) 207 #define nfserr_openmode cpu_to_be32(NFSERR_OPENMODE) 208 #define nfserr_badowner cpu_to_be32(NFSERR_BADOWNER) 209 #define nfserr_locks_held cpu_to_be32(NFSERR_LOCKS_HELD) 210 #define nfserr_op_illegal cpu_to_be32(NFSERR_OP_ILLEGAL) 211 #define nfserr_grace cpu_to_be32(NFSERR_GRACE) 212 #define nfserr_no_grace cpu_to_be32(NFSERR_NO_GRACE) 213 #define nfserr_reclaim_bad cpu_to_be32(NFSERR_RECLAIM_BAD) 214 #define nfserr_badname cpu_to_be32(NFSERR_BADNAME) 215 #define nfserr_cb_path_down cpu_to_be32(NFSERR_CB_PATH_DOWN) 216 #define nfserr_locked cpu_to_be32(NFSERR_LOCKED) 217 #define nfserr_wrongsec cpu_to_be32(NFSERR_WRONGSEC) 218 #define nfserr_badiomode cpu_to_be32(NFS4ERR_BADIOMODE) 219 #define nfserr_badlayout cpu_to_be32(NFS4ERR_BADLAYOUT) 220 #define nfserr_bad_session_digest cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST) 221 #define nfserr_badsession cpu_to_be32(NFS4ERR_BADSESSION) 222 #define nfserr_badslot cpu_to_be32(NFS4ERR_BADSLOT) 223 #define nfserr_complete_already cpu_to_be32(NFS4ERR_COMPLETE_ALREADY) 224 #define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION) 225 #define nfserr_deleg_already_wanted cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED) 226 #define nfserr_back_chan_busy cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY) 227 #define nfserr_layouttrylater cpu_to_be32(NFS4ERR_LAYOUTTRYLATER) 228 #define nfserr_layoutunavailable cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE) 229 #define nfserr_nomatching_layout cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT) 230 #define nfserr_recallconflict cpu_to_be32(NFS4ERR_RECALLCONFLICT) 231 #define nfserr_unknown_layouttype cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE) 232 #define nfserr_seq_misordered cpu_to_be32(NFS4ERR_SEQ_MISORDERED) 233 #define nfserr_sequence_pos cpu_to_be32(NFS4ERR_SEQUENCE_POS) 234 #define nfserr_req_too_big cpu_to_be32(NFS4ERR_REQ_TOO_BIG) 235 #define nfserr_rep_too_big cpu_to_be32(NFS4ERR_REP_TOO_BIG) 236 #define nfserr_rep_too_big_to_cache cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE) 237 #define nfserr_retry_uncached_rep cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP) 238 #define nfserr_unsafe_compound cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND) 239 #define nfserr_too_many_ops cpu_to_be32(NFS4ERR_TOO_MANY_OPS) 240 #define nfserr_op_not_in_session cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION) 241 #define nfserr_hash_alg_unsupp cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP) 242 #define nfserr_clientid_busy cpu_to_be32(NFS4ERR_CLIENTID_BUSY) 243 #define nfserr_pnfs_io_hole cpu_to_be32(NFS4ERR_PNFS_IO_HOLE) 244 #define nfserr_seq_false_retry cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY) 245 #define nfserr_bad_high_slot cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT) 246 #define nfserr_deadsession cpu_to_be32(NFS4ERR_DEADSESSION) 247 #define nfserr_encr_alg_unsupp cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP) 248 #define nfserr_pnfs_no_layout cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT) 249 #define nfserr_not_only_op cpu_to_be32(NFS4ERR_NOT_ONLY_OP) 250 #define nfserr_wrong_cred cpu_to_be32(NFS4ERR_WRONG_CRED) 251 #define nfserr_wrong_type cpu_to_be32(NFS4ERR_WRONG_TYPE) 252 #define nfserr_dirdeleg_unavail cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL) 253 #define nfserr_reject_deleg cpu_to_be32(NFS4ERR_REJECT_DELEG) 254 #define nfserr_returnconflict cpu_to_be32(NFS4ERR_RETURNCONFLICT) 255 #define nfserr_deleg_revoked cpu_to_be32(NFS4ERR_DELEG_REVOKED) 256 257 /* error codes for internal use */ 258 /* if a request fails due to kmalloc failure, it gets dropped. 259 * Client should resend eventually 260 */ 261 #define nfserr_dropit cpu_to_be32(30000) 262 /* end-of-file indicator in readdir */ 263 #define nfserr_eof cpu_to_be32(30001) 264 /* replay detected */ 265 #define nfserr_replay_me cpu_to_be32(11001) 266 /* nfs41 replay detected */ 267 #define nfserr_replay_cache cpu_to_be32(11002) 268 269 /* Check for dir entries '.' and '..' */ 270 #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.')) 271 272 /* 273 * Time of server startup 274 */ 275 extern struct timeval nfssvc_boot; 276 277 #ifdef CONFIG_NFSD_V4 278 279 extern time_t nfsd4_grace; 280 281 /* before processing a COMPOUND operation, we have to check that there 282 * is enough space in the buffer for XDR encode to succeed. otherwise, 283 * we might process an operation with side effects, and be unable to 284 * tell the client that the operation succeeded. 285 * 286 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space 287 * needed to encode an "ordinary" _successful_ operation. (GETATTR, 288 * READ, READDIR, and READLINK have their own buffer checks.) if we 289 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE. 290 * 291 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space 292 * needed to encode an operation which has failed with NFS4ERR_RESOURCE. 293 * care is taken to ensure that we never fall below this level for any 294 * reason. 295 */ 296 #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */ 297 #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */ 298 299 #define NFSD_LAUNDROMAT_MINTIMEOUT 1 /* seconds */ 300 301 /* 302 * The following attributes are currently not supported by the NFSv4 server: 303 * ARCHIVE (deprecated anyway) 304 * HIDDEN (unlikely to be supported any time soon) 305 * MIMETYPE (unlikely to be supported any time soon) 306 * QUOTA_* (will be supported in a forthcoming patch) 307 * SYSTEM (unlikely to be supported any time soon) 308 * TIME_BACKUP (unlikely to be supported any time soon) 309 * TIME_CREATE (unlikely to be supported any time soon) 310 */ 311 #define NFSD4_SUPPORTED_ATTRS_WORD0 \ 312 (FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \ 313 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \ 314 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \ 315 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \ 316 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \ 317 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \ 318 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \ 319 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \ 320 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \ 321 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL) 322 323 #define NFSD4_SUPPORTED_ATTRS_WORD1 \ 324 (FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \ 325 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \ 326 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \ 327 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \ 328 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \ 329 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID) 330 331 #define NFSD4_SUPPORTED_ATTRS_WORD2 0 332 333 #define NFSD4_1_SUPPORTED_ATTRS_WORD0 \ 334 NFSD4_SUPPORTED_ATTRS_WORD0 335 336 #define NFSD4_1_SUPPORTED_ATTRS_WORD1 \ 337 NFSD4_SUPPORTED_ATTRS_WORD1 338 339 #define NFSD4_1_SUPPORTED_ATTRS_WORD2 \ 340 (NFSD4_SUPPORTED_ATTRS_WORD2 | FATTR4_WORD2_SUPPATTR_EXCLCREAT) 341 342 static inline u32 nfsd_suppattrs0(u32 minorversion) 343 { 344 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD0 345 : NFSD4_SUPPORTED_ATTRS_WORD0; 346 } 347 348 static inline u32 nfsd_suppattrs1(u32 minorversion) 349 { 350 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD1 351 : NFSD4_SUPPORTED_ATTRS_WORD1; 352 } 353 354 static inline u32 nfsd_suppattrs2(u32 minorversion) 355 { 356 return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD2 357 : NFSD4_SUPPORTED_ATTRS_WORD2; 358 } 359 360 /* These will return ERR_INVAL if specified in GETATTR or READDIR. */ 361 #define NFSD_WRITEONLY_ATTRS_WORD1 \ 362 (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET) 363 364 /* These are the only attrs allowed in CREATE/OPEN/SETATTR. */ 365 #define NFSD_WRITEABLE_ATTRS_WORD0 \ 366 (FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL) 367 #define NFSD_WRITEABLE_ATTRS_WORD1 \ 368 (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \ 369 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET) 370 #define NFSD_WRITEABLE_ATTRS_WORD2 0 371 372 #define NFSD_SUPPATTR_EXCLCREAT_WORD0 \ 373 NFSD_WRITEABLE_ATTRS_WORD0 374 /* 375 * we currently store the exclusive create verifier in the v_{a,m}time 376 * attributes so the client can't set these at create time using EXCLUSIVE4_1 377 */ 378 #define NFSD_SUPPATTR_EXCLCREAT_WORD1 \ 379 (NFSD_WRITEABLE_ATTRS_WORD1 & \ 380 ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)) 381 #define NFSD_SUPPATTR_EXCLCREAT_WORD2 \ 382 NFSD_WRITEABLE_ATTRS_WORD2 383 384 extern int nfsd4_is_junction(struct dentry *dentry); 385 extern int register_cld_notifier(void); 386 extern void unregister_cld_notifier(void); 387 #else /* CONFIG_NFSD_V4 */ 388 static inline int nfsd4_is_junction(struct dentry *dentry) 389 { 390 return 0; 391 } 392 393 #define register_cld_notifier() 0 394 #define unregister_cld_notifier() do { } while(0) 395 396 #endif /* CONFIG_NFSD_V4 */ 397 398 #endif /* LINUX_NFSD_NFSD_H */ 399