(translate_040_to_space) [MOUNTED_GETMNTENT1]: New function.
[gnulib.git] / lib / mountlist.c
index 68fc41a..c2c77b3 100644 (file)
@@ -1,5 +1,5 @@
 /* mountlist.c -- return a list of mounted filesystems
-   Copyright (C) 1991, 1992, 1997, 1998 Free Software Foundation, Inc.
+   Copyright (C) 1991, 1992, 1997, 1998, 1999 Free Software Foundation, Inc.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -42,6 +42,19 @@ char *xrealloc ();
 char *xstrdup ();
 void error ();
 
+#include <errno.h>
+#ifndef errno
+extern int errno;
+#endif
+
+#ifdef HAVE_FCNTL_H
+# include <fcntl.h>
+#endif
+
+#ifdef HAVE_UNISTD_H
+# include <unistd.h>
+#endif
+
 #if HAVE_SYS_PARAM_H
 # include <sys/param.h>
 #endif
@@ -116,10 +129,10 @@ void error ();
 /* Return the value of the hexadecimal number represented by CP.
    No prefix (like '0x') or suffix (like 'h') is expected to be
    part of CP. */
+/* FIXME: this can overflow */
 
 static int
-xatoi (cp)
-     char *cp;
+xatoi (char *cp)
 {
   int val;
 
@@ -138,6 +151,46 @@ xatoi (cp)
     }
   return val;
 }
+
+/* Convert, in place, each unambiguous `\040' sequence in the NUL-terminated
+   string, STR, to a single space.  `unambiguous' means that it must not be
+   immediately preceded by an odd number of backslash characters.  */
+
+static void
+translate_040_to_space (char *str)
+{
+  while (1)
+    {
+      char *p;
+      char *backslash = strstr (str, "\\040");
+      unsigned int backslash_count = 0;
+
+      if (backslash == NULL)
+       break;
+
+      /* Count preceding backslashes, going no further than str.  */
+      for (p = backslash - 1; p >= str && *p == '\\'; p--)
+       ++backslash_count;
+
+      if (backslash_count % 2 == 1)
+       {
+         /* The backslash is escaped;  advance past the 040 and
+            continue searching.  */
+         str = backslash + 4;
+         continue;
+       }
+
+      /* We found an unambiguous `\040'.  Replace it with a space
+        and move everything following it back by 3 bytes.
+         The source and destination regions may overlap, so we have
+        to use memmove.  */
+      *backslash = ' ';
+      str = backslash + 1;
+      /* Be sure to copy the trailing NUL byte, too.  */
+      memmove (str, backslash + 4, strlen (backslash + 4) + 1);
+    }
+}
+
 #endif /* MOUNTED_GETMNTENT1.  */
 
 #if MOUNTED_GETMNTINFO
@@ -243,7 +296,7 @@ static char *
 fsp_to_string (const struct statfs *fsp)
 {
 # if defined HAVE_F_FSTYPENAME_IN_STATFS
-  return xstrdup (fsp->f_fstypename);
+  return fsp->f_fstypename;
 # else
   return fstype_to_string (fsp->f_type);
 # endif
@@ -253,8 +306,7 @@ fsp_to_string (const struct statfs *fsp)
 
 #ifdef MOUNTED_VMOUNT          /* AIX.  */
 static char *
-fstype_to_string (t)
-     int t;
+fstype_to_string (int t)
 {
   struct vfs_ent *e;
 
@@ -269,22 +321,14 @@ fstype_to_string (t)
 /* Return a list of the currently mounted filesystems, or NULL on error.
    Add each entry to the tail of the list so that they stay in order.
    If NEED_FS_TYPE is nonzero, ensure that the filesystem type fields in
-   the returned list are valid.  Otherwise, they might not be.
-   If ALL_FS is zero, do not return entries for filesystems that
-   are automounter (dummy) entries.  */
+   the returned list are valid.  Otherwise, they might not be.  */
 
 struct mount_entry *
-read_filesystem_list (need_fs_type, all_fs)
-     int need_fs_type, all_fs;
+read_filesystem_list (int need_fs_type)
 {
   struct mount_entry *mount_list;
   struct mount_entry *me;
-  struct mount_entry *mtail;
-
-  /* Start the list off with a dummy entry. */
-  me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
-  me->me_next = NULL;
-  mount_list = mtail = me;
+  struct mount_entry **mtail = &mount_list;
 
 #ifdef MOUNTED_LISTMNTENT
   {
@@ -299,18 +343,17 @@ read_filesystem_list (need_fs_type, all_fs)
 
     if(listmntent(&mntlist, KMTAB, NULL, NULL) < 0)
       return NULL;
-    p = mntlist;
-    while(p){
+    for (p = mntlist; p; p = p->next) {
       mnt = p->ment;
       me = (struct mount_entry*) xmalloc(sizeof (struct mount_entry));
       me->me_devname = xstrdup(mnt->mnt_fsname);
       me->me_mountdir = xstrdup(mnt->mnt_dir);
       me->me_type = xstrdup(mnt->mnt_type);
+      me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
+      me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
       me->me_dev = -1;
-      me->me_next = NULL;
-      mtail->me_next = me;
-      mtail = me;
-      p = p->next;
+      *mtail = me;
+      mtail = &me->me_next;
     }
     freemntlist(mntlist);
   }
@@ -329,14 +372,12 @@ read_filesystem_list (need_fs_type, all_fs)
 
     while ((mnt = getmntent (fp)))
       {
-       if (!all_fs && (!strcmp (mnt->mnt_type, "ignore")
-                       || !strcmp (mnt->mnt_type, "auto")))
-         continue;
-
        me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
        me->me_devname = xstrdup (mnt->mnt_fsname);
        me->me_mountdir = xstrdup (mnt->mnt_dir);
        me->me_type = xstrdup (mnt->mnt_type);
+       me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
+       me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
        devopt = strstr (mnt->mnt_opts, "dev=");
        if (devopt)
          {
@@ -347,15 +388,19 @@ read_filesystem_list (need_fs_type, all_fs)
          }
        else
          me->me_dev = (dev_t) -1;      /* Magic; means not known yet. */
-       me->me_next = NULL;
+
+       /* FIXME: do the conversion only if we're using some version of
+          GNU libc -- which one?  */
+       /* Convert each `\040' string to a space.  */
+       translate_040_to_space (me->me_mountdir);
 
        /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
+       *mtail = me;
+       mtail = &me->me_next;
       }
 
     if (endmntent (fp) == 0)
-      return NULL;
+      goto free_then_fail;
   }
 #endif /* MOUNTED_GETMNTENT1. */
 
@@ -367,19 +412,21 @@ read_filesystem_list (need_fs_type, all_fs)
     entries = getmntinfo (&fsp, MNT_NOWAIT);
     if (entries < 0)
       return NULL;
-    while (entries-- > 0)
+    for (; entries-- > 0; fsp++)
       {
+       char *fs_type = fsp_to_string (fsp);
+
        me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
        me->me_devname = xstrdup (fsp->f_mntfromname);
        me->me_mountdir = xstrdup (fsp->f_mntonname);
-       me->me_type = fsp_to_string (fsp);
+       me->me_type = fs_type;
+       me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
+       me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
        me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
-       me->me_next = NULL;
 
        /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
-       fsp++;
+       *mtail = me;
+       mtail = &me->me_next;
       }
   }
 #endif /* MOUNTED_GETMNTINFO */
@@ -390,22 +437,24 @@ read_filesystem_list (need_fs_type, all_fs)
     int val;
     struct fs_data fsd;
 
-    while ((val = getmnt (&offset, &fsd, sizeof (fsd), NOSTAT_MANY,
-                         (char *) 0)) > 0)
+    while (errno = 0,
+          0 < (val = getmnt (&offset, &fsd, sizeof (fsd), NOSTAT_MANY,
+                             (char *) 0)))
       {
        me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
        me->me_devname = xstrdup (fsd.fd_req.devname);
        me->me_mountdir = xstrdup (fsd.fd_req.path);
        me->me_type = gt_names[fsd.fd_req.fstype];
+       me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
+       me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
        me->me_dev = fsd.fd_req.dev;
-       me->me_next = NULL;
 
        /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
+       *mtail = me;
+       mtail = &me->me_next;
       }
     if (val < 0)
-      return NULL;
+      goto free_then_fail;
   }
 #endif /* MOUNTED_GETMNT. */
 
@@ -434,12 +483,13 @@ read_filesystem_list (need_fs_type, all_fs)
        me->me_devname = xstrdup (stats[counter].f_mntfromname);
        me->me_mountdir = xstrdup (stats[counter].f_mntonname);
        me->me_type = mnt_names[stats[counter].f_type];
+       me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
+       me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
        me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
-       me->me_next = NULL;
 
        /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
+       *mtail = me;
+       mtail = &me->me_next;
       }
 
     free (stats);
@@ -480,15 +530,24 @@ read_filesystem_list (need_fs_type, all_fs)
              me->me_type = xstrdup (typebuf);
          }
 # endif
-       me->me_next = NULL;
+       me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
+       me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
 
        /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
+       *mtail = me;
+       mtail = &me->me_next;
+      }
+
+    if (ferror (fp))
+      {
+       int saved_errno = errno;
+       fclose (fp);
+       errno = saved_errno;
+       goto free_then_fail;
       }
 
     if (fclose (fp) == EOF)
-      return NULL;
+      goto free_then_fail;
   }
 #endif /* MOUNTED_FREAD || MOUNTED_FREAD_FSTYP.  */
 
@@ -501,12 +560,13 @@ read_filesystem_list (need_fs_type, all_fs)
        me->me_devname = xstrdup ( (*ent)->mt_resource);
        me->me_mountdir = xstrdup( (*ent)->mt_directory);
        me->me_type =  xstrdup ((*ent)->mt_fstype);
+       me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
+       me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
        me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
-       me->me_next = NULL;
 
        /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
+       *mtail = me;
+       mtail = &me->me_next;
       }
     endmnttbl();
   }
@@ -518,33 +578,69 @@ read_filesystem_list (need_fs_type, all_fs)
     char *table = MNTTAB;
     FILE *fp;
     int ret;
+    int lockfd = -1;
+
+# if defined F_RDLCK && defined F_SETLKW
+    /* MNTTAB_LOCK is a macro name of our own invention; it's not present in
+       e.g. Solaris 2.6.  If the SVR4 folks ever define a macro
+       for this file name, we should use their macro name instead.
+       (Why not just lock MNTTAB directly?  We don't know.)  */
+#  ifndef MNTTAB_LOCK
+#   define MNTTAB_LOCK "/etc/.mnttab.lock"
+#  endif
+    lockfd = open (MNTTAB_LOCK, O_RDONLY);
+    if (0 <= lockfd)
+      {
+       struct flock flock;
+       flock.l_type = F_RDLCK;
+       flock.l_whence = SEEK_SET;
+       flock.l_start = 0;
+       flock.l_len = 0;
+       while (fcntl (lockfd, F_SETLKW, &flock) == -1)
+         if (errno != EINTR)
+           {
+             int saved_errno = errno;
+             close (lockfd);
+             errno = saved_errno;
+             return NULL;
+           }
+      }
+    else if (errno != ENOENT)
+      return NULL;
+# endif
 
+    errno = 0;
     fp = fopen (table, "r");
     if (fp == NULL)
-      return NULL;
-
-    while ((ret = getmntent (fp, &mnt)) == 0)
+      ret = errno;
+    else
       {
-       /* Don't show automounted filesystems twice on e.g., Solaris.  */
-       if (!all_fs && MNT_IGNORE (&mnt))
-         continue;
-
-       me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
-       me->me_devname = xstrdup (mnt.mnt_special);
-       me->me_mountdir = xstrdup (mnt.mnt_mountp);
-       me->me_type = xstrdup (mnt.mnt_fstype);
-       me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
-       me->me_next = NULL;
+       while ((ret = getmntent (fp, &mnt)) == 0)
+         {
+           me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
+           me->me_devname = xstrdup (mnt.mnt_special);
+           me->me_mountdir = xstrdup (mnt.mnt_mountp);
+           me->me_type = xstrdup (mnt.mnt_fstype);
+           me->me_dummy = MNT_IGNORE (&mnt) != 0;
+           me->me_remote = ME_REMOTE (me->me_devname, me->me_type);
+           me->me_dev = (dev_t) -1;    /* Magic; means not known yet. */
+
+           /* Add to the linked list. */
+           *mtail = me;
+           mtail = &me->me_next;
+         }
 
-       /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
+       ret = fclose (fp) == EOF ? errno : 0 < ret ? 0 : -1;
       }
 
-    if (ret > 0)
-      return NULL;
-   if (fclose (fp) == EOF)
-      return NULL;
+    if (0 <= lockfd && close (lockfd) != 0)
+      ret = errno;
+
+    if (0 <= ret)
+      {
+       errno = ret;
+       goto free_then_fail;
+      }
   }
 #endif /* MOUNTED_GETMNTENT2.  */
 
@@ -570,6 +666,7 @@ read_filesystem_list (need_fs_type, all_fs)
          {
            char *host, *path;
 
+           me->me_remote = 1;
            /* Prepend the remote pathname.  */
            host = thisent + vmp->vmt_data[VMT_HOSTNAME].vmt_off;
            path = thisent + vmp->vmt_data[VMT_OBJECT].vmt_off;
@@ -580,25 +677,58 @@ read_filesystem_list (need_fs_type, all_fs)
          }
        else
          {
+           me->me_remote = 0;
            me->me_devname = xstrdup (thisent +
                                      vmp->vmt_data[VMT_OBJECT].vmt_off);
          }
        me->me_mountdir = xstrdup (thisent + vmp->vmt_data[VMT_STUB].vmt_off);
        me->me_type = xstrdup (fstype_to_string (vmp->vmt_gfstype));
+       me->me_dummy = ME_DUMMY (me->me_devname, me->me_type);
        me->me_dev = (dev_t) -1; /* vmt_fsid might be the info we want.  */
-       me->me_next = NULL;
 
        /* Add to the linked list. */
-       mtail->me_next = me;
-       mtail = me;
+       *mtail = me;
+       mtail = &me->me_next;
       }
     free (entries);
   }
 #endif /* MOUNTED_VMOUNT. */
 
-  /* Free the dummy head. */
-  me = mount_list;
-  mount_list = mount_list->me_next;
-  free (me);
+  *mtail = NULL;
   return mount_list;
+
+
+ free_then_fail:
+  {
+    int saved_errno = errno;
+    *mtail = NULL;
+
+    while (mount_list)
+      {
+       me = mount_list->me_next;
+       free (mount_list->me_devname);
+       free (mount_list->me_mountdir);
+       /* FIXME: me_type is not always malloced.  */
+       free (mount_list);
+       mount_list = me;
+      }
+
+    errno = saved_errno;
+    return NULL;
+  }
 }
+
+#ifdef TEST
+int
+main (int argc, char **argv)
+{
+  int i;
+  for (i = 1; i < argc; i++)
+    {
+      char *p = xstrdup (argv[i]);
+      translate_040_to_space (p);
+      printf ("%s: %s\n", argv[i], p);
+    }
+  exit (0);
+}
+#endif