original/man2/stat.2

   1 '\" t
   2 .\" Hey Emacs! This file is -*- nroff -*- source.
   3 .\"
   4 .\" Copyright (c) 1992 Drew Eckhardt (drew@cs.colorado.edu), March 28, 1992
   5 .\" Parts Copyright (c) 1995 Nicolai Langfeldt (janl@ifi.uio.no), 1/1/95
   6 .\" and Copyright (c) 2007 Michael Kerrisk <mtk.manpages@gmail.com>
   7 .\"
   8 .\" Permission is granted to make and distribute verbatim copies of this
   9 .\" manual provided the copyright notice and this permission notice are
  10 .\" preserved on all copies.
  11 .\"
  12 .\" Permission is granted to copy and distribute modified versions of this
  13 .\" manual under the conditions for verbatim copying, provided that the
  14 .\" entire resulting derived work is distributed under the terms of a
  15 .\" permission notice identical to this one.
  16 .\"
  17 .\" Since the Linux kernel and libraries are constantly changing, this
  18 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  19 .\" responsibility for errors or omissions, or for damages resulting from
  20 .\" the use of the information contained herein.  The author(s) may not
  21 .\" have taken the same level of care in the production of this manual,
  22 .\" which is licensed free of charge, as they might when working
  23 .\" professionally.
  24 .\"
  25 .\" Formatted or processed versions of this manual, if unaccompanied by
  26 .\" the source, must acknowledge the copyright and authors of this work.
  27 .\"
  28 .\" Modified by Michael Haardt <michael@moria.de>
  29 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  30 .\" Modified 1995-05-18 by Todd Larason <jtl@molehill.org>
  31 .\" Modified 1997-01-31 by Eric S. Raymond <esr@thyrsus.com>
  32 .\" Modified 1995-01-09 by Richard Kettlewell <richard@greenend.org.uk>
  33 .\" Modified 1998-05-13 by Michael Haardt <michael@cantor.informatik.rwth-aachen.de>
  34 .\" Modified 1999-07-06 by aeb & Albert Cahalan
  35 .\" Modified 2000-01-07 by aeb
  36 .\" Modified 2004-06-23 by Michael Kerrisk <mtk.manpages@gmail.com>
  37 .\" 2007-06-08 mtk: Added example program
  38 .\" 2007-07-05 mtk: Added details on underlying system call interfaces
  39 .\"
  40 .TH STAT 2 2010-12-03 "Linux" "Linux Programmer's Manual"
  41 .SH NAME
  42 stat, fstat, lstat \- get file status
  43 .SH SYNOPSIS
  44 .B #include <sys/types.h>
  45 .br
  46 .B #include <sys/stat.h>
  47 .br
  48 .B #include <unistd.h>
  49 .sp
  50 .BI "int stat(const char *" path ", struct stat *" buf );
  51 .br
  52 .BI "int fstat(int " fd ", struct stat *" buf );
  53 .br
  54 .BI "int lstat(const char *" path ", struct stat *" buf );
  55 .sp
  56 .in -4n
  57 Feature Test Macro Requirements for glibc (see
  58 .BR feature_test_macros (7)):
  59 .in
  60 .ad l
  61 .PD 0
  62 .sp
  63 .BR lstat ():
  64 .RS 4
  65 _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  66 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
  67 .br
  68 || /* Since glibc 2.10: */ _POSIX_C_SOURCE\ >=\ 200112L
  69 .RE
  70 .PD
  71 .ad
  72 .SH DESCRIPTION
  73 .PP
  74 These functions return information about a file.
  75 No permissions are required on the file itself, but \(em in the case of
  76 .BR stat ()
  77 and
  78 .BR lstat ()
  79 \(em
  80 execute (search) permission is required on all of the directories in
  81 .I path
  82 that lead to the file.
  83 .PP
  84 .BR stat ()
  85 stats the file pointed to by
  86 .I path
  87 and fills in
  88 .IR buf .
  89
  90 .BR lstat ()
  91 is identical to
  92 .BR stat (),
  93 except that if
  94 .I path
  95 is a symbolic link, then the link itself is stat-ed,
  96 not the file that it refers to.
  97
  98 .BR fstat ()
  99 is identical to
 100 .BR stat (),
 101 except that the file to be stat-ed is specified by the file descriptor
 102 .IR fd .
 103 .PP
 104 All of these system calls return a
 105 .I stat
 106 structure, which contains the following fields:
 107 .PP
 108 .in +4n
 109 .nf
 110 struct stat {
 111     dev_t     st_dev;     /* ID of device containing file */
 112     ino_t     st_ino;     /* inode number */
 113     mode_t    st_mode;    /* protection */
 114     nlink_t   st_nlink;   /* number of hard links */
 115     uid_t     st_uid;     /* user ID of owner */
 116     gid_t     st_gid;     /* group ID of owner */
 117     dev_t     st_rdev;    /* device ID (if special file) */
 118     off_t     st_size;    /* total size, in bytes */
 119     blksize_t st_blksize; /* blocksize for file system I/O */
 120     blkcnt_t  st_blocks;  /* number of 512B blocks allocated */
 121     time_t    st_atime;   /* time of last access */
 122     time_t    st_mtime;   /* time of last modification */
 123     time_t    st_ctime;   /* time of last status change */
 124 };
 125 .fi
 126 .in
 127 .PP
 128 The
 129 .I st_dev
 130 field describes the device on which this file resides.
 131 (The
 132 .BR major (3)
 133 and
 134 .BR minor (3)
 135 macros may be useful to decompose the device ID in this field.)
 136
 137 The
 138 .I st_rdev
 139 field describes the device that this file (inode) represents.
 140
 141 The
 142 .I st_size
 143 field gives the size of the file (if it is a regular
 144 file or a symbolic link) in bytes.
 145 The size of a symlink is the length of the pathname
 146 it contains, without a trailing null byte.
 147
 148 The
 149 .I st_blocks
 150 field indicates the number of blocks allocated to the file, 512-byte units.
 151 (This may be smaller than
 152 .IR st_size /512
 153 when the file has holes.)
 154
 155 The
 156 .I st_blksize
 157 field gives the "preferred" blocksize for efficient file system I/O.
 158 (Writing to a file in smaller chunks may cause
 159 an inefficient read-modify-rewrite.)
 160 .PP
 161 Not all of the Linux file systems implement all of the time fields.
 162 Some file system types allow mounting in such a way that file
 163 and/or directory accesses do not cause an update of the
 164 .I st_atime
 165 field.
 166 (See
 167 .IR noatime ,
 168 .IR nodiratime ,
 169 and
 170 .I relatime
 171 in
 172 .BR mount (8),
 173 and related information in
 174 .BR mount (2).)
 175 In addition,
 176 .I st_atime
 177 is not updated if a file is opened with the
 178 .BR O_NOATIME ;
 179 see
 180 .BR open (2).
 181
 182 The field
 183 .I st_atime
 184 is changed by file accesses, for example, by
 185 .BR execve (2),
 186 .BR mknod (2),
 187 .BR pipe (2),
 188 .BR utime (2)
 189 and
 190 .BR read (2)
 191 (of more than zero bytes).
 192 Other routines, like
 193 .BR mmap (2),
 194 may or may not update
 195 .IR st_atime .
 196
 197 The field
 198 .I st_mtime
 199 is changed by file modifications, for example, by
 200 .BR mknod (2),
 201 .BR truncate (2),
 202 .BR utime (2)
 203 and
 204 .BR write (2)
 205 (of more than zero bytes).
 206 Moreover,
 207 .I st_mtime
 208 of a directory is changed by the creation or deletion of files
 209 in that directory.
 210 The
 211 .I st_mtime
 212 field is
 213 .I not
 214 changed for changes in owner, group, hard link count, or mode.
 215
 216 The field
 217 .I st_ctime
 218 is changed by writing or by setting inode information
 219 (i.e., owner, group, link count, mode, etc.).
 220 .PP
 221 The following POSIX macros are defined to check the file type using the
 222 .I st_mode
 223 field:
 224 .RS 4
 225 .TP 1.2i
 226 .BR S_ISREG (m)
 227 is it a regular file?
 228 .TP
 229 .BR S_ISDIR (m)
 230 directory?
 231 .TP
 232 .BR S_ISCHR (m)
 233 character device?
 234 .TP
 235 .BR S_ISBLK (m)
 236 block device?
 237 .TP
 238 .BR S_ISFIFO (m)
 239 FIFO (named pipe)?
 240 .TP
 241 .BR S_ISLNK (m)
 242 symbolic link? (Not in POSIX.1-1996.)
 243 .TP
 244 .BR S_ISSOCK (m)
 245 socket? (Not in POSIX.1-1996.)
 246 .RE
 247 .PP
 248 The following flags are defined for the
 249 .I st_mode
 250 field:
 251 .in +4n
 252 .TS
 253 lB l l.
 254 S_IFMT  0170000 bit mask for the file type bit fields
 255 S_IFSOCK        0140000 socket
 256 S_IFLNK 0120000 symbolic link
 257 S_IFREG 0100000 regular file
 258 S_IFBLK 0060000 block device
 259 S_IFDIR 0040000 directory
 260 S_IFCHR 0020000 character device
 261 S_IFIFO 0010000 FIFO
 262 S_ISUID 0004000 set UID bit
 263 S_ISGID 0002000 set-group-ID bit (see below)
 264 S_ISVTX 0001000 sticky bit (see below)
 265 S_IRWXU 00700   mask for file owner permissions
 266 S_IRUSR 00400   owner has read permission
 267 S_IWUSR 00200   owner has write permission
 268 S_IXUSR 00100   owner has execute permission
 269 S_IRWXG 00070   mask for group permissions
 270 S_IRGRP 00040   group has read permission
 271 S_IWGRP 00020   group has write permission
 272 S_IXGRP 00010   group has execute permission
 273 S_IRWXO 00007   mask for permissions for others (not in group)
 274 S_IROTH 00004   others have read permission
 275 S_IWOTH 00002   others have write permission
 276 S_IXOTH 00001   others have execute permission
 277 .TE
 278 .in
 279 .P
 280 The set-group-ID bit
 281 .RB ( S_ISGID )
 282 has several special uses.
 283 For a directory it indicates that BSD semantics is to be used
 284 for that directory: files created there inherit their group ID from
 285 the directory, not from the effective group ID of the creating process,
 286 and directories created there will also get the
 287 .B S_ISGID
 288 bit set.
 289 For a file that does not have the group execution bit
 290 .RB ( S_IXGRP )
 291 set,
 292 the set-group-ID bit indicates mandatory file/record locking.
 293 .P
 294 The sticky bit
 295 .RB ( S_ISVTX )
 296 on a directory means that a file
 297 in that directory can be renamed or deleted only by the owner
 298 of the file, by the owner of the directory, and by a privileged
 299 process.
 300 .SH "RETURN VALUE"
 301 On success, zero is returned.
 302 On error, \-1 is returned, and
 303 .I errno
 304 is set appropriately.
 305 .SH ERRORS
 306 .TP
 307 .B EACCES
 308 Search permission is denied for one of the directories
 309 in the path prefix of
 310 .IR path .
 311 (See also
 312 .BR path_resolution (7).)
 313 .TP
 314 .B EBADF
 315 .I fd
 316 is bad.
 317 .TP
 318 .B EFAULT
 319 Bad address.
 320 .TP
 321 .B ELOOP
 322 Too many symbolic links encountered while traversing the path.
 323 .TP
 324 .B ENAMETOOLONG
 325 .I path
 326 is too long.
 327 .TP
 328 .B ENOENT
 329 A component of
 330 .I path
 331 does not exist, or
 332 .I path
 333 is an empty string.
 334 .TP
 335 .B ENOMEM
 336 Out of memory (i.e., kernel memory).
 337 .TP
 338 .B ENOTDIR
 339 A component of the path prefix of
 340 .I path
 341 is not a directory.
 342 .TP
 343 .B EOVERFLOW
 344 .RB ( stat ())
 345 .I path
 346 refers to a file whose size cannot be represented in the type
 347 .IR off_t .
 348 This can occur when an application compiled on a 32-bit platform without
 349 .I -D_FILE_OFFSET_BITS=64
 350 calls
 351 .BR stat ()
 352 on a file whose size exceeds
 353 .I (1<<31)-1
 354 bits.
 355 .SH "CONFORMING TO"
 356 These system calls conform to SVr4, 4.3BSD, POSIX.1-2001.
 357 .\" SVr4 documents additional
 358 .\" .BR fstat ()
 359 .\" error conditions EINTR, ENOLINK, and EOVERFLOW.  SVr4
 360 .\" documents additional
 361 .\" .BR stat ()
 362 .\" and
 363 .\" .BR lstat ()
 364 .\" error conditions EINTR, EMULTIHOP, ENOLINK, and EOVERFLOW.
 365
 366 Use of the
 367 .I st_blocks
 368 and
 369 .I st_blksize
 370 fields may be less portable.
 371 (They were introduced in BSD.
 372 The interpretation differs between systems,
 373 and possibly on a single system when NFS mounts are involved.)
 374 If you need to obtain the definition of the
 375 .IR blkcnt_t
 376 or
 377 .IR blksize_t
 378 types from
 379 .IR <sys/stat.h> ,
 380 then define
 381 .BR _XOPEN_SOURCE
 382 with the value 500 or greater (before including
 383 .I any
 384 header files).
 385 .LP
 386 POSIX does not describe the
 387 .BR S_IFMT ,
 388 .BR S_IFSOCK ,
 389 .BR S_IFLNK ,
 390 .BR S_IFREG ,
 391 .BR S_IFBLK ,
 392 .BR S_IFDIR ,
 393 .BR S_IFCHR ,
 394 .BR S_IFIFO ,
 395 .B S_ISVTX
 396 bits, but instead demands the use of
 397 the macros
 398 .BR S_ISDIR (),
 399 etc.
 400 The
 401 .BR S_ISLNK ()
 402 and
 403 .BR S_ISSOCK ()
 404 macros are not in
 405 POSIX.1-1996, but both are present in POSIX.1-2001;
 406 the former is from SVID 4, the latter from SUSv2.
 407 .LP
 408 UNIX V7 (and later systems) had
 409 .BR S_IREAD ,
 410 .BR S_IWRITE ,
 411 .BR S_IEXEC ,
 412 where POSIX
 413 prescribes the synonyms
 414 .BR S_IRUSR ,
 415 .BR S_IWUSR ,
 416 .BR S_IXUSR .
 417 .SS "Other Systems"
 418 Values that have been (or are) in use on various systems:
 419 .TS
 420 l l l l l.
 421 hex     name    ls      octal   description
 422 f000    S_IFMT          170000  mask for file type
 423 0000                    000000  SCO out-of-service inode; BSD unknown
 424                                 type; SVID-v2 and XPG2 have both
 425                                 0 and 0100000 for ordinary file
 426 1000    S_IFIFO p|      010000  FIFO (named pipe)
 427 2000    S_IFCHR c       020000  character special (V7)
 428 3000    S_IFMPC         030000  multiplexed character special (V7)
 429 4000    S_IFDIR d/      040000  directory (V7)
 430 5000    S_IFNAM         050000  XENIX named special file
 431                                 with two subtypes, distinguished by
 432                                 \fIst_rdev\fP values 1, 2
 433 0001    S_INSEM s       000001  XENIX semaphore subtype of IFNAM
 434 0002    S_INSHD m       000002  XENIX shared data subtype of IFNAM
 435 6000    S_IFBLK b       060000  block special (V7)
 436 7000    S_IFMPB         070000  multiplexed block special (V7)
 437 8000    S_IFREG -       100000  regular (V7)
 438 9000    S_IFCMP         110000  VxFS compressed
 439 9000    S_IFNWK n       110000  network special (HP-UX)
 440 a000    S_IFLNK l@      120000  symbolic link (BSD)
 441 b000    S_IFSHAD                130000  Solaris shadow inode for ACL
 442                                 (not seen by userspace)
 443 c000    S_IFSOCK        s=      140000  socket (BSD; also "S_IFSOC" on VxFS)
 444 d000    S_IFDOOR        D>      150000  Solaris door
 445 e000    S_IFWHT w%      160000  BSD whiteout (not used for inode)
 446 0200    S_ISVTX         001000  sticky bit: save swapped text even
 447                                 after use (V7)
 448                                 reserved (SVID-v2)
 449                                 On nondirectories: don't cache this
 450                                 file (SunOS)
 451                                 On directories: restricted deletion
 452                                 flag (SVID-v4.2)
 453 0400    S_ISGID         002000  set-group-ID on execution (V7)
 454                                 for directories: use BSD semantics for
 455                                 propagation of GID
 456 0400    S_ENFMT         002000  System V file locking enforcement (shared
 457                                 with S_ISGID)
 458 0800    S_ISUID         004000  set-user-ID on execution (V7)
 459 0800    S_CDF           004000  directory is a context dependent
 460                                 file (HP-UX)
 461 .TE
 462
 463 A sticky command appeared in Version 32V AT&T UNIX.
 464 .SH NOTES
 465 Since kernel 2.5.48, the
 466 .I stat
 467 structure supports nanosecond resolution for the three file timestamp fields.
 468 Glibc exposes the nanosecond component of each field using names of the form
 469 .IR st_atim.tv_nsec
 470 if the
 471 .B _BSD_SOURCE
 472 or
 473 .B _SVID_SOURCE
 474 feature test macro is defined.
 475 These fields are specified in POSIX.1-2008, and, starting with version 2.12,
 476 glibc also exposes these field names if
 477 .BR _POSIX_C_SOURCE
 478 is defined with the value 200809L or greater, or
 479 .BR _XOPEN_SOURCE
 480 is defined with the value 700 or greater.
 481 If none of the aforementioned macros are defined,
 482 then the nanosecond values are exposed with names of the form
 483 .IR st_atimensec .
 484 On file systems that do not support subsecond timestamps,
 485 the nanosecond fields are returned with the value 0.
 486 .\" As at kernel 2.6.25, XFS and JFS support nanosecond timestamps,
 487 .\" but ext2, ext3, and Reiserfs do not.
 488
 489 On Linux,
 490 .BR lstat ()
 491 will generally not trigger automounter action, whereas
 492 .BR stat ()
 493 will.
 494
 495 For most files under the
 496 .I /proc
 497 directory,
 498 .BR stat ()
 499 does not return the file size in the
 500 .I st_size
 501 field; instead the field is returned with the value 0.
 502 .SS Underlying kernel interface
 503 Over time, increases in the size of the
 504 .I stat
 505 structure have led to three successive versions of
 506 .BR stat ():
 507 .IR sys_stat ()
 508 (slot
 509 .IR __NR_oldstat ),
 510 .IR sys_newstat ()
 511 (slot
 512 .IR __NR_stat ),
 513 and
 514 .I sys_stat64()
 515 (new in kernel 2.4; slot
 516 .IR __NR_stat64 ).
 517 The glibc
 518 .BR stat ()
 519 wrapper function hides these details from applications,
 520 invoking the most recent version of the system call provided by the kernel,
 521 and repacking the returned information if required for old binaries.
 522 Similar remarks apply for
 523 .BR fstat ()
 524 and
 525 .BR lstat ().
 526 .\"
 527 .\" A note from Andries Brouwer, July 2007
 528 .\"
 529 .\" > Is the story not rather more complicated for some calls like
 530 .\" > stat(2)?
 531 .\"
 532 .\" Yes and no, mostly no. See /usr/include/sys/stat.h .
 533 .\"
 534 .\" The idea is here not so much that syscalls change, but that
 535 .\" the definitions of struct stat and of the types dev_t and mode_t change.
 536 .\" This means that libc (even if it does not call the kernel
 537 .\" but only calls some internal function) must know what the
 538 .\" format of dev_t or of struct stat is.
 539 .\" The communication between the application and libc goes via
 540 .\" the include file <sys/stat.h> that defines a _STAT_VER and
 541 .\" _MKNOD_VER describing the layout of the data that user space
 542 .\" uses. Each (almost each) occurrence of stat() is replaced by
 543 .\" an occurrence of xstat() where the first parameter of xstat()
 544 .\" is this version number _STAT_VER.
 545 .\"
 546 .\" Now, also the definitions used by the kernel change.
 547 .\" But glibc copes with this in the standard way, and the
 548 .\" struct stat as returned by the kernel is repacked into
 549 .\" the struct stat as expected by the application.
 550 .\" Thus, _STAT_VER and this setup cater for the application-libc
 551 .\" interface, rather than the libc-kernel interface.
 552 .\"
 553 .\" (Note that the details depend on gcc being used as c compiler.)
 554 .SH EXAMPLE
 555 The following program calls
 556 .BR stat ()
 557 and displays selected fields in the returned
 558 .I stat
 559 structure.
 560 .nf
 561
 562 #include <sys/types.h>
 563 #include <sys/stat.h>
 564 #include <time.h>
 565 #include <stdio.h>
 566 #include <stdlib.h>
 567
 568 int
 569 main(int argc, char *argv[])
 570 {
 571     struct stat sb;
 572
 573     if (argc != 2) {
 574         fprintf(stderr, "Usage: %s <pathname>\\n", argv[0]);
 575         exit(EXIT_FAILURE);
 576     }
 577
 578     if (stat(argv[1], &sb) == \-1) {
 579         perror("stat");
 580         exit(EXIT_FAILURE);
 581     }
 582
 583     printf("File type:                ");
 584
 585     switch (sb.st_mode & S_IFMT) {
 586     case S_IFBLK:  printf("block device\\n");            break;
 587     case S_IFCHR:  printf("character device\\n");        break;
 588     case S_IFDIR:  printf("directory\\n");               break;
 589     case S_IFIFO:  printf("FIFO/pipe\\n");               break;
 590     case S_IFLNK:  printf("symlink\\n");                 break;
 591     case S_IFREG:  printf("regular file\\n");            break;
 592     case S_IFSOCK: printf("socket\\n");                  break;
 593     default:       printf("unknown?\\n");                break;
 594     }
 595
 596     printf("I\-node number:            %ld\\n", (long) sb.st_ino);
 597
 598     printf("Mode:                     %lo (octal)\\n",
 599             (unsigned long) sb.st_mode);
 600
 601     printf("Link count:               %ld\\n", (long) sb.st_nlink);
 602     printf("Ownership:                UID=%ld   GID=%ld\\n",
 603             (long) sb.st_uid, (long) sb.st_gid);
 604
 605     printf("Preferred I/O block size: %ld bytes\\n",
 606             (long) sb.st_blksize);
 607     printf("File size:                %lld bytes\\n",
 608             (long long) sb.st_size);
 609     printf("Blocks allocated:         %lld\\n",
 610             (long long) sb.st_blocks);
 611
 612     printf("Last status change:       %s", ctime(&sb.st_ctime));
 613     printf("Last file access:         %s", ctime(&sb.st_atime));
 614     printf("Last file modification:   %s", ctime(&sb.st_mtime));
 615
 616     exit(EXIT_SUCCESS);
 617 }
 618 .fi
 619 .SH "SEE ALSO"
 620 .BR access (2),
 621 .BR chmod (2),
 622 .BR chown (2),
 623 .BR fstatat (2),
 624 .BR readlink (2),
 625 .BR utime (2),
 626 .BR capabilities (7),
 627 .BR symlink (7)