Changeset 4617

Timestamp:

10/06/05 09:43:04 (8 years ago)

Author:

robl

Message:

[pcarns]: add protocol versioning to PVFS2. Major version changes are
incompatible up or down. New clients can't talk to old servers, but new
servers can talk to old clients.

Location:

trunk

Files:

• ChangeLog (modified) (2 diffs)
• doc/add-server-req (modified) (1 diff)
• include/pvfs2-mgmt.h (modified) (1 diff)
• include/pvfs2-types.h (modified) (1 diff)
• src/proto/PINT-reqproto-encode.c (modified) (3 diffs)
• src/proto/PINT-reqproto-module.h (modified) (1 diff)
• src/proto/endecode-funcs.h (modified) (1 diff)
• src/proto/pvfs2-attr.h (modified) (1 diff)
• src/proto/pvfs2-req-proto.h (modified) (2 diffs)

trunk/ChangeLog

@@ -3 +3 @@
 -----------------------
 
-pvfs2-1.2.1-pre1
+pvfs2-1.3.0-pre1
 ===============
 - Murali Vilayannur contributed extened attribute support to the VFS interface
@@ -11 +11 @@
 - Phil also contributed improvements to the request processor which should
   help speed up some concurrent workloads.
+- Phil further contributed protocol versioning to PVFS2.  Major version
+  changes are incompatible up or down.  New clients can't talk to old servers,
+  but new servers can talk to old clients. 
 
 pvfs2-1.2.0

trunk/doc/add-server-req

@@ -15 +15 @@
                         add a stub in include/pvfs2-encode-stubs.h
 
+2b) update the protocol version number
+                src/proto/pvfs2-req-proto.h
+                        increment PVFS2_PROTO_MINOR, assuming that the
+                        addition of this new request does not break backwards
+                        compatibility for other request types
+       
 3) add entries to decode/encode functions
                 src/proto/PINT-le-bytefield.c

trunk/include/pvfs2-mgmt.h

@@ -3 +3 @@
  *
  * See COPYING in top-level directory.
+ */
+/* NOTE: if you make any changes to the encoding definitions in this file,
+ * please update the PVFS2_PROTO_VERSION in pvfs2-req-proto.h accordingly
  */
 

trunk/include/pvfs2-types.h

@@ -3 +3 @@
  *
  * See COPYING in top-level directory.
+ */
+/* NOTE: if you make any changes to the encoding definitions in this file, 
+ * please update the PVFS2_PROTO_VERSION in pvfs2-req-proto.h accordingly
  */
 

trunk/src/proto/PINT-reqproto-encode.c

@@ -63 +63 @@
         /* header prepended to all messages of this type */
         *((int32_t*)&(le_bytefield_table.generic_header[0])) = 
-            htobmi32(PVFS_RELEASE_NR);
+            htobmi32(PVFS2_PROTO_VERSION);
         *((int32_t*)&(le_bytefield_table.generic_header[4])) = 
             htobmi32(ENCODING_LE_BFIELD);
 
+        le_bytefield_table.enc_type = ENCODING_LE_BFIELD;
         ret = 0;
     }
@@ -166 +167 @@
     int ret;
     int32_t enc_type_recved, proto_ver_recved;
+    int proto_major_recved, proto_minor_recved;
 
     gossip_debug(GOSSIP_ENDECODE_DEBUG,"PINT_decode\n");
-    /* compare the header of the incoming buffer against the precalculated
-     * header associated with each module
-     */
+
+    /* sanity check size */
+    if(size < PINT_ENC_GENERIC_HEADER_SIZE)
+    {
+        gossip_err("Error: poorly formatted protocol message received.\n");
+        gossip_err("   Too small: message only %Ld bytes.\n",
+            Ld(size));
+        return(-PVFS_EPROTO);
+    }
+    
+    /* pull the encoding type and protocol version out */
+    proto_ver_recved = (int)bmitoh32(*((int32_t*)input_buffer));
+    enc_type_recved = bmitoh32(*((int32_t*)enc_type_ptr));
+    proto_major_recved = proto_ver_recved / 1000;
+    proto_minor_recved = proto_ver_recved - (proto_major_recved*1000);
+
+    /* check encoding type */
+    if(enc_type_recved != ENCODING_LE_BFIELD)
+    {
+        gossip_err("Error: poorly formatted protocol message received.\n");
+        gossip_err("   Encoding type mismatch: received type %d when "
+            "expecting %d.\n", (int)enc_type_recved, 
+            ENCODING_LE_BFIELD);
+        return(-PVFS_EPROTONOSUPPORT);
+    }
+
+    /* check various protocol version possibilities */
+    if(proto_major_recved != PVFS2_PROTO_MAJOR)
+    {
+        gossip_err("Error: poorly formatted protocol message received.\n");
+        gossip_err("   Protocol version mismatch: received major version %d when "
+            "expecting %d.\n", (int)proto_major_recved,
+            PVFS2_PROTO_MAJOR);
+        gossip_err("   Please verify your PVFS2 installation and make sure "
+        "that the version is\n   consistent.\n");
+        return(-PVFS_EPROTONOSUPPORT);
+    }
+
+    if((input_type == PINT_DECODE_REQ) && 
+        (proto_minor_recved > PVFS2_PROTO_MINOR))
+    {
+        gossip_err("Error: poorly formatted protocol message received.\n");
+        gossip_err("   Protocol version mismatch: request has minor version %d when "
+            "expecting %d or lower.\n", (int)proto_minor_recved,
+            PVFS2_PROTO_MINOR);
+        gossip_err("   Client is too new for server.\n");
+        gossip_err("   Please verify your PVFS2 installation and make sure "
+        "that the version is\n   consistent.\n");
+        return(-PVFS_EPROTONOSUPPORT);
+    }
+
+    if((input_type == PINT_DECODE_RESP) && 
+        (proto_minor_recved < PVFS2_PROTO_MINOR))
+    {
+        gossip_err("Error: poorly formatted protocol message received.\n");
+        gossip_err("   Protocol version mismatch: request has minor version %d when "
+            "expecting %d or higher.\n", (int)proto_minor_recved,
+            PVFS2_PROTO_MINOR);
+        gossip_err("   Server is too old for client.\n");
+        gossip_err("   Please verify your PVFS2 installation and make sure "
+        "that the version is\n   consistent.\n");
+        return(-PVFS_EPROTONOSUPPORT);
+    }
+
     for(i=0; i<ENCODING_TABLE_SIZE; i++)
     {
-        if(PINT_encoding_table[i] && !(memcmp(input_buffer, 
-            PINT_encoding_table[i]->generic_header, 
-            PINT_ENC_GENERIC_HEADER_SIZE)))
-        {
+        if(PINT_encoding_table[i] && (PINT_encoding_table[i]->enc_type
+            == enc_type_recved))
+        {
             struct PVFS_server_req* tmp_req;
             struct PVFS_server_req* tmp_resp;
-            target_msg->enc_type = bmitoh32(*((int32_t*)enc_type_ptr));
+            target_msg->enc_type = enc_type_recved;
             if(input_type == PINT_DECODE_REQ)
             {
@@ -215 +277 @@
     gossip_err("Error: poorly formatted protocol message received.\n");
 
-    enc_type_recved = bmitoh32(*((int32_t*)enc_type_ptr));
-    proto_ver_recved = (int)bmitoh32(*((int32_t*)input_buffer));
-
-    if(size < PINT_ENC_GENERIC_HEADER_SIZE)
-    {
-        gossip_err("   Too small: message only %Ld bytes.\n",
-            Ld(size));
-        return(-PVFS_EPROTO);
-    }
-
-    if(enc_type_recved != ENCODING_LE_BFIELD)
-    {
-        gossip_err("   Encoding type mismatch: received type %d when "
-            "expecting %d.\n", (int)enc_type_recved, 
-            ENCODING_LE_BFIELD);
-    }
-
-    if(proto_ver_recved != PVFS_RELEASE_NR)
-    {
-        gossip_err("   Protocol version mismatch: received version %d when "
-            "expecting version %d.\n", (int)proto_ver_recved,
-            PVFS_RELEASE_NR);
-        gossip_err("   Please verify your PVFS2 installation and make sure "
-        "that the version is consistent.\n");
-    }
-
     return(-PVFS_EPROTONOSUPPORT);
 }

trunk/src/proto/PINT-reqproto-module.h

@@ -51 +51 @@
     void (*init_fun) (void);
     char generic_header[PINT_ENC_GENERIC_HEADER_SIZE];
+    int enc_type;
 } PINT_encoding_table_values;
 

trunk/src/proto/endecode-funcs.h

@@ -6 +6 @@
  * Defines for macros related to wire encoding and decoding.  Only included
  * by include/pvfs2-encode-stubs.h by core encoding users.
+ */
+/* NOTE: if you make any changes to the code contained in this file, please
+ * update the PVFS2_PROTO_VERSION in pvfs2-req-proto.h accordingly
  */
 #ifndef __SRC_PROTO_ENDECODE_FUNCS_H

trunk/src/proto/pvfs2-attr.h

@@ -3 +3 @@
  *
  * See COPYING in top-level directory.
+ */
+/* NOTE: if you make any changes to the code contained in this file, please
+ * update the PVFS2_PROTO_VERSION in pvfs2-req-proto.h accordingly
  */
 

trunk/src/proto/pvfs2-req-proto.h

@@ -3 +3 @@
  *
  * See COPYING in top-level directory.
+ */
+/* NOTE: if you make any changes to the code contained in this file, please
+ * update the PVFS2_PROTO_VERSION accordingly
  */
 
@@ -15 +18 @@
 #include "pvfs2-mgmt.h"
 
-/* release number: This is a base-10, 5 digit number, with one digit
- * for the most significant version number and two for the last two
- * (e.g. 1.5.6 => 10506)
+/* update PVFS2_PROTO_MAJOR on wire protocol changes that break backwards
+ * compatibility (such as changing the semantics or protocol fields for an
+ * existing request type)
  */
-#define PVFS_RELEASE_NR ((PVFS2_VERSION_MAJOR * 10000) + \
-  (PVFS2_VERSION_MINOR * 100) + PVFS2_VERSION_SUB)
+#define PVFS2_PROTO_MAJOR 1
+/* update PVFS2_PROTO_MINOR on wire protocol changes that preserve backwards
+ * compatibility (such as adding a new request type)
+ */
+#define PVFS2_PROTO_MINOR 1
+#define PVFS2_PROTO_VERSION ((PVFS2_PROTO_MAJOR*1000)+(PVFS2_PROTO_MINOR))
 
 enum PVFS_server_op