2009-05-04 15:23:58 +00:00
|
|
|
/*-
|
2017-11-20 19:43:44 +00:00
|
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
*
|
2009-05-04 15:23:58 +00:00
|
|
|
* Copyright (c) 1989, 1993
|
|
|
|
* The Regents of the University of California. All rights reserved.
|
|
|
|
*
|
|
|
|
* This code is derived from software contributed to Berkeley by
|
|
|
|
* Rick Macklem at The University of Guelph.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
2017-02-28 23:42:47 +00:00
|
|
|
* 3. Neither the name of the University nor the names of its contributors
|
2009-05-04 15:23:58 +00:00
|
|
|
* may be used to endorse or promote products derived from this software
|
|
|
|
* without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
* $FreeBSD$
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _NFSCLIENT_NFSNODE_H_
|
|
|
|
#define _NFSCLIENT_NFSNODE_H_
|
|
|
|
|
2011-08-02 11:28:42 +00:00
|
|
|
#include <sys/_task.h>
|
|
|
|
|
2009-05-04 15:23:58 +00:00
|
|
|
/*
|
|
|
|
* Silly rename structure that hangs off the nfsnode until the name
|
|
|
|
* can be removed by nfs_inactive()
|
|
|
|
*/
|
|
|
|
struct sillyrename {
|
2011-08-02 11:28:42 +00:00
|
|
|
struct task s_task;
|
2009-05-04 15:23:58 +00:00
|
|
|
struct ucred *s_cred;
|
|
|
|
struct vnode *s_dvp;
|
|
|
|
long s_namlen;
|
|
|
|
char s_name[32];
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This structure is used to save the logical directory offset to
|
|
|
|
* NFS cookie mappings.
|
|
|
|
* The mappings are stored in a list headed
|
|
|
|
* by n_cookies, as required.
|
|
|
|
* There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
|
|
|
|
* stored in increasing logical offset byte order.
|
|
|
|
*/
|
|
|
|
#define NFSNUMCOOKIES 31
|
|
|
|
|
|
|
|
struct nfsdmap {
|
|
|
|
LIST_ENTRY(nfsdmap) ndm_list;
|
|
|
|
int ndm_eocookie;
|
|
|
|
union {
|
|
|
|
nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
|
|
|
|
uint64_t ndmu4_cookies[NFSNUMCOOKIES];
|
|
|
|
} ndm_un1;
|
|
|
|
};
|
|
|
|
|
|
|
|
#define ndm_cookies ndm_un1.ndmu3_cookies
|
|
|
|
#define ndm4_cookies ndm_un1.ndmu4_cookies
|
|
|
|
|
|
|
|
struct nfs_accesscache {
|
|
|
|
u_int32_t mode; /* ACCESS mode cache */
|
|
|
|
uid_t uid; /* credentials having mode */
|
|
|
|
time_t stamp; /* mode cache timestamp */
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* The nfsnode is the nfs equivalent to ufs's inode. Any similarity
|
|
|
|
* is purely coincidental.
|
|
|
|
* There is a unique nfsnode allocated for each active file,
|
|
|
|
* each current directory, each mounted-on file, text file, and the root.
|
|
|
|
* An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
|
|
|
|
* If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
|
|
|
|
* type definitions), file handles of > 32 bytes should probably be split out
|
2018-01-25 22:25:13 +00:00
|
|
|
* into a separate malloc()'d data structure. (Reduce the size of nfsfh_t by
|
2009-05-04 15:23:58 +00:00
|
|
|
* changing the definition in nfsproto.h of NFS_SMALLFH.)
|
|
|
|
* NB: Hopefully the current order of the fields is such that everything will
|
|
|
|
* be well aligned and, therefore, tightly packed.
|
|
|
|
*/
|
|
|
|
struct nfsnode {
|
|
|
|
struct mtx n_mtx; /* Protects all of these members */
|
2017-08-20 10:08:45 +00:00
|
|
|
struct lock n_excl; /* Exclusive helper for shared
|
|
|
|
vnode lock */
|
2009-05-04 15:23:58 +00:00
|
|
|
u_quad_t n_size; /* Current size of file */
|
|
|
|
u_quad_t n_brev; /* Modify rev when cached */
|
|
|
|
u_quad_t n_lrev; /* Modify rev for lease */
|
|
|
|
struct nfsvattr n_vattr; /* Vnode attribute cache */
|
|
|
|
time_t n_attrstamp; /* Attr. cache timestamp */
|
|
|
|
struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
|
|
|
|
struct timespec n_mtime; /* Prev modify time. */
|
|
|
|
struct nfsfh *n_fhp; /* NFS File Handle */
|
|
|
|
struct vnode *n_vnode; /* associated vnode */
|
|
|
|
struct vnode *n_dvp; /* parent vnode */
|
|
|
|
struct lockf *n_lockf; /* Locking record of file */
|
|
|
|
int n_error; /* Save write error value */
|
|
|
|
union {
|
|
|
|
struct timespec nf_atim; /* Special file times */
|
|
|
|
nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
|
|
|
|
u_char nd4_cookieverf[NFSX_VERF];
|
|
|
|
} n_un1;
|
|
|
|
union {
|
|
|
|
struct timespec nf_mtim;
|
|
|
|
off_t nd_direof; /* Dir. EOF offset cache */
|
|
|
|
} n_un2;
|
|
|
|
union {
|
|
|
|
struct sillyrename *nf_silly; /* Ptr to silly rename struct */
|
|
|
|
LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
|
|
|
|
} n_un3;
|
|
|
|
short n_fhsize; /* size in bytes, of fh */
|
|
|
|
u_int32_t n_flag; /* Flag for locking.. */
|
|
|
|
int n_directio_opens;
|
|
|
|
int n_directio_asyncwr;
|
|
|
|
u_int64_t n_change; /* old Change attribute */
|
|
|
|
struct nfsv4node *n_v4; /* extra V4 stuff */
|
2012-05-12 12:02:51 +00:00
|
|
|
struct ucred *n_writecred; /* Cred. for putpages */
|
2021-07-28 22:48:27 +00:00
|
|
|
struct nfsclopen *n_openstateid; /* Cached open stateid */
|
PR#259071 provides a test program that fails for the NFS client.
Testing with it, there appears to be a race between Lookup
and VOPs like Setattr-of-size, where Lookup ends up loading
stale attributes (including what might be the wrong file size)
into the NFS vnode's attribute cache.
The race occurs when the modifying VOP (which holds a lock
on the vnode), blocks the acquisition of the vnode in Lookup,
after the RPC (with now potentially stale attributes).
Here's what seems to happen:
Child Parent
does stat(), which does
VOP_LOOKUP(), doing the Lookup
RPC with the directory vnode
locked, acquiring file attributes
valid at this point in time
blocks waiting for locked file does ftruncate(), which
vnode does VOP_SETATTR() of Size,
changing the file's size
while holding an exclusive
lock on the file's vnode
releases the vnode lock
acquires file vnode and fills in
now stale attributes including
the old wrong Size
does a read() which returns
wrong data size
This patch fixes the problem by saving a timestamp in the NFS vnode
in the VOPs that modify the file (Setattr-of-size, Allocate).
Then lookup/readdirplus compares that timestamp with the time just
before starting the RPC after it has acquired the file's vnode.
If the modifying RPC occurred during the Lookup, the attributes
in the RPC reply are discarded, since they might be stale.
With this patch the test program works as expected.
Note that the test program does not fail on a July stable/12,
although this race is in the NFS client code. I suspect a
fairly recent change to the name caching code exposed this
bug.
PR: 259071
Reviewed by: asomers
MFC after: 2 weeks
Differential Revision: https://reviews.freebsd.org/D32635
2021-10-30 23:35:02 +00:00
|
|
|
struct timespec n_localmodtime; /* Last local modify */
|
2009-05-04 15:23:58 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#define n_atim n_un1.nf_atim
|
|
|
|
#define n_mtim n_un2.nf_mtim
|
|
|
|
#define n_sillyrename n_un3.nf_silly
|
|
|
|
#define n_cookieverf n_un1.nd_cookieverf
|
|
|
|
#define n4_cookieverf n_un1.nd4_cookieverf
|
|
|
|
#define n_direofoffset n_un2.nd_direof
|
|
|
|
#define n_cookies n_un3.nd_cook
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Flags for n_flag
|
|
|
|
*/
|
|
|
|
#define NDIRCOOKIELK 0x00000001 /* Lock to serialize access to directory cookies */
|
|
|
|
#define NFSYNCWAIT 0x00000002 /* fsync waiting for all directio async
|
|
|
|
writes to drain */
|
|
|
|
#define NMODIFIED 0x00000004 /* Might have a modified buffer in bio */
|
|
|
|
#define NWRITEERR 0x00000008 /* Flag write errors so close will know */
|
|
|
|
#define NCREATED 0x00000010 /* Opened by nfs_create() */
|
|
|
|
#define NTRUNCATE 0x00000020 /* Opened by nfs_setattr() */
|
|
|
|
#define NSIZECHANGED 0x00000040 /* File size has changed: need cache inval */
|
|
|
|
#define NNONCACHE 0x00000080 /* Node marked as noncacheable */
|
|
|
|
#define NACC 0x00000100 /* Special file accessed */
|
|
|
|
#define NUPD 0x00000200 /* Special file updated */
|
|
|
|
#define NCHG 0x00000400 /* Special file times changed */
|
|
|
|
#define NDELEGMOD 0x00000800 /* Modified delegation */
|
|
|
|
#define NDELEGRECALL 0x00001000 /* Recall in progress */
|
|
|
|
#define NREMOVEINPROG 0x00002000 /* Remove in progress */
|
|
|
|
#define NREMOVEWANT 0x00004000 /* Want notification that remove is done */
|
|
|
|
#define NLOCK 0x00008000 /* Sleep lock the node */
|
|
|
|
#define NLOCKWANT 0x00010000 /* Want the sleep lock */
|
2012-12-08 22:52:39 +00:00
|
|
|
#define NNOLAYOUT 0x00020000 /* Can't get a layout for this file */
|
|
|
|
#define NWRITEOPENED 0x00040000 /* Has been opened for writing */
|
2013-12-07 23:05:59 +00:00
|
|
|
#define NHASBEENLOCKED 0x00080000 /* Has been file locked. */
|
2017-06-26 00:43:04 +00:00
|
|
|
#define NDSCOMMIT 0x00100000 /* Commit is done via the DS. */
|
2019-10-22 16:17:38 +00:00
|
|
|
#define NVNSETSZSKIP 0x00200000 /* Skipped vnode_pager_setsize() */
|
2021-07-28 22:48:27 +00:00
|
|
|
#define NMIGHTBELOCKED 0x00400000 /* Might be file locked. */
|
2009-05-04 15:23:58 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Convert between nfsnode pointers and vnode pointers
|
|
|
|
*/
|
|
|
|
#define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
|
|
|
|
#define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
|
|
|
|
|
|
|
|
#define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
|
|
|
|
|
|
|
|
#if defined(_KERNEL)
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Prototypes for NFS vnode operations
|
|
|
|
*/
|
|
|
|
int ncl_getpages(struct vop_getpages_args *);
|
|
|
|
int ncl_putpages(struct vop_putpages_args *);
|
|
|
|
int ncl_write(struct vop_write_args *);
|
|
|
|
int ncl_inactive(struct vop_inactive_args *);
|
|
|
|
int ncl_reclaim(struct vop_reclaim_args *);
|
|
|
|
|
|
|
|
/* other stuff */
|
|
|
|
int ncl_removeit(struct sillyrename *, struct vnode *);
|
2011-04-16 23:20:21 +00:00
|
|
|
int ncl_nget(struct mount *, u_int8_t *, int, struct nfsnode **, int);
|
2009-05-04 15:23:58 +00:00
|
|
|
nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
|
|
|
|
void ncl_invaldir(struct vnode *);
|
2017-08-20 10:08:45 +00:00
|
|
|
bool ncl_excl_start(struct vnode *);
|
|
|
|
void ncl_excl_finish(struct vnode *, bool old_lock);
|
2009-05-04 15:23:58 +00:00
|
|
|
void ncl_dircookie_lock(struct nfsnode *);
|
|
|
|
void ncl_dircookie_unlock(struct nfsnode *);
|
|
|
|
|
|
|
|
#endif /* _KERNEL */
|
|
|
|
|
|
|
|
#endif /* _NFSCLIENT_NFSNODE_H_ */
|