nfsd.h

  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 * Default and maximum payload size (NFS READ or WRITE), in bytes.
 48 * The default is historical, and the maximum is an implementation
 49 * limit.
 50 */
 51enum {
 52	NFSSVC_DEFBLKSIZE       = 1 * 1024 * 1024,
 53	NFSSVC_MAXBLKSIZE       = RPCSVC_MAXPAYLOAD,
 54};
 55
 56struct readdir_cd {
 57	__be32			err;	/* 0, nfserr, or nfserr_eof */
 58};
 59
 60/* Maximum number of operations per session compound */
 61#define NFSD_MAX_OPS_PER_COMPOUND	200
 62
 63struct nfsd_genl_rqstp {
 64	struct sockaddr		rq_daddr;
 65	struct sockaddr		rq_saddr;
 66	unsigned long		rq_flags;
 67	ktime_t			rq_stime;
 68	__be32			rq_xid;
 69	u32			rq_vers;
 70	u32			rq_prog;
 71	u32			rq_proc;
 72
 73	/* NFSv4 compound */
 74	u32			rq_opcnt;
 75	u32			rq_opnum[16];
 76};
 77
 78extern struct svc_program	nfsd_programs[];
 79extern const struct svc_version	nfsd_version2, nfsd_version3, nfsd_version4;
 80extern struct mutex		nfsd_mutex;
 81extern atomic_t			nfsd_th_cnt;		/* number of available threads */
 82
 83extern const struct seq_operations nfs_exports_op;
 84
 85/*
 86 * Common void argument and result helpers
 87 */
 88struct nfsd_voidargs { };
 89struct nfsd_voidres { };
 90bool		nfssvc_decode_voidarg(struct svc_rqst *rqstp,
 91				      struct xdr_stream *xdr);
 92bool		nfssvc_encode_voidres(struct svc_rqst *rqstp,
 93				      struct xdr_stream *xdr);
 94
 95/*
 96 * Function prototypes.
 97 */
 98int		nfsd_svc(int n, int *nservers, struct net *net,
 99			 const struct cred *cred, const char *scope);
100int		nfsd_dispatch(struct svc_rqst *rqstp);
101
102int		nfsd_nrthreads(struct net *);
103int		nfsd_nrpools(struct net *);
104int		nfsd_get_nrthreads(int n, int *, struct net *);
105int		nfsd_set_nrthreads(int n, int *, struct net *);
106void		nfsd_shutdown_threads(struct net *net);
107
108struct svc_rqst *nfsd_current_rqst(void);
109
110struct nfsdfs_client {
111	struct kref cl_ref;
112	void (*cl_release)(struct kref *kref);
113};
114
115struct nfsdfs_client *get_nfsdfs_client(struct inode *);
116struct dentry *nfsd_client_mkdir(struct nfsd_net *nn,
117				 struct nfsdfs_client *ncl, u32 id,
118				 const struct tree_descr *,
119				 struct dentry **fdentries);
120void nfsd_client_rmdir(struct dentry *dentry);
121
122
123#if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
124#ifdef CONFIG_NFSD_V2_ACL
125extern const struct svc_version nfsd_acl_version2;
126#else
127#define nfsd_acl_version2 NULL
128#endif
129#ifdef CONFIG_NFSD_V3_ACL
130extern const struct svc_version nfsd_acl_version3;
131#else
132#define nfsd_acl_version3 NULL
133#endif
134#endif
135
136#if IS_ENABLED(CONFIG_NFS_LOCALIO)
137extern const struct svc_version localio_version1;
138#endif
139
140struct nfsd_net;
141
142enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
143int nfsd_vers(struct nfsd_net *nn, int vers, enum vers_op change);
144int nfsd_minorversion(struct nfsd_net *nn, u32 minorversion, enum vers_op change);
145void nfsd_reset_versions(struct nfsd_net *nn);
146int nfsd_create_serv(struct net *net);
147void nfsd_destroy_serv(struct net *net);
148
149#ifdef CONFIG_DEBUG_FS
150void nfsd_debugfs_init(void);
151void nfsd_debugfs_exit(void);
152#else
153static inline void nfsd_debugfs_init(void) {}
154static inline void nfsd_debugfs_exit(void) {}
155#endif
156
157extern bool nfsd_disable_splice_read __read_mostly;
158
159enum {
160	/* Any new NFSD_IO enum value must be added at the end */
161	NFSD_IO_BUFFERED,
162	NFSD_IO_DONTCACHE,
163	NFSD_IO_DIRECT,
164};
165
166extern u64 nfsd_io_cache_read __read_mostly;
167extern u64 nfsd_io_cache_write __read_mostly;
168
169extern int nfsd_max_blksize;
170
171static inline int nfsd_v4client(struct svc_rqst *rq)
172{
173	return rq && rq->rq_prog == NFS_PROGRAM && rq->rq_vers == 4;
174}
175static inline struct user_namespace *
176nfsd_user_namespace(const struct svc_rqst *rqstp)
177{
178	const struct cred *cred = rqstp->rq_xprt->xpt_cred;
179	return cred ? cred->user_ns : &init_user_ns;
180}
181
182/* 
183 * NFSv4 State
184 */
185#ifdef CONFIG_NFSD_V4
186extern unsigned long max_delegations;
187int nfsd4_init_slabs(void);
188void nfsd4_free_slabs(void);
189int nfs4_state_start(void);
190int nfs4_state_start_net(struct net *net);
191void nfs4_state_shutdown(void);
192void nfs4_state_shutdown_net(struct net *net);
193int nfs4_reset_recoverydir(char *recdir);
194char * nfs4_recoverydir(void);
195bool nfsd4_spo_must_allow(struct svc_rqst *rqstp);
196int nfsd4_create_laundry_wq(void);
197void nfsd4_destroy_laundry_wq(void);
198bool nfsd_wait_for_delegreturn(struct svc_rqst *rqstp, struct inode *inode);
199#else
200static inline int nfsd4_init_slabs(void) { return 0; }
201static inline void nfsd4_free_slabs(void) { }
202static inline int nfs4_state_start(void) { return 0; }
203static inline int nfs4_state_start_net(struct net *net) { return 0; }
204static inline void nfs4_state_shutdown(void) { }
205static inline void nfs4_state_shutdown_net(struct net *net) { }
206static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
207static inline char * nfs4_recoverydir(void) {return NULL; }
208static inline bool nfsd4_spo_must_allow(struct svc_rqst *rqstp)
209{
210	return false;
211}
212static inline int nfsd4_create_laundry_wq(void) { return 0; };
213static inline void nfsd4_destroy_laundry_wq(void) {};
214static inline bool nfsd_wait_for_delegreturn(struct svc_rqst *rqstp,
215					      struct inode *inode)
216{
217	return false;
218}
219#endif
220
221/*
222 * lockd binding
223 */
224void		nfsd_lockd_init(void);
225void		nfsd_lockd_shutdown(void);
226
227
228/*
229 * These macros provide pre-xdr'ed values for faster operation.
230 */
231#define	nfs_ok			cpu_to_be32(NFS_OK)
232#define	nfserr_perm		cpu_to_be32(NFSERR_PERM)
233#define	nfserr_noent		cpu_to_be32(NFSERR_NOENT)
234#define	nfserr_io		cpu_to_be32(NFSERR_IO)
235#define	nfserr_nxio		cpu_to_be32(NFSERR_NXIO)
236#define	nfserr_acces		cpu_to_be32(NFSERR_ACCES)
237#define	nfserr_exist		cpu_to_be32(NFSERR_EXIST)
238#define	nfserr_xdev		cpu_to_be32(NFSERR_XDEV)
239#define	nfserr_nodev		cpu_to_be32(NFSERR_NODEV)
240#define	nfserr_notdir		cpu_to_be32(NFSERR_NOTDIR)
241#define	nfserr_isdir		cpu_to_be32(NFSERR_ISDIR)
242#define	nfserr_inval		cpu_to_be32(NFSERR_INVAL)
243#define	nfserr_fbig		cpu_to_be32(NFSERR_FBIG)
244#define	nfserr_nospc		cpu_to_be32(NFSERR_NOSPC)
245#define	nfserr_rofs		cpu_to_be32(NFSERR_ROFS)
246#define	nfserr_mlink		cpu_to_be32(NFSERR_MLINK)
247#define	nfserr_nametoolong	cpu_to_be32(NFSERR_NAMETOOLONG)
248#define	nfserr_notempty		cpu_to_be32(NFSERR_NOTEMPTY)
249#define	nfserr_dquot		cpu_to_be32(NFSERR_DQUOT)
250#define	nfserr_stale		cpu_to_be32(NFSERR_STALE)
251#define	nfserr_remote		cpu_to_be32(NFSERR_REMOTE)
252#define	nfserr_wflush		cpu_to_be32(NFSERR_WFLUSH)
253#define	nfserr_badhandle	cpu_to_be32(NFSERR_BADHANDLE)
254#define	nfserr_notsync		cpu_to_be32(NFSERR_NOT_SYNC)
255#define	nfserr_badcookie	cpu_to_be32(NFSERR_BAD_COOKIE)
256#define	nfserr_notsupp		cpu_to_be32(NFSERR_NOTSUPP)
257#define	nfserr_toosmall		cpu_to_be32(NFSERR_TOOSMALL)
258#define	nfserr_serverfault	cpu_to_be32(NFSERR_SERVERFAULT)
259#define	nfserr_badtype		cpu_to_be32(NFSERR_BADTYPE)
260#define	nfserr_jukebox		cpu_to_be32(NFSERR_JUKEBOX)
261#define	nfserr_denied		cpu_to_be32(NFSERR_DENIED)
262#define	nfserr_deadlock		cpu_to_be32(NFSERR_DEADLOCK)
263#define nfserr_expired          cpu_to_be32(NFSERR_EXPIRED)
264#define	nfserr_bad_cookie	cpu_to_be32(NFSERR_BAD_COOKIE)
265#define	nfserr_same		cpu_to_be32(NFSERR_SAME)
266#define	nfserr_clid_inuse	cpu_to_be32(NFSERR_CLID_INUSE)
267#define	nfserr_stale_clientid	cpu_to_be32(NFSERR_STALE_CLIENTID)
268#define	nfserr_resource		cpu_to_be32(NFSERR_RESOURCE)
269#define	nfserr_moved		cpu_to_be32(NFSERR_MOVED)
270#define	nfserr_nofilehandle	cpu_to_be32(NFSERR_NOFILEHANDLE)
271#define	nfserr_minor_vers_mismatch	cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH)
272#define nfserr_share_denied	cpu_to_be32(NFSERR_SHARE_DENIED)
273#define nfserr_stale_stateid	cpu_to_be32(NFSERR_STALE_STATEID)
274#define nfserr_old_stateid	cpu_to_be32(NFSERR_OLD_STATEID)
275#define nfserr_bad_stateid	cpu_to_be32(NFSERR_BAD_STATEID)
276#define nfserr_bad_seqid	cpu_to_be32(NFSERR_BAD_SEQID)
277#define	nfserr_symlink		cpu_to_be32(NFSERR_SYMLINK)
278#define	nfserr_not_same		cpu_to_be32(NFSERR_NOT_SAME)
279#define nfserr_lock_range	cpu_to_be32(NFSERR_LOCK_RANGE)
280#define	nfserr_restorefh	cpu_to_be32(NFSERR_RESTOREFH)
281#define	nfserr_attrnotsupp	cpu_to_be32(NFSERR_ATTRNOTSUPP)
282#define	nfserr_bad_xdr		cpu_to_be32(NFSERR_BAD_XDR)
283#define	nfserr_openmode		cpu_to_be32(NFSERR_OPENMODE)
284#define	nfserr_badowner		cpu_to_be32(NFSERR_BADOWNER)
285#define	nfserr_locks_held	cpu_to_be32(NFSERR_LOCKS_HELD)
286#define	nfserr_op_illegal	cpu_to_be32(NFSERR_OP_ILLEGAL)
287#define	nfserr_grace		cpu_to_be32(NFSERR_GRACE)
288#define	nfserr_no_grace		cpu_to_be32(NFSERR_NO_GRACE)
289#define	nfserr_reclaim_bad	cpu_to_be32(NFSERR_RECLAIM_BAD)
290#define	nfserr_badname		cpu_to_be32(NFSERR_BADNAME)
291#define	nfserr_admin_revoked	cpu_to_be32(NFS4ERR_ADMIN_REVOKED)
292#define	nfserr_cb_path_down	cpu_to_be32(NFSERR_CB_PATH_DOWN)
293#define	nfserr_locked		cpu_to_be32(NFSERR_LOCKED)
294#define	nfserr_wrongsec		cpu_to_be32(NFSERR_WRONGSEC)
295#define nfserr_delay			cpu_to_be32(NFS4ERR_DELAY)
296#define nfserr_badiomode		cpu_to_be32(NFS4ERR_BADIOMODE)
297#define nfserr_badlayout		cpu_to_be32(NFS4ERR_BADLAYOUT)
298#define nfserr_bad_session_digest	cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST)
299#define nfserr_badsession		cpu_to_be32(NFS4ERR_BADSESSION)
300#define nfserr_badslot			cpu_to_be32(NFS4ERR_BADSLOT)
301#define nfserr_complete_already		cpu_to_be32(NFS4ERR_COMPLETE_ALREADY)
302#define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
303#define nfserr_deleg_already_wanted	cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED)
304#define nfserr_back_chan_busy		cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY)
305#define nfserr_layouttrylater		cpu_to_be32(NFS4ERR_LAYOUTTRYLATER)
306#define nfserr_layoutunavailable	cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE)
307#define nfserr_nomatching_layout	cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT)
308#define nfserr_recallconflict		cpu_to_be32(NFS4ERR_RECALLCONFLICT)
309#define nfserr_unknown_layouttype	cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE)
310#define nfserr_seq_misordered		cpu_to_be32(NFS4ERR_SEQ_MISORDERED)
311#define nfserr_sequence_pos		cpu_to_be32(NFS4ERR_SEQUENCE_POS)
312#define nfserr_req_too_big		cpu_to_be32(NFS4ERR_REQ_TOO_BIG)
313#define nfserr_rep_too_big		cpu_to_be32(NFS4ERR_REP_TOO_BIG)
314#define nfserr_rep_too_big_to_cache	cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE)
315#define nfserr_retry_uncached_rep	cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP)
316#define nfserr_unsafe_compound		cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND)
317#define nfserr_too_many_ops		cpu_to_be32(NFS4ERR_TOO_MANY_OPS)
318#define nfserr_op_not_in_session	cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION)
319#define nfserr_hash_alg_unsupp		cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP)
320#define nfserr_clientid_busy		cpu_to_be32(NFS4ERR_CLIENTID_BUSY)
321#define nfserr_pnfs_io_hole		cpu_to_be32(NFS4ERR_PNFS_IO_HOLE)
322#define nfserr_seq_false_retry		cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY)
323#define nfserr_bad_high_slot		cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT)
324#define nfserr_deadsession		cpu_to_be32(NFS4ERR_DEADSESSION)
325#define nfserr_encr_alg_unsupp		cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP)
326#define nfserr_pnfs_no_layout		cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT)
327#define nfserr_not_only_op		cpu_to_be32(NFS4ERR_NOT_ONLY_OP)
328#define nfserr_wrong_cred		cpu_to_be32(NFS4ERR_WRONG_CRED)
329#define nfserr_wrong_type		cpu_to_be32(NFS4ERR_WRONG_TYPE)
330#define nfserr_dirdeleg_unavail		cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL)
331#define nfserr_reject_deleg		cpu_to_be32(NFS4ERR_REJECT_DELEG)
332#define nfserr_returnconflict		cpu_to_be32(NFS4ERR_RETURNCONFLICT)
333#define nfserr_deleg_revoked		cpu_to_be32(NFS4ERR_DELEG_REVOKED)
334#define nfserr_partner_notsupp		cpu_to_be32(NFS4ERR_PARTNER_NOTSUPP)
335#define nfserr_partner_no_auth		cpu_to_be32(NFS4ERR_PARTNER_NO_AUTH)
336#define nfserr_union_notsupp		cpu_to_be32(NFS4ERR_UNION_NOTSUPP)
337#define nfserr_offload_denied		cpu_to_be32(NFS4ERR_OFFLOAD_DENIED)
338#define nfserr_wrong_lfs		cpu_to_be32(NFS4ERR_WRONG_LFS)
339#define nfserr_badlabel			cpu_to_be32(NFS4ERR_BADLABEL)
340#define nfserr_file_open		cpu_to_be32(NFS4ERR_FILE_OPEN)
341#define nfserr_xattr2big		cpu_to_be32(NFS4ERR_XATTR2BIG)
342#define nfserr_noxattr			cpu_to_be32(NFS4ERR_NOXATTR)
343
344/*
345 * Error codes for internal use.  We use enum to choose numbers that are
346 * not already assigned, then covert to be32 resulting in a number that
347 * cannot conflict with any existing be32 nfserr value.
348 */
349enum {
350/* end-of-file indicator in readdir */
351	NFSERR_EOF = NFS4ERR_FIRST_FREE,
352#define	nfserr_eof		cpu_to_be32(NFSERR_EOF)
353
354/* replay detected */
355	NFSERR_REPLAY_ME,
356#define	nfserr_replay_me	cpu_to_be32(NFSERR_REPLAY_ME)
357
358/* nfs41 replay detected */
359	NFSERR_REPLAY_CACHE,
360#define	nfserr_replay_cache	cpu_to_be32(NFSERR_REPLAY_CACHE)
361
362/* symlink found where dir expected - handled differently to
363 * other symlink found errors by NFSv3.
364 */
365	NFSERR_SYMLINK_NOT_DIR,
366#define	nfserr_symlink_not_dir	cpu_to_be32(NFSERR_SYMLINK_NOT_DIR)
367};
368
369/* Check for dir entries '.' and '..' */
370#define isdotent(n, l)	(l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
371
372#ifdef CONFIG_NFSD_V4
373
374/* before processing a COMPOUND operation, we have to check that there
375 * is enough space in the buffer for XDR encode to succeed.  otherwise,
376 * we might process an operation with side effects, and be unable to
377 * tell the client that the operation succeeded.
378 *
379 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
380 * needed to encode an "ordinary" _successful_ operation.  (GETATTR,
381 * READ, READDIR, and READLINK have their own buffer checks.)  if we
382 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
383 *
384 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
385 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
386 * care is taken to ensure that we never fall below this level for any
387 * reason.
388 */
389#define	COMPOUND_SLACK_SPACE		140    /* OP_GETFH */
390#define COMPOUND_ERR_SLACK_SPACE	16     /* OP_SETATTR */
391
392#define NFSD_LAUNDROMAT_MINTIMEOUT      1   /* seconds */
393#define	NFSD_COURTESY_CLIENT_TIMEOUT	(24 * 60 * 60)	/* seconds */
394#define	NFSD_CLIENT_MAX_TRIM_PER_RUN	128
395#define	NFS4_CLIENTS_PER_GB		1024
396#define NFSD_DELEGRETURN_TIMEOUT	(HZ / 34)	/* 30ms */
397#define	NFSD_CB_GETATTR_TIMEOUT		NFSD_DELEGRETURN_TIMEOUT
398
399/*
400 * The following attributes are not implemented by NFSD:
401 *    ARCHIVE       (deprecated anyway)
402 *    HIDDEN        (unlikely to be supported any time soon)
403 *    MIMETYPE      (unlikely to be supported any time soon)
404 *    QUOTA_*       (will be supported in a forthcoming patch)
405 *    SYSTEM        (unlikely to be supported any time soon)
406 *    TIME_BACKUP   (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	FATTR4_WORD2_CLONE_BLKSIZE | \
461	NFSD4_2_SECURITY_ATTRS | \
462	FATTR4_WORD2_XATTR_SUPPORT | \
463	FATTR4_WORD2_TIME_DELEG_ACCESS | \
464	FATTR4_WORD2_TIME_DELEG_MODIFY | \
465	FATTR4_WORD2_OPEN_ARGUMENTS)
466
467extern const u32 nfsd_suppattrs[3][3];
468
469static inline __be32 nfsd4_set_netaddr(struct sockaddr *addr,
470				    struct nfs42_netaddr *netaddr)
471{
472	struct sockaddr_in *sin = (struct sockaddr_in *)addr;
473	struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)addr;
474	unsigned int port;
475	size_t ret_addr, ret_port;
476
477	switch (addr->sa_family) {
478	case AF_INET:
479		port = ntohs(sin->sin_port);
480		sprintf(netaddr->netid, "tcp");
481		netaddr->netid_len = 3;
482		break;
483	case AF_INET6:
484		port = ntohs(sin6->sin6_port);
485		sprintf(netaddr->netid, "tcp6");
486		netaddr->netid_len = 4;
487		break;
488	default:
489		return nfserr_inval;
490	}
491	ret_addr = rpc_ntop(addr, netaddr->addr, sizeof(netaddr->addr));
492	ret_port = snprintf(netaddr->addr + ret_addr,
493			    RPCBIND_MAXUADDRLEN + 1 - ret_addr,
494			    ".%u.%u", port >> 8, port & 0xff);
495	WARN_ON(ret_port >= RPCBIND_MAXUADDRLEN + 1 - ret_addr);
496	netaddr->addr_len = ret_addr + ret_port;
497	return 0;
498}
499
500static inline bool bmval_is_subset(const u32 *bm1, const u32 *bm2)
501{
502	return !((bm1[0] & ~bm2[0]) ||
503	         (bm1[1] & ~bm2[1]) ||
504		 (bm1[2] & ~bm2[2]));
505}
506
507static inline bool nfsd_attrs_supported(u32 minorversion, const u32 *bmval)
508{
509	return bmval_is_subset(bmval, nfsd_suppattrs[minorversion]);
510}
511
512/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
513#define NFSD_WRITEONLY_ATTRS_WORD1 \
514	(FATTR4_WORD1_TIME_ACCESS_SET   | FATTR4_WORD1_TIME_MODIFY_SET)
515
516/*
517 * These are the only attrs allowed in CREATE/OPEN/SETATTR. Don't add
518 * a writeable attribute here without also adding code to parse it to
519 * nfsd4_decode_fattr().
520 */
521#define NFSD_WRITEABLE_ATTRS_WORD0 \
522	(FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL)
523#define NFSD_WRITEABLE_ATTRS_WORD1 \
524	(FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
525	| FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_CREATE \
526	| FATTR4_WORD1_TIME_MODIFY_SET)
527#ifdef CONFIG_NFSD_V4_SECURITY_LABEL
528#define MAYBE_FATTR4_WORD2_SECURITY_LABEL \
529	FATTR4_WORD2_SECURITY_LABEL
530#else
531#define MAYBE_FATTR4_WORD2_SECURITY_LABEL 0
532#endif
533#define NFSD_WRITEABLE_ATTRS_WORD2 \
534	(FATTR4_WORD2_MODE_UMASK \
535	| MAYBE_FATTR4_WORD2_SECURITY_LABEL \
536	| FATTR4_WORD2_TIME_DELEG_ACCESS \
537	| FATTR4_WORD2_TIME_DELEG_MODIFY \
538	)
539
540#define NFSD_SUPPATTR_EXCLCREAT_WORD0 \
541	NFSD_WRITEABLE_ATTRS_WORD0
542/*
543 * we currently store the exclusive create verifier in the v_{a,m}time
544 * attributes so the client can't set these at create time using EXCLUSIVE4_1
545 */
546#define NFSD_SUPPATTR_EXCLCREAT_WORD1 \
547	(NFSD_WRITEABLE_ATTRS_WORD1 & \
548	 ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET))
549/*
550 * The FATTR4_WORD2_TIME_DELEG attributes are not to be allowed for
551 * OPEN(create) with EXCLUSIVE4_1. It doesn't make sense to set a
552 * delegated timestamp on a new file.
553 */
554#define NFSD_SUPPATTR_EXCLCREAT_WORD2 \
555	(NFSD_WRITEABLE_ATTRS_WORD2 & \
556	~(FATTR4_WORD2_TIME_DELEG_ACCESS | FATTR4_WORD2_TIME_DELEG_MODIFY))
557
558extern int nfsd4_is_junction(struct dentry *dentry);
559extern int register_cld_notifier(void);
560extern void unregister_cld_notifier(void);
561#ifdef CONFIG_NFSD_V4_2_INTER_SSC
562extern void nfsd4_ssc_init_umount_work(struct nfsd_net *nn);
563#endif
564
565extern void nfsd4_init_leases_net(struct nfsd_net *nn);
566
567#else /* CONFIG_NFSD_V4 */
568static inline int nfsd4_is_junction(struct dentry *dentry)
569{
570	return 0;
571}
572
573static inline void nfsd4_init_leases_net(struct nfsd_net *nn) { };
574
575#define register_cld_notifier() 0
576#define unregister_cld_notifier() do { } while(0)
577
578#endif /* CONFIG_NFSD_V4 */
579
580#endif /* LINUX_NFSD_NFSD_H */