Some cleanup in IPC headers and documentation.

 - Cleanup of unused macros for VFS - FS protocols
 - Update servers/vfs/README to reflect the new requests names.
 - Alphabetically re-order the message union, as well as minor
   formatting, for readability.

Change-Id: Ief7c38489e93bcf5f795dccbf3a8e10b44b95af4

diff --git a/include/minix/ipc.h b/include/minix/ipc.h
index 552e2b19a82f21102a2820081ca5a6b956744062..7466332fbccfa6b15c8c675b5521e6b120ecbf85 100644 (file)
--- a/include/minix/ipc.h
+++ b/include/minix/ipc.h
@@ -564,68 +564,72 @@ typedef struct {
 _ASSERT_MSG_SIZE(mess_vmmcp_reply);
 
 typedef struct {
-  endpoint_t m_source;         /* who sent the message */
-  int m_type;                  /* what kind of message is it */
-  union {
-       mess_u8 m_u8;
-       mess_u16 m_u16;
-       mess_u32 m_u32;
-       mess_u64 m_u64;
-
-       mess_1 m_m1;
-       mess_2 m_m2;
-       mess_3 m_m3;
-       mess_4 m_m4;
-       mess_5 m_m5;
-       mess_7 m_m7;
-       mess_8 m_m8;
-       mess_9 m_m9;
-       mess_10 m_m10;
-       mess_11 m_m11;
-       mess_mmap m_mmap;
-       mess_notify m_notify;
-       mess_sigcalls m_sigcalls;
-       mess_vfs_fs_newnode m_vfs_fs_newnode;
-       mess_fs_vfs_newnode m_fs_vfs_newnode;
-       mess_vfs_fs_breadwrite m_vfs_fs_breadwrite;
-       mess_fs_vfs_breadwrite m_fs_vfs_breadwrite;
-       mess_vfs_fs_chmod m_vfs_fs_chmod;
-       mess_fs_vfs_chmod m_fs_vfs_chmod;
-       mess_vfs_fs_chown m_vfs_fs_chown;
-       mess_fs_vfs_chown m_fs_vfs_chown;
-       mess_vfs_fs_create m_vfs_fs_create;
-       mess_fs_vfs_create m_fs_vfs_create;
-       mess_vfs_fs_flush m_vfs_fs_flush;
-       mess_vfs_fs_ftrunc m_vfs_fs_ftrunc;
-       mess_vfs_fs_getdents m_vfs_fs_getdents;
-       mess_fs_vfs_getdents m_fs_vfs_getdents;
-       mess_vfs_fs_inhibread m_vfs_fs_inhibread;
-       mess_vfs_fs_link m_vfs_fs_link;
-       mess_vfs_fs_lookup m_vfs_fs_lookup;
-       mess_fs_vfs_lookup m_fs_vfs_lookup;
-       mess_vfs_fs_mkdir m_vfs_fs_mkdir;
-       mess_vfs_fs_mknod m_vfs_fs_mknod;
-       mess_vfs_fs_mountpoint m_vfs_fs_mountpoint;
-       mess_vfs_fs_new_driver m_vfs_fs_new_driver;
-       mess_vfs_fs_putnode m_vfs_fs_putnode;
-       mess_vfs_fs_rdlink m_vfs_fs_rdlink;
-       mess_fs_vfs_rdlink m_fs_vfs_rdlink;
-       mess_vfs_fs_readsuper m_vfs_fs_readsuper;
-       mess_fs_vfs_readsuper m_fs_vfs_readsuper;
-       mess_vfs_fs_rename m_vfs_fs_rename;
-       mess_vfs_fs_readwrite m_vfs_fs_readwrite;
-       mess_fs_vfs_readwrite m_fs_vfs_readwrite;
-       mess_vfs_fs_slink m_vfs_fs_slink;
-       mess_vfs_fs_stat m_vfs_fs_stat;
-       mess_vfs_fs_statvfs m_vfs_fs_statvfs;
-       mess_vfs_fs_unlink m_vfs_fs_unlink;
-       mess_vfs_fs_utime m_vfs_fs_utime;
-       mess_vfs_utimens m_vfs_utimens;
-       mess_vm_vfs_mmap m_vm_vfs_mmap;
-       mess_vmmcp m_vmmcp;
-       mess_vmmcp_reply m_vmmcp_reply;
-       u8_t size[56];          /* message payload may have 56 bytes at most */
-  };
+       endpoint_t m_source;            /* who sent the message */
+       int m_type;                     /* what kind of message is it */
+       union {
+               mess_u8                 m_u8;
+               mess_u16                m_u16;
+               mess_u32                m_u32;
+               mess_u64                m_u64;
+
+               mess_1                  m_m1;
+               mess_2                  m_m2;
+               mess_3                  m_m3;
+               mess_4                  m_m4;
+               mess_5                  m_m5;
+               mess_7                  m_m7;
+               mess_8                  m_m8;
+               mess_9                  m_m9;
+               mess_10                 m_m10;
+               mess_11                 m_m11;
+               mess_mmap               m_mmap;
+               mess_notify             m_notify;
+               mess_sigcalls           m_sigcalls;
+
+               mess_fs_vfs_breadwrite  m_fs_vfs_breadwrite;
+               mess_fs_vfs_chmod       m_fs_vfs_chmod;
+               mess_fs_vfs_chown       m_fs_vfs_chown;
+               mess_fs_vfs_create      m_fs_vfs_create;
+               mess_fs_vfs_getdents    m_fs_vfs_getdents;
+               mess_fs_vfs_lookup      m_fs_vfs_lookup;
+               mess_fs_vfs_newnode     m_fs_vfs_newnode;
+               mess_fs_vfs_rdlink      m_fs_vfs_rdlink;
+               mess_fs_vfs_readsuper   m_fs_vfs_readsuper;
+               mess_fs_vfs_readwrite   m_fs_vfs_readwrite;
+
+               mess_vfs_fs_breadwrite  m_vfs_fs_breadwrite;
+               mess_vfs_fs_chmod       m_vfs_fs_chmod;
+               mess_vfs_fs_chown       m_vfs_fs_chown;
+               mess_vfs_fs_create      m_vfs_fs_create;
+               mess_vfs_fs_flush       m_vfs_fs_flush;
+               mess_vfs_fs_ftrunc      m_vfs_fs_ftrunc;
+               mess_vfs_fs_getdents    m_vfs_fs_getdents;
+               mess_vfs_fs_inhibread   m_vfs_fs_inhibread;
+               mess_vfs_fs_link        m_vfs_fs_link;
+               mess_vfs_fs_lookup      m_vfs_fs_lookup;
+               mess_vfs_fs_mkdir       m_vfs_fs_mkdir;
+               mess_vfs_fs_mknod       m_vfs_fs_mknod;
+               mess_vfs_fs_mountpoint  m_vfs_fs_mountpoint;
+               mess_vfs_fs_newnode     m_vfs_fs_newnode;
+               mess_vfs_fs_new_driver  m_vfs_fs_new_driver;
+               mess_vfs_fs_putnode     m_vfs_fs_putnode;
+               mess_vfs_fs_rdlink      m_vfs_fs_rdlink;
+               mess_vfs_fs_readsuper   m_vfs_fs_readsuper;
+               mess_vfs_fs_rename      m_vfs_fs_rename;
+               mess_vfs_fs_readwrite   m_vfs_fs_readwrite;
+               mess_vfs_fs_slink       m_vfs_fs_slink;
+               mess_vfs_fs_stat        m_vfs_fs_stat;
+               mess_vfs_fs_statvfs     m_vfs_fs_statvfs;
+               mess_vfs_fs_unlink      m_vfs_fs_unlink;
+               mess_vfs_fs_utime       m_vfs_fs_utime;
+
+               mess_vfs_utimens        m_vfs_utimens;
+               mess_vm_vfs_mmap        m_vm_vfs_mmap;
+               mess_vmmcp              m_vmmcp;
+               mess_vmmcp_reply        m_vmmcp_reply;
+
+               u8_t size[56];  /* message payload may have 56 bytes at most */
+       };
 } message __aligned(16);
 
 /* Ensure the complete union respects the IPC assumptions. */

diff --git a/include/minix/vfsif.h b/include/minix/vfsif.h
index 8b0c5acec1fbac4e6bebf13f98dcd28c0b47d79d..1a308b2b832d8facf1a07363c14fc152bb8153a1 100644 (file)
--- a/include/minix/vfsif.h
+++ b/include/minix/vfsif.h
@@ -4,51 +4,6 @@
 #include <sys/types.h>
 #include <limits.h>
 
-/* VFS/FS request fields */
-#define REQ_ACTIME             m9_l2
-#define REQ_ACNSEC             m9_l4
-#define REQ_COUNT              m9_l2
-#define REQ_DEV                        m9_ull1
-#define REQ_DIR_INO            m9_l3
-#define REQ_FLAGS              m9_s3
-#define REQ_GID                        m9_s1
-#define REQ_GRANT              m9_l2
-#define REQ_GRANT2             m9_l1 
-#define REQ_GRANT3             m9_l3
-#define REQ_INODE_NR           m9_l1
-#define REQ_MEM_SIZE           m9_l5
-#define REQ_MODE               m9_s3
-#define REQ_MODTIME            m9_l3
-#define REQ_MODNSEC            m9_l5
-#define REQ_NBYTES             m9_l5
-#define REQ_PATH_LEN           m9_s2
-#define REQ_PATH_SIZE          m9_l5
-#define REQ_REN_GRANT_NEW      m9_l1
-#define REQ_REN_GRANT_OLD      m9_l2
-#define REQ_REN_LEN_NEW                m9_s2
-#define REQ_REN_LEN_OLD                m9_s1
-#define REQ_REN_NEW_DIR                m9_l4
-#define REQ_REN_OLD_DIR                m9_l3
-#define REQ_ROOT_INO           m9_l4
-#define REQ_SEEK_POS           m9_ull2
-#define REQ_TRC_START          m9_ull1
-#define REQ_TRC_END            m9_ull2
-#define REQ_UCRED_SIZE         m9_s4 
-#define REQ_UID                        m9_s4
-
-/* VFS/FS reply fields */
-#define RES_DEV                        m9_ull1
-#define RES_GID                        m9_s1
-#define RES_INODE_NR           m9_l1
-#define RES_FILE_SIZE          m9_ull2
-#define RES_MODE               m9_s2
-#define RES_NBYTES             m9_l5
-#define RES_OFFSET             m9_s2
-#define RES_SEEK_POS           m9_ull2
-#define RES_SYMLOOP            m9_s3
-#define RES_UID                        m9_s4
-#define        RES_FLAGS               m9_s3
-
 /* VFS/FS flags */
 #define REQ_RDONLY             001     /* FS is mounted read-only */
 #define REQ_ISROOT             002     /* FS is root file system */

diff --git a/servers/vfs/README b/servers/vfs/README
index e6ee5f6e7755d81b40425aed2d0952935e4cdd78..5f28b3c0a8a4753f481107a026cccfc9a8c3a07d 100644 (file)
--- a/servers/vfs/README
+++ b/servers/vfs/README
@@ -571,7 +571,7 @@ For File Servers that support concurrent requests, it's useful to know which
 locking guarantees VFS provides for vmnts and vnodes, so it can take that
 into account when protecting internal data structures. READ = TLL_READ,
 READSER = TLL_READSER, WRITE = TLL_WRITE. The vnode locks applies to the
-REQ_INODE_NR field in requests, unless the notes say otherwise.
+'''inode''' field in requests, unless the notes say otherwise.
 {{{
 ------------------------------------------------------------------------------
 | request      | vmnt    | vnode   | notes                                   |
@@ -602,8 +602,8 @@ REQ_INODE_NR field in requests, unless the notes say otherwise.
 +--------------+---------+---------+-----------------------------------------+
 | REQ_INHIBREAD|         | READ    |                                         |
 +--------------+---------+---------+-----------------------------------------+
-| REQ_LINK     | READSER | WRITE   | REQ_INODE_NR is locked READ             |
-|              |         |         | REQ_DIR_INO is locked WRITE             |
+| REQ_LINK     | READSER | WRITE   | vfs_fs_link.inode is locked READ        |
+|              |         |         | vfs_fs_link.dir_ino is locked WRITE     |
 +--------------+---------+---------+-----------------------------------------+
 | REQ_LOOKUP   | READSER |         |                                         |
 +--------------+---------+---------+-----------------------------------------+