tipc: tipc: rename address types in user api

The three address type structs in the user API have names that in
reality reflect the specific, non-Linux environment where they were
originally created.

We now give them more intuitive names, in accordance with how TIPC is
described in the current documentation.

struct tipc_portid   -> struct tipc_socket_addr
struct tipc_name     -> struct tipc_service_addr
struct tipc_name_seq -> struct tipc_service_range

To avoid confusion, we also update some commmets and macro names to
 match the new terminology.

For compatibility, we add macros that map all old names to the new ones.

Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

1 files changed, 33 insertions, 24 deletions

diff --git a/include/uapi/linux/tipc.h b/include/uapi/linux/tipc.h
index 4ac9f1f02b06..156224ac3d74 100644
--- a/include/uapi/linux/tipc.h
+++ b/include/uapi/linux/tipc.h
@@ -45,33 +45,33 @@
  * TIPC addressing primitives
  */
 
-struct tipc_portid {
+struct tipc_socket_addr {
         __u32 ref;
         __u32 node;
 };
 
-struct tipc_name {
+struct tipc_service_addr {
         __u32 type;
         __u32 instance;
 };
 
-struct tipc_name_seq {
+struct tipc_service_range {
         __u32 type;
         __u32 lower;
         __u32 upper;
 };
 
 /*
- * Application-accessible port name types
+ * Application-accessible service types
  */
 
-#define TIPC_CFG_SRV            0       /* configuration service name type */
-#define TIPC_TOP_SRV            1       /* topology service name type */
-#define TIPC_LINK_STATE         2       /* link state name type */
-#define TIPC_RESERVED_TYPES     64      /* lowest user-publishable name type */
+#define TIPC_NODE_STATE         0       /* node state service type */
+#define TIPC_TOP_SRV            1       /* topology server service type */
+#define TIPC_LINK_STATE         2       /* link state service type */
+#define TIPC_RESERVED_TYPES     64      /* lowest user-allowed service type */
 
 /*
- * Publication scopes when binding port names and port name sequences
+ * Publication scopes when binding service / service range
  */
 enum tipc_scope {
         TIPC_CLUSTER_SCOPE = 2, /* 0 can also be used */
@@ -108,28 +108,28 @@ enum tipc_scope {
  * TIPC topology subscription service definitions
  */
 
-#define TIPC_SUB_PORTS          0x01    /* filter for port availability */
-#define TIPC_SUB_SERVICE        0x02    /* filter for service availability */
-#define TIPC_SUB_CANCEL         0x04    /* cancel a subscription */
+#define TIPC_SUB_PORTS          0x01    /* filter: evt at each match */
+#define TIPC_SUB_SERVICE        0x02    /* filter: evt at first up/last down */
+#define TIPC_SUB_CANCEL         0x04    /* filter: cancel a subscription */
 
 #define TIPC_WAIT_FOREVER       (~0)    /* timeout for permanent subscription */
 
 struct tipc_subscr {
-        struct tipc_name_seq seq;       /* name sequence of interest */
+        struct tipc_service_range seq;  /* range of interest */
         __u32 timeout;                  /* subscription duration (in ms) */
         __u32 filter;                   /* bitmask of filter options */
         char usr_handle[8];             /* available for subscriber use */
 };
 
 #define TIPC_PUBLISHED          1       /* publication event */
-#define TIPC_WITHDRAWN          2       /* withdraw event */
+#define TIPC_WITHDRAWN          2       /* withdrawal event */
 #define TIPC_SUBSCR_TIMEOUT     3       /* subscription timeout event */
 
 struct tipc_event {
         __u32 event;                    /* event type */
-        __u32 found_lower;              /* matching name seq instances */
-        __u32 found_upper;              /*    "      "    "     "      */
-        struct tipc_portid port;        /* associated port */
+        __u32 found_lower;              /* matching range */
+        __u32 found_upper;              /*    "      "    */
+        struct tipc_socket_addr port;   /* associated socket */
         struct tipc_subscr s;           /* associated subscription */
 };
 
@@ -149,20 +149,20 @@ struct tipc_event {
 #define SOL_TIPC        271
 #endif
 
-#define TIPC_ADDR_NAMESEQ       1
-#define TIPC_ADDR_MCAST         1
-#define TIPC_ADDR_NAME          2
-#define TIPC_ADDR_ID            3
+#define TIPC_ADDR_MCAST         1
+#define TIPC_SERVICE_RANGE      1
+#define TIPC_SERVICE_ADDR       2
+#define TIPC_SOCKET_ADDR        3
 
 struct sockaddr_tipc {
         unsigned short family;
         unsigned char  addrtype;
         signed   char  scope;
         union {
-                struct tipc_portid id;
-                struct tipc_name_seq nameseq;
+                struct tipc_socket_addr id;
+                struct tipc_service_range nameseq;
                 struct {
-                        struct tipc_name name;
+                        struct tipc_service_addr name;
                         __u32 domain;
                 } name;
         } addr;
@@ -230,8 +230,13 @@ struct tipc_sioc_ln_req {
 /* The macros and functions below are deprecated:
  */
 
+#define TIPC_CFG_SRV            0
 #define TIPC_ZONE_SCOPE         1
 
+#define TIPC_ADDR_NAMESEQ       1
+#define TIPC_ADDR_NAME          2
+#define TIPC_ADDR_ID            3
+
 #define TIPC_NODE_BITS          12
 #define TIPC_CLUSTER_BITS       12
 #define TIPC_ZONE_BITS          8
@@ -250,6 +255,10 @@ struct tipc_sioc_ln_req {
 
 #define TIPC_ZONE_CLUSTER_MASK (TIPC_ZONE_MASK | TIPC_CLUSTER_MASK)
 
+#define tipc_portid tipc_socket_addr
+#define tipc_name tipc_service_addr
+#define tipc_name_seq tipc_service_range
+
 static inline __u32 tipc_addr(unsigned int zone,
                               unsigned int cluster,
                               unsigned int node)