lib/openat.h

   1 /* provide a replacement openat function
   2    Copyright (C) 2004-2006, 2008-2011 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 /* written by Jim Meyering */
  18
  19 #ifndef _GL_HEADER_OPENAT
  20 #define _GL_HEADER_OPENAT
  21
  22 #include <fcntl.h>
  23
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #include <dirent.h>
  27 #include <unistd.h>
  28 #include <stdbool.h>
  29 #include <stdnoreturn.h>
  30
  31 #if !HAVE_OPENAT
  32
  33 int openat_permissive (int fd, char const *file, int flags, mode_t mode,
  34                        int *cwd_errno);
  35 bool openat_needs_fchdir (void);
  36
  37 #else
  38
  39 # define openat_permissive(Fd, File, Flags, Mode, Cwd_errno) \
  40     openat (Fd, File, Flags, Mode)
  41 # define openat_needs_fchdir() false
  42
  43 #endif
  44
  45 noreturn void openat_restore_fail (int);
  46 noreturn void openat_save_fail (int);
  47
  48 /* Using these function names makes application code
  49    slightly more readable than it would be with
  50    fchownat (..., 0) or fchownat (..., AT_SYMLINK_NOFOLLOW).  */
  51 static inline int
  52 chownat (int fd, char const *file, uid_t owner, gid_t group)
  53 {
  54   return fchownat (fd, file, owner, group, 0);
  55 }
  56
  57 static inline int
  58 lchownat (int fd, char const *file, uid_t owner, gid_t group)
  59 {
  60   return fchownat (fd, file, owner, group, AT_SYMLINK_NOFOLLOW);
  61 }
  62
  63 static inline int
  64 chmodat (int fd, char const *file, mode_t mode)
  65 {
  66   return fchmodat (fd, file, mode, 0);
  67 }
  68
  69 static inline int
  70 lchmodat (int fd, char const *file, mode_t mode)
  71 {
  72   return fchmodat (fd, file, mode, AT_SYMLINK_NOFOLLOW);
  73 }
  74
  75 static inline int
  76 statat (int fd, char const *name, struct stat *st)
  77 {
  78   return fstatat (fd, name, st, 0);
  79 }
  80
  81 static inline int
  82 lstatat (int fd, char const *name, struct stat *st)
  83 {
  84   return fstatat (fd, name, st, AT_SYMLINK_NOFOLLOW);
  85 }
  86
  87 /* For now, there are no wrappers named laccessat or leuidaccessat,
  88    since gnulib doesn't support faccessat(,AT_SYMLINK_NOFOLLOW) and
  89    since access rights on symlinks are of limited utility.  Likewise,
  90    wrappers are not provided for accessat or euidaccessat, so as to
  91    avoid dragging in -lgen on some platforms.  */
  92
  93 #endif /* _GL_HEADER_OPENAT */