Some checksum improvements
[rsync.git] / checksum.c
index cd234038521b052fda015c955f8178a5ee43a050..99c29d989d2200e7d132153f66b9ef000316dbfe 100644 (file)
 
 #include "rsync.h"
 
+extern int am_server;
+extern int local_server;
+extern int whole_file;
+extern int read_batch;
 extern int checksum_seed;
 extern int protocol_version;
 extern int proper_seed_order;
@@ -33,27 +37,32 @@ extern char *checksum_choice;
 #define CSUM_MD4 4
 #define CSUM_MD5 5
 
+#define CSUM_SAW_BUFLEN 10
+
+struct csum_struct {
+       int num;
+       const char *name;
+} valid_checksums[] = {
+       { CSUM_MD5, "md5" },
+       { CSUM_MD4, "md4" },
+       { CSUM_NONE, "none" },
+       { -1, NULL }
+};
+
+#define MAX_CHECKSUM_LIST 1024
+
 int xfersum_type = 0; /* used for the file transfer checksums */
 int checksum_type = 0; /* used for the pre-transfer (--checksum) checksums */
+const char *negotiated_csum_name = NULL;
 
-/* Returns 1 if --whole-file must be enabled. */
-int parse_checksum_choice(void)
+static int parse_csum_name(const char *name, int len, int allow_auto)
 {
-       char *cp = checksum_choice ? strchr(checksum_choice, ',') : NULL;
-       if (cp) {
-               xfersum_type = parse_csum_name(checksum_choice, cp - checksum_choice);
-               checksum_type = parse_csum_name(cp+1, -1);
-       } else
-               xfersum_type = checksum_type = parse_csum_name(checksum_choice, -1);
-       return xfersum_type == CSUM_NONE;
-}
+       struct csum_struct *cs;
 
-int parse_csum_name(const char *name, int len)
-{
        if (len < 0 && name)
                len = strlen(name);
 
-       if (!name || (len == 4 && strncasecmp(name, "auto", 4) == 0)) {
+       if (!name || (allow_auto && len == 4 && strncasecmp(name, "auto", 4) == 0)) {
                if (protocol_version >= 30)
                        return CSUM_MD5;
                if (protocol_version >= 27)
@@ -62,14 +71,164 @@ int parse_csum_name(const char *name, int len)
                        return CSUM_MD4_BUSTED;
                return CSUM_MD4_ARCHAIC;
        }
-       if (len == 3 && strncasecmp(name, "md4", 3) == 0)
-               return CSUM_MD4;
-       if (len == 3 && strncasecmp(name, "md5", 3) == 0)
-               return CSUM_MD5;
-       if (len == 4 && strncasecmp(name, "none", 4) == 0)
-               return CSUM_NONE;
-
-       rprintf(FERROR, "unknown checksum name: %s\n", name);
+
+       for (cs = valid_checksums; cs->name; cs++) {
+               if (strncasecmp(name, cs->name, len) == 0 && cs->name[len] == '\0')
+                       return cs->num;
+       }
+
+       if (allow_auto) {
+               rprintf(FERROR, "unknown checksum name: %s\n", name);
+               exit_cleanup(RERR_UNSUPPORTED);
+       }
+
+       return -1;
+}
+
+static const char *checksum_name(int num)
+{
+       struct csum_struct *cs;
+
+       for (cs = valid_checksums; cs->name; cs++) {
+               if (num == cs->num)
+                       return cs->name;
+       }
+
+       if (num < CSUM_MD4)
+               return "MD4";
+
+       return "UNKNOWN";
+}
+
+void parse_checksum_choice(int final_call)
+{
+       if (!negotiated_csum_name) {
+               char *cp = checksum_choice ? strchr(checksum_choice, ',') : NULL;
+               if (cp) {
+                       xfersum_type = parse_csum_name(checksum_choice, cp - checksum_choice, 1);
+                       checksum_type = parse_csum_name(cp+1, -1, 1);
+               } else
+                       xfersum_type = checksum_type = parse_csum_name(checksum_choice, -1, 1);
+       }
+
+       if (xfersum_type == CSUM_NONE)
+               whole_file = 1;
+
+       if (final_call && DEBUG_GTE(CSUM, 1)) {
+               if (negotiated_csum_name)
+                       rprintf(FINFO, "[%s] negotiated checksum: %s\n", who_am_i(), negotiated_csum_name);
+               else if (xfersum_type == checksum_type) {
+                       rprintf(FINFO, "[%s] %s checksum: %s\n", who_am_i(),
+                               checksum_choice ? "chosen" : "protocol-based",
+                               checksum_name(xfersum_type));
+               } else {
+                       rprintf(FINFO, "[%s] chosen transfer checksum: %s\n",
+                               who_am_i(), checksum_name(xfersum_type));
+                       rprintf(FINFO, "[%s] chosen pre-transfer checksum: %s\n",
+                               who_am_i(), checksum_name(checksum_type));
+               }
+       }
+}
+
+static int parse_checksum_list(const char *from, char *sumbuf, int sumbuf_len, char *saw)
+{
+       char *to = sumbuf, *tok = NULL;
+       int cnt = 0;
+
+       memset(saw, 0, CSUM_SAW_BUFLEN);
+
+       while (1) {
+               if (*from == ' ' || !*from) {
+                       if (tok) {
+                               int sum_type = parse_csum_name(tok, to - tok, 0);
+                               if (sum_type >= 0 && !saw[sum_type])
+                                       saw[sum_type] = ++cnt;
+                               else
+                                       to = tok - (tok != sumbuf);
+                               tok = NULL;
+                       }
+                       if (!*from++)
+                               break;
+                       continue;
+               }
+               if (!tok) {
+                       if (to != sumbuf)
+                               *to++ = ' ';
+                       tok = to;
+               }
+               if (to - sumbuf >= sumbuf_len - 1) {
+                       to = tok - (tok != sumbuf);
+                       break;
+               }
+               *to++ = *from++;
+       }
+       *to = '\0';
+
+       return to - sumbuf;
+}
+
+void negotiate_checksum(int f_in, int f_out, const char *csum_list, int saw_fail)
+{
+       char *tok, sumbuf[MAX_CHECKSUM_LIST], saw[CSUM_SAW_BUFLEN];
+       int sum_type, len;
+
+       /* Simplify the user-provided string so that it contains valid
+        * checksum names without any duplicates. The client side also
+        * makes use of the saw values when scanning the server's list. */
+       if (csum_list && *csum_list && (!am_server || local_server)) {
+               len = parse_checksum_list(csum_list, sumbuf, sizeof sumbuf, saw);
+               if (saw_fail && !len)
+                       len = strlcpy(sumbuf, "FAIL", sizeof sumbuf);
+               csum_list = sumbuf;
+       } else
+               csum_list = NULL;
+
+       if (!csum_list || !*csum_list) {
+               struct csum_struct *cs;
+               for (tok = sumbuf, cs = valid_checksums, len = 0; cs->name; cs++) {
+                       if (cs->num == CSUM_NONE)
+                               continue;
+                       if (tok != sumbuf)
+                               *tok++ = ' ';
+                       tok += strlcpy(tok, cs->name, sizeof sumbuf - (tok - sumbuf));
+                       saw[cs->num] = ++len;
+               }
+               *tok = '\0';
+               len = tok - sumbuf;
+       }
+
+       /* Each side sends their list of valid checksum names to the other side and
+        * then both sides pick the first name in the client's list that is also in
+        * the server's list. */
+       if (!local_server)
+               write_vstring(f_out, sumbuf, len);
+
+       if (!local_server || read_batch)
+               len = read_vstring(f_in, sumbuf, sizeof sumbuf);
+
+       if (len > 0) {
+               int best = CSUM_SAW_BUFLEN; /* We want best == 1 from the client list */
+               if (am_server)
+                       memset(saw, 1, CSUM_SAW_BUFLEN); /* The first client's choice is the best choice */
+               for (tok = strtok(sumbuf, " \t"); tok; tok = strtok(NULL, " \t")) {
+                       sum_type = parse_csum_name(tok, -1, 0);
+                       if (sum_type < 0 || !saw[sum_type] || best < saw[sum_type])
+                               continue;
+                       xfersum_type = checksum_type = sum_type;
+                       negotiated_csum_name = tok;
+                       best = saw[sum_type];
+                       if (best == 1)
+                               break;
+               }
+               if (negotiated_csum_name) {
+                       negotiated_csum_name = strdup(negotiated_csum_name);
+                       return;
+               }
+       }
+
+       if (!am_server)
+               msleep(20);
+       rprintf(FERROR, "Failed to negotiate a common checksum\n");
        exit_cleanup(RERR_UNSUPPORTED);
 }
 
@@ -99,6 +258,7 @@ int canonical_checksum(int csum_type)
        return csum_type >= CSUM_MD4 ? 1 : 0;
 }
 
+#ifndef HAVE_SIMD /* See simd-checksum-*.cpp. */
 /*
   a simple 32 bit checksum that can be updated from either end
   (inspired by Mark Adler's Adler-32 checksum)
@@ -119,6 +279,7 @@ uint32 get_checksum1(char *buf1, int32 len)
        }
        return (s1 & 0xffff) + (s2 << 16);
 }
+#endif
 
 void get_checksum2(char *buf, int32 len, char *sum)
 {
@@ -258,7 +419,7 @@ void sum_init(int csum_type, int seed)
        char s[4];
 
        if (csum_type < 0)
-               csum_type = parse_csum_name(NULL, 0);
+               csum_type = parse_csum_name(NULL, 0, 1);
        cursum_type = csum_type;
 
        switch (csum_type) {