lib/xreadlink.c

   1 /* xreadlink.c -- readlink wrapper to return the link name in malloc'd storage
   2
   3    Copyright (C) 2001, 2003, 2004 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    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 /* Written by Jim Meyering <jim@meyering.net>  */
  21
  22 #if 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 #if HAVE_UNISTD_H
  34 # include <unistd.h>
  35 #endif
  36
  37 #ifndef SIZE_MAX
  38 # define SIZE_MAX ((size_t) -1)
  39 #endif
  40 #ifndef SSIZE_MAX
  41 # define SSIZE_MAX ((ssize_t) (SIZE_MAX / 2))
  42 #endif
  43
  44 #include "xalloc.h"
  45
  46 /* Call readlink to get the symbolic link value of FILENAME.
  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 *filename, 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 + 1;
  60
  61   while (1)
  62     {
  63       char *buffer = xmalloc (buf_size);
  64       ssize_t link_length = readlink (filename, buffer, buf_size);
  65
  66       if (link_length < 0)
  67         {
  68           int saved_errno = errno;
  69           free (buffer);
  70           errno = saved_errno;
  71           return NULL;
  72         }
  73
  74       if ((size_t) link_length < buf_size)
  75         {
  76           buffer[link_length] = 0;
  77           return buffer;
  78         }
  79
  80       free (buffer);
  81       buf_size *= 2;
  82       if (! (0 < buf_size && buf_size <= SSIZE_MAX))
  83         xalloc_die ();
  84     }
  85 }