lib/areadlinkat-with-size.c

   1 /* readlinkat wrapper to return the link name in malloc'd storage.
   2    Unlike xreadlinkat, only call exit on failure to change directory.
   3
   4    Copyright (C) 2001, 2003-2007, 2009 Free Software Foundation, Inc.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 /* Written by Jim Meyering <jim@meyering.net>
  20    and Eric Blake <ebb9@byu.net>.  */
  21
  22 #include <config.h>
  23
  24 #include "areadlink.h"
  25
  26 #include <stdio.h>
  27 #include <errno.h>
  28 #include <limits.h>
  29 #include <sys/types.h>
  30 #include <stdlib.h>
  31 #include <unistd.h>
  32
  33 #if HAVE_READLINKAT
  34
  35 # ifndef SSIZE_MAX
  36 #  define SSIZE_MAX ((ssize_t) (SIZE_MAX / 2))
  37 # endif
  38
  39 /* SYMLINK_MAX is used only for an initial memory-allocation sanity
  40    check, so it's OK to guess too small on hosts where there is no
  41    arbitrary limit to symbolic link length.  */
  42 # ifndef SYMLINK_MAX
  43 #  define SYMLINK_MAX 1024
  44 # endif
  45
  46 # define MAXSIZE (SIZE_MAX < SSIZE_MAX ? SIZE_MAX : SSIZE_MAX)
  47
  48 /* Call readlinkat to get the symbolic link value of FILE, relative to FD.
  49    SIZE is a hint as to how long the link is expected to be;
  50    typically it is taken from st_size.  It need not be correct.
  51    Return a pointer to that NUL-terminated string in malloc'd storage.
  52    If readlinkat fails, malloc fails, or if the link value is longer
  53    than SSIZE_MAX, return NULL (caller may use errno to diagnose).
  54    However, failure to change directory during readlinkat will issue
  55    a diagnostic and exit.  */
  56
  57 char *
  58 areadlinkat_with_size (int fd, char const *file, size_t size)
  59 {
  60   /* Some buggy file systems report garbage in st_size.  Defend
  61      against them by ignoring outlandish st_size values in the initial
  62      memory allocation.  */
  63   size_t symlink_max = SYMLINK_MAX;
  64   size_t INITIAL_LIMIT_BOUND = 8 * 1024;
  65   size_t initial_limit = (symlink_max < INITIAL_LIMIT_BOUND
  66                           ? symlink_max + 1
  67                           : INITIAL_LIMIT_BOUND);
  68
  69   /* The initial buffer size for the link value.  */
  70   size_t buf_size = size < initial_limit ? size + 1 : initial_limit;
  71
  72   while (1)
  73     {
  74       ssize_t r;
  75       size_t link_length;
  76       char *buffer = malloc (buf_size);
  77
  78       if (buffer == NULL)
  79         return NULL;
  80       r = readlinkat (fd, file, buffer, buf_size);
  81       link_length = r;
  82
  83       /* On AIX 5L v5.3 and HP-UX 11i v2 04/09, readlink returns -1
  84          with errno == ERANGE if the buffer is too small.  */
  85       if (r < 0 && errno != ERANGE)
  86         {
  87           int saved_errno = errno;
  88           free (buffer);
  89           errno = saved_errno;
  90           return NULL;
  91         }
  92
  93       if (link_length < buf_size)
  94         {
  95           buffer[link_length] = 0;
  96           return buffer;
  97         }
  98
  99       free (buffer);
 100       if (buf_size <= MAXSIZE / 2)
 101         buf_size *= 2;
 102       else if (buf_size < MAXSIZE)
 103         buf_size = MAXSIZE;
 104       else
 105         {
 106           errno = ENOMEM;
 107           return NULL;
 108         }
 109     }
 110 }
 111
 112 #else /* !HAVE_READLINKAT */
 113
 114
 115 /* It is more efficient to change directories only once and call
 116    areadlink_with_size, rather than repeatedly call the replacement
 117    readlinkat.  */
 118
 119 # define AT_FUNC_NAME areadlinkat_with_size
 120 # define AT_FUNC_F1 areadlink_with_size
 121 # define AT_FUNC_POST_FILE_PARAM_DECLS , size_t size
 122 # define AT_FUNC_POST_FILE_ARGS        , size
 123 # define AT_FUNC_RESULT char *
 124 # define AT_FUNC_FAIL NULL
 125 # include "at-func.c"
 126 # undef AT_FUNC_NAME
 127 # undef AT_FUNC_F1
 128 # undef AT_FUNC_POST_FILE_PARAM_DECLS
 129 # undef AT_FUNC_POST_FILE_ARGS
 130 # undef AT_FUNC_RESULT
 131 # undef AT_FUNC_FAIL
 132
 133 #endif /* !HAVE_READLINKAT */