License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 17:07:57 +03:00
/* SPDX-License-Identifier: GPL-2.0 */
2009-11-05 02:12:35 +03:00
/*
* Copyright ( C ) 1995 - 1997 Olaf Kirch < okir @ monad . swb . de >
*/
# ifndef LINUX_NFSD_VFS_H
# define LINUX_NFSD_VFS_H
2022-07-26 09:45:30 +03:00
# include <linux/fs.h>
# include <linux/posix_acl.h>
2009-12-05 03:36:06 +03:00
# include "nfsfh.h"
2013-01-24 11:18:08 +04:00
# include "nfsd.h"
2009-12-05 03:36:06 +03:00
2009-11-05 02:12:35 +03:00
/*
* Flags for nfsd_permission
*/
2011-08-25 22:23:39 +04:00
# define NFSD_MAY_NOP 0
# define NFSD_MAY_EXEC 0x001 /* == MAY_EXEC */
# define NFSD_MAY_WRITE 0x002 /* == MAY_WRITE */
# define NFSD_MAY_READ 0x004 /* == MAY_READ */
# define NFSD_MAY_SATTR 0x008
# define NFSD_MAY_TRUNC 0x010
# define NFSD_MAY_LOCK 0x020
# define NFSD_MAY_MASK 0x03f
2011-04-10 18:35:12 +04:00
/* extra hints to permission and open routines: */
2011-08-25 22:23:39 +04:00
# define NFSD_MAY_OWNER_OVERRIDE 0x040
# define NFSD_MAY_LOCAL_ACCESS 0x080 /* for device special files */
# define NFSD_MAY_BYPASS_GSS_ON_ROOT 0x100
# define NFSD_MAY_NOT_BREAK_LEASE 0x200
# define NFSD_MAY_BYPASS_GSS 0x400
# define NFSD_MAY_READ_IF_EXEC 0x800
2009-11-05 02:12:35 +03:00
2012-03-19 06:44:50 +04:00
# define NFSD_MAY_64BIT_COOKIE 0x1000 /* 64 bit readdir cookies for >= NFSv3 */
2009-11-05 02:12:35 +03:00
# define NFSD_MAY_CREATE (NFSD_MAY_EXEC|NFSD_MAY_WRITE)
# define NFSD_MAY_REMOVE (NFSD_MAY_EXEC|NFSD_MAY_WRITE|NFSD_MAY_TRUNC)
2020-01-06 21:40:29 +03:00
struct nfsd_file ;
2009-11-05 02:12:35 +03:00
/*
* Callback function for readdir
*/
2014-10-30 19:37:34 +03:00
typedef int ( * nfsd_filldir_t ) ( void * , const char * , int , loff_t , u64 , unsigned ) ;
2009-11-05 02:12:35 +03:00
/* nfsd/vfs.c */
2022-07-26 09:45:30 +03:00
struct nfsd_attrs {
struct iattr * na_iattr ; /* input */
2022-07-26 09:45:30 +03:00
struct xdr_netobj * na_seclabel ; /* input */
2022-07-26 09:45:30 +03:00
struct posix_acl * na_pacl ; /* input */
struct posix_acl * na_dpacl ; /* input */
2022-07-26 09:45:30 +03:00
int na_labelerr ; /* output */
2022-07-26 09:45:30 +03:00
int na_aclerr ; /* output */
2022-07-26 09:45:30 +03:00
} ;
2022-07-26 09:45:30 +03:00
static inline void nfsd_attrs_free ( struct nfsd_attrs * attrs )
{
posix_acl_release ( attrs - > na_pacl ) ;
posix_acl_release ( attrs - > na_dpacl ) ;
}
2022-10-18 14:47:55 +03:00
__be32 nfserrno ( int errno ) ;
2009-11-05 02:12:35 +03:00
int nfsd_cross_mnt ( struct svc_rqst * rqstp , struct dentry * * dpp ,
struct svc_export * * expp ) ;
__be32 nfsd_lookup ( struct svc_rqst * , struct svc_fh * ,
const char * , unsigned int , struct svc_fh * ) ;
__be32 nfsd_lookup_dentry ( struct svc_rqst * , struct svc_fh * ,
const char * , unsigned int ,
struct svc_export * * , struct dentry * * ) ;
__be32 nfsd_setattr ( struct svc_rqst * , struct svc_fh * ,
2022-07-26 09:45:30 +03:00
struct nfsd_attrs * , int , time64_t ) ;
2009-10-26 04:43:01 +03:00
int nfsd_mountpoint ( struct dentry * , struct svc_export * ) ;
2009-11-05 02:12:35 +03:00
# ifdef CONFIG_NFSD_V4
2014-11-07 22:44:26 +03:00
__be32 nfsd4_vfs_fallocate ( struct svc_rqst * , struct svc_fh * ,
struct file * , loff_t , loff_t , int ) ;
2021-12-19 04:38:00 +03:00
__be32 nfsd4_clone_file_range ( struct svc_rqst * rqstp ,
struct nfsd_file * nf_src , u64 src_pos ,
2020-01-06 21:40:32 +03:00
struct nfsd_file * nf_dst , u64 dst_pos ,
u64 count , bool sync ) ;
2009-11-05 02:12:35 +03:00
# endif /* CONFIG_NFSD_V4 */
2016-07-20 23:16:06 +03:00
__be32 nfsd_create_locked ( struct svc_rqst * , struct svc_fh * ,
2022-09-06 03:42:19 +03:00
struct nfsd_attrs * attrs , int type , dev_t rdev ,
struct svc_fh * res ) ;
2009-11-05 02:12:35 +03:00
__be32 nfsd_create ( struct svc_rqst * , struct svc_fh * ,
2022-07-26 09:45:30 +03:00
char * name , int len , struct nfsd_attrs * attrs ,
2009-11-05 02:12:35 +03:00
int type , dev_t rdev , struct svc_fh * res ) ;
__be32 nfsd_access ( struct svc_rqst * , struct svc_fh * , u32 * , u32 * ) ;
2022-03-28 23:10:17 +03:00
__be32 nfsd_create_setattr ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
2022-07-26 09:45:30 +03:00
struct svc_fh * resfhp , struct nfsd_attrs * iap ) ;
NFSD: COMMIT operations must not return NFS?ERR_INVAL
Since, well, forever, the Linux NFS server's nfsd_commit() function
has returned nfserr_inval when the passed-in byte range arguments
were non-sensical.
However, according to RFC 1813 section 3.3.21, NFSv3 COMMIT requests
are permitted to return only the following non-zero status codes:
NFS3ERR_IO
NFS3ERR_STALE
NFS3ERR_BADHANDLE
NFS3ERR_SERVERFAULT
NFS3ERR_INVAL is not included in that list. Likewise, NFS4ERR_INVAL
is not listed in the COMMIT row of Table 6 in RFC 8881.
RFC 7530 does permit COMMIT to return NFS4ERR_INVAL, but does not
specify when it can or should be used.
Instead of dropping or failing a COMMIT request in a byte range that
is not supported, turn it into a valid request by treating one or
both arguments as zero. Offset zero means start-of-file, count zero
means until-end-of-file, so we only ever extend the commit range.
NFS servers are always allowed to commit more and sooner than
requested.
The range check is no longer bounded by NFS_OFFSET_MAX, but rather
by the value that is returned in the maxfilesize field of the NFSv3
FSINFO procedure or the NFSv4 maxfilesize file attribute.
Note that this change results in a new pynfs failure:
CMT4 st_commit.testCommitOverflow : RUNNING
CMT4 st_commit.testCommitOverflow : FAILURE
COMMIT with offset + count overflow should return
NFS4ERR_INVAL, instead got NFS4_OK
IMO the test is not correct as written: RFC 8881 does not allow the
COMMIT operation to return NFS4ERR_INVAL.
Reported-by: Dan Aloni <dan.aloni@vastdata.com>
Cc: stable@vger.kernel.org
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Reviewed-by: Bruce Fields <bfields@fieldses.org>
2022-01-24 23:50:31 +03:00
__be32 nfsd_commit ( struct svc_rqst * rqst , struct svc_fh * fhp ,
2022-10-28 17:46:38 +03:00
struct nfsd_file * nf , u64 offset , u32 count ,
__be32 * verf ) ;
2020-06-24 01:39:23 +03:00
# ifdef CONFIG_NFSD_V4
__be32 nfsd_getxattr ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
char * name , void * * bufp , int * lenp ) ;
__be32 nfsd_listxattr ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
char * * bufp , int * lenp ) ;
__be32 nfsd_removexattr ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
char * name ) ;
__be32 nfsd_setxattr ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
char * name , void * buf , u32 len , u32 flags ) ;
# endif
2019-08-18 21:18:48 +03:00
int nfsd_open_break_lease ( struct inode * , int ) ;
2011-07-26 11:30:54 +04:00
__be32 nfsd_open ( struct svc_rqst * , struct svc_fh * , umode_t ,
2009-11-05 02:12:35 +03:00
int , struct file * * ) ;
2023-09-11 21:30:27 +03:00
int nfsd_open_verified ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
int may_flags , struct file * * filp ) ;
2018-03-28 20:29:11 +03:00
__be32 nfsd_splice_read ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
struct file * file , loff_t offset ,
2019-08-26 20:03:11 +03:00
unsigned long * count ,
u32 * eof ) ;
2023-05-18 20:45:56 +03:00
__be32 nfsd_iter_read ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
struct file * file , loff_t offset ,
unsigned long * count , unsigned int base ,
u32 * eof ) ;
__be32 nfsd_read ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
loff_t offset , unsigned long * count ,
2019-08-26 20:03:11 +03:00
u32 * eof ) ;
2016-12-31 16:00:13 +03:00
__be32 nfsd_write ( struct svc_rqst * , struct svc_fh * , loff_t ,
2020-01-06 21:40:37 +03:00
struct kvec * , int , unsigned long * ,
int stable , __be32 * verf ) ;
2015-06-18 17:45:00 +03:00
__be32 nfsd_vfs_write ( struct svc_rqst * rqstp , struct svc_fh * fhp ,
2020-01-06 21:40:29 +03:00
struct nfsd_file * nf , loff_t offset ,
2015-06-18 17:45:00 +03:00
struct kvec * vec , int vlen , unsigned long * cnt ,
2020-01-06 21:40:37 +03:00
int stable , __be32 * verf ) ;
2009-11-05 02:12:35 +03:00
__be32 nfsd_readlink ( struct svc_rqst * , struct svc_fh * ,
char * , int * ) ;
__be32 nfsd_symlink ( struct svc_rqst * , struct svc_fh * ,
2022-07-26 09:45:30 +03:00
char * name , int len , char * path ,
struct nfsd_attrs * attrs ,
struct svc_fh * res ) ;
2009-11-05 02:12:35 +03:00
__be32 nfsd_link ( struct svc_rqst * , struct svc_fh * ,
char * , int , struct svc_fh * ) ;
2016-09-07 22:57:30 +03:00
ssize_t nfsd_copy_file_range ( struct file * , u64 ,
struct file * , u64 , u64 ) ;
2009-11-05 02:12:35 +03:00
__be32 nfsd_rename ( struct svc_rqst * ,
struct svc_fh * , char * , int ,
struct svc_fh * , char * , int ) ;
__be32 nfsd_unlink ( struct svc_rqst * , struct svc_fh * , int type ,
char * name , int len ) ;
__be32 nfsd_readdir ( struct svc_rqst * , struct svc_fh * ,
2014-10-30 19:37:34 +03:00
loff_t * , struct readdir_cd * , nfsd_filldir_t ) ;
2009-11-05 02:12:35 +03:00
__be32 nfsd_statfs ( struct svc_rqst * , struct svc_fh * ,
struct kstatfs * , int access ) ;
__be32 nfsd_permission ( struct svc_rqst * , struct svc_export * ,
struct dentry * , int ) ;
2011-11-23 21:03:18 +04:00
static inline int fh_want_write ( struct svc_fh * fh )
{
2019-04-12 23:37:30 +03:00
int ret ;
2012-06-12 18:20:33 +04:00
2019-04-12 23:37:30 +03:00
if ( fh - > fh_want_write )
return 0 ;
ret = mnt_want_write ( fh - > fh_export - > ex_path . mnt ) ;
2012-06-12 18:20:33 +04:00
if ( ! ret )
2015-09-17 15:28:39 +03:00
fh - > fh_want_write = true ;
2012-06-12 18:20:33 +04:00
return ret ;
2011-11-23 21:03:18 +04:00
}
static inline void fh_drop_write ( struct svc_fh * fh )
{
2012-06-12 18:20:33 +04:00
if ( fh - > fh_want_write ) {
2015-09-17 15:28:39 +03:00
fh - > fh_want_write = false ;
2012-06-12 18:20:33 +04:00
mnt_drop_write ( fh - > fh_export - > ex_path . mnt ) ;
}
2011-11-23 21:03:18 +04:00
}
2020-10-22 20:56:58 +03:00
static inline __be32 fh_getattr ( const struct svc_fh * fh , struct kstat * stat )
2013-01-24 11:18:08 +04:00
{
2022-09-07 21:45:01 +03:00
u32 request_mask = STATX_BASIC_STATS ;
2013-01-24 11:18:08 +04:00
struct path p = { . mnt = fh - > fh_export - > ex_path . mnt ,
. dentry = fh - > fh_dentry } ;
2022-09-07 21:45:01 +03:00
if ( fh - > fh_maxsize = = NFS4_FHSIZE )
request_mask | = ( STATX_BTIME | STATX_CHANGE_COOKIE ) ;
return nfserrno ( vfs_getattr ( & p , stat , request_mask ,
statx: Add a system call to make enhanced file info available
Add a system call to make extended file information available, including
file creation and some attribute flags where available through the
underlying filesystem.
The getattr inode operation is altered to take two additional arguments: a
u32 request_mask and an unsigned int flags that indicate the
synchronisation mode. This change is propagated to the vfs_getattr*()
function.
Functions like vfs_stat() are now inline wrappers around new functions
vfs_statx() and vfs_statx_fd() to reduce stack usage.
========
OVERVIEW
========
The idea was initially proposed as a set of xattrs that could be retrieved
with getxattr(), but the general preference proved to be for a new syscall
with an extended stat structure.
A number of requests were gathered for features to be included. The
following have been included:
(1) Make the fields a consistent size on all arches and make them large.
(2) Spare space, request flags and information flags are provided for
future expansion.
(3) Better support for the y2038 problem [Arnd Bergmann] (tv_sec is an
__s64).
(4) Creation time: The SMB protocol carries the creation time, which could
be exported by Samba, which will in turn help CIFS make use of
FS-Cache as that can be used for coherency data (stx_btime).
This is also specified in NFSv4 as a recommended attribute and could
be exported by NFSD [Steve French].
(5) Lightweight stat: Ask for just those details of interest, and allow a
netfs (such as NFS) to approximate anything not of interest, possibly
without going to the server [Trond Myklebust, Ulrich Drepper, Andreas
Dilger] (AT_STATX_DONT_SYNC).
(6) Heavyweight stat: Force a netfs to go to the server, even if it thinks
its cached attributes are up to date [Trond Myklebust]
(AT_STATX_FORCE_SYNC).
And the following have been left out for future extension:
(7) Data version number: Could be used by userspace NFS servers [Aneesh
Kumar].
Can also be used to modify fill_post_wcc() in NFSD which retrieves
i_version directly, but has just called vfs_getattr(). It could get
it from the kstat struct if it used vfs_xgetattr() instead.
(There's disagreement on the exact semantics of a single field, since
not all filesystems do this the same way).
(8) BSD stat compatibility: Including more fields from the BSD stat such
as creation time (st_btime) and inode generation number (st_gen)
[Jeremy Allison, Bernd Schubert].
(9) Inode generation number: Useful for FUSE and userspace NFS servers
[Bernd Schubert].
(This was asked for but later deemed unnecessary with the
open-by-handle capability available and caused disagreement as to
whether it's a security hole or not).
(10) Extra coherency data may be useful in making backups [Andreas Dilger].
(No particular data were offered, but things like last backup
timestamp, the data version number and the DOS archive bit would come
into this category).
(11) Allow the filesystem to indicate what it can/cannot provide: A
filesystem can now say it doesn't support a standard stat feature if
that isn't available, so if, for instance, inode numbers or UIDs don't
exist or are fabricated locally...
(This requires a separate system call - I have an fsinfo() call idea
for this).
(12) Store a 16-byte volume ID in the superblock that can be returned in
struct xstat [Steve French].
(Deferred to fsinfo).
(13) Include granularity fields in the time data to indicate the
granularity of each of the times (NFSv4 time_delta) [Steve French].
(Deferred to fsinfo).
(14) FS_IOC_GETFLAGS value. These could be translated to BSD's st_flags.
Note that the Linux IOC flags are a mess and filesystems such as Ext4
define flags that aren't in linux/fs.h, so translation in the kernel
may be a necessity (or, possibly, we provide the filesystem type too).
(Some attributes are made available in stx_attributes, but the general
feeling was that the IOC flags were to ext[234]-specific and shouldn't
be exposed through statx this way).
(15) Mask of features available on file (eg: ACLs, seclabel) [Brad Boyer,
Michael Kerrisk].
(Deferred, probably to fsinfo. Finding out if there's an ACL or
seclabal might require extra filesystem operations).
(16) Femtosecond-resolution timestamps [Dave Chinner].
(A __reserved field has been left in the statx_timestamp struct for
this - if there proves to be a need).
(17) A set multiple attributes syscall to go with this.
===============
NEW SYSTEM CALL
===============
The new system call is:
int ret = statx(int dfd,
const char *filename,
unsigned int flags,
unsigned int mask,
struct statx *buffer);
The dfd, filename and flags parameters indicate the file to query, in a
similar way to fstatat(). There is no equivalent of lstat() as that can be
emulated with statx() by passing AT_SYMLINK_NOFOLLOW in flags. There is
also no equivalent of fstat() as that can be emulated by passing a NULL
filename to statx() with the fd of interest in dfd.
Whether or not statx() synchronises the attributes with the backing store
can be controlled by OR'ing a value into the flags argument (this typically
only affects network filesystems):
(1) AT_STATX_SYNC_AS_STAT tells statx() to behave as stat() does in this
respect.
(2) AT_STATX_FORCE_SYNC will require a network filesystem to synchronise
its attributes with the server - which might require data writeback to
occur to get the timestamps correct.
(3) AT_STATX_DONT_SYNC will suppress synchronisation with the server in a
network filesystem. The resulting values should be considered
approximate.
mask is a bitmask indicating the fields in struct statx that are of
interest to the caller. The user should set this to STATX_BASIC_STATS to
get the basic set returned by stat(). It should be noted that asking for
more information may entail extra I/O operations.
buffer points to the destination for the data. This must be 256 bytes in
size.
======================
MAIN ATTRIBUTES RECORD
======================
The following structures are defined in which to return the main attribute
set:
struct statx_timestamp {
__s64 tv_sec;
__s32 tv_nsec;
__s32 __reserved;
};
struct statx {
__u32 stx_mask;
__u32 stx_blksize;
__u64 stx_attributes;
__u32 stx_nlink;
__u32 stx_uid;
__u32 stx_gid;
__u16 stx_mode;
__u16 __spare0[1];
__u64 stx_ino;
__u64 stx_size;
__u64 stx_blocks;
__u64 __spare1[1];
struct statx_timestamp stx_atime;
struct statx_timestamp stx_btime;
struct statx_timestamp stx_ctime;
struct statx_timestamp stx_mtime;
__u32 stx_rdev_major;
__u32 stx_rdev_minor;
__u32 stx_dev_major;
__u32 stx_dev_minor;
__u64 __spare2[14];
};
The defined bits in request_mask and stx_mask are:
STATX_TYPE Want/got stx_mode & S_IFMT
STATX_MODE Want/got stx_mode & ~S_IFMT
STATX_NLINK Want/got stx_nlink
STATX_UID Want/got stx_uid
STATX_GID Want/got stx_gid
STATX_ATIME Want/got stx_atime{,_ns}
STATX_MTIME Want/got stx_mtime{,_ns}
STATX_CTIME Want/got stx_ctime{,_ns}
STATX_INO Want/got stx_ino
STATX_SIZE Want/got stx_size
STATX_BLOCKS Want/got stx_blocks
STATX_BASIC_STATS [The stuff in the normal stat struct]
STATX_BTIME Want/got stx_btime{,_ns}
STATX_ALL [All currently available stuff]
stx_btime is the file creation time, stx_mask is a bitmask indicating the
data provided and __spares*[] are where as-yet undefined fields can be
placed.
Time fields are structures with separate seconds and nanoseconds fields
plus a reserved field in case we want to add even finer resolution. Note
that times will be negative if before 1970; in such a case, the nanosecond
fields will also be negative if not zero.
The bits defined in the stx_attributes field convey information about a
file, how it is accessed, where it is and what it does. The following
attributes map to FS_*_FL flags and are the same numerical value:
STATX_ATTR_COMPRESSED File is compressed by the fs
STATX_ATTR_IMMUTABLE File is marked immutable
STATX_ATTR_APPEND File is append-only
STATX_ATTR_NODUMP File is not to be dumped
STATX_ATTR_ENCRYPTED File requires key to decrypt in fs
Within the kernel, the supported flags are listed by:
KSTAT_ATTR_FS_IOC_FLAGS
[Are any other IOC flags of sufficient general interest to be exposed
through this interface?]
New flags include:
STATX_ATTR_AUTOMOUNT Object is an automount trigger
These are for the use of GUI tools that might want to mark files specially,
depending on what they are.
Fields in struct statx come in a number of classes:
(0) stx_dev_*, stx_blksize.
These are local system information and are always available.
(1) stx_mode, stx_nlinks, stx_uid, stx_gid, stx_[amc]time, stx_ino,
stx_size, stx_blocks.
These will be returned whether the caller asks for them or not. The
corresponding bits in stx_mask will be set to indicate whether they
actually have valid values.
If the caller didn't ask for them, then they may be approximated. For
example, NFS won't waste any time updating them from the server,
unless as a byproduct of updating something requested.
If the values don't actually exist for the underlying object (such as
UID or GID on a DOS file), then the bit won't be set in the stx_mask,
even if the caller asked for the value. In such a case, the returned
value will be a fabrication.
Note that there are instances where the type might not be valid, for
instance Windows reparse points.
(2) stx_rdev_*.
This will be set only if stx_mode indicates we're looking at a
blockdev or a chardev, otherwise will be 0.
(3) stx_btime.
Similar to (1), except this will be set to 0 if it doesn't exist.
=======
TESTING
=======
The following test program can be used to test the statx system call:
samples/statx/test-statx.c
Just compile and run, passing it paths to the files you want to examine.
The file is built automatically if CONFIG_SAMPLES is enabled.
Here's some example output. Firstly, an NFS directory that crosses to
another FSID. Note that the AUTOMOUNT attribute is set because transiting
this directory will cause d_automount to be invoked by the VFS.
[root@andromeda ~]# /tmp/test-statx -A /warthog/data
statx(/warthog/data) = 0
results=7ff
Size: 4096 Blocks: 8 IO Block: 1048576 directory
Device: 00:26 Inode: 1703937 Links: 125
Access: (3777/drwxrwxrwx) Uid: 0 Gid: 4041
Access: 2016-11-24 09:02:12.219699527+0000
Modify: 2016-11-17 10:44:36.225653653+0000
Change: 2016-11-17 10:44:36.225653653+0000
Attributes: 0000000000001000 (-------- -------- -------- -------- -------- -------- ---m---- --------)
Secondly, the result of automounting on that directory.
[root@andromeda ~]# /tmp/test-statx /warthog/data
statx(/warthog/data) = 0
results=7ff
Size: 4096 Blocks: 8 IO Block: 1048576 directory
Device: 00:27 Inode: 2 Links: 125
Access: (3777/drwxrwxrwx) Uid: 0 Gid: 4041
Access: 2016-11-24 09:02:12.219699527+0000
Modify: 2016-11-17 10:44:36.225653653+0000
Change: 2016-11-17 10:44:36.225653653+0000
Signed-off-by: David Howells <dhowells@redhat.com>
Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2017-01-31 19:46:22 +03:00
AT_STATX_SYNC_AS_STAT ) ) ;
2013-01-24 11:18:08 +04:00
}
2009-11-05 02:12:35 +03:00
# endif /* LINUX_NFSD_VFS_H */
