gnulib/lib/at-func.c

   1 /* Define an at-style functions like fstatat, unlinkat, fchownat, etc.
   2    Copyright (C) 2006, 2009-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 #include "dosname.h" /* solely for definition of IS_ABSOLUTE_FILE_NAME */
  20 #include "openat.h"
  21 #include "openat-priv.h"
  22 #include "save-cwd.h"
  23
  24 #ifdef AT_FUNC_USE_F1_COND
  25 # define CALL_FUNC(F)                           \
  26   (flag == AT_FUNC_USE_F1_COND                  \
  27     ? AT_FUNC_F1 (F AT_FUNC_POST_FILE_ARGS)     \
  28     : AT_FUNC_F2 (F AT_FUNC_POST_FILE_ARGS))
  29 # define VALIDATE_FLAG(F)                       \
  30   if (flag & ~AT_FUNC_USE_F1_COND)              \
  31     {                                           \
  32       errno = EINVAL;                           \
  33       return FUNC_FAIL;                         \
  34     }
  35 #else
  36 # define CALL_FUNC(F) (AT_FUNC_F1 (F AT_FUNC_POST_FILE_ARGS))
  37 # define VALIDATE_FLAG(F) /* empty */
  38 #endif
  39
  40 #ifdef AT_FUNC_RESULT
  41 # define FUNC_RESULT AT_FUNC_RESULT
  42 #else
  43 # define FUNC_RESULT int
  44 #endif
  45
  46 #ifdef AT_FUNC_FAIL
  47 # define FUNC_FAIL AT_FUNC_FAIL
  48 #else
  49 # define FUNC_FAIL -1
  50 #endif
  51
  52 /* Call AT_FUNC_F1 to operate on FILE, which is in the directory
  53    open on descriptor FD.  If AT_FUNC_USE_F1_COND is defined to a value,
  54    AT_FUNC_POST_FILE_PARAM_DECLS must inlude a parameter named flag;
  55    call AT_FUNC_F2 if FLAG is 0 or fail if FLAG contains more bits than
  56    AT_FUNC_USE_F1_COND.  Return int and fail with -1 unless AT_FUNC_RESULT
  57    or AT_FUNC_FAIL are defined.  If possible, do it without changing the
  58    working directory.  Otherwise, resort to using save_cwd/fchdir,
  59    then AT_FUNC_F?/restore_cwd.  If either the save_cwd or the restore_cwd
  60    fails, then give a diagnostic and exit nonzero.  */
  61 FUNC_RESULT
  62 AT_FUNC_NAME (int fd, char const *file AT_FUNC_POST_FILE_PARAM_DECLS)
  63 {
  64   /* Be careful to choose names unlikely to conflict with
  65      AT_FUNC_POST_FILE_PARAM_DECLS.  */
  66   struct saved_cwd saved_cwd;
  67   int saved_errno;
  68   FUNC_RESULT err;
  69
  70   VALIDATE_FLAG (flag);
  71
  72   if (fd == AT_FDCWD || IS_ABSOLUTE_FILE_NAME (file))
  73     return CALL_FUNC (file);
  74
  75   {
  76     char proc_buf[OPENAT_BUFFER_SIZE];
  77     char *proc_file = openat_proc_name (proc_buf, fd, file);
  78     if (proc_file)
  79       {
  80         FUNC_RESULT proc_result = CALL_FUNC (proc_file);
  81         int proc_errno = errno;
  82         if (proc_file != proc_buf)
  83           free (proc_file);
  84         /* If the syscall succeeds, or if it fails with an unexpected
  85            errno value, then return right away.  Otherwise, fall through
  86            and resort to using save_cwd/restore_cwd.  */
  87         if (FUNC_FAIL != proc_result)
  88           return proc_result;
  89         if (! EXPECTED_ERRNO (proc_errno))
  90           {
  91             errno = proc_errno;
  92             return proc_result;
  93           }
  94       }
  95   }
  96
  97   if (save_cwd (&saved_cwd) != 0)
  98     openat_save_fail (errno);
  99   if (0 <= fd && fd == saved_cwd.desc)
 100     {
 101       /* If saving the working directory collides with the user's
 102          requested fd, then the user's fd must have been closed to
 103          begin with.  */
 104       free_cwd (&saved_cwd);
 105       errno = EBADF;
 106       return FUNC_FAIL;
 107     }
 108
 109   if (fchdir (fd) != 0)
 110     {
 111       saved_errno = errno;
 112       free_cwd (&saved_cwd);
 113       errno = saved_errno;
 114       return FUNC_FAIL;
 115     }
 116
 117   err = CALL_FUNC (file);
 118   saved_errno = (err == FUNC_FAIL ? errno : 0);
 119
 120   if (restore_cwd (&saved_cwd) != 0)
 121     openat_restore_fail (errno);
 122
 123   free_cwd (&saved_cwd);
 124
 125   if (saved_errno)
 126     errno = saved_errno;
 127   return err;
 128 }
 129 #undef CALL_FUNC
 130 #undef FUNC_RESULT
 131 #undef FUNC_FAIL