blob: d63cf8196fedac141a3540c40e81e92cd5664408 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/mount.h>
14
J. Bruce Fieldsc10bd392011-08-19 11:38:52 -040015#include <linux/nfs.h>
16#include <linux/nfs2.h>
17#include <linux/nfs3.h>
18#include <linux/nfs4.h>
Christoph Hellwig9c69de42014-05-06 19:37:13 +020019#include <linux/sunrpc/svc.h>
Trond Myklebuste45d1a12019-04-09 12:13:42 -040020#include <linux/sunrpc/svc_xprt.h>
J. Bruce Fieldsc10bd392011-08-19 11:38:52 -040021#include <linux/sunrpc/msg_prot.h>
Olga Kornievskaiaaf76fc62019-06-05 13:46:29 -040022#include <linux/sunrpc/addr.h>
J. Bruce Fieldsc10bd392011-08-19 11:38:52 -040023
Christoph Hellwig6f226e22014-05-06 19:37:16 +020024#include <uapi/linux/nfsd/debug.h>
J. Bruce Fieldsc10bd392011-08-19 11:38:52 -040025
J. Bruce Fieldse8a79fb2019-03-22 11:11:06 -040026#include "netns.h"
Christoph Hellwig7f944232014-05-06 19:37:15 +020027#include "stats.h"
Christoph Hellwigd430e8d52014-05-06 19:37:14 +020028#include "export.h"
29
Christoph Hellwig6f226e22014-05-06 19:37:16 +020030#undef ifdebug
Mark Salter135dd002015-04-06 09:46:00 -040031#ifdef CONFIG_SUNRPC_DEBUG
Christoph Hellwig6f226e22014-05-06 19:37:16 +020032# define ifdebug(flag) if (nfsd_debug & NFSDDBG_##flag)
33#else
34# define ifdebug(flag) if (0)
35#endif
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/*
38 * nfsd version
39 */
Steve Dickson4bdc33e2013-05-02 13:18:57 -040040#define NFSD_SUPPORTED_MINOR_VERSION 2
J. Bruce Fieldsc10bd392011-08-19 11:38:52 -040041/*
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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Linus Torvalds1da177e2005-04-16 15:20:36 -070061struct readdir_cd {
Al Viro131a21c2006-10-19 23:28:56 -070062 __be32 err; /* 0, nfserr, or nfserr_eof */
Linus Torvalds1da177e2005-04-16 15:20:36 -070063};
J. Bruce Fields0a3adad2009-11-04 18:12:35 -050064
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66extern struct svc_program nfsd_program;
Christoph Hellwige9679182017-05-12 16:21:37 +020067extern const struct svc_version nfsd_version2, nfsd_version3,
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 nfsd_version4;
Neil Brownbedbdd82008-06-10 08:40:35 -040069extern struct mutex nfsd_mutex;
Andy Adamson4bd9b0f42009-06-24 15:37:45 -040070extern spinlock_t nfsd_drc_lock;
Zhang Yanfei697ce9b2013-02-22 16:35:47 -080071extern unsigned long nfsd_drc_max_mem;
72extern unsigned long nfsd_drc_mem_used;
Harvey Harrisona254b242008-02-20 12:49:00 -080073
James Morris88e9d342009-09-22 16:43:43 -070074extern const struct seq_operations nfs_exports_op;
Harvey Harrisona254b242008-02-20 12:49:00 -080075
Linus Torvalds1da177e2005-04-16 15:20:36 -070076/*
Chuck Lever788f7182020-11-05 14:48:29 -050077 * Common void argument and result helpers
78 */
79struct nfsd_voidargs { };
80struct nfsd_voidres { };
81int nfssvc_decode_voidarg(struct svc_rqst *rqstp, __be32 *p);
82int nfssvc_encode_voidres(struct svc_rqst *rqstp, __be32 *p);
83
84/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 * Function prototypes.
86 */
Trond Myklebust4df493a2019-04-09 12:13:37 -040087int nfsd_svc(int nrservs, struct net *net, const struct cred *cred);
Al Viroc7afef12006-10-19 23:29:02 -070088int nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Stanislav Kinsbursky9dd98452012-12-06 14:23:24 +030090int nfsd_nrthreads(struct net *);
91int nfsd_nrpools(struct net *);
92int nfsd_get_nrthreads(int n, int *, struct net *);
Stanislav Kinsbursky3938a0d2012-12-10 12:19:30 +030093int nfsd_set_nrthreads(int n, int *, struct net *);
J. Bruce Fields7f2e7dc2012-06-12 16:06:29 -040094int nfsd_pool_stats_open(struct inode *, struct file *);
95int nfsd_pool_stats_release(struct inode *, struct file *);
Harvey Harrisona254b242008-02-20 12:49:00 -080096
Stanislav Kinsbursky9dd98452012-12-06 14:23:24 +030097void nfsd_destroy(struct net *net);
Stanislav Kinsbursky19f7e2c2012-07-03 16:46:41 +040098
J. Bruce Fields28df3d12017-07-28 16:35:15 -040099bool i_am_nfsd(void);
100
J. Bruce Fields681370f2020-06-23 16:00:33 -0400101int get_nfsdfs(struct net *);
102
J. Bruce Fieldse8a79fb2019-03-22 11:11:06 -0400103struct nfsdfs_client {
104 struct kref cl_ref;
105 void (*cl_release)(struct kref *kref);
106};
107
J. Bruce Fields97ad4032019-04-09 15:56:57 -0400108struct nfsdfs_client *get_nfsdfs_client(struct inode *);
109struct dentry *nfsd_client_mkdir(struct nfsd_net *nn,
110 struct nfsdfs_client *ncl, u32 id, const struct tree_descr *);
J. Bruce Fieldse8a79fb2019-03-22 11:11:06 -0400111void nfsd_client_rmdir(struct dentry *dentry);
112
J. Bruce Fields681370f2020-06-23 16:00:33 -0400113
Andreas Gruenbachera257cdd2005-06-22 17:16:26 +0000114#if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
115#ifdef CONFIG_NFSD_V2_ACL
Christoph Hellwige9679182017-05-12 16:21:37 +0200116extern const struct svc_version nfsd_acl_version2;
Andreas Gruenbachera257cdd2005-06-22 17:16:26 +0000117#else
118#define nfsd_acl_version2 NULL
119#endif
120#ifdef CONFIG_NFSD_V3_ACL
Christoph Hellwige9679182017-05-12 16:21:37 +0200121extern const struct svc_version nfsd_acl_version3;
Andreas Gruenbachera257cdd2005-06-22 17:16:26 +0000122#else
123#define nfsd_acl_version3 NULL
124#endif
Andreas Gruenbachera257cdd2005-06-22 17:16:26 +0000125#endif
126
Trond Myklebuste333f3b2019-04-09 11:46:19 -0400127struct nfsd_net;
128
NeilBrown6658d3a2006-10-02 02:17:46 -0700129enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
Trond Myklebuste333f3b2019-04-09 11:46:19 -0400130int nfsd_vers(struct nfsd_net *nn, int vers, enum vers_op change);
131int nfsd_minorversion(struct nfsd_net *nn, u32 minorversion, enum vers_op change);
132void nfsd_reset_versions(struct nfsd_net *nn);
Stanislav Kinsbursky67774362012-12-10 12:19:20 +0300133int nfsd_create_serv(struct net *net);
NeilBrown6658d3a2006-10-02 02:17:46 -0700134
NeilBrown596bbe52006-10-04 02:15:48 -0700135extern int nfsd_max_blksize;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Steve Dickson03a816b42009-09-09 15:06:05 -0400137static inline int nfsd_v4client(struct svc_rqst *rq)
138{
139 return rq->rq_prog == NFS_PROGRAM && rq->rq_vers == 4;
140}
Trond Myklebuste45d1a12019-04-09 12:13:42 -0400141static inline struct user_namespace *
142nfsd_user_namespace(const struct svc_rqst *rqstp)
143{
144 const struct cred *cred = rqstp->rq_xprt->xpt_cred;
145 return cred ? cred->user_ns : &init_user_ns;
146}
Steve Dickson03a816b42009-09-09 15:06:05 -0400147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148/*
149 * NFSv4 State
150 */
151#ifdef CONFIG_NFSD_V4
Zhang Yanfei697ce9b2013-02-22 16:35:47 -0800152extern unsigned long max_delegations;
Bryan Schumaker72083392011-11-01 15:24:59 -0400153int nfsd4_init_slabs(void);
J. Bruce Fieldse8ff2a82007-08-01 15:30:59 -0400154void nfsd4_free_slabs(void);
J. Bruce Fields29ab23c2009-09-15 15:56:50 -0400155int nfs4_state_start(void);
Stanislav Kinsburskyf252bc62012-11-26 15:22:18 +0300156int nfs4_state_start_net(struct net *net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157void nfs4_state_shutdown(void);
Stanislav Kinsburskyf252bc62012-11-26 15:22:18 +0300158void nfs4_state_shutdown_net(struct net *net);
NeilBrown0964a3d2005-06-23 22:04:32 -0700159int nfs4_reset_recoverydir(char *recdir);
J. Bruce Fields87f26f92012-07-27 15:49:26 -0400160char * nfs4_recoverydir(void);
Andrew Elbleed941642016-06-15 12:52:09 -0400161bool nfsd4_spo_must_allow(struct svc_rqst *rqstp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162#else
Bryan Schumaker72083392011-11-01 15:24:59 -0400163static inline int nfsd4_init_slabs(void) { return 0; }
J. Bruce Fieldse8ff2a82007-08-01 15:30:59 -0400164static inline void nfsd4_free_slabs(void) { }
Stephen Rothwellc0826572009-09-17 17:03:06 +1000165static inline int nfs4_state_start(void) { return 0; }
Stanislav Kinsburskyf252bc62012-11-26 15:22:18 +0300166static inline int nfs4_state_start_net(struct net *net) { return 0; }
J. Bruce Fieldse8ff2a82007-08-01 15:30:59 -0400167static inline void nfs4_state_shutdown(void) { }
Stanislav Kinsburskyf252bc62012-11-26 15:22:18 +0300168static inline void nfs4_state_shutdown_net(struct net *net) { }
J. Bruce Fieldse8ff2a82007-08-01 15:30:59 -0400169static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
J. Bruce Fields87f26f92012-07-27 15:49:26 -0400170static inline char * nfs4_recoverydir(void) {return NULL; }
Andrew Elbleed941642016-06-15 12:52:09 -0400171static inline bool nfsd4_spo_must_allow(struct svc_rqst *rqstp)
172{
173 return false;
174}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175#endif
176
177/*
178 * lockd binding
179 */
180void nfsd_lockd_init(void);
181void nfsd_lockd_shutdown(void);
182
183
184/*
185 * These macros provide pre-xdr'ed values for faster operation.
186 */
Harvey Harrison77f18f52009-02-11 17:16:58 -0800187#define nfs_ok cpu_to_be32(NFS_OK)
188#define nfserr_perm cpu_to_be32(NFSERR_PERM)
189#define nfserr_noent cpu_to_be32(NFSERR_NOENT)
190#define nfserr_io cpu_to_be32(NFSERR_IO)
191#define nfserr_nxio cpu_to_be32(NFSERR_NXIO)
192#define nfserr_eagain cpu_to_be32(NFSERR_EAGAIN)
193#define nfserr_acces cpu_to_be32(NFSERR_ACCES)
194#define nfserr_exist cpu_to_be32(NFSERR_EXIST)
195#define nfserr_xdev cpu_to_be32(NFSERR_XDEV)
196#define nfserr_nodev cpu_to_be32(NFSERR_NODEV)
197#define nfserr_notdir cpu_to_be32(NFSERR_NOTDIR)
198#define nfserr_isdir cpu_to_be32(NFSERR_ISDIR)
199#define nfserr_inval cpu_to_be32(NFSERR_INVAL)
200#define nfserr_fbig cpu_to_be32(NFSERR_FBIG)
201#define nfserr_nospc cpu_to_be32(NFSERR_NOSPC)
202#define nfserr_rofs cpu_to_be32(NFSERR_ROFS)
203#define nfserr_mlink cpu_to_be32(NFSERR_MLINK)
204#define nfserr_opnotsupp cpu_to_be32(NFSERR_OPNOTSUPP)
205#define nfserr_nametoolong cpu_to_be32(NFSERR_NAMETOOLONG)
206#define nfserr_notempty cpu_to_be32(NFSERR_NOTEMPTY)
207#define nfserr_dquot cpu_to_be32(NFSERR_DQUOT)
208#define nfserr_stale cpu_to_be32(NFSERR_STALE)
209#define nfserr_remote cpu_to_be32(NFSERR_REMOTE)
210#define nfserr_wflush cpu_to_be32(NFSERR_WFLUSH)
211#define nfserr_badhandle cpu_to_be32(NFSERR_BADHANDLE)
212#define nfserr_notsync cpu_to_be32(NFSERR_NOT_SYNC)
213#define nfserr_badcookie cpu_to_be32(NFSERR_BAD_COOKIE)
214#define nfserr_notsupp cpu_to_be32(NFSERR_NOTSUPP)
215#define nfserr_toosmall cpu_to_be32(NFSERR_TOOSMALL)
216#define nfserr_serverfault cpu_to_be32(NFSERR_SERVERFAULT)
217#define nfserr_badtype cpu_to_be32(NFSERR_BADTYPE)
218#define nfserr_jukebox cpu_to_be32(NFSERR_JUKEBOX)
219#define nfserr_denied cpu_to_be32(NFSERR_DENIED)
220#define nfserr_deadlock cpu_to_be32(NFSERR_DEADLOCK)
221#define nfserr_expired cpu_to_be32(NFSERR_EXPIRED)
222#define nfserr_bad_cookie cpu_to_be32(NFSERR_BAD_COOKIE)
223#define nfserr_same cpu_to_be32(NFSERR_SAME)
224#define nfserr_clid_inuse cpu_to_be32(NFSERR_CLID_INUSE)
225#define nfserr_stale_clientid cpu_to_be32(NFSERR_STALE_CLIENTID)
226#define nfserr_resource cpu_to_be32(NFSERR_RESOURCE)
227#define nfserr_moved cpu_to_be32(NFSERR_MOVED)
228#define nfserr_nofilehandle cpu_to_be32(NFSERR_NOFILEHANDLE)
229#define nfserr_minor_vers_mismatch cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH)
230#define nfserr_share_denied cpu_to_be32(NFSERR_SHARE_DENIED)
231#define nfserr_stale_stateid cpu_to_be32(NFSERR_STALE_STATEID)
232#define nfserr_old_stateid cpu_to_be32(NFSERR_OLD_STATEID)
233#define nfserr_bad_stateid cpu_to_be32(NFSERR_BAD_STATEID)
234#define nfserr_bad_seqid cpu_to_be32(NFSERR_BAD_SEQID)
235#define nfserr_symlink cpu_to_be32(NFSERR_SYMLINK)
236#define nfserr_not_same cpu_to_be32(NFSERR_NOT_SAME)
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400237#define nfserr_lock_range cpu_to_be32(NFSERR_LOCK_RANGE)
Harvey Harrison77f18f52009-02-11 17:16:58 -0800238#define nfserr_restorefh cpu_to_be32(NFSERR_RESTOREFH)
239#define nfserr_attrnotsupp cpu_to_be32(NFSERR_ATTRNOTSUPP)
240#define nfserr_bad_xdr cpu_to_be32(NFSERR_BAD_XDR)
241#define nfserr_openmode cpu_to_be32(NFSERR_OPENMODE)
J. Bruce Fieldsf6af99e2011-01-04 18:02:15 -0500242#define nfserr_badowner cpu_to_be32(NFSERR_BADOWNER)
Harvey Harrison77f18f52009-02-11 17:16:58 -0800243#define nfserr_locks_held cpu_to_be32(NFSERR_LOCKS_HELD)
244#define nfserr_op_illegal cpu_to_be32(NFSERR_OP_ILLEGAL)
245#define nfserr_grace cpu_to_be32(NFSERR_GRACE)
246#define nfserr_no_grace cpu_to_be32(NFSERR_NO_GRACE)
247#define nfserr_reclaim_bad cpu_to_be32(NFSERR_RECLAIM_BAD)
248#define nfserr_badname cpu_to_be32(NFSERR_BADNAME)
249#define nfserr_cb_path_down cpu_to_be32(NFSERR_CB_PATH_DOWN)
250#define nfserr_locked cpu_to_be32(NFSERR_LOCKED)
251#define nfserr_wrongsec cpu_to_be32(NFSERR_WRONGSEC)
Marc Eshel10add802009-04-03 08:27:40 +0300252#define nfserr_badiomode cpu_to_be32(NFS4ERR_BADIOMODE)
253#define nfserr_badlayout cpu_to_be32(NFS4ERR_BADLAYOUT)
254#define nfserr_bad_session_digest cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST)
255#define nfserr_badsession cpu_to_be32(NFS4ERR_BADSESSION)
256#define nfserr_badslot cpu_to_be32(NFS4ERR_BADSLOT)
257#define nfserr_complete_already cpu_to_be32(NFS4ERR_COMPLETE_ALREADY)
258#define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
259#define nfserr_deleg_already_wanted cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED)
260#define nfserr_back_chan_busy cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY)
261#define nfserr_layouttrylater cpu_to_be32(NFS4ERR_LAYOUTTRYLATER)
262#define nfserr_layoutunavailable cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE)
263#define nfserr_nomatching_layout cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT)
264#define nfserr_recallconflict cpu_to_be32(NFS4ERR_RECALLCONFLICT)
265#define nfserr_unknown_layouttype cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE)
266#define nfserr_seq_misordered cpu_to_be32(NFS4ERR_SEQ_MISORDERED)
267#define nfserr_sequence_pos cpu_to_be32(NFS4ERR_SEQUENCE_POS)
268#define nfserr_req_too_big cpu_to_be32(NFS4ERR_REQ_TOO_BIG)
269#define nfserr_rep_too_big cpu_to_be32(NFS4ERR_REP_TOO_BIG)
270#define nfserr_rep_too_big_to_cache cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE)
271#define nfserr_retry_uncached_rep cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP)
272#define nfserr_unsafe_compound cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND)
273#define nfserr_too_many_ops cpu_to_be32(NFS4ERR_TOO_MANY_OPS)
274#define nfserr_op_not_in_session cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION)
275#define nfserr_hash_alg_unsupp cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP)
276#define nfserr_clientid_busy cpu_to_be32(NFS4ERR_CLIENTID_BUSY)
277#define nfserr_pnfs_io_hole cpu_to_be32(NFS4ERR_PNFS_IO_HOLE)
278#define nfserr_seq_false_retry cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY)
279#define nfserr_bad_high_slot cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT)
280#define nfserr_deadsession cpu_to_be32(NFS4ERR_DEADSESSION)
281#define nfserr_encr_alg_unsupp cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP)
282#define nfserr_pnfs_no_layout cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT)
283#define nfserr_not_only_op cpu_to_be32(NFS4ERR_NOT_ONLY_OP)
284#define nfserr_wrong_cred cpu_to_be32(NFS4ERR_WRONG_CRED)
285#define nfserr_wrong_type cpu_to_be32(NFS4ERR_WRONG_TYPE)
286#define nfserr_dirdeleg_unavail cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL)
287#define nfserr_reject_deleg cpu_to_be32(NFS4ERR_REJECT_DELEG)
288#define nfserr_returnconflict cpu_to_be32(NFS4ERR_RETURNCONFLICT)
289#define nfserr_deleg_revoked cpu_to_be32(NFS4ERR_DELEG_REVOKED)
Steve Dickson4488cc92013-05-02 13:18:55 -0400290#define nfserr_partner_notsupp cpu_to_be32(NFS4ERR_PARTNER_NOTSUPP)
291#define nfserr_partner_no_auth cpu_to_be32(NFS4ERR_PARTNER_NO_AUTH)
Anna Schumaker2b8941b2014-08-27 11:17:56 -0400292#define nfserr_union_notsupp cpu_to_be32(NFS4ERR_UNION_NOTSUPP)
Steve Dickson4488cc92013-05-02 13:18:55 -0400293#define nfserr_offload_denied cpu_to_be32(NFS4ERR_OFFLOAD_DENIED)
294#define nfserr_wrong_lfs cpu_to_be32(NFS4ERR_WRONG_LFS)
NeilBrown466e16f2019-11-28 13:56:43 +1100295#define nfserr_badlabel cpu_to_be32(NFS4ERR_BADLABEL)
296#define nfserr_file_open cpu_to_be32(NFS4ERR_FILE_OPEN)
Frank van der Linden4dd05fc2020-06-23 22:39:22 +0000297#define nfserr_xattr2big cpu_to_be32(NFS4ERR_XATTR2BIG)
298#define nfserr_noxattr cpu_to_be32(NFS4ERR_NOXATTR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
300/* error codes for internal use */
301/* if a request fails due to kmalloc failure, it gets dropped.
302 * Client should resend eventually
303 */
Harvey Harrison77f18f52009-02-11 17:16:58 -0800304#define nfserr_dropit cpu_to_be32(30000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305/* end-of-file indicator in readdir */
Harvey Harrison77f18f52009-02-11 17:16:58 -0800306#define nfserr_eof cpu_to_be32(30001)
Marc Eshel10add802009-04-03 08:27:40 +0300307/* replay detected */
308#define nfserr_replay_me cpu_to_be32(11001)
309/* nfs41 replay detected */
310#define nfserr_replay_cache cpu_to_be32(11002)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312/* Check for dir entries '.' and '..' */
313#define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315#ifdef CONFIG_NFSD_V4
316
317/* before processing a COMPOUND operation, we have to check that there
318 * is enough space in the buffer for XDR encode to succeed. otherwise,
319 * we might process an operation with side effects, and be unable to
320 * tell the client that the operation succeeded.
321 *
J.Bruce Fieldse5710192006-12-13 00:35:20 -0800322 * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 * needed to encode an "ordinary" _successful_ operation. (GETATTR,
324 * READ, READDIR, and READLINK have their own buffer checks.) if we
325 * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
326 *
J.Bruce Fieldse5710192006-12-13 00:35:20 -0800327 * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
329 * care is taken to ensure that we never fall below this level for any
330 * reason.
331 */
332#define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
J. Bruce Fields04819bf2014-02-03 16:38:47 -0500333#define COMPOUND_ERR_SLACK_SPACE 16 /* OP_SETATTR */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
J. Bruce Fieldsecec6e32010-10-11 16:49:44 -0400335#define NFSD_LAUNDROMAT_MINTIMEOUT 1 /* seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
337/*
338 * The following attributes are currently not supported by the NFSv4 server:
339 * ARCHIVE (deprecated anyway)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 * HIDDEN (unlikely to be supported any time soon)
341 * MIMETYPE (unlikely to be supported any time soon)
342 * QUOTA_* (will be supported in a forthcoming patch)
343 * SYSTEM (unlikely to be supported any time soon)
344 * TIME_BACKUP (unlikely to be supported any time soon)
345 * TIME_CREATE (unlikely to be supported any time soon)
346 */
Andy Adamson7e705702009-04-03 08:29:11 +0300347#define NFSD4_SUPPORTED_ATTRS_WORD0 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348(FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
349 | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
350 | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
351 | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
352 | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
353 | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
354 | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
J.Bruce Fields81c3f412006-10-04 02:16:19 -0700355 | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
357 | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
358
Andy Adamson7e705702009-04-03 08:29:11 +0300359#define NFSD4_SUPPORTED_ATTRS_WORD1 \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360(FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
361 | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
362 | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
363 | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
364 | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
365 | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
366
Andy Adamson7e705702009-04-03 08:29:11 +0300367#define NFSD4_SUPPORTED_ATTRS_WORD2 0
368
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200369/* 4.1 */
370#ifdef CONFIG_NFSD_PNFS
371#define PNFSD_SUPPORTED_ATTRS_WORD1 FATTR4_WORD1_FS_LAYOUT_TYPES
372#define PNFSD_SUPPORTED_ATTRS_WORD2 \
373(FATTR4_WORD2_LAYOUT_BLKSIZE | FATTR4_WORD2_LAYOUT_TYPES)
374#else
375#define PNFSD_SUPPORTED_ATTRS_WORD1 0
376#define PNFSD_SUPPORTED_ATTRS_WORD2 0
377#endif /* CONFIG_NFSD_PNFS */
378
Andy Adamson7e705702009-04-03 08:29:11 +0300379#define NFSD4_1_SUPPORTED_ATTRS_WORD0 \
380 NFSD4_SUPPORTED_ATTRS_WORD0
381
382#define NFSD4_1_SUPPORTED_ATTRS_WORD1 \
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200383 (NFSD4_SUPPORTED_ATTRS_WORD1 | PNFSD_SUPPORTED_ATTRS_WORD1)
Andy Adamson7e705702009-04-03 08:29:11 +0300384
385#define NFSD4_1_SUPPORTED_ATTRS_WORD2 \
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200386 (NFSD4_SUPPORTED_ATTRS_WORD2 | PNFSD_SUPPORTED_ATTRS_WORD2 | \
387 FATTR4_WORD2_SUPPATTR_EXCLCREAT)
Andy Adamson7e705702009-04-03 08:29:11 +0300388
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200389/* 4.2 */
David Quigley18032ca2013-05-02 13:19:10 -0400390#ifdef CONFIG_NFSD_V4_SECURITY_LABEL
Christoph Hellwig6d0ba042014-11-08 13:11:03 +0100391#define NFSD4_2_SECURITY_ATTRS FATTR4_WORD2_SECURITY_LABEL
David Quigley18032ca2013-05-02 13:19:10 -0400392#else
Christoph Hellwig6d0ba042014-11-08 13:11:03 +0100393#define NFSD4_2_SECURITY_ATTRS 0
David Quigley18032ca2013-05-02 13:19:10 -0400394#endif
395
Christoph Hellwig6d0ba042014-11-08 13:11:03 +0100396#define NFSD4_2_SUPPORTED_ATTRS_WORD2 \
397 (NFSD4_1_SUPPORTED_ATTRS_WORD2 | \
Andreas Gruenbacher47057ab2016-01-12 20:24:14 +0100398 FATTR4_WORD2_MODE_UMASK | \
Frank van der Linden4dd05fc2020-06-23 22:39:22 +0000399 NFSD4_2_SECURITY_ATTRS | \
400 FATTR4_WORD2_XATTR_SUPPORT)
Christoph Hellwig6d0ba042014-11-08 13:11:03 +0100401
J. Bruce Fields5cf23db2017-01-11 20:40:36 -0500402extern const u32 nfsd_suppattrs[3][3];
J. Bruce Fields916d2d82016-10-18 14:18:40 -0400403
Olga Kornievskaia10db6512019-12-04 15:13:52 -0500404static inline __be32 nfsd4_set_netaddr(struct sockaddr *addr,
Olga Kornievskaiaaf76fc62019-06-05 13:46:29 -0400405 struct nfs42_netaddr *netaddr)
406{
407 struct sockaddr_in *sin = (struct sockaddr_in *)addr;
408 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)addr;
409 unsigned int port;
410 size_t ret_addr, ret_port;
411
412 switch (addr->sa_family) {
413 case AF_INET:
414 port = ntohs(sin->sin_port);
415 sprintf(netaddr->netid, "tcp");
416 netaddr->netid_len = 3;
417 break;
418 case AF_INET6:
419 port = ntohs(sin6->sin6_port);
420 sprintf(netaddr->netid, "tcp6");
421 netaddr->netid_len = 4;
422 break;
423 default:
424 return nfserr_inval;
425 }
426 ret_addr = rpc_ntop(addr, netaddr->addr, sizeof(netaddr->addr));
427 ret_port = snprintf(netaddr->addr + ret_addr,
428 RPCBIND_MAXUADDRLEN + 1 - ret_addr,
429 ".%u.%u", port >> 8, port & 0xff);
430 WARN_ON(ret_port >= RPCBIND_MAXUADDRLEN + 1 - ret_addr);
431 netaddr->addr_len = ret_addr + ret_port;
432 return 0;
433}
434
J. Bruce Fields5cf23db2017-01-11 20:40:36 -0500435static inline bool bmval_is_subset(const u32 *bm1, const u32 *bm2)
Andy Adamson7e705702009-04-03 08:29:11 +0300436{
J. Bruce Fields916d2d82016-10-18 14:18:40 -0400437 return !((bm1[0] & ~bm2[0]) ||
438 (bm1[1] & ~bm2[1]) ||
439 (bm1[2] & ~bm2[2]));
Andy Adamson7e705702009-04-03 08:29:11 +0300440}
441
J. Bruce Fields5cf23db2017-01-11 20:40:36 -0500442static inline bool nfsd_attrs_supported(u32 minorversion, const u32 *bmval)
Andy Adamson7e705702009-04-03 08:29:11 +0300443{
J. Bruce Fields916d2d82016-10-18 14:18:40 -0400444 return bmval_is_subset(bmval, nfsd_suppattrs[minorversion]);
Andy Adamson7e705702009-04-03 08:29:11 +0300445}
446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447/* These will return ERR_INVAL if specified in GETATTR or READDIR. */
Bryan Schumakerc7e84722011-11-01 14:18:28 -0400448#define NFSD_WRITEONLY_ATTRS_WORD1 \
449 (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
J. Bruce Fieldse864c182016-06-10 16:56:05 -0400451/*
452 * These are the only attrs allowed in CREATE/OPEN/SETATTR. Don't add
453 * a writeable attribute here without also adding code to parse it to
454 * nfsd4_decode_fattr().
455 */
Bryan Schumakerc7e84722011-11-01 14:18:28 -0400456#define NFSD_WRITEABLE_ATTRS_WORD0 \
457 (FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL)
458#define NFSD_WRITEABLE_ATTRS_WORD1 \
459 (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
460 | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
David Quigley18032ca2013-05-02 13:19:10 -0400461#ifdef CONFIG_NFSD_V4_SECURITY_LABEL
Andreas Gruenbacher47057ab2016-01-12 20:24:14 +0100462#define MAYBE_FATTR4_WORD2_SECURITY_LABEL \
463 FATTR4_WORD2_SECURITY_LABEL
David Quigley18032ca2013-05-02 13:19:10 -0400464#else
Andreas Gruenbacher47057ab2016-01-12 20:24:14 +0100465#define MAYBE_FATTR4_WORD2_SECURITY_LABEL 0
David Quigley18032ca2013-05-02 13:19:10 -0400466#endif
Andreas Gruenbacher47057ab2016-01-12 20:24:14 +0100467#define NFSD_WRITEABLE_ATTRS_WORD2 \
468 (FATTR4_WORD2_MODE_UMASK \
469 | MAYBE_FATTR4_WORD2_SECURITY_LABEL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Benny Halevy8c18f202009-04-03 08:29:14 +0300471#define NFSD_SUPPATTR_EXCLCREAT_WORD0 \
472 NFSD_WRITEABLE_ATTRS_WORD0
473/*
474 * we currently store the exclusive create verifier in the v_{a,m}time
475 * attributes so the client can't set these at create time using EXCLUSIVE4_1
476 */
477#define NFSD_SUPPATTR_EXCLCREAT_WORD1 \
478 (NFSD_WRITEABLE_ATTRS_WORD1 & \
479 ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET))
480#define NFSD_SUPPATTR_EXCLCREAT_WORD2 \
481 NFSD_WRITEABLE_ATTRS_WORD2
482
Trond Myklebust11fcee022011-09-12 19:37:26 -0400483extern int nfsd4_is_junction(struct dentry *dentry);
Jeff Layton797a9d72012-03-29 07:52:49 -0400484extern int register_cld_notifier(void);
485extern void unregister_cld_notifier(void);
486#else /* CONFIG_NFSD_V4 */
Trond Myklebust11fcee022011-09-12 19:37:26 -0400487static inline int nfsd4_is_junction(struct dentry *dentry)
488{
489 return 0;
490}
491
Jeff Layton797a9d72012-03-29 07:52:49 -0400492#define register_cld_notifier() 0
493#define unregister_cld_notifier() do { } while(0)
494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495#endif /* CONFIG_NFSD_V4 */
496
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497#endif /* LINUX_NFSD_NFSD_H */