(read_filesystem_list) [MOUNTED_GETMNTINFO]: Use fsp_to_string.
[gnulib.git] / lib / mountlist.c
1 /* mountlist.c -- return a list of mounted filesystems
2    Copyright (C) 1991, 1992, 1997, 1998 Free Software Foundation, Inc.
3
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2, or (at your option)
7    any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program; if not, write to the Free Software Foundation,
16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
17
18 #if HAVE_CONFIG_H
19 # include <config.h>
20 #endif
21
22 #include <stdio.h>
23 #include <sys/types.h>
24 #include "mountlist.h"
25
26 #ifdef STDC_HEADERS
27 # include <stdlib.h>
28 #else
29 void free ();
30 #endif
31 #if defined(STDC_HEADERS) || defined(HAVE_STRING_H)
32 # include <string.h>
33 #else
34 # include <strings.h>
35 #endif
36
37 #ifndef strstr
38 char *strstr ();
39 #endif
40 char *xmalloc ();
41 char *xrealloc ();
42 char *xstrdup ();
43 void error ();
44
45 #include <errno.h>
46 #ifndef errno
47 extern int errno;
48 #endif
49
50 #ifdef HAVE_FCNTL_H
51 # include <fcntl.h>
52 #endif
53
54 #ifdef HAVE_UNISTD_H
55 # include <unistd.h>
56 #endif
57
58 #if HAVE_SYS_PARAM_H
59 # include <sys/param.h>
60 #endif
61
62 #if defined (MOUNTED_GETFSSTAT) /* __alpha running OSF_1 */
63 # include <sys/mount.h>
64 # include <sys/fs_types.h>
65 #endif /* MOUNTED_GETFSSTAT */
66
67 #ifdef MOUNTED_GETMNTENT1       /* 4.3BSD, SunOS, HP-UX, Dynix, Irix.  */
68 # include <mntent.h>
69 # if !defined(MOUNTED)
70 #  if defined(MNT_MNTTAB)       /* HP-UX.  */
71 #   define MOUNTED MNT_MNTTAB
72 #  endif
73 #  if defined(MNTTABNAME)       /* Dynix.  */
74 #   define MOUNTED MNTTABNAME
75 #  endif
76 # endif
77 #endif
78
79 #ifdef MOUNTED_GETMNTINFO       /* 4.4BSD.  */
80 # include <sys/mount.h>
81 #endif
82
83 #ifdef MOUNTED_GETMNT           /* Ultrix.  */
84 # include <sys/mount.h>
85 # include <sys/fs_types.h>
86 #endif
87
88 #ifdef MOUNTED_FREAD            /* SVR2.  */
89 # include <mnttab.h>
90 #endif
91
92 #ifdef MOUNTED_FREAD_FSTYP      /* SVR3.  */
93 # include <mnttab.h>
94 # include <sys/fstyp.h>
95 # include <sys/statfs.h>
96 #endif
97
98 #ifdef MOUNTED_LISTMNTENT
99 # include <mntent.h>
100 #endif
101
102 #ifdef MOUNTED_GETMNTENT2       /* SVR4.  */
103 # include <sys/mnttab.h>
104 #endif
105
106 #ifdef MOUNTED_VMOUNT           /* AIX.  */
107 # include <fshelp.h>
108 # include <sys/vfs.h>
109 #endif
110
111 #ifdef DOLPHIN
112 /* So special that it's not worth putting this in autoconf.  */
113 # undef MOUNTED_FREAD_FSTYP
114 # define MOUNTED_GETMNTTBL
115 #endif
116
117 #if HAVE_SYS_MNTENT_H
118 /* This is to get MNTOPT_IGNORE on e.g. SVR4.  */
119 # include <sys/mntent.h>
120 #endif
121
122 #if defined (MNTOPT_IGNORE) && defined (HAVE_HASMNTOPT)
123 # define MNT_IGNORE(M) hasmntopt ((M), MNTOPT_IGNORE)
124 #else
125 # define MNT_IGNORE(M) 0
126 #endif
127
128 #ifdef MOUNTED_GETMNTENT1       /* 4.3BSD, SunOS, HP-UX, Dynix, Irix.  */
129 /* Return the value of the hexadecimal number represented by CP.
130    No prefix (like '0x') or suffix (like 'h') is expected to be
131    part of CP. */
132
133 static int
134 xatoi (cp)
135      char *cp;
136 {
137   int val;
138
139   val = 0;
140   while (*cp)
141     {
142       if (*cp >= 'a' && *cp <= 'f')
143         val = val * 16 + *cp - 'a' + 10;
144       else if (*cp >= 'A' && *cp <= 'F')
145         val = val * 16 + *cp - 'A' + 10;
146       else if (*cp >= '0' && *cp <= '9')
147         val = val * 16 + *cp - '0';
148       else
149         break;
150       cp++;
151     }
152   return val;
153 }
154 #endif /* MOUNTED_GETMNTENT1.  */
155
156 #if MOUNTED_GETMNTINFO
157
158 # if ! HAVE_F_FSTYPENAME_IN_STATFS
159 static char *
160 fstype_to_string (short t)
161 {
162   switch (t)
163     {
164 #  ifdef MOUNT_PC
165     case MOUNT_PC:
166       return "pc";
167 #  endif
168 #  ifdef MOUNT_MFS
169     case MOUNT_MFS:
170       return "mfs";
171 #  endif
172 #  ifdef MOUNT_LO
173     case MOUNT_LO:
174       return "lo";
175 #  endif
176 #  ifdef MOUNT_TFS
177     case MOUNT_TFS:
178       return "tfs";
179 #  endif
180 #  ifdef MOUNT_TMP
181     case MOUNT_TMP:
182       return "tmp";
183 #  endif
184 #  ifdef MOUNT_UFS
185    case MOUNT_UFS:
186      return "ufs" ;
187 #  endif
188 #  ifdef MOUNT_NFS
189    case MOUNT_NFS:
190      return "nfs" ;
191 #  endif
192 #  ifdef MOUNT_MSDOS
193    case MOUNT_MSDOS:
194      return "msdos" ;
195 #  endif
196 #  ifdef MOUNT_LFS
197    case MOUNT_LFS:
198      return "lfs" ;
199 #  endif
200 #  ifdef MOUNT_LOFS
201    case MOUNT_LOFS:
202      return "lofs" ;
203 #  endif
204 #  ifdef MOUNT_FDESC
205    case MOUNT_FDESC:
206      return "fdesc" ;
207 #  endif
208 #  ifdef MOUNT_PORTAL
209    case MOUNT_PORTAL:
210      return "portal" ;
211 #  endif
212 #  ifdef MOUNT_NULL
213    case MOUNT_NULL:
214      return "null" ;
215 #  endif
216 #  ifdef MOUNT_UMAP
217    case MOUNT_UMAP:
218      return "umap" ;
219 #  endif
220 #  ifdef MOUNT_KERNFS
221    case MOUNT_KERNFS:
222      return "kernfs" ;
223 #  endif
224 #  ifdef MOUNT_PROCFS
225    case MOUNT_PROCFS:
226      return "procfs" ;
227 #  endif
228 #  ifdef MOUNT_AFS
229    case MOUNT_AFS:
230      return "afs" ;
231 #  endif
232 #  ifdef MOUNT_CD9660
233    case MOUNT_CD9660:
234      return "cd9660" ;
235 #  endif
236 #  ifdef MOUNT_UNION
237    case MOUNT_UNION:
238      return "union" ;
239 #  endif
240 #  ifdef MOUNT_DEVFS
241    case MOUNT_DEVFS:
242      return "devfs" ;
243 #  endif
244 #  ifdef MOUNT_EXT2FS
245    case MOUNT_EXT2FS:
246      return "ext2fs" ;
247 #  endif
248     default:
249       return "?";
250     }
251 }
252 # endif /* ! HAVE_F_FSTYPENAME_IN_STATFS */
253
254 /* __NetBSD__ || BSD_NET2 || __OpenBSD__ */
255 static char *
256 fsp_to_string (const struct statfs *fsp)
257 {
258 # if defined HAVE_F_FSTYPENAME_IN_STATFS
259   return fsp->f_fstypename;
260 # else
261   return fstype_to_string (fsp->f_type);
262 # endif
263 }
264
265 #endif /* MOUNTED_GETMNTINFO */
266
267 #ifdef MOUNTED_VMOUNT           /* AIX.  */
268 static char *
269 fstype_to_string (t)
270      int t;
271 {
272   struct vfs_ent *e;
273
274   e = getvfsbytype (t);
275   if (!e || !e->vfsent_name)
276     return "none";
277   else
278     return e->vfsent_name;
279 }
280 #endif /* MOUNTED_VMOUNT */
281
282 /* Return a list of the currently mounted filesystems, or NULL on error.
283    Add each entry to the tail of the list so that they stay in order.
284    If NEED_FS_TYPE is nonzero, ensure that the filesystem type fields in
285    the returned list are valid.  Otherwise, they might not be.
286    If ALL_FS is positive, return all entries; if zero, omit entries
287    for filesystems that are automounter (dummy) entries; if negative,
288    also omit non-local filesystems.  */
289
290 struct mount_entry *
291 read_filesystem_list (int need_fs_type, int all_fs)
292 {
293   struct mount_entry *mount_list;
294   struct mount_entry *me;
295   struct mount_entry **mtail = &mount_list;
296
297 #ifdef MOUNTED_LISTMNTENT
298   {
299     struct tabmntent *mntlist, *p;
300     struct mntent *mnt;
301     struct mount_entry *me;
302
303     /* the third and fourth arguments could be used to filter mounts,
304        but Crays doesn't seem to have any mounts that we want to
305        remove. Specifically, automount create normal NFS mounts.
306        */
307
308     if(listmntent(&mntlist, KMTAB, NULL, NULL) < 0)
309       return NULL;
310     for (p = mntlist; p; p = p->next) {
311       mnt = p->ment;
312       if (all_fs < 0 && REMOTE_FS_TYPE (mnt->mnt_type))
313         continue;
314       me = (struct mount_entry*) xmalloc(sizeof (struct mount_entry));
315       me->me_devname = xstrdup(mnt->mnt_fsname);
316       me->me_mountdir = xstrdup(mnt->mnt_dir);
317       me->me_type = xstrdup(mnt->mnt_type);
318       me->me_dev = -1;
319       *mtail = me;
320       mtail = &me->me_next;
321     }
322     freemntlist(mntlist);
323   }
324 #endif
325
326 #ifdef MOUNTED_GETMNTENT1       /* 4.3BSD, SunOS, HP-UX, Dynix, Irix.  */
327   {
328     struct mntent *mnt;
329     char *table = MOUNTED;
330     FILE *fp;
331     char *devopt;
332
333     fp = setmntent (table, "r");
334     if (fp == NULL)
335       return NULL;
336
337     while ((mnt = getmntent (fp)))
338       {
339         if (all_fs <= 0 && (!strcmp (mnt->mnt_type, "ignore")
340                             || !strcmp (mnt->mnt_type, "auto")))
341           continue;
342         if (all_fs < 0 && REMOTE_FS_TYPE (mnt->mnt_type))
343           continue;
344
345         me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
346         me->me_devname = xstrdup (mnt->mnt_fsname);
347         me->me_mountdir = xstrdup (mnt->mnt_dir);
348         me->me_type = xstrdup (mnt->mnt_type);
349         devopt = strstr (mnt->mnt_opts, "dev=");
350         if (devopt)
351           {
352             if (devopt[4] == '0' && (devopt[5] == 'x' || devopt[5] == 'X'))
353               me->me_dev = xatoi (devopt + 6);
354             else
355               me->me_dev = xatoi (devopt + 4);
356           }
357         else
358           me->me_dev = (dev_t) -1;      /* Magic; means not known yet. */
359
360         /* Add to the linked list. */
361         *mtail = me;
362         mtail = &me->me_next;
363       }
364
365     if (endmntent (fp) == 0)
366       goto free_then_fail;
367   }
368 #endif /* MOUNTED_GETMNTENT1. */
369
370 #ifdef MOUNTED_GETMNTINFO       /* 4.4BSD.  */
371   {
372     struct statfs *fsp;
373     int entries;
374
375     entries = getmntinfo (&fsp, MNT_NOWAIT);
376     if (entries < 0)
377       return NULL;
378     for (; entries-- > 0; fsp++)
379       {
380         char *fs_type = fsp_to_string (fsp);
381         if (all_fs < 0 && REMOTE_FS_TYPE (fs_type))
382           continue;
383
384         me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
385         me->me_devname = xstrdup (fsp->f_mntfromname);
386         me->me_mountdir = xstrdup (fsp->f_mntonname);
387         me->me_type = fs_type;
388         me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
389
390         /* Add to the linked list. */
391         *mtail = me;
392         mtail = &me->me_next;
393       }
394   }
395 #endif /* MOUNTED_GETMNTINFO */
396
397 #ifdef MOUNTED_GETMNT           /* Ultrix.  */
398   {
399     int offset = 0;
400     int val;
401     struct fs_data fsd;
402
403     while (errno = 0,
404            0 <= (val = getmnt (&offset, &fsd, sizeof (fsd), NOSTAT_MANY,
405                                (char *) 0)))
406       {
407         if (all_fs < 0 && REMOTE_FS_TYPE (gt_names[fsd.fd_req.fstype]))
408           continue;
409
410         me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
411         me->me_devname = xstrdup (fsd.fd_req.devname);
412         me->me_mountdir = xstrdup (fsd.fd_req.path);
413         me->me_type = gt_names[fsd.fd_req.fstype];
414         me->me_dev = fsd.fd_req.dev;
415
416         /* Add to the linked list. */
417         *mtail = me;
418         mtail = &me->me_next;
419       }
420     if (val < 0)
421       goto free_then_fail;
422   }
423 #endif /* MOUNTED_GETMNT. */
424
425 #if defined (MOUNTED_GETFSSTAT) /* __alpha running OSF_1 */
426   {
427     int numsys, counter, bufsize;
428     struct statfs *stats;
429
430     numsys = getfsstat ((struct statfs *)0, 0L, MNT_WAIT);
431     if (numsys < 0)
432       return (NULL);
433
434     bufsize = (1 + numsys) * sizeof (struct statfs);
435     stats = (struct statfs *)xmalloc (bufsize);
436     numsys = getfsstat (stats, bufsize, MNT_WAIT);
437
438     if (numsys < 0)
439       {
440         free (stats);
441         return (NULL);
442       }
443
444     for (counter = 0; counter < numsys; counter++)
445       {
446         if (all_fs < 0 && REMOTE_FS_TYPE (mnt_names[stats[counter].f_type]))
447           continue;
448
449         me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
450         me->me_devname = xstrdup (stats[counter].f_mntfromname);
451         me->me_mountdir = xstrdup (stats[counter].f_mntonname);
452         me->me_type = mnt_names[stats[counter].f_type];
453         me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
454
455         /* Add to the linked list. */
456         *mtail = me;
457         mtail = &me->me_next;
458       }
459
460     free (stats);
461   }
462 #endif /* MOUNTED_GETFSSTAT */
463
464 #if defined (MOUNTED_FREAD) || defined (MOUNTED_FREAD_FSTYP) /* SVR[23].  */
465   {
466     struct mnttab mnt;
467     char *table = "/etc/mnttab";
468     FILE *fp;
469
470     fp = fopen (table, "r");
471     if (fp == NULL)
472       return NULL;
473
474     while (fread (&mnt, sizeof mnt, 1, fp) > 0)
475       {
476         char *fs_type = "";
477
478 # ifdef GETFSTYP                        /* SVR3.  */
479         if (need_fs_type || all_fs < 0)
480           {
481             struct statfs fsd;
482             char typebuf[FSTYPSZ];
483
484             if (statfs (mnt.mt_filsys, &fsd, sizeof fsd, 0) != -1
485                 && sysfs (GETFSTYP, fsd.f_fstyp, typebuf) != -1)
486               {
487                 if (all_fs < 0 && REMOTE_FS_TYPE (typebuf))
488                   continue;
489                 fs_type = xstrdup (typebuf);
490               }
491           }
492 # endif
493
494         me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
495 # ifdef GETFSTYP                        /* SVR3.  */
496         me->me_devname = xstrdup (mnt.mt_dev);
497 # else
498         me->me_devname = xmalloc (strlen (mnt.mt_dev) + 6);
499         strcpy (me->me_devname, "/dev/");
500         strcpy (me->me_devname + 5, mnt.mt_dev);
501 # endif
502         me->me_mountdir = xstrdup (mnt.mt_filsys);
503         me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
504         me->me_type = fs_type;
505
506         /* Add to the linked list. */
507         *mtail = me;
508         mtail = &me->me_next;
509       }
510
511     if (ferror (fp))
512       {
513         int saved_errno = errno;
514         fclose (fp);
515         errno = saved_errno;
516         goto free_then_fail;
517       }
518
519     if (fclose (fp) == EOF)
520       goto free_then_fail;
521   }
522 #endif /* MOUNTED_FREAD || MOUNTED_FREAD_FSTYP.  */
523
524 #ifdef MOUNTED_GETMNTTBL        /* DolphinOS goes it's own way */
525   {
526     struct mntent **mnttbl=getmnttbl(),**ent;
527     for (ent=mnttbl;*ent;ent++)
528       {
529         if (all_fs < 0 && REMOTE_FS_TYPE ((*ent)->mt_fstype))
530           continue;
531
532         me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
533         me->me_devname = xstrdup ( (*ent)->mt_resource);
534         me->me_mountdir = xstrdup( (*ent)->mt_directory);
535         me->me_type =  xstrdup ((*ent)->mt_fstype);
536         me->me_dev = (dev_t) -1;        /* Magic; means not known yet. */
537
538         /* Add to the linked list. */
539         *mtail = me;
540         mtail = &me->me_next;
541       }
542     endmnttbl();
543   }
544 #endif
545
546 #ifdef MOUNTED_GETMNTENT2       /* SVR4.  */
547   {
548     struct mnttab mnt;
549     char *table = MNTTAB;
550     FILE *fp;
551     int ret;
552     int lockfd = -1;
553
554 # if defined F_RDLCK && defined F_SETLKW
555     /* MNTTAB_LOCK is a macro name of our own invention; it's not present in
556        e.g. Solaris 2.6.  If the SVR4 folks ever define a macro
557        for this file name, we should use their macro name instead.
558        (Why not just lock MNTTAB directly?  We don't know.)  */
559 #  ifndef MNTTAB_LOCK
560 #   define MNTTAB_LOCK "/etc/.mnttab.lock"
561 #  endif
562     lockfd = open (MNTTAB_LOCK, O_RDONLY);
563     if (0 <= lockfd)
564       {
565         struct flock flock;
566         flock.l_type = F_RDLCK;
567         flock.l_whence = SEEK_SET;
568         flock.l_start = 0;
569         flock.l_len = 0;
570         while (fcntl (lockfd, F_SETLKW, &flock) == -1)
571           if (errno != EINTR)
572             {
573               int saved_errno = errno;
574               close (lockfd);
575               errno = saved_errno;
576               return NULL;
577             }
578       }
579     else if (errno != ENOENT)
580       return NULL;
581 # endif
582
583     errno = 0;
584     fp = fopen (table, "r");
585     if (fp == NULL)
586       ret = errno;
587     else
588       {
589         while ((ret = getmntent (fp, &mnt)) == 0)
590           {
591             /* Don't show automounted filesystems twice on e.g., Solaris.  */
592             if (all_fs <= 0 && MNT_IGNORE (&mnt))
593               continue;
594
595             if (all_fs < 0 && REMOTE_FS_TYPE (mnt.mnt_fstype))
596               continue;
597
598             me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
599             me->me_devname = xstrdup (mnt.mnt_special);
600             me->me_mountdir = xstrdup (mnt.mnt_mountp);
601             me->me_type = xstrdup (mnt.mnt_fstype);
602             me->me_dev = (dev_t) -1;    /* Magic; means not known yet. */
603
604             /* Add to the linked list. */
605             *mtail = me;
606             mtail = &me->me_next;
607           }
608
609         ret = fclose (fp) == EOF ? errno : 0 < ret ? 0 : -1;
610       }
611
612     if (0 <= lockfd && close (lockfd) != 0)
613       ret = errno;
614
615     if (0 <= ret)
616       {
617         errno = ret;
618         goto free_then_fail;
619       }
620   }
621 #endif /* MOUNTED_GETMNTENT2.  */
622
623 #ifdef MOUNTED_VMOUNT           /* AIX.  */
624   {
625     int bufsize;
626     char *entries, *thisent;
627     struct vmount *vmp;
628
629     /* Ask how many bytes to allocate for the mounted filesystem info.  */
630     mntctl (MCTL_QUERY, sizeof bufsize, (struct vmount *) &bufsize);
631     entries = xmalloc (bufsize);
632
633     /* Get the list of mounted filesystems.  */
634     mntctl (MCTL_QUERY, bufsize, (struct vmount *) entries);
635
636     for (thisent = entries; thisent < entries + bufsize;
637          thisent += vmp->vmt_length)
638       {
639         vmp = (struct vmount *) thisent;
640         if (all_fs < 0 && vmp->vmt_flags & MNT_REMOTE)
641           continue;
642         me = (struct mount_entry *) xmalloc (sizeof (struct mount_entry));
643         if (vmp->vmt_flags & MNT_REMOTE)
644           {
645             char *host, *path;
646
647             /* Prepend the remote pathname.  */
648             host = thisent + vmp->vmt_data[VMT_HOSTNAME].vmt_off;
649             path = thisent + vmp->vmt_data[VMT_OBJECT].vmt_off;
650             me->me_devname = xmalloc (strlen (host) + strlen (path) + 2);
651             strcpy (me->me_devname, host);
652             strcat (me->me_devname, ":");
653             strcat (me->me_devname, path);
654           }
655         else
656           {
657             me->me_devname = xstrdup (thisent +
658                                       vmp->vmt_data[VMT_OBJECT].vmt_off);
659           }
660         me->me_mountdir = xstrdup (thisent + vmp->vmt_data[VMT_STUB].vmt_off);
661         me->me_type = xstrdup (fstype_to_string (vmp->vmt_gfstype));
662         me->me_dev = (dev_t) -1; /* vmt_fsid might be the info we want.  */
663
664         /* Add to the linked list. */
665         *mtail = me;
666         mtail = &me->me_next;
667       }
668     free (entries);
669   }
670 #endif /* MOUNTED_VMOUNT. */
671
672   *mtail = NULL;
673   return mount_list;
674
675
676  free_then_fail:
677   {
678     int saved_errno = errno;
679     *mtail = NULL;
680
681     while (mount_list)
682       {
683         me = mount_list->me_next;
684         free (mount_list->me_devname);
685         free (mount_list->me_mountdir);
686         /* FIXME: me_type is not always malloced.  */
687         free (mount_list);
688         mount_list = me;
689       }
690
691     errno = saved_errno;
692     return NULL;
693   }
694 }