lib/isapipe.c

   1 /* Test whether a file descriptor is a pipe.
   2
   3    Copyright (C) 2006 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; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 /* Written by Paul Eggert.  */
  20
  21 #include <config.h>
  22
  23 #include "isapipe.h"
  24
  25 #include <errno.h>
  26 #include <stdbool.h>
  27 #include <sys/types.h>
  28 #include <sys/stat.h>
  29 #include <unistd.h>
  30
  31 /* The maximum link count for pipes; (nlink_t) -1 if not known.  */
  32 #ifndef PIPE_LINK_COUNT_MAX
  33 # define PIPE_LINK_COUNT_MAX ((nlink_t) (-1))
  34 #endif
  35
  36 /* Return 1 if FD is a pipe, 0 if not, -1 (setting errno) on error.
  37
  38    Test fairly strictly whether FD is a pipe.  lseek and checking for
  39    ESPIPE does not suffice, since many non-pipe files cause lseek to
  40    fail with errno == ESPIPE.  */
  41
  42 int
  43 isapipe (int fd)
  44 {
  45   nlink_t pipe_link_count_max = PIPE_LINK_COUNT_MAX;
  46   bool check_for_fifo = (HAVE_FIFO_PIPES == 1);
  47   struct stat st;
  48   int fstat_result = fstat (fd, &st);
  49
  50   if (fstat_result != 0)
  51     return fstat_result;
  52
  53   /* We want something that succeeds only for pipes, but on
  54      POSIX-conforming hosts S_ISFIFO succeeds for both FIFOs and pipes
  55      and we know of no portable, reliable way to distinguish them in
  56      general.  However, in practice pipes always have a link count <=
  57      PIPE_LINK_COUNT_MAX (unless someone attaches them to the file
  58      system name space using fattach, in which case they're not really
  59      pipes any more), so test for that as well.
  60
  61      On Darwin 7.7, pipes are sockets, so check for those instead.  */
  62
  63   if (! ((HAVE_FIFO_PIPES == 0 || HAVE_FIFO_PIPES == 1)
  64          && PIPE_LINK_COUNT_MAX != (nlink_t) -1)
  65       && (S_ISFIFO (st.st_mode) | S_ISSOCK (st.st_mode)))
  66     {
  67       int fd_pair[2];
  68       int pipe_result = pipe (fd_pair);
  69       if (pipe_result != 0)
  70         return pipe_result;
  71       else
  72         {
  73           struct stat pipe_st;
  74           int fstat_pipe_result = fstat (fd_pair[0], &pipe_st);
  75           int fstat_pipe_errno = errno;
  76           close (fd_pair[0]);
  77           close (fd_pair[1]);
  78           if (fstat_pipe_result != 0)
  79             {
  80               errno = fstat_pipe_errno;
  81               return fstat_pipe_result;
  82             }
  83           check_for_fifo = (S_ISFIFO (pipe_st.st_mode) != 0);
  84           pipe_link_count_max = pipe_st.st_nlink;
  85         }
  86     }
  87
  88   return
  89     (st.st_nlink <= pipe_link_count_max
  90      && (check_for_fifo ? S_ISFIFO (st.st_mode) : S_ISSOCK (st.st_mode)));
  91 }