1/* 2 * linux/include/linux/nfsd/nfsd.h 3 * 4 * Hodge-podge collection of knfsd-related stuff. 5 * I will sort this out later. 6 * 7 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de> 8 */ 9 10#ifndef LINUX_NFSD_NFSD_H 11#define LINUX_NFSD_NFSD_H 12 13#include <linux/config.h> 14#include <linux/types.h> 15#include <linux/unistd.h> 16#include <linux/dirent.h> 17#include <linux/fs.h> 18 19#include <linux/nfsd/debug.h> 20#include <linux/nfsd/nfsfh.h> 21#include <linux/nfsd/export.h> 22#include <linux/nfsd/auth.h> 23#include <linux/nfsd/stats.h> 24#include <linux/nfsd/interface.h> 25/* 26 * nfsd version 27 */ 28#define NFSD_VERSION "0.5" 29#define NFSD_SUPPORTED_MINOR_VERSION 0 30 31#ifdef __KERNEL__ 32/* 33 * Special flags for nfsd_permission. These must be different from MAY_READ, 34 * MAY_WRITE, and MAY_EXEC. 35 */ 36#define MAY_NOP 0 37#define MAY_SATTR 8 38#define MAY_TRUNC 16 39#define MAY_LOCK 32 40#define MAY_OWNER_OVERRIDE 64 41#define MAY_LOCAL_ACCESS 128 /* IRIX doing local access check on device special file*/ 42#if (MAY_SATTR | MAY_TRUNC | MAY_LOCK | MAY_OWNER_OVERRIDE | MAY_LOCAL_ACCESS) & (MAY_READ | MAY_WRITE | MAY_EXEC) 43# error "please use a different value for MAY_SATTR or MAY_TRUNC or MAY_LOCK or MAY_OWNER_OVERRIDE." 44#endif 45#define MAY_CREATE (MAY_EXEC|MAY_WRITE) 46#define MAY_REMOVE (MAY_EXEC|MAY_WRITE|MAY_TRUNC) 47 48/* 49 * Callback function for readdir 50 */ 51struct readdir_cd { 52 int err; /* 0, nfserr, or nfserr_eof */ 53}; 54typedef int (*encode_dent_fn)(struct readdir_cd *, const char *, 55 int, loff_t, ino_t, unsigned int); 56typedef int (*nfsd_dirop_t)(struct inode *, struct dentry *, int, int); 57 58extern struct svc_program nfsd_program; 59extern struct svc_version nfsd_version2, nfsd_version3, 60 nfsd_version4; 61 62/* 63 * Function prototypes. 64 */ 65int nfsd_svc(unsigned short port, int nrservs); 66int nfsd_dispatch(struct svc_rqst *rqstp, u32 *statp); 67 68/* nfsd/vfs.c */ 69int fh_lock_parent(struct svc_fh *, struct dentry *); 70int nfsd_racache_init(int); 71void nfsd_racache_shutdown(void); 72int nfsd_lookup(struct svc_rqst *, struct svc_fh *, 73 const char *, int, struct svc_fh *); 74int nfsd_setattr(struct svc_rqst *, struct svc_fh *, 75 struct iattr *, int, time_t); 76int nfsd_create(struct svc_rqst *, struct svc_fh *, 77 char *name, int len, struct iattr *attrs, 78 int type, dev_t rdev, struct svc_fh *res); 79#ifdef CONFIG_NFSD_V3 80int nfsd_access(struct svc_rqst *, struct svc_fh *, u32 *, u32 *); 81int nfsd_create_v3(struct svc_rqst *, struct svc_fh *, 82 char *name, int len, struct iattr *attrs, 83 struct svc_fh *res, int createmode, 84 u32 *verifier, int *truncp); 85int nfsd_commit(struct svc_rqst *, struct svc_fh *, 86 off_t, unsigned long); 87#endif /* CONFIG_NFSD_V3 */ 88int nfsd_open(struct svc_rqst *, struct svc_fh *, int, 89 int, struct file *); 90void nfsd_close(struct file *); 91int nfsd_read(struct svc_rqst *, struct svc_fh *, 92 loff_t, struct iovec *,int, unsigned long *); 93int nfsd_write(struct svc_rqst *, struct svc_fh *, 94 loff_t, struct iovec *,int, unsigned long, int *); 95int nfsd_readlink(struct svc_rqst *, struct svc_fh *, 96 char *, int *); 97int nfsd_symlink(struct svc_rqst *, struct svc_fh *, 98 char *name, int len, char *path, int plen, 99 struct svc_fh *res, struct iattr *); 100int nfsd_link(struct svc_rqst *, struct svc_fh *, 101 char *, int, struct svc_fh *); 102int nfsd_rename(struct svc_rqst *, 103 struct svc_fh *, char *, int, 104 struct svc_fh *, char *, int); 105int nfsd_remove(struct svc_rqst *, 106 struct svc_fh *, char *, int); 107int nfsd_unlink(struct svc_rqst *, struct svc_fh *, int type, 108 char *name, int len); 109int nfsd_truncate(struct svc_rqst *, struct svc_fh *, 110 unsigned long size); 111int nfsd_readdir(struct svc_rqst *, struct svc_fh *, 112 loff_t *, struct readdir_cd *, encode_dent_fn); 113int nfsd_statfs(struct svc_rqst *, struct svc_fh *, 114 struct statfs *); 115 116int nfsd_notify_change(struct inode *, struct iattr *); 117int nfsd_permission(struct svc_export *, struct dentry *, int); 118 119 120/* 121 * NFSv4 State 122 */ 123#ifdef CONFIG_NFSD_V4 124void nfs4_state_init(void); 125void nfs4_state_shutdown(void); 126#else 127void static inline nfs4_state_init(void){} 128void static inline nfs4_state_shutdown(void){} 129#endif 130 131/* 132 * lockd binding 133 */ 134void nfsd_lockd_init(void); 135void nfsd_lockd_shutdown(void); 136 137 138/* 139 * These macros provide pre-xdr'ed values for faster operation. 140 */ 141#define nfs_ok __constant_htonl(NFS_OK) 142#define nfserr_perm __constant_htonl(NFSERR_PERM) 143#define nfserr_noent __constant_htonl(NFSERR_NOENT) 144#define nfserr_io __constant_htonl(NFSERR_IO) 145#define nfserr_nxio __constant_htonl(NFSERR_NXIO) 146#define nfserr_eagain __constant_htonl(NFSERR_EAGAIN) 147#define nfserr_acces __constant_htonl(NFSERR_ACCES) 148#define nfserr_exist __constant_htonl(NFSERR_EXIST) 149#define nfserr_xdev __constant_htonl(NFSERR_XDEV) 150#define nfserr_nodev __constant_htonl(NFSERR_NODEV) 151#define nfserr_notdir __constant_htonl(NFSERR_NOTDIR) 152#define nfserr_isdir __constant_htonl(NFSERR_ISDIR) 153#define nfserr_inval __constant_htonl(NFSERR_INVAL) 154#define nfserr_fbig __constant_htonl(NFSERR_FBIG) 155#define nfserr_nospc __constant_htonl(NFSERR_NOSPC) 156#define nfserr_rofs __constant_htonl(NFSERR_ROFS) 157#define nfserr_mlink __constant_htonl(NFSERR_MLINK) 158#define nfserr_opnotsupp __constant_htonl(NFSERR_OPNOTSUPP) 159#define nfserr_nametoolong __constant_htonl(NFSERR_NAMETOOLONG) 160#define nfserr_notempty __constant_htonl(NFSERR_NOTEMPTY) 161#define nfserr_dquot __constant_htonl(NFSERR_DQUOT) 162#define nfserr_stale __constant_htonl(NFSERR_STALE) 163#define nfserr_remote __constant_htonl(NFSERR_REMOTE) 164#define nfserr_wflush __constant_htonl(NFSERR_WFLUSH) 165#define nfserr_badhandle __constant_htonl(NFSERR_BADHANDLE) 166#define nfserr_notsync __constant_htonl(NFSERR_NOT_SYNC) 167#define nfserr_badcookie __constant_htonl(NFSERR_BAD_COOKIE) 168#define nfserr_notsupp __constant_htonl(NFSERR_NOTSUPP) 169#define nfserr_toosmall __constant_htonl(NFSERR_TOOSMALL) 170#define nfserr_serverfault __constant_htonl(NFSERR_SERVERFAULT) 171#define nfserr_badtype __constant_htonl(NFSERR_BADTYPE) 172#define nfserr_jukebox __constant_htonl(NFSERR_JUKEBOX) 173#define nfserr_bad_cookie __constant_htonl(NFSERR_BAD_COOKIE) 174#define nfserr_same __constant_htonl(NFSERR_SAME) 175#define nfserr_clid_inuse __constant_htonl(NFSERR_CLID_INUSE) 176#define nfserr_stale_clientid __constant_htonl(NFSERR_STALE_CLIENTID) 177#define nfserr_resource __constant_htonl(NFSERR_RESOURCE) 178#define nfserr_nofilehandle __constant_htonl(NFSERR_NOFILEHANDLE) 179#define nfserr_minor_vers_mismatch __constant_htonl(NFSERR_MINOR_VERS_MISMATCH) 180#define nfserr_symlink __constant_htonl(NFSERR_SYMLINK) 181#define nfserr_not_same __constant_htonl(NFSERR_NOT_SAME) 182#define nfserr_readdir_nospc __constant_htonl(NFSERR_READDIR_NOSPC) 183#define nfserr_bad_xdr __constant_htonl(NFSERR_BAD_XDR) 184 185/* error codes for internal use */ 186/* if a request fails due to kmalloc failure, it gets dropped. 187 * Client should resend eventually 188 */ 189#define nfserr_dropit __constant_htonl(30000) 190/* end-of-file indicator in readdir */ 191#define nfserr_eof __constant_htonl(30001) 192 193/* Check for dir entries '.' and '..' */ 194#define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.')) 195 196/* 197 * Time of server startup 198 */ 199extern struct timeval nfssvc_boot; 200 201 202#ifdef CONFIG_NFSD_V4 203 204/* before processing a COMPOUND operation, we have to check that there 205 * is enough space in the buffer for XDR encode to succeed. otherwise, 206 * we might process an operation with side effects, and be unable to 207 * tell the client that the operation succeeded. 208 * 209 * COMPOUND_SLACK_SPACE - this is the minimum amount of buffer space 210 * needed to encode an "ordinary" _successful_ operation. (GETATTR, 211 * READ, READDIR, and READLINK have their own buffer checks.) if we 212 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE. 213 * 214 * COMPOUND_ERR_SLACK_SPACE - this is the minimum amount of buffer space 215 * needed to encode an operation which has failed with NFS4ERR_RESOURCE. 216 * care is taken to ensure that we never fall below this level for any 217 * reason. 218 */ 219#define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */ 220#define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */ 221 222#define NFSD_LEASE_TIME 60 /* seconds */ 223 224/* 225 * The following attributes are currently not supported by the NFSv4 server: 226 * ACL (will be supported in a forthcoming patch) 227 * ARCHIVE (deprecated anyway) 228 * FS_LOCATIONS (will be supported eventually) 229 * HIDDEN (unlikely to be supported any time soon) 230 * MIMETYPE (unlikely to be supported any time soon) 231 * QUOTA_* (will be supported in a forthcoming patch) 232 * SYSTEM (unlikely to be supported any time soon) 233 * TIME_BACKUP (unlikely to be supported any time soon) 234 * TIME_CREATE (unlikely to be supported any time soon) 235 */ 236#define NFSD_SUPPORTED_ATTRS_WORD0 \ 237(FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \ 238 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \ 239 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \ 240 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \ 241 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \ 242 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \ 243 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \ 244 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_HOMOGENEOUS \ 245 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \ 246 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE) 247 248#define NFSD_SUPPORTED_ATTRS_WORD1 \ 249(FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \ 250 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \ 251 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \ 252 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \ 253 | FATTR4_WORD1_TIME_CREATE | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \ 254 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET) 255 256/* These will return ERR_INVAL if specified in GETATTR or READDIR. */ 257#define NFSD_WRITEONLY_ATTRS_WORD1 \ 258(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET) 259 260/* These are the only attrs allowed in CREATE/OPEN/SETATTR. */ 261#define NFSD_WRITEABLE_ATTRS_WORD0 FATTR4_WORD0_SIZE 262#define NFSD_WRITEABLE_ATTRS_WORD1 \ 263(FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \ 264 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_METADATA | FATTR4_WORD1_TIME_MODIFY_SET) 265 266#endif /* CONFIG_NFSD_V4 */ 267 268#endif /* __KERNEL__ */ 269 270#endif /* LINUX_NFSD_NFSD_H */ 271