lib/xreadlink.c

   1 /* xreadlink.c -- readlink wrapper to return the link name in malloc'd storage
   2
   3    Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; see the file COPYING.
  17    If not, write to the Free Software Foundation,
  18    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  19
  20 /* Written by Jim Meyering <jim@meyering.net>  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include <config.h>
  24 #endif
  25
  26 #include "xreadlink.h"
  27
  28 #include <stdio.h>
  29 #include <errno.h>
  30 #include <limits.h>
  31 #include <sys/types.h>
  32 #include <stdlib.h>
  33 #include <unistd.h>
  34
  35 #ifndef SIZE_MAX
  36 # define SIZE_MAX ((size_t) -1)
  37 #endif
  38 #ifndef SSIZE_MAX
  39 # define SSIZE_MAX ((ssize_t) (SIZE_MAX / 2))
  40 #endif
  41
  42 #define MAXSIZE (SIZE_MAX < SSIZE_MAX ? SIZE_MAX : SSIZE_MAX)
  43
  44 #include "xalloc.h"
  45
  46 /* Call readlink to get the symbolic link value of FILE.
  47    SIZE is a hint as to how long the link is expected to be;
  48    typically it is taken from st_size.  It need not be correct.
  49    Return a pointer to that NUL-terminated string in malloc'd storage.
  50    If readlink fails, return NULL (caller may use errno to diagnose).
  51    If malloc fails, or if the link value is longer than SSIZE_MAX :-),
  52    give a diagnostic and exit.  */
  53
  54 char *
  55 xreadlink (char const *file, size_t size)
  56 {
  57   /* The initial buffer size for the link value.  A power of 2
  58      detects arithmetic overflow earlier, but is not required.  */
  59   size_t buf_size = size < MAXSIZE ? size + 1 : MAXSIZE;
  60
  61   while (1)
  62     {
  63       char *buffer = xmalloc (buf_size);
  64       ssize_t r = readlink (file, buffer, buf_size);
  65       size_t link_length = r;
  66
  67       /* On AIX 5L v5.3 and HP-UX 11i v2 04/09, readlink returns -1
  68          with errno == ERANGE if the buffer is too small.  */
  69       if (r < 0 && errno != ERANGE)
  70         {
  71           int saved_errno = errno;
  72           free (buffer);
  73           errno = saved_errno;
  74           return NULL;
  75         }
  76
  77       if (link_length < buf_size)
  78         {
  79           buffer[link_length] = 0;
  80           return buffer;
  81         }
  82
  83       free (buffer);
  84       if (buf_size <= MAXSIZE / 2)
  85         buf_size *= 2;
  86       else if (buf_size < MAXSIZE)
  87         buf_size = MAXSIZE;
  88       else
  89         xalloc_die ();
  90     }
  91 }