filemode changes to support Solaris 10 port files, etc.

[Paul Eggert]

After thinking a bit about
<http://lists.gnu.org/archive/html/bug-coreutils/2006-04/msg00079.html>
I looked to see if there are some other file modes we weren't handling
or documenting, and came up with the following patch which I installed.

2006-04-17  Paul Eggert  <address@hidden>

        * doc/coreutils.texi (What information is listed): Add P for Solaris
        10 ports.  Add commented-out entries for other types that POSIX
        says are possible, or that I observed in FreeBSD documentation.
        * lib/filemode.c: Include "filemode.h" first, to test the interface.
        Assume that filemode.h includes sys/types.h and sys/stat.h.
        (HAVE_ST_DM_MODE): New macro, moved here from ls.c.
        (ftypelet): Reorder to put common cases first, for efficiency.
        Add 'P', 'w'.  Remove 'M', since it's now the caller's responsibility
        to do 'M'.
        (strmode): Renamed from mode_string, and now stores 12 bytes instead
        of 10, for compatibility with FreeBSD.  All callers changed.
        (filemodestring): Now stores 12 bytes instead of 10, and sets file types
        that can't be deduced solely from st_mode.  First arg is now a const
        pointer.
        * lib/filemode.h (HAVE_DECL_STRMODE): Include <string.h> for strmode.
        (strmode): Renamed from mode_string.
        (filemodestring): New decl.
        * lib/stat-macros.h: Don't undef S_ISDOOR, since it's never buggy.
        (S_ISDOOR): Don't bother with S_IFDOOR, since that code is never needed.
        (S_ISPORT, S_ISWHT): New macros, if not already defined.
        * m4/filemode.m4 (gl_FILEMODE): Check for strmode declaration.
        * src/chmod.c (describe_change): Adjust to filemode changes.
        * src/ls.c (HAVE_ST_DM_MODE): Remove; moved to ../lib/filemode.c.
        (print_long_format): Use (new) filemodestring rather than
        (old) mode_string, so that we get more file types right, at least
        in theory.  Adjust to filemode changes.
        * src/stat.c (human_access): Likewise.

Index: doc/coreutils.texi
===================================================================
RCS file: /fetish/cu/doc/coreutils.texi,v
retrieving revision 1.324
diff -p -u -r1.324 coreutils.texi
--- doc/coreutils.texi  17 Apr 2006 23:14:45 -0000      1.324
+++ doc/coreutils.texi  17 Apr 2006 23:20:23 -0000
@@ -5769,6 +5769,8 @@ this is arguably a deficiency.
 
 The file type is one of the following characters:
 
address@hidden The commented-out entries are ones we're not sure about.
+
 @table @samp
 @item -
 regular file
@@ -5781,19 +5783,31 @@ high performance (``contiguous data'') f
 @item d
 directory
 @item D
-door
+door (Solaris 2.5 and up)
address@hidden @item F
address@hidden semaphore, if this is a distinct file type
 @item l
 symbolic link
 @c @item m
address@hidden multiplexed character special file (7th edition Unix; obsolete)
address@hidden multiplexed file (7th edition Unix; obsolete)
 @item M
 off-line (``migrated'') file (Cray DMF)
 @item n
 network special file (HP-UX)
 @item p
 FIFO (named pipe)
address@hidden P
+port (Solaris 10 and up)
address@hidden @item Q
address@hidden message queue, if this is a distinct file type
 @item s
 socket
address@hidden @item S
address@hidden shared memory object, if this is a distinct file type
address@hidden @item T
address@hidden typed memory object, if this is a distinct file type
address@hidden @item w
address@hidden whiteout (4.4BSD; not implemented)
 @item ?
 some other file type
 @end table
Index: lib/filemode.c
===================================================================
RCS file: /fetish/cu/lib/filemode.c,v
retrieving revision 1.16
diff -p -u -r1.16 filemode.c
--- lib/filemode.c      22 Sep 2005 06:05:39 -0000      1.16
+++ lib/filemode.c      17 Apr 2006 23:20:23 -0000
@@ -1,5 +1,7 @@
 /* filemode.c -- make a string describing file modes
-   Copyright (C) 1985, 1990, 1993, 1998-2000, 2004 Free Software Foundation, 
Inc.
+
+   Copyright (C) 1985, 1990, 1993, 1998-2000, 2004, 2006 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
@@ -19,12 +21,22 @@
 # include <config.h>
 #endif
 
-#include <sys/types.h>
-#include <sys/stat.h>
-
 #include "filemode.h"
+
 #include "stat-macros.h"
 
+/* The following is for Cray DMF (Data Migration Facility), which is a
+   HSM file system.  A migrated file has a `st_dm_mode' that is
+   different from the normal `st_mode', so any tests for migrated
+   files should use the former.  */
+#if HAVE_ST_DM_MODE
+# define IS_MIGRATED_FILE(statp) \
+    (S_ISOFD (statp->st_dm_mode) || S_ISOFL (statp->st_dm_mode))
+#else
+# define IS_MIGRATED_FILE(statp) 0
+#endif
+
+#if ! HAVE_DECL_STRMODE
 
 /* Set the 's' and 't' flags in file attributes string CHARS,
    according to the file mode BITS.  */
@@ -60,65 +72,65 @@ setst (mode_t bits, char *chars)
 
 /* Return a character indicating the type of file described by
    file mode BITS:
-   'd' for directories
-   'D' for doors
-   'b' for block special files
-   'c' for character special files
-   'n' for network special files
-   'm' for multiplexor files
-   'M' for an off-line (regular) file
-   'l' for symbolic links
-   's' for sockets
-   'p' for fifos
-   'C' for contigous data files
-   '-' for regular files
-   '?' for any other file type.  */
+   '-' regular file
+   'b' block special file
+   'c' character special file
+   'C' high performance ("contiguous data") file
+   'd' directory
+   'D' door
+   'l' symbolic link
+   'm' multiplexed file (7th edition Unix; obsolete)
+   'n' network special file (HP-UX)
+   'p' fifo (named pipe)
+   'P' port
+   's' socket
+   'w' whiteout (4.4BSD)
+   '?' some other file type  */
 
 static char
 ftypelet (mode_t bits)
 {
+  /* These are the most common, so test for them first.  */
+  if (S_ISREG (bits))
+    return '-';
+  if (S_ISDIR (bits))
+    return 'd';
+
+  /* Other letters standardized by POSIX 1003.1-2004.  */
   if (S_ISBLK (bits))
     return 'b';
   if (S_ISCHR (bits))
     return 'c';
-  if (S_ISDIR (bits))
-    return 'd';
-  if (S_ISREG (bits))
-    return '-';
-  if (S_ISFIFO (bits))
-    return 'p';
   if (S_ISLNK (bits))
     return 'l';
+  if (S_ISFIFO (bits))
+    return 'p';
+
+  /* Other file types (though not letters) standardized by POSIX.  */
   if (S_ISSOCK (bits))
     return 's';
-  if (S_ISMPC (bits))
+
+  /* Nonstandard file types.  */
+  if (S_ISCTG (bits))
+    return 'C';
+  if (S_ISDOOR (bits))
+    return 'D';
+  if (S_ISMPB (bits) || S_ISMPC (bits))
     return 'm';
   if (S_ISNWK (bits))
     return 'n';
-  if (S_ISDOOR (bits))
-    return 'D';
-  if (S_ISCTG (bits))
-    return 'C';
+  if (S_ISPORT (bits))
+    return 'P';
+  if (S_ISWHT (bits))
+    return 'w';
 
-  /* The following two tests are for Cray DMF (Data Migration
-     Facility), which is a HSM file system.  A migrated file has a
-     `st_dm_mode' that is different from the normal `st_mode', so any
-     tests for migrated files should use the former.  */
-
-  if (S_ISOFD (bits))
-    /* off line, with data  */
-    return 'M';
-  /* off line, with no data  */
-  if (S_ISOFL (bits))
-    return 'M';
   return '?';
 }
 
-/* Like filemodestring, but only the relevant part of the `struct stat'
-   is given as an argument.  */
+/* Like filemodestring, but rely only on MODE.  */
 
 void
-mode_string (mode_t mode, char *str)
+strmode (mode_t mode, char *str)
 {
   str[0] = ftypelet (mode);
   str[1] = mode & S_IRUSR ? 'r' : '-';
@@ -130,18 +142,26 @@ mode_string (mode_t mode, char *str)
   str[7] = mode & S_IROTH ? 'r' : '-';
   str[8] = mode & S_IWOTH ? 'w' : '-';
   str[9] = mode & S_IXOTH ? 'x' : '-';
+  str[10] = ' ';
+  str[11] = '\0';
   setst (mode, str);
 }
 
+#endif /* ! HAVE_DECL_STRMODE */
+
 /* filemodestring - fill in string STR with an ls-style ASCII
    representation of the st_mode field of file stats block STATP.
-   10 characters are stored in STR; no terminating null is added.
+   12 characters are stored in STR.
    The characters stored in STR are:
 
-   0   File type.  'd' for directory, 'c' for character
-       special, 'b' for block special, 'm' for multiplex,
-       'l' for symbolic link, 's' for socket, 'p' for fifo,
-       '-' for regular, '?' for any other file type
+   0   File type, as in ftypelet above, except that other letters are used
+        for files whose type cannot be determined solely from st_mode:
+
+           'F' semaphore
+           'M' migrated file (Cray DMF)
+           'Q' message queue
+           'S' shared memory object
+           'T' typed memory object
 
    1   'r' if the owner may read, '-' otherwise.
 
@@ -167,10 +187,26 @@ mode_string (mode_t mode, char *str)
    9   'x' if any user may execute, 't' if the file is "sticky"
        (will be retained in swap space after execution), '-'
        otherwise.
-       'T' if the file is sticky but not executable.  */
+       'T' if the file is sticky but not executable.
+
+   10   ' ' for compatibility with 4.4BSD strmode,
+       since this interface does not support ACLs.
+
+   11   '\0'.  */
 
 void
-filemodestring (struct stat *statp, char *str)
+filemodestring (struct stat const *statp, char *str)
 {
-  mode_string (statp->st_mode, str);
+  strmode (statp->st_mode, str);
+
+  if (S_TYPEISSEM (statp))
+    str[0] = 'F';
+  else if (IS_MIGRATED_FILE (statp))
+    str[0] = 'M';
+  else if (S_TYPEISMQ (statp))
+    str[0] = 'Q';
+  else if (S_TYPEISSHM (statp))
+    str[0] = 'S';
+  else if (S_TYPEISTMO (statp))
+    str[0] = 'T';
 }
Index: lib/filemode.h
===================================================================
RCS file: /fetish/cu/lib/filemode.h,v
retrieving revision 1.6
diff -p -u -r1.6 filemode.h
--- lib/filemode.h      14 May 2005 07:58:06 -0000      1.6
+++ lib/filemode.h      17 Apr 2006 23:20:23 -0000
@@ -1,6 +1,6 @@
 /* Make a string describing file modes.
 
-   Copyright (C) 1998, 1999, 2003 Free Software Foundation, Inc.
+   Copyright (C) 1998, 1999, 2003, 2006 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
@@ -19,7 +19,14 @@
 #ifndef FILEMODE_H_
 
 # include <sys/types.h>
+# include <sys/stat.h>
 
-void mode_string (mode_t mode, char *str);
+# if HAVE_DECL_STRMODE
+#  include <string.h>
+# else
+void strmode (mode_t mode, char *str);
+# endif
+
+void filemodestring (struct stat const *statp, char *str);
 
 #endif
Index: lib/stat-macros.h
===================================================================
RCS file: /fetish/cu/lib/stat-macros.h,v
retrieving revision 1.4
diff -p -u -r1.4 stat-macros.h
--- lib/stat-macros.h   14 May 2005 07:58:07 -0000      1.4
+++ lib/stat-macros.h   17 Apr 2006 23:20:23 -0000
@@ -33,7 +33,6 @@
 #  undef S_ISBLK
 #  undef S_ISCHR
 #  undef S_ISDIR
-#  undef S_ISDOOR
 #  undef S_ISFIFO
 #  undef S_ISLNK
 #  undef S_ISNAM
@@ -70,11 +69,7 @@
 # endif
 
 # ifndef S_ISDOOR /* Solaris 2.5 and up */
-#  ifdef S_IFDOOR
-#   define S_ISDOOR(m) (((m) & S_IFMT) == S_IFDOOR)
-#  else
-#   define S_ISDOOR(m) 0
-#  endif
+#  define S_ISDOOR(m) 0
 # endif
 
 # ifndef S_ISFIFO
@@ -119,6 +114,10 @@
 #  endif
 # endif
 
+# ifndef S_ISPORT /* Solaris 10 and up */
+#  define S_ISPORT(m) 0
+# endif
+
 # ifndef S_ISREG
 #  ifdef S_IFREG
 #   define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
@@ -161,7 +160,7 @@
 #  endif
 # endif
 
-/* contiguous */
+/* high performance ("contiguous data") */
 # ifndef S_ISCTG
 #  define S_ISCTG(p) 0
 # endif
@@ -176,6 +175,11 @@
 #  define S_ISOFL(p) 0
 # endif
 
+/* 4.4BSD whiteout */
+# ifndef S_ISWHT
+#  define S_ISWHT(m) 0
+# endif
+
 /* If any of the following are undefined,
    define them to their de facto standard values.  */
 # if !S_ISUID
Index: m4/filemode.m4
===================================================================
RCS file: /fetish/cu/m4/filemode.m4,v
retrieving revision 1.5
diff -p -u -r1.5 filemode.m4
--- m4/filemode.m4      28 Apr 2005 16:55:43 -0000      1.5
+++ m4/filemode.m4      17 Apr 2006 23:20:23 -0000
@@ -1,5 +1,5 @@
-# filemode.m4 serial 5
-dnl Copyright (C) 2002, 2005 Free Software Foundation, Inc.
+# filemode.m4 serial 6
+dnl Copyright (C) 2002, 2005, 2006 Free Software Foundation, Inc.
 dnl This file is free software; the Free Software Foundation
 dnl gives unlimited permission to copy and/or distribute it,
 dnl with or without modifications, as long as this notice is preserved.
@@ -8,4 +8,5 @@ AC_DEFUN([gl_FILEMODE],
 [
   AC_LIBSOURCES([filemode.c, filemode.h])
   AC_LIBOBJ([filemode])
+  AC_CHECK_DECLS_ONCE([strmode])
 ])
Index: src/chmod.c
===================================================================
RCS file: /fetish/cu/src/chmod.c,v
retrieving revision 1.114
diff -p -u -r1.114 chmod.c
--- src/chmod.c 17 Jan 2006 17:25:42 -0000      1.114
+++ src/chmod.c 17 Apr 2006 23:20:23 -0000
@@ -143,7 +143,7 @@ static void
 describe_change (const char *file, mode_t mode,
                 enum Change_status changed)
 {
-  char perms[11];              /* "-rwxrwxrwx" ls-style modes. */
+  char perms[12];              /* "-rwxrwxrwx" ls-style modes. */
   const char *fmt;
 
   if (changed == CH_NOT_APPLIED)
@@ -153,8 +153,8 @@ describe_change (const char *file, mode_
       return;
     }
 
-  mode_string (mode, perms);
-  perms[10] = '\0';            /* `mode_string' does not null terminate. */
+  strmode (mode, perms);
+  perms[10] = '\0';            /* Remove trailing space.  */
   switch (changed)
     {
     case CH_SUCCEEDED:
@@ -259,10 +259,10 @@ process_file (FTS *fts, FTSENT *ent)
       mode_t naively_expected_mode = mode_adjust (old_mode, change, 0);
       if (new_mode & ~naively_expected_mode)
        {
-         char new_perms[11];
-         char naively_expected_perms[11];
-         mode_string (new_mode, new_perms);
-         mode_string (naively_expected_mode, naively_expected_perms);
+         char new_perms[12];
+         char naively_expected_perms[12];
+         strmode (new_mode, new_perms);
+         strmode (naively_expected_mode, naively_expected_perms);
          new_perms[10] = naively_expected_perms[10] = '\0';
          error (0, 0,
                 _("%s: new permissions are %s, not %s"),
Index: src/ls.c
===================================================================
RCS file: /fetish/cu/src/ls.c,v
retrieving revision 1.408
diff -p -u -r1.408 ls.c
--- src/ls.c    26 Mar 2006 12:07:20 -0000      1.408
+++ src/ls.c    17 Apr 2006 23:20:23 -0000
@@ -152,13 +152,6 @@ int wcwidth ();
 # define st_author st_uid
 #endif
 
-/* Cray/Unicos DMF: use the file's migrated, not real, status */
-#if HAVE_ST_DM_MODE
-# define ST_DM_MODE(Stat_buf) ((Stat_buf).st_dm_mode)
-#else
-# define ST_DM_MODE(Stat_buf) ((Stat_buf).st_mode)
-#endif
-
 enum filetype
   {
     unknown DT_INIT (DT_UNKNOWN),
@@ -3270,13 +3263,13 @@ print_long_format (const struct fileinfo
   struct timespec when_timespec;
   struct tm *when_local;
 
-  /* Compute mode string.  On most systems, it's based on st_mode.
-     On systems with migration (via the stat.st_dm_mode field), use
-     the file's migrated status.  */
-  mode_string (ST_DM_MODE (f->stat), modebuf);
-
-  modebuf[10] = (FILE_HAS_ACL (f) ? '+' : ' ');
-  modebuf[10 + any_has_acl] = '\0';
+  /* Compute the mode string, except remove the trailing space if no
+     files in this directory have ACLs.  */
+  filemodestring (&f->stat, modebuf);
+  if (! any_has_acl)
+    modebuf[10] = '\0';
+  else if (FILE_HAS_ACL (f))
+    modebuf[10] = '+';
 
   switch (time_type)
     {
Index: src/stat.c
===================================================================
RCS file: /fetish/cu/src/stat.c,v
retrieving revision 1.92
diff -p -u -r1.92 stat.c
--- src/stat.c  12 Apr 2006 20:14:42 -0000      1.92
+++ src/stat.c  17 Apr 2006 23:20:23 -0000
@@ -294,8 +294,8 @@ human_fstype (STRUCT_STATVFS const *stat
 static char *
 human_access (struct stat const *statbuf)
 {
-  static char modebuf[11];
-  mode_string (statbuf->st_mode, modebuf);
+  static char modebuf[12];
+  filemodestring (statbuf, modebuf);
   modebuf[10] = 0;
   return modebuf;
 }