Linux Audio

Check our new training course

Loading...
v6.2
  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * Hodge-podge collection of knfsd-related stuff.
  4 * I will sort this out later.
  5 *
  6 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
  7 */
  8
  9#ifndef LINUX_NFSD_NFSD_H
 10#define LINUX_NFSD_NFSD_H
 11
 12#include <linux/types.h>
 13#include <linux/mount.h>
 14
 15#include <linux/nfs.h>
 16#include <linux/nfs2.h>
 17#include <linux/nfs3.h>
 18#include <linux/nfs4.h>
 19#include <linux/sunrpc/svc.h>
 20#include <linux/sunrpc/svc_xprt.h>
 21#include <linux/sunrpc/msg_prot.h>
 22#include <linux/sunrpc/addr.h>
 23
 24#include <uapi/linux/nfsd/debug.h>
 25
 26#include "netns.h"
 27#include "export.h"
 28#include "stats.h"
 29
 30#undef ifdebug
 31#ifdef CONFIG_SUNRPC_DEBUG
 32# define ifdebug(flag)		if (nfsd_debug & NFSDDBG_##flag)
 33#else
 34# define ifdebug(flag)		if (0)
 35#endif
 36
 37/*
 38 * nfsd version
 39 */
 
 
 40#define NFSD_SUPPORTED_MINOR_VERSION	2
 
 
 
 
 
 41/*
 42 * Maximum blocksizes supported by daemon under various circumstances.
 43 */
 44#define NFSSVC_MAXBLKSIZE       RPCSVC_MAXPAYLOAD
 45/* NFSv2 is limited by the protocol specification, see RFC 1094 */
 46#define NFSSVC_MAXBLKSIZE_V2    (8*1024)
 47
 48
 49/*
 50 * Largest number of bytes we need to allocate for an NFS
 51 * call or reply.  Used to control buffer sizes.  We use
 52 * the length of v3 WRITE, READDIR and READDIR replies
 53 * which are an RPC header, up to 26 XDR units of reply
 54 * data, and some page data.
 55 *
 56 * Note that accuracy here doesn't matter too much as the
 57 * size is rounded up to a page size when allocating space.
 58 */
 59#define NFSD_BUFSIZE            ((RPC_MAX_HEADER_WITH_AUTH+26)*XDR_UNIT + NFSSVC_MAXBLKSIZE)
 60
 61struct readdir_cd {
 62	__be32			err;	/* 0, nfserr, or nfserr_eof */
 63};
 64
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 65
 66extern struct svc_program	nfsd_program;
 67extern const struct svc_version	nfsd_version2, nfsd_version3, nfsd_version4;
 68extern struct mutex		nfsd_mutex;
 69extern spinlock_t		nfsd_drc_lock;
 70extern unsigned long		nfsd_drc_max_mem;
 71extern unsigned long		nfsd_drc_mem_used;
 
 72
 73extern const struct seq_operations nfs_exports_op;
 74
 75/*
 76 * Common void argument and result helpers
 77 */
 78struct nfsd_voidargs { };
 79struct nfsd_voidres { };
 80bool		nfssvc_decode_voidarg(struct svc_rqst *rqstp,
 81				      struct xdr_stream *xdr);
 82bool		nfssvc_encode_voidres(struct svc_rqst *rqstp,
 83				      struct xdr_stream *xdr);
 84
 85/*
 86 * Function prototypes.
 87 */
 88int		nfsd_svc(int nrservs, struct net *net, const struct cred *cred);
 89int		nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
 
 90
 91int		nfsd_nrthreads(struct net *);
 92int		nfsd_nrpools(struct net *);
 93int		nfsd_get_nrthreads(int n, int *, struct net *);
 94int		nfsd_set_nrthreads(int n, int *, struct net *);
 95int		nfsd_pool_stats_open(struct inode *, struct file *);
 96int		nfsd_pool_stats_release(struct inode *, struct file *);
 97void		nfsd_shutdown_threads(struct net *net);
 98
 99void		nfsd_put(struct net *net);
100
101bool		i_am_nfsd(void);
102
103struct nfsdfs_client {
104	struct kref cl_ref;
105	void (*cl_release)(struct kref *kref);
106};
107
108struct nfsdfs_client *get_nfsdfs_client(struct inode *);
109struct dentry *nfsd_client_mkdir(struct nfsd_net *nn,
110				 struct nfsdfs_client *ncl, u32 id,
111				 const struct tree_descr *,
112				 struct dentry **fdentries);
113void nfsd_client_rmdir(struct dentry *dentry);
114
115
116#if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
117#ifdef CONFIG_NFSD_V2_ACL
118extern const struct svc_version nfsd_acl_version2;
119#else
120#define nfsd_acl_version2 NULL
121#endif
122#ifdef CONFIG_NFSD_V3_ACL
123extern const struct svc_version nfsd_acl_version3;
124#else
125#define nfsd_acl_version3 NULL
126#endif
127#endif
128
 
 
 
 
129struct nfsd_net;
130
131enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
132int nfsd_vers(struct nfsd_net *nn, int vers, enum vers_op change);
133int nfsd_minorversion(struct nfsd_net *nn, u32 minorversion, enum vers_op change);
134void nfsd_reset_versions(struct nfsd_net *nn);
135int nfsd_create_serv(struct net *net);
 
136
137extern int nfsd_max_blksize;
138
139static inline int nfsd_v4client(struct svc_rqst *rq)
140{
141	return rq->rq_prog == NFS_PROGRAM && rq->rq_vers == 4;
142}
143static inline struct user_namespace *
144nfsd_user_namespace(const struct svc_rqst *rqstp)
145{
146	const struct cred *cred = rqstp->rq_xprt->xpt_cred;
147	return cred ? cred->user_ns : &init_user_ns;
148}
149
150/* 
151 * NFSv4 State
152 */
153#ifdef CONFIG_NFSD_V4
154extern unsigned long max_delegations;
155int nfsd4_init_slabs(void);
156void nfsd4_free_slabs(void);
157int nfs4_state_start(void);
158int nfs4_state_start_net(struct net *net);
159void nfs4_state_shutdown(void);
160void nfs4_state_shutdown_net(struct net *net);
161int nfs4_reset_recoverydir(char *recdir);
162char * nfs4_recoverydir(void);
163bool nfsd4_spo_must_allow(struct svc_rqst *rqstp);
164int nfsd4_create_laundry_wq(void);
165void nfsd4_destroy_laundry_wq(void);
166bool nfsd_wait_for_delegreturn(struct svc_rqst *rqstp, struct inode *inode);
167#else
168static inline int nfsd4_init_slabs(void) { return 0; }
169static inline void nfsd4_free_slabs(void) { }
170static inline int nfs4_state_start(void) { return 0; }
171static inline int nfs4_state_start_net(struct net *net) { return 0; }
172static inline void nfs4_state_shutdown(void) { }
173static inline void nfs4_state_shutdown_net(struct net *net) { }
174static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
175static inline char * nfs4_recoverydir(void) {return NULL; }
176static inline bool nfsd4_spo_must_allow(struct svc_rqst *rqstp)
177{
178	return false;
179}
180static inline int nfsd4_create_laundry_wq(void) { return 0; };
181static inline void nfsd4_destroy_laundry_wq(void) {};
182static inline bool nfsd_wait_for_delegreturn(struct svc_rqst *rqstp,
183					      struct inode *inode)
184{
185	return false;
186}
187#endif
188
189/*
190 * lockd binding
191 */
192void		nfsd_lockd_init(void);
193void		nfsd_lockd_shutdown(void);
194
195
196/*
197 * These macros provide pre-xdr'ed values for faster operation.
198 */
199#define	nfs_ok			cpu_to_be32(NFS_OK)
200#define	nfserr_perm		cpu_to_be32(NFSERR_PERM)
201#define	nfserr_noent		cpu_to_be32(NFSERR_NOENT)
202#define	nfserr_io		cpu_to_be32(NFSERR_IO)
203#define	nfserr_nxio		cpu_to_be32(NFSERR_NXIO)
204#define	nfserr_eagain		cpu_to_be32(NFSERR_EAGAIN)
205#define	nfserr_acces		cpu_to_be32(NFSERR_ACCES)
206#define	nfserr_exist		cpu_to_be32(NFSERR_EXIST)
207#define	nfserr_xdev		cpu_to_be32(NFSERR_XDEV)
208#define	nfserr_nodev		cpu_to_be32(NFSERR_NODEV)
209#define	nfserr_notdir		cpu_to_be32(NFSERR_NOTDIR)
210#define	nfserr_isdir		cpu_to_be32(NFSERR_ISDIR)
211#define	nfserr_inval		cpu_to_be32(NFSERR_INVAL)
212#define	nfserr_fbig		cpu_to_be32(NFSERR_FBIG)
213#define	nfserr_nospc		cpu_to_be32(NFSERR_NOSPC)
214#define	nfserr_rofs		cpu_to_be32(NFSERR_ROFS)
215#define	nfserr_mlink		cpu_to_be32(NFSERR_MLINK)
216#define	nfserr_opnotsupp	cpu_to_be32(NFSERR_OPNOTSUPP)
217#define	nfserr_nametoolong	cpu_to_be32(NFSERR_NAMETOOLONG)
218#define	nfserr_notempty		cpu_to_be32(NFSERR_NOTEMPTY)
219#define	nfserr_dquot		cpu_to_be32(NFSERR_DQUOT)
220#define	nfserr_stale		cpu_to_be32(NFSERR_STALE)
221#define	nfserr_remote		cpu_to_be32(NFSERR_REMOTE)
222#define	nfserr_wflush		cpu_to_be32(NFSERR_WFLUSH)
223#define	nfserr_badhandle	cpu_to_be32(NFSERR_BADHANDLE)
224#define	nfserr_notsync		cpu_to_be32(NFSERR_NOT_SYNC)
225#define	nfserr_badcookie	cpu_to_be32(NFSERR_BAD_COOKIE)
226#define	nfserr_notsupp		cpu_to_be32(NFSERR_NOTSUPP)
227#define	nfserr_toosmall		cpu_to_be32(NFSERR_TOOSMALL)
228#define	nfserr_serverfault	cpu_to_be32(NFSERR_SERVERFAULT)
229#define	nfserr_badtype		cpu_to_be32(NFSERR_BADTYPE)
230#define	nfserr_jukebox		cpu_to_be32(NFSERR_JUKEBOX)
231#define	nfserr_denied		cpu_to_be32(NFSERR_DENIED)
232#define	nfserr_deadlock		cpu_to_be32(NFSERR_DEADLOCK)
233#define nfserr_expired          cpu_to_be32(NFSERR_EXPIRED)
234#define	nfserr_bad_cookie	cpu_to_be32(NFSERR_BAD_COOKIE)
235#define	nfserr_same		cpu_to_be32(NFSERR_SAME)
236#define	nfserr_clid_inuse	cpu_to_be32(NFSERR_CLID_INUSE)
237#define	nfserr_stale_clientid	cpu_to_be32(NFSERR_STALE_CLIENTID)
238#define	nfserr_resource		cpu_to_be32(NFSERR_RESOURCE)
239#define	nfserr_moved		cpu_to_be32(NFSERR_MOVED)
240#define	nfserr_nofilehandle	cpu_to_be32(NFSERR_NOFILEHANDLE)
241#define	nfserr_minor_vers_mismatch	cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH)
242#define nfserr_share_denied	cpu_to_be32(NFSERR_SHARE_DENIED)
243#define nfserr_stale_stateid	cpu_to_be32(NFSERR_STALE_STATEID)
244#define nfserr_old_stateid	cpu_to_be32(NFSERR_OLD_STATEID)
245#define nfserr_bad_stateid	cpu_to_be32(NFSERR_BAD_STATEID)
246#define nfserr_bad_seqid	cpu_to_be32(NFSERR_BAD_SEQID)
247#define	nfserr_symlink		cpu_to_be32(NFSERR_SYMLINK)
248#define	nfserr_not_same		cpu_to_be32(NFSERR_NOT_SAME)
249#define nfserr_lock_range	cpu_to_be32(NFSERR_LOCK_RANGE)
250#define	nfserr_restorefh	cpu_to_be32(NFSERR_RESTOREFH)
251#define	nfserr_attrnotsupp	cpu_to_be32(NFSERR_ATTRNOTSUPP)
252#define	nfserr_bad_xdr		cpu_to_be32(NFSERR_BAD_XDR)
253#define	nfserr_openmode		cpu_to_be32(NFSERR_OPENMODE)
254#define	nfserr_badowner		cpu_to_be32(NFSERR_BADOWNER)
255#define	nfserr_locks_held	cpu_to_be32(NFSERR_LOCKS_HELD)
256#define	nfserr_op_illegal	cpu_to_be32(NFSERR_OP_ILLEGAL)
257#define	nfserr_grace		cpu_to_be32(NFSERR_GRACE)
258#define	nfserr_no_grace		cpu_to_be32(NFSERR_NO_GRACE)
259#define	nfserr_reclaim_bad	cpu_to_be32(NFSERR_RECLAIM_BAD)
260#define	nfserr_badname		cpu_to_be32(NFSERR_BADNAME)
 
261#define	nfserr_cb_path_down	cpu_to_be32(NFSERR_CB_PATH_DOWN)
262#define	nfserr_locked		cpu_to_be32(NFSERR_LOCKED)
263#define	nfserr_wrongsec		cpu_to_be32(NFSERR_WRONGSEC)
264#define nfserr_badiomode		cpu_to_be32(NFS4ERR_BADIOMODE)
265#define nfserr_badlayout		cpu_to_be32(NFS4ERR_BADLAYOUT)
266#define nfserr_bad_session_digest	cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST)
267#define nfserr_badsession		cpu_to_be32(NFS4ERR_BADSESSION)
268#define nfserr_badslot			cpu_to_be32(NFS4ERR_BADSLOT)
269#define nfserr_complete_already		cpu_to_be32(NFS4ERR_COMPLETE_ALREADY)
270#define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
271#define nfserr_deleg_already_wanted	cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED)
272#define nfserr_back_chan_busy		cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY)
273#define nfserr_layouttrylater		cpu_to_be32(NFS4ERR_LAYOUTTRYLATER)
274#define nfserr_layoutunavailable	cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE)
275#define nfserr_nomatching_layout	cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT)
276#define nfserr_recallconflict		cpu_to_be32(NFS4ERR_RECALLCONFLICT)
277#define nfserr_unknown_layouttype	cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE)
278#define nfserr_seq_misordered		cpu_to_be32(NFS4ERR_SEQ_MISORDERED)
279#define nfserr_sequence_pos		cpu_to_be32(NFS4ERR_SEQUENCE_POS)
280#define nfserr_req_too_big		cpu_to_be32(NFS4ERR_REQ_TOO_BIG)
281#define nfserr_rep_too_big		cpu_to_be32(NFS4ERR_REP_TOO_BIG)
282#define nfserr_rep_too_big_to_cache	cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE)
283#define nfserr_retry_uncached_rep	cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP)
284#define nfserr_unsafe_compound		cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND)
285#define nfserr_too_many_ops		cpu_to_be32(NFS4ERR_TOO_MANY_OPS)
286#define nfserr_op_not_in_session	cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION)
287#define nfserr_hash_alg_unsupp		cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP)
288#define nfserr_clientid_busy		cpu_to_be32(NFS4ERR_CLIENTID_BUSY)
289#define nfserr_pnfs_io_hole		cpu_to_be32(NFS4ERR_PNFS_IO_HOLE)
290#define nfserr_seq_false_retry		cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY)
291#define nfserr_bad_high_slot		cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT)
292#define nfserr_deadsession		cpu_to_be32(NFS4ERR_DEADSESSION)
293#define nfserr_encr_alg_unsupp		cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP)
294#define nfserr_pnfs_no_layout		cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT)
295#define nfserr_not_only_op		cpu_to_be32(NFS4ERR_NOT_ONLY_OP)
296#define nfserr_wrong_cred		cpu_to_be32(NFS4ERR_WRONG_CRED)
297#define nfserr_wrong_type		cpu_to_be32(NFS4ERR_WRONG_TYPE)
298#define nfserr_dirdeleg_unavail		cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL)
299#define nfserr_reject_deleg		cpu_to_be32(NFS4ERR_REJECT_DELEG)
300#define nfserr_returnconflict		cpu_to_be32(NFS4ERR_RETURNCONFLICT)
301#define nfserr_deleg_revoked		cpu_to_be32(NFS4ERR_DELEG_REVOKED)
302#define nfserr_partner_notsupp		cpu_to_be32(NFS4ERR_PARTNER_NOTSUPP)
303#define nfserr_partner_no_auth		cpu_to_be32(NFS4ERR_PARTNER_NO_AUTH)
304#define nfserr_union_notsupp		cpu_to_be32(NFS4ERR_UNION_NOTSUPP)
305#define nfserr_offload_denied		cpu_to_be32(NFS4ERR_OFFLOAD_DENIED)
306#define nfserr_wrong_lfs		cpu_to_be32(NFS4ERR_WRONG_LFS)
307#define nfserr_badlabel			cpu_to_be32(NFS4ERR_BADLABEL)
308#define nfserr_file_open		cpu_to_be32(NFS4ERR_FILE_OPEN)
309#define nfserr_xattr2big		cpu_to_be32(NFS4ERR_XATTR2BIG)
310#define nfserr_noxattr			cpu_to_be32(NFS4ERR_NOXATTR)
311
312/* error codes for internal use */
 
 
 
 
 
 
313/* if a request fails due to kmalloc failure, it gets dropped.
314 *  Client should resend eventually
315 */
316#define	nfserr_dropit		cpu_to_be32(30000)
 
317/* end-of-file indicator in readdir */
318#define	nfserr_eof		cpu_to_be32(30001)
 
 
319/* replay detected */
320#define	nfserr_replay_me	cpu_to_be32(11001)
 
 
321/* nfs41 replay detected */
322#define	nfserr_replay_cache	cpu_to_be32(11002)
 
 
 
 
 
 
 
 
323
324/* Check for dir entries '.' and '..' */
325#define isdotent(n, l)	(l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
326
327#ifdef CONFIG_NFSD_V4
328
329/* before processing a COMPOUND operation, we have to check that there
330 * is enough space in the buffer for XDR encode to succeed.  otherwise,
331 * we might process an operation with side effects, and be unable to
332 * tell the client that the operation succeeded.
333 *
334 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
335 * needed to encode an "ordinary" _successful_ operation.  (GETATTR,
336 * READ, READDIR, and READLINK have their own buffer checks.)  if we
337 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
338 *
339 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
340 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
341 * care is taken to ensure that we never fall below this level for any
342 * reason.
343 */
344#define	COMPOUND_SLACK_SPACE		140    /* OP_GETFH */
345#define COMPOUND_ERR_SLACK_SPACE	16     /* OP_SETATTR */
346
347#define NFSD_LAUNDROMAT_MINTIMEOUT      1   /* seconds */
348#define	NFSD_COURTESY_CLIENT_TIMEOUT	(24 * 60 * 60)	/* seconds */
349#define	NFSD_CLIENT_MAX_TRIM_PER_RUN	128
350#define	NFS4_CLIENTS_PER_GB		1024
351#define NFSD_DELEGRETURN_TIMEOUT	(HZ / 34)	/* 30ms */
 
352
353/*
354 * The following attributes are currently not supported by the NFSv4 server:
355 *    ARCHIVE       (deprecated anyway)
356 *    HIDDEN        (unlikely to be supported any time soon)
357 *    MIMETYPE      (unlikely to be supported any time soon)
358 *    QUOTA_*       (will be supported in a forthcoming patch)
359 *    SYSTEM        (unlikely to be supported any time soon)
360 *    TIME_BACKUP   (unlikely to be supported any time soon)
361 *    TIME_CREATE   (unlikely to be supported any time soon)
362 */
363#define NFSD4_SUPPORTED_ATTRS_WORD0                                                         \
364(FATTR4_WORD0_SUPPORTED_ATTRS   | FATTR4_WORD0_TYPE         | FATTR4_WORD0_FH_EXPIRE_TYPE   \
365 | FATTR4_WORD0_CHANGE          | FATTR4_WORD0_SIZE         | FATTR4_WORD0_LINK_SUPPORT     \
366 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR   | FATTR4_WORD0_FSID             \
367 | FATTR4_WORD0_UNIQUE_HANDLES  | FATTR4_WORD0_LEASE_TIME   | FATTR4_WORD0_RDATTR_ERROR     \
368 | FATTR4_WORD0_ACLSUPPORT      | FATTR4_WORD0_CANSETTIME   | FATTR4_WORD0_CASE_INSENSITIVE \
369 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED                             \
370 | FATTR4_WORD0_FILEHANDLE      | FATTR4_WORD0_FILEID       | FATTR4_WORD0_FILES_AVAIL      \
371 | FATTR4_WORD0_FILES_FREE      | FATTR4_WORD0_FILES_TOTAL  | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS      \
372 | FATTR4_WORD0_MAXFILESIZE     | FATTR4_WORD0_MAXLINK      | FATTR4_WORD0_MAXNAME          \
373 | FATTR4_WORD0_MAXREAD         | FATTR4_WORD0_MAXWRITE     | FATTR4_WORD0_ACL)
374
375#define NFSD4_SUPPORTED_ATTRS_WORD1                                                         \
376(FATTR4_WORD1_MODE              | FATTR4_WORD1_NO_TRUNC     | FATTR4_WORD1_NUMLINKS         \
377 | FATTR4_WORD1_OWNER	        | FATTR4_WORD1_OWNER_GROUP  | FATTR4_WORD1_RAWDEV           \
378 | FATTR4_WORD1_SPACE_AVAIL     | FATTR4_WORD1_SPACE_FREE   | FATTR4_WORD1_SPACE_TOTAL      \
379 | FATTR4_WORD1_SPACE_USED      | FATTR4_WORD1_TIME_ACCESS  | FATTR4_WORD1_TIME_ACCESS_SET  \
380 | FATTR4_WORD1_TIME_DELTA      | FATTR4_WORD1_TIME_METADATA   | FATTR4_WORD1_TIME_CREATE      \
381 | FATTR4_WORD1_TIME_MODIFY     | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
382
383#define NFSD4_SUPPORTED_ATTRS_WORD2 0
384
385/* 4.1 */
386#ifdef CONFIG_NFSD_PNFS
387#define PNFSD_SUPPORTED_ATTRS_WORD1	FATTR4_WORD1_FS_LAYOUT_TYPES
388#define PNFSD_SUPPORTED_ATTRS_WORD2 \
389(FATTR4_WORD2_LAYOUT_BLKSIZE	| FATTR4_WORD2_LAYOUT_TYPES)
390#else
391#define PNFSD_SUPPORTED_ATTRS_WORD1	0
392#define PNFSD_SUPPORTED_ATTRS_WORD2	0
393#endif /* CONFIG_NFSD_PNFS */
394
395#define NFSD4_1_SUPPORTED_ATTRS_WORD0 \
396	NFSD4_SUPPORTED_ATTRS_WORD0
397
398#define NFSD4_1_SUPPORTED_ATTRS_WORD1 \
399	(NFSD4_SUPPORTED_ATTRS_WORD1	| PNFSD_SUPPORTED_ATTRS_WORD1)
400
401#define NFSD4_1_SUPPORTED_ATTRS_WORD2 \
402	(NFSD4_SUPPORTED_ATTRS_WORD2	| PNFSD_SUPPORTED_ATTRS_WORD2 | \
403	 FATTR4_WORD2_SUPPATTR_EXCLCREAT)
404
405/* 4.2 */
406#ifdef CONFIG_NFSD_V4_SECURITY_LABEL
407#define NFSD4_2_SECURITY_ATTRS		FATTR4_WORD2_SECURITY_LABEL
408#else
409#define NFSD4_2_SECURITY_ATTRS		0
410#endif
411
412#define NFSD4_2_SUPPORTED_ATTRS_WORD2 \
413	(NFSD4_1_SUPPORTED_ATTRS_WORD2 | \
414	FATTR4_WORD2_MODE_UMASK | \
415	NFSD4_2_SECURITY_ATTRS | \
416	FATTR4_WORD2_XATTR_SUPPORT)
417
418extern const u32 nfsd_suppattrs[3][3];
419
420static inline __be32 nfsd4_set_netaddr(struct sockaddr *addr,
421				    struct nfs42_netaddr *netaddr)
422{
423	struct sockaddr_in *sin = (struct sockaddr_in *)addr;
424	struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)addr;
425	unsigned int port;
426	size_t ret_addr, ret_port;
427
428	switch (addr->sa_family) {
429	case AF_INET:
430		port = ntohs(sin->sin_port);
431		sprintf(netaddr->netid, "tcp");
432		netaddr->netid_len = 3;
433		break;
434	case AF_INET6:
435		port = ntohs(sin6->sin6_port);
436		sprintf(netaddr->netid, "tcp6");
437		netaddr->netid_len = 4;
438		break;
439	default:
440		return nfserr_inval;
441	}
442	ret_addr = rpc_ntop(addr, netaddr->addr, sizeof(netaddr->addr));
443	ret_port = snprintf(netaddr->addr + ret_addr,
444			    RPCBIND_MAXUADDRLEN + 1 - ret_addr,
445			    ".%u.%u", port >> 8, port & 0xff);
446	WARN_ON(ret_port >= RPCBIND_MAXUADDRLEN + 1 - ret_addr);
447	netaddr->addr_len = ret_addr + ret_port;
448	return 0;
449}
450
451static inline bool bmval_is_subset(const u32 *bm1, const u32 *bm2)
452{
453	return !((bm1[0] & ~bm2[0]) ||
454	         (bm1[1] & ~bm2[1]) ||
455		 (bm1[2] & ~bm2[2]));
456}
457
458static inline bool nfsd_attrs_supported(u32 minorversion, const u32 *bmval)
459{
460	return bmval_is_subset(bmval, nfsd_suppattrs[minorversion]);
461}
462
463/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
464#define NFSD_WRITEONLY_ATTRS_WORD1 \
465	(FATTR4_WORD1_TIME_ACCESS_SET   | FATTR4_WORD1_TIME_MODIFY_SET)
466
467/*
468 * These are the only attrs allowed in CREATE/OPEN/SETATTR. Don't add
469 * a writeable attribute here without also adding code to parse it to
470 * nfsd4_decode_fattr().
471 */
472#define NFSD_WRITEABLE_ATTRS_WORD0 \
473	(FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL)
474#define NFSD_WRITEABLE_ATTRS_WORD1 \
475	(FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
476	| FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_CREATE \
477	| FATTR4_WORD1_TIME_MODIFY_SET)
478#ifdef CONFIG_NFSD_V4_SECURITY_LABEL
479#define MAYBE_FATTR4_WORD2_SECURITY_LABEL \
480	FATTR4_WORD2_SECURITY_LABEL
481#else
482#define MAYBE_FATTR4_WORD2_SECURITY_LABEL 0
483#endif
484#define NFSD_WRITEABLE_ATTRS_WORD2 \
485	(FATTR4_WORD2_MODE_UMASK \
486	| MAYBE_FATTR4_WORD2_SECURITY_LABEL)
487
488#define NFSD_SUPPATTR_EXCLCREAT_WORD0 \
489	NFSD_WRITEABLE_ATTRS_WORD0
490/*
491 * we currently store the exclusive create verifier in the v_{a,m}time
492 * attributes so the client can't set these at create time using EXCLUSIVE4_1
493 */
494#define NFSD_SUPPATTR_EXCLCREAT_WORD1 \
495	(NFSD_WRITEABLE_ATTRS_WORD1 & \
496	 ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET))
497#define NFSD_SUPPATTR_EXCLCREAT_WORD2 \
498	NFSD_WRITEABLE_ATTRS_WORD2
499
500extern int nfsd4_is_junction(struct dentry *dentry);
501extern int register_cld_notifier(void);
502extern void unregister_cld_notifier(void);
503#ifdef CONFIG_NFSD_V4_2_INTER_SSC
504extern void nfsd4_ssc_init_umount_work(struct nfsd_net *nn);
505#endif
506
507extern void nfsd4_init_leases_net(struct nfsd_net *nn);
508
509#else /* CONFIG_NFSD_V4 */
510static inline int nfsd4_is_junction(struct dentry *dentry)
511{
512	return 0;
513}
514
515static inline void nfsd4_init_leases_net(struct nfsd_net *nn) { };
516
517#define register_cld_notifier() 0
518#define unregister_cld_notifier() do { } while(0)
519
520#endif /* CONFIG_NFSD_V4 */
521
522#endif /* LINUX_NFSD_NFSD_H */
v6.13.7
  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * Hodge-podge collection of knfsd-related stuff.
  4 * I will sort this out later.
  5 *
  6 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
  7 */
  8
  9#ifndef LINUX_NFSD_NFSD_H
 10#define LINUX_NFSD_NFSD_H
 11
 12#include <linux/types.h>
 13#include <linux/mount.h>
 14
 15#include <linux/nfs.h>
 16#include <linux/nfs2.h>
 17#include <linux/nfs3.h>
 18#include <linux/nfs4.h>
 19#include <linux/sunrpc/svc.h>
 20#include <linux/sunrpc/svc_xprt.h>
 21#include <linux/sunrpc/msg_prot.h>
 22#include <linux/sunrpc/addr.h>
 23
 24#include <uapi/linux/nfsd/debug.h>
 25
 
 26#include "export.h"
 
 27
 28#undef ifdebug
 29#ifdef CONFIG_SUNRPC_DEBUG
 30# define ifdebug(flag)		if (nfsd_debug & NFSDDBG_##flag)
 31#else
 32# define ifdebug(flag)		if (0)
 33#endif
 34
 35/*
 36 * nfsd version
 37 */
 38#define NFSD_MINVERS			2
 39#define	NFSD_MAXVERS			4
 40#define NFSD_SUPPORTED_MINOR_VERSION	2
 41bool nfsd_support_version(int vers);
 42
 43#include "netns.h"
 44#include "stats.h"
 45
 46/*
 47 * Maximum blocksizes supported by daemon under various circumstances.
 48 */
 49#define NFSSVC_MAXBLKSIZE       RPCSVC_MAXPAYLOAD
 50/* NFSv2 is limited by the protocol specification, see RFC 1094 */
 51#define NFSSVC_MAXBLKSIZE_V2    (8*1024)
 52
 53
 54/*
 55 * Largest number of bytes we need to allocate for an NFS
 56 * call or reply.  Used to control buffer sizes.  We use
 57 * the length of v3 WRITE, READDIR and READDIR replies
 58 * which are an RPC header, up to 26 XDR units of reply
 59 * data, and some page data.
 60 *
 61 * Note that accuracy here doesn't matter too much as the
 62 * size is rounded up to a page size when allocating space.
 63 */
 64#define NFSD_BUFSIZE            ((RPC_MAX_HEADER_WITH_AUTH+26)*XDR_UNIT + NFSSVC_MAXBLKSIZE)
 65
 66struct readdir_cd {
 67	__be32			err;	/* 0, nfserr, or nfserr_eof */
 68};
 69
 70/* Maximum number of operations per session compound */
 71#define NFSD_MAX_OPS_PER_COMPOUND	50
 72
 73struct nfsd_genl_rqstp {
 74	struct sockaddr		rq_daddr;
 75	struct sockaddr		rq_saddr;
 76	unsigned long		rq_flags;
 77	ktime_t			rq_stime;
 78	__be32			rq_xid;
 79	u32			rq_vers;
 80	u32			rq_prog;
 81	u32			rq_proc;
 82
 83	/* NFSv4 compound */
 84	u32			rq_opcnt;
 85	u32			rq_opnum[NFSD_MAX_OPS_PER_COMPOUND];
 86};
 87
 88extern struct svc_program	nfsd_programs[];
 89extern const struct svc_version	nfsd_version2, nfsd_version3, nfsd_version4;
 90extern struct mutex		nfsd_mutex;
 91extern spinlock_t		nfsd_drc_lock;
 92extern unsigned long		nfsd_drc_max_mem;
 93extern unsigned long		nfsd_drc_mem_used;
 94extern atomic_t			nfsd_th_cnt;		/* number of available threads */
 95
 96extern const struct seq_operations nfs_exports_op;
 97
 98/*
 99 * Common void argument and result helpers
100 */
101struct nfsd_voidargs { };
102struct nfsd_voidres { };
103bool		nfssvc_decode_voidarg(struct svc_rqst *rqstp,
104				      struct xdr_stream *xdr);
105bool		nfssvc_encode_voidres(struct svc_rqst *rqstp,
106				      struct xdr_stream *xdr);
107
108/*
109 * Function prototypes.
110 */
111int		nfsd_svc(int n, int *nservers, struct net *net,
112			 const struct cred *cred, const char *scope);
113int		nfsd_dispatch(struct svc_rqst *rqstp);
114
115int		nfsd_nrthreads(struct net *);
116int		nfsd_nrpools(struct net *);
117int		nfsd_get_nrthreads(int n, int *, struct net *);
118int		nfsd_set_nrthreads(int n, int *, struct net *);
 
 
119void		nfsd_shutdown_threads(struct net *net);
120
121struct svc_rqst *nfsd_current_rqst(void);
 
 
122
123struct nfsdfs_client {
124	struct kref cl_ref;
125	void (*cl_release)(struct kref *kref);
126};
127
128struct nfsdfs_client *get_nfsdfs_client(struct inode *);
129struct dentry *nfsd_client_mkdir(struct nfsd_net *nn,
130				 struct nfsdfs_client *ncl, u32 id,
131				 const struct tree_descr *,
132				 struct dentry **fdentries);
133void nfsd_client_rmdir(struct dentry *dentry);
134
135
136#if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
137#ifdef CONFIG_NFSD_V2_ACL
138extern const struct svc_version nfsd_acl_version2;
139#else
140#define nfsd_acl_version2 NULL
141#endif
142#ifdef CONFIG_NFSD_V3_ACL
143extern const struct svc_version nfsd_acl_version3;
144#else
145#define nfsd_acl_version3 NULL
146#endif
147#endif
148
149#if IS_ENABLED(CONFIG_NFS_LOCALIO)
150extern const struct svc_version localio_version1;
151#endif
152
153struct nfsd_net;
154
155enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
156int nfsd_vers(struct nfsd_net *nn, int vers, enum vers_op change);
157int nfsd_minorversion(struct nfsd_net *nn, u32 minorversion, enum vers_op change);
158void nfsd_reset_versions(struct nfsd_net *nn);
159int nfsd_create_serv(struct net *net);
160void nfsd_destroy_serv(struct net *net);
161
162extern int nfsd_max_blksize;
163
164static inline int nfsd_v4client(struct svc_rqst *rq)
165{
166	return rq && rq->rq_prog == NFS_PROGRAM && rq->rq_vers == 4;
167}
168static inline struct user_namespace *
169nfsd_user_namespace(const struct svc_rqst *rqstp)
170{
171	const struct cred *cred = rqstp->rq_xprt->xpt_cred;
172	return cred ? cred->user_ns : &init_user_ns;
173}
174
175/* 
176 * NFSv4 State
177 */
178#ifdef CONFIG_NFSD_V4
179extern unsigned long max_delegations;
180int nfsd4_init_slabs(void);
181void nfsd4_free_slabs(void);
182int nfs4_state_start(void);
183int nfs4_state_start_net(struct net *net);
184void nfs4_state_shutdown(void);
185void nfs4_state_shutdown_net(struct net *net);
186int nfs4_reset_recoverydir(char *recdir);
187char * nfs4_recoverydir(void);
188bool nfsd4_spo_must_allow(struct svc_rqst *rqstp);
189int nfsd4_create_laundry_wq(void);
190void nfsd4_destroy_laundry_wq(void);
191bool nfsd_wait_for_delegreturn(struct svc_rqst *rqstp, struct inode *inode);
192#else
193static inline int nfsd4_init_slabs(void) { return 0; }
194static inline void nfsd4_free_slabs(void) { }
195static inline int nfs4_state_start(void) { return 0; }
196static inline int nfs4_state_start_net(struct net *net) { return 0; }
197static inline void nfs4_state_shutdown(void) { }
198static inline void nfs4_state_shutdown_net(struct net *net) { }
199static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
200static inline char * nfs4_recoverydir(void) {return NULL; }
201static inline bool nfsd4_spo_must_allow(struct svc_rqst *rqstp)
202{
203	return false;
204}
205static inline int nfsd4_create_laundry_wq(void) { return 0; };
206static inline void nfsd4_destroy_laundry_wq(void) {};
207static inline bool nfsd_wait_for_delegreturn(struct svc_rqst *rqstp,
208					      struct inode *inode)
209{
210	return false;
211}
212#endif
213
214/*
215 * lockd binding
216 */
217void		nfsd_lockd_init(void);
218void		nfsd_lockd_shutdown(void);
219
220
221/*
222 * These macros provide pre-xdr'ed values for faster operation.
223 */
224#define	nfs_ok			cpu_to_be32(NFS_OK)
225#define	nfserr_perm		cpu_to_be32(NFSERR_PERM)
226#define	nfserr_noent		cpu_to_be32(NFSERR_NOENT)
227#define	nfserr_io		cpu_to_be32(NFSERR_IO)
228#define	nfserr_nxio		cpu_to_be32(NFSERR_NXIO)
229#define	nfserr_eagain		cpu_to_be32(NFSERR_EAGAIN)
230#define	nfserr_acces		cpu_to_be32(NFSERR_ACCES)
231#define	nfserr_exist		cpu_to_be32(NFSERR_EXIST)
232#define	nfserr_xdev		cpu_to_be32(NFSERR_XDEV)
233#define	nfserr_nodev		cpu_to_be32(NFSERR_NODEV)
234#define	nfserr_notdir		cpu_to_be32(NFSERR_NOTDIR)
235#define	nfserr_isdir		cpu_to_be32(NFSERR_ISDIR)
236#define	nfserr_inval		cpu_to_be32(NFSERR_INVAL)
237#define	nfserr_fbig		cpu_to_be32(NFSERR_FBIG)
238#define	nfserr_nospc		cpu_to_be32(NFSERR_NOSPC)
239#define	nfserr_rofs		cpu_to_be32(NFSERR_ROFS)
240#define	nfserr_mlink		cpu_to_be32(NFSERR_MLINK)
 
241#define	nfserr_nametoolong	cpu_to_be32(NFSERR_NAMETOOLONG)
242#define	nfserr_notempty		cpu_to_be32(NFSERR_NOTEMPTY)
243#define	nfserr_dquot		cpu_to_be32(NFSERR_DQUOT)
244#define	nfserr_stale		cpu_to_be32(NFSERR_STALE)
245#define	nfserr_remote		cpu_to_be32(NFSERR_REMOTE)
246#define	nfserr_wflush		cpu_to_be32(NFSERR_WFLUSH)
247#define	nfserr_badhandle	cpu_to_be32(NFSERR_BADHANDLE)
248#define	nfserr_notsync		cpu_to_be32(NFSERR_NOT_SYNC)
249#define	nfserr_badcookie	cpu_to_be32(NFSERR_BAD_COOKIE)
250#define	nfserr_notsupp		cpu_to_be32(NFSERR_NOTSUPP)
251#define	nfserr_toosmall		cpu_to_be32(NFSERR_TOOSMALL)
252#define	nfserr_serverfault	cpu_to_be32(NFSERR_SERVERFAULT)
253#define	nfserr_badtype		cpu_to_be32(NFSERR_BADTYPE)
254#define	nfserr_jukebox		cpu_to_be32(NFSERR_JUKEBOX)
255#define	nfserr_denied		cpu_to_be32(NFSERR_DENIED)
256#define	nfserr_deadlock		cpu_to_be32(NFSERR_DEADLOCK)
257#define nfserr_expired          cpu_to_be32(NFSERR_EXPIRED)
258#define	nfserr_bad_cookie	cpu_to_be32(NFSERR_BAD_COOKIE)
259#define	nfserr_same		cpu_to_be32(NFSERR_SAME)
260#define	nfserr_clid_inuse	cpu_to_be32(NFSERR_CLID_INUSE)
261#define	nfserr_stale_clientid	cpu_to_be32(NFSERR_STALE_CLIENTID)
262#define	nfserr_resource		cpu_to_be32(NFSERR_RESOURCE)
263#define	nfserr_moved		cpu_to_be32(NFSERR_MOVED)
264#define	nfserr_nofilehandle	cpu_to_be32(NFSERR_NOFILEHANDLE)
265#define	nfserr_minor_vers_mismatch	cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH)
266#define nfserr_share_denied	cpu_to_be32(NFSERR_SHARE_DENIED)
267#define nfserr_stale_stateid	cpu_to_be32(NFSERR_STALE_STATEID)
268#define nfserr_old_stateid	cpu_to_be32(NFSERR_OLD_STATEID)
269#define nfserr_bad_stateid	cpu_to_be32(NFSERR_BAD_STATEID)
270#define nfserr_bad_seqid	cpu_to_be32(NFSERR_BAD_SEQID)
271#define	nfserr_symlink		cpu_to_be32(NFSERR_SYMLINK)
272#define	nfserr_not_same		cpu_to_be32(NFSERR_NOT_SAME)
273#define nfserr_lock_range	cpu_to_be32(NFSERR_LOCK_RANGE)
274#define	nfserr_restorefh	cpu_to_be32(NFSERR_RESTOREFH)
275#define	nfserr_attrnotsupp	cpu_to_be32(NFSERR_ATTRNOTSUPP)
276#define	nfserr_bad_xdr		cpu_to_be32(NFSERR_BAD_XDR)
277#define	nfserr_openmode		cpu_to_be32(NFSERR_OPENMODE)
278#define	nfserr_badowner		cpu_to_be32(NFSERR_BADOWNER)
279#define	nfserr_locks_held	cpu_to_be32(NFSERR_LOCKS_HELD)
280#define	nfserr_op_illegal	cpu_to_be32(NFSERR_OP_ILLEGAL)
281#define	nfserr_grace		cpu_to_be32(NFSERR_GRACE)
282#define	nfserr_no_grace		cpu_to_be32(NFSERR_NO_GRACE)
283#define	nfserr_reclaim_bad	cpu_to_be32(NFSERR_RECLAIM_BAD)
284#define	nfserr_badname		cpu_to_be32(NFSERR_BADNAME)
285#define	nfserr_admin_revoked	cpu_to_be32(NFS4ERR_ADMIN_REVOKED)
286#define	nfserr_cb_path_down	cpu_to_be32(NFSERR_CB_PATH_DOWN)
287#define	nfserr_locked		cpu_to_be32(NFSERR_LOCKED)
288#define	nfserr_wrongsec		cpu_to_be32(NFSERR_WRONGSEC)
289#define nfserr_badiomode		cpu_to_be32(NFS4ERR_BADIOMODE)
290#define nfserr_badlayout		cpu_to_be32(NFS4ERR_BADLAYOUT)
291#define nfserr_bad_session_digest	cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST)
292#define nfserr_badsession		cpu_to_be32(NFS4ERR_BADSESSION)
293#define nfserr_badslot			cpu_to_be32(NFS4ERR_BADSLOT)
294#define nfserr_complete_already		cpu_to_be32(NFS4ERR_COMPLETE_ALREADY)
295#define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
296#define nfserr_deleg_already_wanted	cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED)
297#define nfserr_back_chan_busy		cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY)
298#define nfserr_layouttrylater		cpu_to_be32(NFS4ERR_LAYOUTTRYLATER)
299#define nfserr_layoutunavailable	cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE)
300#define nfserr_nomatching_layout	cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT)
301#define nfserr_recallconflict		cpu_to_be32(NFS4ERR_RECALLCONFLICT)
302#define nfserr_unknown_layouttype	cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE)
303#define nfserr_seq_misordered		cpu_to_be32(NFS4ERR_SEQ_MISORDERED)
304#define nfserr_sequence_pos		cpu_to_be32(NFS4ERR_SEQUENCE_POS)
305#define nfserr_req_too_big		cpu_to_be32(NFS4ERR_REQ_TOO_BIG)
306#define nfserr_rep_too_big		cpu_to_be32(NFS4ERR_REP_TOO_BIG)
307#define nfserr_rep_too_big_to_cache	cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE)
308#define nfserr_retry_uncached_rep	cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP)
309#define nfserr_unsafe_compound		cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND)
310#define nfserr_too_many_ops		cpu_to_be32(NFS4ERR_TOO_MANY_OPS)
311#define nfserr_op_not_in_session	cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION)
312#define nfserr_hash_alg_unsupp		cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP)
313#define nfserr_clientid_busy		cpu_to_be32(NFS4ERR_CLIENTID_BUSY)
314#define nfserr_pnfs_io_hole		cpu_to_be32(NFS4ERR_PNFS_IO_HOLE)
315#define nfserr_seq_false_retry		cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY)
316#define nfserr_bad_high_slot		cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT)
317#define nfserr_deadsession		cpu_to_be32(NFS4ERR_DEADSESSION)
318#define nfserr_encr_alg_unsupp		cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP)
319#define nfserr_pnfs_no_layout		cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT)
320#define nfserr_not_only_op		cpu_to_be32(NFS4ERR_NOT_ONLY_OP)
321#define nfserr_wrong_cred		cpu_to_be32(NFS4ERR_WRONG_CRED)
322#define nfserr_wrong_type		cpu_to_be32(NFS4ERR_WRONG_TYPE)
323#define nfserr_dirdeleg_unavail		cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL)
324#define nfserr_reject_deleg		cpu_to_be32(NFS4ERR_REJECT_DELEG)
325#define nfserr_returnconflict		cpu_to_be32(NFS4ERR_RETURNCONFLICT)
326#define nfserr_deleg_revoked		cpu_to_be32(NFS4ERR_DELEG_REVOKED)
327#define nfserr_partner_notsupp		cpu_to_be32(NFS4ERR_PARTNER_NOTSUPP)
328#define nfserr_partner_no_auth		cpu_to_be32(NFS4ERR_PARTNER_NO_AUTH)
329#define nfserr_union_notsupp		cpu_to_be32(NFS4ERR_UNION_NOTSUPP)
330#define nfserr_offload_denied		cpu_to_be32(NFS4ERR_OFFLOAD_DENIED)
331#define nfserr_wrong_lfs		cpu_to_be32(NFS4ERR_WRONG_LFS)
332#define nfserr_badlabel			cpu_to_be32(NFS4ERR_BADLABEL)
333#define nfserr_file_open		cpu_to_be32(NFS4ERR_FILE_OPEN)
334#define nfserr_xattr2big		cpu_to_be32(NFS4ERR_XATTR2BIG)
335#define nfserr_noxattr			cpu_to_be32(NFS4ERR_NOXATTR)
336
337/*
338 * Error codes for internal use.  We use enum to choose numbers that are
339 * not already assigned, then covert to be32 resulting in a number that
340 * cannot conflict with any existing be32 nfserr value.
341 */
342enum {
343	NFSERR_DROPIT = NFS4ERR_FIRST_FREE,
344/* if a request fails due to kmalloc failure, it gets dropped.
345 *  Client should resend eventually
346 */
347#define	nfserr_dropit		cpu_to_be32(NFSERR_DROPIT)
348
349/* end-of-file indicator in readdir */
350	NFSERR_EOF,
351#define	nfserr_eof		cpu_to_be32(NFSERR_EOF)
352
353/* replay detected */
354	NFSERR_REPLAY_ME,
355#define	nfserr_replay_me	cpu_to_be32(NFSERR_REPLAY_ME)
356
357/* nfs41 replay detected */
358	NFSERR_REPLAY_CACHE,
359#define	nfserr_replay_cache	cpu_to_be32(NFSERR_REPLAY_CACHE)
360
361/* symlink found where dir expected - handled differently to
362 * other symlink found errors by NFSv3.
363 */
364	NFSERR_SYMLINK_NOT_DIR,
365#define	nfserr_symlink_not_dir	cpu_to_be32(NFSERR_SYMLINK_NOT_DIR)
366};
367
368/* Check for dir entries '.' and '..' */
369#define isdotent(n, l)	(l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
370
371#ifdef CONFIG_NFSD_V4
372
373/* before processing a COMPOUND operation, we have to check that there
374 * is enough space in the buffer for XDR encode to succeed.  otherwise,
375 * we might process an operation with side effects, and be unable to
376 * tell the client that the operation succeeded.
377 *
378 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
379 * needed to encode an "ordinary" _successful_ operation.  (GETATTR,
380 * READ, READDIR, and READLINK have their own buffer checks.)  if we
381 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
382 *
383 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
384 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
385 * care is taken to ensure that we never fall below this level for any
386 * reason.
387 */
388#define	COMPOUND_SLACK_SPACE		140    /* OP_GETFH */
389#define COMPOUND_ERR_SLACK_SPACE	16     /* OP_SETATTR */
390
391#define NFSD_LAUNDROMAT_MINTIMEOUT      1   /* seconds */
392#define	NFSD_COURTESY_CLIENT_TIMEOUT	(24 * 60 * 60)	/* seconds */
393#define	NFSD_CLIENT_MAX_TRIM_PER_RUN	128
394#define	NFS4_CLIENTS_PER_GB		1024
395#define NFSD_DELEGRETURN_TIMEOUT	(HZ / 34)	/* 30ms */
396#define	NFSD_CB_GETATTR_TIMEOUT		NFSD_DELEGRETURN_TIMEOUT
397
398/*
399 * The following attributes are currently not supported by the NFSv4 server:
400 *    ARCHIVE       (deprecated anyway)
401 *    HIDDEN        (unlikely to be supported any time soon)
402 *    MIMETYPE      (unlikely to be supported any time soon)
403 *    QUOTA_*       (will be supported in a forthcoming patch)
404 *    SYSTEM        (unlikely to be supported any time soon)
405 *    TIME_BACKUP   (unlikely to be supported any time soon)
406 *    TIME_CREATE   (unlikely to be supported any time soon)
407 */
408#define NFSD4_SUPPORTED_ATTRS_WORD0                                                         \
409(FATTR4_WORD0_SUPPORTED_ATTRS   | FATTR4_WORD0_TYPE         | FATTR4_WORD0_FH_EXPIRE_TYPE   \
410 | FATTR4_WORD0_CHANGE          | FATTR4_WORD0_SIZE         | FATTR4_WORD0_LINK_SUPPORT     \
411 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR   | FATTR4_WORD0_FSID             \
412 | FATTR4_WORD0_UNIQUE_HANDLES  | FATTR4_WORD0_LEASE_TIME   | FATTR4_WORD0_RDATTR_ERROR     \
413 | FATTR4_WORD0_ACLSUPPORT      | FATTR4_WORD0_CANSETTIME   | FATTR4_WORD0_CASE_INSENSITIVE \
414 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED                             \
415 | FATTR4_WORD0_FILEHANDLE      | FATTR4_WORD0_FILEID       | FATTR4_WORD0_FILES_AVAIL      \
416 | FATTR4_WORD0_FILES_FREE      | FATTR4_WORD0_FILES_TOTAL  | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS      \
417 | FATTR4_WORD0_MAXFILESIZE     | FATTR4_WORD0_MAXLINK      | FATTR4_WORD0_MAXNAME          \
418 | FATTR4_WORD0_MAXREAD         | FATTR4_WORD0_MAXWRITE     | FATTR4_WORD0_ACL)
419
420#define NFSD4_SUPPORTED_ATTRS_WORD1                                                         \
421(FATTR4_WORD1_MODE              | FATTR4_WORD1_NO_TRUNC     | FATTR4_WORD1_NUMLINKS         \
422 | FATTR4_WORD1_OWNER	        | FATTR4_WORD1_OWNER_GROUP  | FATTR4_WORD1_RAWDEV           \
423 | FATTR4_WORD1_SPACE_AVAIL     | FATTR4_WORD1_SPACE_FREE   | FATTR4_WORD1_SPACE_TOTAL      \
424 | FATTR4_WORD1_SPACE_USED      | FATTR4_WORD1_TIME_ACCESS  | FATTR4_WORD1_TIME_ACCESS_SET  \
425 | FATTR4_WORD1_TIME_DELTA      | FATTR4_WORD1_TIME_METADATA   | FATTR4_WORD1_TIME_CREATE      \
426 | FATTR4_WORD1_TIME_MODIFY     | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
427
428#define NFSD4_SUPPORTED_ATTRS_WORD2 0
429
430/* 4.1 */
431#ifdef CONFIG_NFSD_PNFS
432#define PNFSD_SUPPORTED_ATTRS_WORD1	FATTR4_WORD1_FS_LAYOUT_TYPES
433#define PNFSD_SUPPORTED_ATTRS_WORD2 \
434(FATTR4_WORD2_LAYOUT_BLKSIZE	| FATTR4_WORD2_LAYOUT_TYPES)
435#else
436#define PNFSD_SUPPORTED_ATTRS_WORD1	0
437#define PNFSD_SUPPORTED_ATTRS_WORD2	0
438#endif /* CONFIG_NFSD_PNFS */
439
440#define NFSD4_1_SUPPORTED_ATTRS_WORD0 \
441	NFSD4_SUPPORTED_ATTRS_WORD0
442
443#define NFSD4_1_SUPPORTED_ATTRS_WORD1 \
444	(NFSD4_SUPPORTED_ATTRS_WORD1	| PNFSD_SUPPORTED_ATTRS_WORD1)
445
446#define NFSD4_1_SUPPORTED_ATTRS_WORD2 \
447	(NFSD4_SUPPORTED_ATTRS_WORD2	| PNFSD_SUPPORTED_ATTRS_WORD2 | \
448	 FATTR4_WORD2_SUPPATTR_EXCLCREAT)
449
450/* 4.2 */
451#ifdef CONFIG_NFSD_V4_SECURITY_LABEL
452#define NFSD4_2_SECURITY_ATTRS		FATTR4_WORD2_SECURITY_LABEL
453#else
454#define NFSD4_2_SECURITY_ATTRS		0
455#endif
456
457#define NFSD4_2_SUPPORTED_ATTRS_WORD2 \
458	(NFSD4_1_SUPPORTED_ATTRS_WORD2 | \
459	FATTR4_WORD2_MODE_UMASK | \
460	NFSD4_2_SECURITY_ATTRS | \
461	FATTR4_WORD2_XATTR_SUPPORT)
462
463extern const u32 nfsd_suppattrs[3][3];
464
465static inline __be32 nfsd4_set_netaddr(struct sockaddr *addr,
466				    struct nfs42_netaddr *netaddr)
467{
468	struct sockaddr_in *sin = (struct sockaddr_in *)addr;
469	struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)addr;
470	unsigned int port;
471	size_t ret_addr, ret_port;
472
473	switch (addr->sa_family) {
474	case AF_INET:
475		port = ntohs(sin->sin_port);
476		sprintf(netaddr->netid, "tcp");
477		netaddr->netid_len = 3;
478		break;
479	case AF_INET6:
480		port = ntohs(sin6->sin6_port);
481		sprintf(netaddr->netid, "tcp6");
482		netaddr->netid_len = 4;
483		break;
484	default:
485		return nfserr_inval;
486	}
487	ret_addr = rpc_ntop(addr, netaddr->addr, sizeof(netaddr->addr));
488	ret_port = snprintf(netaddr->addr + ret_addr,
489			    RPCBIND_MAXUADDRLEN + 1 - ret_addr,
490			    ".%u.%u", port >> 8, port & 0xff);
491	WARN_ON(ret_port >= RPCBIND_MAXUADDRLEN + 1 - ret_addr);
492	netaddr->addr_len = ret_addr + ret_port;
493	return 0;
494}
495
496static inline bool bmval_is_subset(const u32 *bm1, const u32 *bm2)
497{
498	return !((bm1[0] & ~bm2[0]) ||
499	         (bm1[1] & ~bm2[1]) ||
500		 (bm1[2] & ~bm2[2]));
501}
502
503static inline bool nfsd_attrs_supported(u32 minorversion, const u32 *bmval)
504{
505	return bmval_is_subset(bmval, nfsd_suppattrs[minorversion]);
506}
507
508/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
509#define NFSD_WRITEONLY_ATTRS_WORD1 \
510	(FATTR4_WORD1_TIME_ACCESS_SET   | FATTR4_WORD1_TIME_MODIFY_SET)
511
512/*
513 * These are the only attrs allowed in CREATE/OPEN/SETATTR. Don't add
514 * a writeable attribute here without also adding code to parse it to
515 * nfsd4_decode_fattr().
516 */
517#define NFSD_WRITEABLE_ATTRS_WORD0 \
518	(FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL)
519#define NFSD_WRITEABLE_ATTRS_WORD1 \
520	(FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
521	| FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_CREATE \
522	| FATTR4_WORD1_TIME_MODIFY_SET)
523#ifdef CONFIG_NFSD_V4_SECURITY_LABEL
524#define MAYBE_FATTR4_WORD2_SECURITY_LABEL \
525	FATTR4_WORD2_SECURITY_LABEL
526#else
527#define MAYBE_FATTR4_WORD2_SECURITY_LABEL 0
528#endif
529#define NFSD_WRITEABLE_ATTRS_WORD2 \
530	(FATTR4_WORD2_MODE_UMASK \
531	| MAYBE_FATTR4_WORD2_SECURITY_LABEL)
532
533#define NFSD_SUPPATTR_EXCLCREAT_WORD0 \
534	NFSD_WRITEABLE_ATTRS_WORD0
535/*
536 * we currently store the exclusive create verifier in the v_{a,m}time
537 * attributes so the client can't set these at create time using EXCLUSIVE4_1
538 */
539#define NFSD_SUPPATTR_EXCLCREAT_WORD1 \
540	(NFSD_WRITEABLE_ATTRS_WORD1 & \
541	 ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET))
542#define NFSD_SUPPATTR_EXCLCREAT_WORD2 \
543	NFSD_WRITEABLE_ATTRS_WORD2
544
545extern int nfsd4_is_junction(struct dentry *dentry);
546extern int register_cld_notifier(void);
547extern void unregister_cld_notifier(void);
548#ifdef CONFIG_NFSD_V4_2_INTER_SSC
549extern void nfsd4_ssc_init_umount_work(struct nfsd_net *nn);
550#endif
551
552extern void nfsd4_init_leases_net(struct nfsd_net *nn);
553
554#else /* CONFIG_NFSD_V4 */
555static inline int nfsd4_is_junction(struct dentry *dentry)
556{
557	return 0;
558}
559
560static inline void nfsd4_init_leases_net(struct nfsd_net *nn) { };
561
562#define register_cld_notifier() 0
563#define unregister_cld_notifier() do { } while(0)
564
565#endif /* CONFIG_NFSD_V4 */
566
567#endif /* LINUX_NFSD_NFSD_H */