Loading...
1/*
2 * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
3 *
4 * This file describes the layout of the file handles as passed
5 * over the wire.
6 */
7#ifndef _LINUX_NFSD_NFSFH_H
8#define _LINUX_NFSD_NFSFH_H
9
10#include <linux/crc32.h>
11#include <linux/sunrpc/svc.h>
12#include <uapi/linux/nfsd/nfsfh.h>
13
14static inline __u32 ino_t_to_u32(ino_t ino)
15{
16 return (__u32) ino;
17}
18
19static inline ino_t u32_to_ino_t(__u32 uino)
20{
21 return (ino_t) uino;
22}
23
24/*
25 * This is the internal representation of an NFS handle used in knfsd.
26 * pre_mtime/post_version will be used to support wcc_attr's in NFSv3.
27 */
28typedef struct svc_fh {
29 struct knfsd_fh fh_handle; /* FH data */
30 int fh_maxsize; /* max size for fh_handle */
31 struct dentry * fh_dentry; /* validated dentry */
32 struct svc_export * fh_export; /* export pointer */
33
34 bool fh_locked; /* inode locked by us */
35 bool fh_want_write; /* remount protection taken */
36
37#ifdef CONFIG_NFSD_V3
38 bool fh_post_saved; /* post-op attrs saved */
39 bool fh_pre_saved; /* pre-op attrs saved */
40
41 /* Pre-op attributes saved during fh_lock */
42 __u64 fh_pre_size; /* size before operation */
43 struct timespec fh_pre_mtime; /* mtime before oper */
44 struct timespec fh_pre_ctime; /* ctime before oper */
45 /*
46 * pre-op nfsv4 change attr: note must check IS_I_VERSION(inode)
47 * to find out if it is valid.
48 */
49 u64 fh_pre_change;
50
51 /* Post-op attributes saved in fh_unlock */
52 struct kstat fh_post_attr; /* full attrs after operation */
53 u64 fh_post_change; /* nfsv4 change; see above */
54#endif /* CONFIG_NFSD_V3 */
55
56} svc_fh;
57
58enum nfsd_fsid {
59 FSID_DEV = 0,
60 FSID_NUM,
61 FSID_MAJOR_MINOR,
62 FSID_ENCODE_DEV,
63 FSID_UUID4_INUM,
64 FSID_UUID8,
65 FSID_UUID16,
66 FSID_UUID16_INUM,
67};
68
69enum fsid_source {
70 FSIDSOURCE_DEV,
71 FSIDSOURCE_FSID,
72 FSIDSOURCE_UUID,
73};
74extern enum fsid_source fsid_source(struct svc_fh *fhp);
75
76
77/*
78 * This might look a little large to "inline" but in all calls except
79 * one, 'vers' is constant so moste of the function disappears.
80 *
81 * In some cases the values are considered to be host endian and in
82 * others, net endian. fsidv is always considered to be u32 as the
83 * callers don't know which it will be. So we must use __force to keep
84 * sparse from complaining. Since these values are opaque to the
85 * client, that shouldn't be a problem.
86 */
87static inline void mk_fsid(int vers, u32 *fsidv, dev_t dev, ino_t ino,
88 u32 fsid, unsigned char *uuid)
89{
90 u32 *up;
91 switch(vers) {
92 case FSID_DEV:
93 fsidv[0] = (__force __u32)htonl((MAJOR(dev)<<16) |
94 MINOR(dev));
95 fsidv[1] = ino_t_to_u32(ino);
96 break;
97 case FSID_NUM:
98 fsidv[0] = fsid;
99 break;
100 case FSID_MAJOR_MINOR:
101 fsidv[0] = (__force __u32)htonl(MAJOR(dev));
102 fsidv[1] = (__force __u32)htonl(MINOR(dev));
103 fsidv[2] = ino_t_to_u32(ino);
104 break;
105
106 case FSID_ENCODE_DEV:
107 fsidv[0] = new_encode_dev(dev);
108 fsidv[1] = ino_t_to_u32(ino);
109 break;
110
111 case FSID_UUID4_INUM:
112 /* 4 byte fsid and inode number */
113 up = (u32*)uuid;
114 fsidv[0] = ino_t_to_u32(ino);
115 fsidv[1] = up[0] ^ up[1] ^ up[2] ^ up[3];
116 break;
117
118 case FSID_UUID8:
119 /* 8 byte fsid */
120 up = (u32*)uuid;
121 fsidv[0] = up[0] ^ up[2];
122 fsidv[1] = up[1] ^ up[3];
123 break;
124
125 case FSID_UUID16:
126 /* 16 byte fsid - NFSv3+ only */
127 memcpy(fsidv, uuid, 16);
128 break;
129
130 case FSID_UUID16_INUM:
131 /* 8 byte inode and 16 byte fsid */
132 *(u64*)fsidv = (u64)ino;
133 memcpy(fsidv+2, uuid, 16);
134 break;
135 default: BUG();
136 }
137}
138
139static inline int key_len(int type)
140{
141 switch(type) {
142 case FSID_DEV: return 8;
143 case FSID_NUM: return 4;
144 case FSID_MAJOR_MINOR: return 12;
145 case FSID_ENCODE_DEV: return 8;
146 case FSID_UUID4_INUM: return 8;
147 case FSID_UUID8: return 8;
148 case FSID_UUID16: return 16;
149 case FSID_UUID16_INUM: return 24;
150 default: return 0;
151 }
152}
153
154/*
155 * Shorthand for dprintk()'s
156 */
157extern char * SVCFH_fmt(struct svc_fh *fhp);
158
159/*
160 * Function prototypes
161 */
162__be32 fh_verify(struct svc_rqst *, struct svc_fh *, umode_t, int);
163__be32 fh_compose(struct svc_fh *, struct svc_export *, struct dentry *, struct svc_fh *);
164__be32 fh_update(struct svc_fh *);
165void fh_put(struct svc_fh *);
166
167static __inline__ struct svc_fh *
168fh_copy(struct svc_fh *dst, struct svc_fh *src)
169{
170 WARN_ON(src->fh_dentry || src->fh_locked);
171
172 *dst = *src;
173 return dst;
174}
175
176static inline void
177fh_copy_shallow(struct knfsd_fh *dst, struct knfsd_fh *src)
178{
179 dst->fh_size = src->fh_size;
180 memcpy(&dst->fh_base, &src->fh_base, src->fh_size);
181}
182
183static __inline__ struct svc_fh *
184fh_init(struct svc_fh *fhp, int maxsize)
185{
186 memset(fhp, 0, sizeof(*fhp));
187 fhp->fh_maxsize = maxsize;
188 return fhp;
189}
190
191static inline bool fh_match(struct knfsd_fh *fh1, struct knfsd_fh *fh2)
192{
193 if (fh1->fh_size != fh2->fh_size)
194 return false;
195 if (memcmp(fh1->fh_base.fh_pad, fh2->fh_base.fh_pad, fh1->fh_size) != 0)
196 return false;
197 return true;
198}
199
200static inline bool fh_fsid_match(struct knfsd_fh *fh1, struct knfsd_fh *fh2)
201{
202 if (fh1->fh_fsid_type != fh2->fh_fsid_type)
203 return false;
204 if (memcmp(fh1->fh_fsid, fh2->fh_fsid, key_len(fh1->fh_fsid_type)) != 0)
205 return false;
206 return true;
207}
208
209#ifdef CONFIG_CRC32
210/**
211 * knfsd_fh_hash - calculate the crc32 hash for the filehandle
212 * @fh - pointer to filehandle
213 *
214 * returns a crc32 hash for the filehandle that is compatible with
215 * the one displayed by "wireshark".
216 */
217
218static inline u32
219knfsd_fh_hash(struct knfsd_fh *fh)
220{
221 return ~crc32_le(0xFFFFFFFF, (unsigned char *)&fh->fh_base, fh->fh_size);
222}
223#else
224static inline u32
225knfsd_fh_hash(struct knfsd_fh *fh)
226{
227 return 0;
228}
229#endif
230
231#ifdef CONFIG_NFSD_V3
232/*
233 * The wcc data stored in current_fh should be cleared
234 * between compound ops.
235 */
236static inline void
237fh_clear_wcc(struct svc_fh *fhp)
238{
239 fhp->fh_post_saved = false;
240 fhp->fh_pre_saved = false;
241}
242
243/*
244 * Fill in the pre_op attr for the wcc data
245 */
246static inline void
247fill_pre_wcc(struct svc_fh *fhp)
248{
249 struct inode *inode;
250
251 inode = d_inode(fhp->fh_dentry);
252 if (!fhp->fh_pre_saved) {
253 fhp->fh_pre_mtime = inode->i_mtime;
254 fhp->fh_pre_ctime = inode->i_ctime;
255 fhp->fh_pre_size = inode->i_size;
256 fhp->fh_pre_change = inode->i_version;
257 fhp->fh_pre_saved = true;
258 }
259}
260
261extern void fill_post_wcc(struct svc_fh *);
262#else
263#define fh_clear_wcc(ignored)
264#define fill_pre_wcc(ignored)
265#define fill_post_wcc(notused)
266#endif /* CONFIG_NFSD_V3 */
267
268
269/*
270 * Lock a file handle/inode
271 * NOTE: both fh_lock and fh_unlock are done "by hand" in
272 * vfs.c:nfsd_rename as it needs to grab 2 i_mutex's at once
273 * so, any changes here should be reflected there.
274 */
275
276static inline void
277fh_lock_nested(struct svc_fh *fhp, unsigned int subclass)
278{
279 struct dentry *dentry = fhp->fh_dentry;
280 struct inode *inode;
281
282 BUG_ON(!dentry);
283
284 if (fhp->fh_locked) {
285 printk(KERN_WARNING "fh_lock: %pd2 already locked!\n",
286 dentry);
287 return;
288 }
289
290 inode = d_inode(dentry);
291 inode_lock_nested(inode, subclass);
292 fill_pre_wcc(fhp);
293 fhp->fh_locked = true;
294}
295
296static inline void
297fh_lock(struct svc_fh *fhp)
298{
299 fh_lock_nested(fhp, I_MUTEX_NORMAL);
300}
301
302/*
303 * Unlock a file handle/inode
304 */
305static inline void
306fh_unlock(struct svc_fh *fhp)
307{
308 if (fhp->fh_locked) {
309 fill_post_wcc(fhp);
310 inode_unlock(d_inode(fhp->fh_dentry));
311 fhp->fh_locked = false;
312 }
313}
314
315#endif /* _LINUX_NFSD_NFSFH_H */
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
4 *
5 * This file describes the layout of the file handles as passed
6 * over the wire.
7 */
8#ifndef _LINUX_NFSD_NFSFH_H
9#define _LINUX_NFSD_NFSFH_H
10
11#include <linux/crc32.h>
12#include <linux/sunrpc/svc.h>
13#include <linux/iversion.h>
14#include <linux/exportfs.h>
15#include <linux/nfs4.h>
16
17/*
18 * The file handle starts with a sequence of four-byte words.
19 * The first word contains a version number (1) and three descriptor bytes
20 * that tell how the remaining 3 variable length fields should be handled.
21 * These three bytes are auth_type, fsid_type and fileid_type.
22 *
23 * All four-byte values are in host-byte-order.
24 *
25 * The auth_type field is deprecated and must be set to 0.
26 *
27 * The fsid_type identifies how the filesystem (or export point) is
28 * encoded.
29 * Current values:
30 * 0 - 4 byte device id (ms-2-bytes major, ls-2-bytes minor), 4byte inode number
31 * NOTE: we cannot use the kdev_t device id value, because kdev_t.h
32 * says we mustn't. We must break it up and reassemble.
33 * 1 - 4 byte user specified identifier
34 * 2 - 4 byte major, 4 byte minor, 4 byte inode number - DEPRECATED
35 * 3 - 4 byte device id, encoded for user-space, 4 byte inode number
36 * 4 - 4 byte inode number and 4 byte uuid
37 * 5 - 8 byte uuid
38 * 6 - 16 byte uuid
39 * 7 - 8 byte inode number and 16 byte uuid
40 *
41 * The fileid_type identifies how the file within the filesystem is encoded.
42 * The values for this field are filesystem specific, exccept that
43 * filesystems must not use the values '0' or '0xff'. 'See enum fid_type'
44 * in include/linux/exportfs.h for currently registered values.
45 */
46
47struct knfsd_fh {
48 unsigned int fh_size; /*
49 * Points to the current size while
50 * building a new file handle.
51 */
52 union {
53 char fh_raw[NFS4_FHSIZE];
54 struct {
55 u8 fh_version; /* == 1 */
56 u8 fh_auth_type; /* deprecated */
57 u8 fh_fsid_type;
58 u8 fh_fileid_type;
59 u32 fh_fsid[]; /* flexible-array member */
60 };
61 };
62};
63
64static inline __u32 ino_t_to_u32(ino_t ino)
65{
66 return (__u32) ino;
67}
68
69static inline ino_t u32_to_ino_t(__u32 uino)
70{
71 return (ino_t) uino;
72}
73
74/*
75 * This is the internal representation of an NFS handle used in knfsd.
76 * pre_mtime/post_version will be used to support wcc_attr's in NFSv3.
77 */
78typedef struct svc_fh {
79 struct knfsd_fh fh_handle; /* FH data */
80 int fh_maxsize; /* max size for fh_handle */
81 struct dentry * fh_dentry; /* validated dentry */
82 struct svc_export * fh_export; /* export pointer */
83
84 bool fh_want_write; /* remount protection taken */
85 bool fh_no_wcc; /* no wcc data needed */
86 bool fh_no_atomic_attr;
87 /*
88 * wcc data is not atomic with
89 * operation
90 */
91 bool fh_use_wgather; /* NFSv2 wgather option */
92 bool fh_64bit_cookies;/* readdir cookie size */
93 int fh_flags; /* FH flags */
94 bool fh_post_saved; /* post-op attrs saved */
95 bool fh_pre_saved; /* pre-op attrs saved */
96
97 /* Pre-op attributes saved when inode is locked */
98 __u64 fh_pre_size; /* size before operation */
99 struct timespec64 fh_pre_mtime; /* mtime before oper */
100 struct timespec64 fh_pre_ctime; /* ctime before oper */
101 /*
102 * pre-op nfsv4 change attr: note must check IS_I_VERSION(inode)
103 * to find out if it is valid.
104 */
105 u64 fh_pre_change;
106
107 /* Post-op attributes saved in fh_fill_post_attrs() */
108 struct kstat fh_post_attr; /* full attrs after operation */
109 u64 fh_post_change; /* nfsv4 change; see above */
110} svc_fh;
111#define NFSD4_FH_FOREIGN (1<<0)
112#define SET_FH_FLAG(c, f) ((c)->fh_flags |= (f))
113#define HAS_FH_FLAG(c, f) ((c)->fh_flags & (f))
114
115enum nfsd_fsid {
116 FSID_DEV = 0,
117 FSID_NUM,
118 FSID_MAJOR_MINOR,
119 FSID_ENCODE_DEV,
120 FSID_UUID4_INUM,
121 FSID_UUID8,
122 FSID_UUID16,
123 FSID_UUID16_INUM,
124};
125
126enum fsid_source {
127 FSIDSOURCE_DEV,
128 FSIDSOURCE_FSID,
129 FSIDSOURCE_UUID,
130};
131extern enum fsid_source fsid_source(const struct svc_fh *fhp);
132
133
134/*
135 * This might look a little large to "inline" but in all calls except
136 * one, 'vers' is constant so moste of the function disappears.
137 *
138 * In some cases the values are considered to be host endian and in
139 * others, net endian. fsidv is always considered to be u32 as the
140 * callers don't know which it will be. So we must use __force to keep
141 * sparse from complaining. Since these values are opaque to the
142 * client, that shouldn't be a problem.
143 */
144static inline void mk_fsid(int vers, u32 *fsidv, dev_t dev, ino_t ino,
145 u32 fsid, unsigned char *uuid)
146{
147 u32 *up;
148 switch(vers) {
149 case FSID_DEV:
150 fsidv[0] = (__force __u32)htonl((MAJOR(dev)<<16) |
151 MINOR(dev));
152 fsidv[1] = ino_t_to_u32(ino);
153 break;
154 case FSID_NUM:
155 fsidv[0] = fsid;
156 break;
157 case FSID_MAJOR_MINOR:
158 fsidv[0] = (__force __u32)htonl(MAJOR(dev));
159 fsidv[1] = (__force __u32)htonl(MINOR(dev));
160 fsidv[2] = ino_t_to_u32(ino);
161 break;
162
163 case FSID_ENCODE_DEV:
164 fsidv[0] = new_encode_dev(dev);
165 fsidv[1] = ino_t_to_u32(ino);
166 break;
167
168 case FSID_UUID4_INUM:
169 /* 4 byte fsid and inode number */
170 up = (u32*)uuid;
171 fsidv[0] = ino_t_to_u32(ino);
172 fsidv[1] = up[0] ^ up[1] ^ up[2] ^ up[3];
173 break;
174
175 case FSID_UUID8:
176 /* 8 byte fsid */
177 up = (u32*)uuid;
178 fsidv[0] = up[0] ^ up[2];
179 fsidv[1] = up[1] ^ up[3];
180 break;
181
182 case FSID_UUID16:
183 /* 16 byte fsid - NFSv3+ only */
184 memcpy(fsidv, uuid, 16);
185 break;
186
187 case FSID_UUID16_INUM:
188 /* 8 byte inode and 16 byte fsid */
189 *(u64*)fsidv = (u64)ino;
190 memcpy(fsidv+2, uuid, 16);
191 break;
192 default: BUG();
193 }
194}
195
196static inline int key_len(int type)
197{
198 switch(type) {
199 case FSID_DEV: return 8;
200 case FSID_NUM: return 4;
201 case FSID_MAJOR_MINOR: return 12;
202 case FSID_ENCODE_DEV: return 8;
203 case FSID_UUID4_INUM: return 8;
204 case FSID_UUID8: return 8;
205 case FSID_UUID16: return 16;
206 case FSID_UUID16_INUM: return 24;
207 default: return 0;
208 }
209}
210
211/*
212 * Shorthand for dprintk()'s
213 */
214extern char * SVCFH_fmt(struct svc_fh *fhp);
215
216/*
217 * Function prototypes
218 */
219__be32 fh_verify(struct svc_rqst *, struct svc_fh *, umode_t, int);
220__be32 fh_verify_local(struct net *, struct svc_cred *, struct auth_domain *,
221 struct svc_fh *, umode_t, int);
222__be32 fh_compose(struct svc_fh *, struct svc_export *, struct dentry *, struct svc_fh *);
223__be32 fh_update(struct svc_fh *);
224void fh_put(struct svc_fh *);
225
226static __inline__ struct svc_fh *
227fh_copy(struct svc_fh *dst, const struct svc_fh *src)
228{
229 WARN_ON(src->fh_dentry);
230
231 *dst = *src;
232 return dst;
233}
234
235static inline void
236fh_copy_shallow(struct knfsd_fh *dst, const struct knfsd_fh *src)
237{
238 dst->fh_size = src->fh_size;
239 memcpy(&dst->fh_raw, &src->fh_raw, src->fh_size);
240}
241
242static __inline__ struct svc_fh *
243fh_init(struct svc_fh *fhp, int maxsize)
244{
245 memset(fhp, 0, sizeof(*fhp));
246 fhp->fh_maxsize = maxsize;
247 return fhp;
248}
249
250static inline bool fh_match(const struct knfsd_fh *fh1,
251 const struct knfsd_fh *fh2)
252{
253 if (fh1->fh_size != fh2->fh_size)
254 return false;
255 if (memcmp(fh1->fh_raw, fh2->fh_raw, fh1->fh_size) != 0)
256 return false;
257 return true;
258}
259
260static inline bool fh_fsid_match(const struct knfsd_fh *fh1,
261 const struct knfsd_fh *fh2)
262{
263 if (fh1->fh_fsid_type != fh2->fh_fsid_type)
264 return false;
265 if (memcmp(fh1->fh_fsid, fh2->fh_fsid, key_len(fh1->fh_fsid_type)) != 0)
266 return false;
267 return true;
268}
269
270#ifdef CONFIG_CRC32
271/**
272 * knfsd_fh_hash - calculate the crc32 hash for the filehandle
273 * @fh - pointer to filehandle
274 *
275 * returns a crc32 hash for the filehandle that is compatible with
276 * the one displayed by "wireshark".
277 */
278static inline u32 knfsd_fh_hash(const struct knfsd_fh *fh)
279{
280 return ~crc32_le(0xFFFFFFFF, fh->fh_raw, fh->fh_size);
281}
282#else
283static inline u32 knfsd_fh_hash(const struct knfsd_fh *fh)
284{
285 return 0;
286}
287#endif
288
289/**
290 * fh_clear_pre_post_attrs - Reset pre/post attributes
291 * @fhp: file handle to be updated
292 *
293 */
294static inline void fh_clear_pre_post_attrs(struct svc_fh *fhp)
295{
296 fhp->fh_post_saved = false;
297 fhp->fh_pre_saved = false;
298}
299
300u64 nfsd4_change_attribute(const struct kstat *stat);
301__be32 __must_check fh_fill_pre_attrs(struct svc_fh *fhp);
302__be32 fh_fill_post_attrs(struct svc_fh *fhp);
303__be32 __must_check fh_fill_both_attrs(struct svc_fh *fhp);
304#endif /* _LINUX_NFSD_NFSFH_H */