Add client error codes to distinguish between network timeout and loss

Summary:
Previously, mysql clients returned CR_SERVER_LOST on any network exception,
including timeout.

This adds two new client error codes `CR_NET_READ_INTERRUPTED` and
`CR_NET_WRITE_INTERRUPTED` which is returned on network timeout.
`CR_SERVER_LOST` is still returned for everything else.

Reference patches:
e3052e1
e5b99cd

Differential Revision: D6325225

Author: lth

include/errmsg.h

@@ -132,13 +132,152 @@ extern const char *client_errors[]; /* Error messages */
 #define CR_MANDATORY_TRACKER_NOT_FOUND 2071
 #define CR_INVALID_FACTOR_NO 2072
 #define CR_CANT_GET_SESSION_DATA 2073
-#define CR_ERROR_LAST /*Copy last error nr:*/ 2073
+#define CR_PLACEHOLDER_2074 2074
+#define CR_PLACEHOLDER_2075 2075
+#define CR_PLACEHOLDER_2076 2076
+#define CR_PLACEHOLDER_2077 2077
+#define CR_PLACEHOLDER_2078 2078
+#define CR_PLACEHOLDER_2079 2079
+#define CR_PLACEHOLDER_2080 2080
+#define CR_PLACEHOLDER_2081 2081
+#define CR_PLACEHOLDER_2082 2082
+#define CR_PLACEHOLDER_2083 2083
+#define CR_PLACEHOLDER_2084 2084
+#define CR_PLACEHOLDER_2085 2085
+#define CR_PLACEHOLDER_2086 2086
+#define CR_PLACEHOLDER_2087 2087
+#define CR_PLACEHOLDER_2088 2088
+#define CR_PLACEHOLDER_2089 2089
+#define CR_PLACEHOLDER_2090 2090
+#define CR_PLACEHOLDER_2091 2091
+#define CR_PLACEHOLDER_2092 2092
+#define CR_PLACEHOLDER_2093 2093
+#define CR_PLACEHOLDER_2094 2094
+#define CR_PLACEHOLDER_2095 2095
+#define CR_PLACEHOLDER_2096 2096
+#define CR_PLACEHOLDER_2097 2097
+#define CR_PLACEHOLDER_2098 2098
+#define CR_PLACEHOLDER_2099 2099
+#define CR_PLACEHOLDER_2100 2100
+#define CR_PLACEHOLDER_2101 2101
+#define CR_PLACEHOLDER_2102 2102
+#define CR_PLACEHOLDER_2103 2103
+#define CR_PLACEHOLDER_2104 2104
+#define CR_PLACEHOLDER_2105 2105
+#define CR_PLACEHOLDER_2106 2106
+#define CR_PLACEHOLDER_2107 2107
+#define CR_PLACEHOLDER_2108 2108
+#define CR_PLACEHOLDER_2109 2109
+#define CR_PLACEHOLDER_2110 2110
+#define CR_PLACEHOLDER_2111 2111
+#define CR_PLACEHOLDER_2112 2112
+#define CR_PLACEHOLDER_2113 2113
+#define CR_PLACEHOLDER_2114 2114
+#define CR_PLACEHOLDER_2115 2115
+#define CR_PLACEHOLDER_2116 2116
+#define CR_PLACEHOLDER_2117 2117
+#define CR_PLACEHOLDER_2118 2118
+#define CR_PLACEHOLDER_2119 2119
+#define CR_PLACEHOLDER_2120 2120
+#define CR_PLACEHOLDER_2121 2121
+#define CR_PLACEHOLDER_2122 2122
+#define CR_PLACEHOLDER_2123 2123
+#define CR_PLACEHOLDER_2124 2124
+#define CR_PLACEHOLDER_2125 2125
+#define CR_PLACEHOLDER_2126 2126
+#define CR_PLACEHOLDER_2127 2127
+#define CR_PLACEHOLDER_2128 2128
+#define CR_PLACEHOLDER_2129 2129
+#define CR_PLACEHOLDER_2130 2130
+#define CR_PLACEHOLDER_2131 2131
+#define CR_PLACEHOLDER_2132 2132
+#define CR_PLACEHOLDER_2133 2133
+#define CR_PLACEHOLDER_2134 2134
+#define CR_PLACEHOLDER_2135 2135
+#define CR_PLACEHOLDER_2136 2136
+#define CR_PLACEHOLDER_2137 2137
+#define CR_PLACEHOLDER_2138 2138
+#define CR_PLACEHOLDER_2139 2139
+#define CR_PLACEHOLDER_2140 2140
+#define CR_PLACEHOLDER_2141 2141
+#define CR_PLACEHOLDER_2142 2142
+#define CR_PLACEHOLDER_2143 2143
+#define CR_PLACEHOLDER_2144 2144
+#define CR_PLACEHOLDER_2145 2145
+#define CR_PLACEHOLDER_2146 2146
+#define CR_PLACEHOLDER_2147 2147
+#define CR_PLACEHOLDER_2148 2148
+#define CR_PLACEHOLDER_2149 2149
+#define CR_PLACEHOLDER_2150 2150
+#define CR_PLACEHOLDER_2151 2151
+#define CR_PLACEHOLDER_2152 2152
+#define CR_PLACEHOLDER_2153 2153
+#define CR_PLACEHOLDER_2154 2154
+#define CR_PLACEHOLDER_2155 2155
+#define CR_PLACEHOLDER_2156 2156
+#define CR_PLACEHOLDER_2157 2157
+#define CR_PLACEHOLDER_2158 2158
+#define CR_PLACEHOLDER_2159 2159
+#define CR_PLACEHOLDER_2160 2160
+#define CR_PLACEHOLDER_2161 2161
+#define CR_PLACEHOLDER_2162 2162
+#define CR_PLACEHOLDER_2163 2163
+#define CR_PLACEHOLDER_2164 2164
+#define CR_PLACEHOLDER_2165 2165
+#define CR_PLACEHOLDER_2166 2166
+#define CR_PLACEHOLDER_2167 2167
+#define CR_PLACEHOLDER_2168 2168
+#define CR_PLACEHOLDER_2169 2169
+#define CR_PLACEHOLDER_2170 2170
+#define CR_PLACEHOLDER_2171 2171
+#define CR_PLACEHOLDER_2172 2172
+#define CR_PLACEHOLDER_2173 2173
+#define CR_PLACEHOLDER_2174 2174
+#define CR_PLACEHOLDER_2175 2175
+#define CR_PLACEHOLDER_2176 2176
+#define CR_PLACEHOLDER_2177 2177
+#define CR_PLACEHOLDER_2178 2178
+#define CR_PLACEHOLDER_2179 2179
+#define CR_PLACEHOLDER_2180 2180
+#define CR_PLACEHOLDER_2181 2181
+#define CR_PLACEHOLDER_2182 2182
+#define CR_PLACEHOLDER_2183 2183
+#define CR_PLACEHOLDER_2184 2184
+#define CR_PLACEHOLDER_2185 2185
+#define CR_PLACEHOLDER_2186 2186
+#define CR_PLACEHOLDER_2187 2187
+#define CR_PLACEHOLDER_2188 2188
+#define CR_PLACEHOLDER_2189 2189
+#define CR_PLACEHOLDER_2190 2190
+#define CR_PLACEHOLDER_2191 2191
+#define CR_PLACEHOLDER_2192 2192
+#define CR_PLACEHOLDER_2193 2193
+#define CR_PLACEHOLDER_2194 2194
+#define CR_PLACEHOLDER_2195 2195
+#define CR_PLACEHOLDER_2196 2196
+#define CR_PLACEHOLDER_2197 2197
+#define CR_PLACEHOLDER_2198 2198
+#define CR_PLACEHOLDER_2199 2199
+// Facebook client errors
+#define CR_NET_READ_INTERRUPTED 2200
+#define CR_NET_WRITE_INTERRUPTED 2201
+#define CR_ERROR_LAST /*Copy last error nr:*/ 2201
 /* Add error numbers before CR_ERROR_LAST and change it accordingly. */
 
+#define CR_PLACEHOLDER_FIRST CR_PLACEHOLDER_2074
+#define CR_PLACEHOLDER_LAST CR_PLACEHOLDER_2199
+
+static inline bool isPlaceHolder(int client_errno) {
+  return client_errno >= CR_PLACEHOLDER_FIRST &&
+         client_errno <= CR_PLACEHOLDER_LAST;
+}
+
 /* Visual Studio requires '__inline' for C code */
 static inline const char *ER_CLIENT(int client_errno) {
-  if (client_errno >= CR_ERROR_FIRST && client_errno <= CR_ERROR_LAST)
+  if (client_errno >= CR_ERROR_FIRST && client_errno <= CR_ERROR_LAST &&
+      !isPlaceHolder(client_errno)) {
     return client_errors[client_errno - CR_ERROR_FIRST];
+  }
   return client_errors[CR_UNKNOWN_ERROR - CR_ERROR_FIRST];
 }
 

include/mysql.h.pp

@@ -363,9 +363,15 @@
 void init_client_errs(void);
 void finish_client_errs(void);
 extern const char *client_errors[];
+static inline bool isPlaceHolder(int client_errno) {
+  return client_errno >= 2074 &&
+         client_errno <= 2199;
+}
 static inline const char *ER_CLIENT(int client_errno) {
-  if (client_errno >= 2000 && client_errno <= 2073)
+  if (client_errno >= 2000 && client_errno <= 2201 &&
+      !isPlaceHolder(client_errno)) {
     return client_errors[client_errno - 2000];
+  }
   return client_errors[2000 - 2000];
 }
 extern unsigned int mysql_port;

libmysql/errmsg.cc

@@ -119,6 +119,134 @@ const char *client_errors[] = {
     "Invalid first argument for MYSQL_OPT_USER_PASSWORD option. Valid value "
     "should be between 1 and 3 inclusive.",
     "Can't get session data: %s",
+    "Placeholder 2074",
+    "Placeholder 2075",
+    "Placeholder 2076",
+    "Placeholder 2077",
+    "Placeholder 2078",
+    "Placeholder 2079",
+    "Placeholder 2080",
+    "Placeholder 2081",
+    "Placeholder 2082",
+    "Placeholder 2083",
+    "Placeholder 2084",
+    "Placeholder 2085",
+    "Placeholder 2086",
+    "Placeholder 2087",
+    "Placeholder 2088",
+    "Placeholder 2089",
+    "Placeholder 2090",
+    "Placeholder 2091",
+    "Placeholder 2092",
+    "Placeholder 2093",
+    "Placeholder 2094",
+    "Placeholder 2095",
+    "Placeholder 2096",
+    "Placeholder 2097",
+    "Placeholder 2098",
+    "Placeholder 2099",
+    "Placeholder 2100",
+    "Placeholder 2101",
+    "Placeholder 2102",
+    "Placeholder 2103",
+    "Placeholder 2104",
+    "Placeholder 2105",
+    "Placeholder 2106",
+    "Placeholder 2107",
+    "Placeholder 2108",
+    "Placeholder 2109",
+    "Placeholder 2110",
+    "Placeholder 2111",
+    "Placeholder 2112",
+    "Placeholder 2113",
+    "Placeholder 2114",
+    "Placeholder 2115",
+    "Placeholder 2116",
+    "Placeholder 2117",
+    "Placeholder 2118",
+    "Placeholder 2119",
+    "Placeholder 2120",
+    "Placeholder 2121",
+    "Placeholder 2122",
+    "Placeholder 2123",
+    "Placeholder 2124",
+    "Placeholder 2125",
+    "Placeholder 2126",
+    "Placeholder 2127",
+    "Placeholder 2128",
+    "Placeholder 2129",
+    "Placeholder 2130",
+    "Placeholder 2131",
+    "Placeholder 2132",
+    "Placeholder 2133",
+    "Placeholder 2134",
+    "Placeholder 2135",
+    "Placeholder 2136",
+    "Placeholder 2137",
+    "Placeholder 2138",
+    "Placeholder 2139",
+    "Placeholder 2140",
+    "Placeholder 2141",
+    "Placeholder 2142",
+    "Placeholder 2143",
+    "Placeholder 2144",
+    "Placeholder 2145",
+    "Placeholder 2146",
+    "Placeholder 2147",
+    "Placeholder 2148",
+    "Placeholder 2149",
+    "Placeholder 2150",
+    "Placeholder 2151",
+    "Placeholder 2152",
+    "Placeholder 2153",
+    "Placeholder 2154",
+    "Placeholder 2155",
+    "Placeholder 2156",
+    "Placeholder 2157",
+    "Placeholder 2158",
+    "Placeholder 2159",
+    "Placeholder 2160",
+    "Placeholder 2161",
+    "Placeholder 2162",
+    "Placeholder 2163",
+    "Placeholder 2164",
+    "Placeholder 2165",
+    "Placeholder 2166",
+    "Placeholder 2167",
+    "Placeholder 2168",
+    "Placeholder 2169",
+    "Placeholder 2170",
+    "Placeholder 2171",
+    "Placeholder 2172",
+    "Placeholder 2173",
+    "Placeholder 2174",
+    "Placeholder 2175",
+    "Placeholder 2176",
+    "Placeholder 2177",
+    "Placeholder 2178",
+    "Placeholder 2179",
+    "Placeholder 2180",
+    "Placeholder 2181",
+    "Placeholder 2182",
+    "Placeholder 2183",
+    "Placeholder 2184",
+    "Placeholder 2185",
+    "Placeholder 2186",
+    "Placeholder 2187",
+    "Placeholder 2188",
+    "Placeholder 2189",
+    "Placeholder 2190",
+    "Placeholder 2191",
+    "Placeholder 2192",
+    "Placeholder 2193",
+    "Placeholder 2194",
+    "Placeholder 2195",
+    "Placeholder 2196",
+    "Placeholder 2197",
+    "Placeholder 2198",
+    "Placeholder 2199",
+    "Read timeout is reached",
+    "Write timeout is reached",
     ""};
 
 static const char *get_client_errmsg(int nr) {

libmysql/libmysql.cc

@@ -1797,8 +1797,16 @@ static bool execute(MYSQL_STMT *stmt, char *packet, ulong length,
     /*
       Don't set stmt error if stmt->mysql is NULL, as the error in this case
       has already been set by mysql_prune_stmt_list().
+
+      Special case for CR_NET_(READ|WRITE)_INTERRUPTED because they were
+      added to disambiguate them from CR_SERVER_LOST. mysql_prune_stmt_list
+      sets CR_SERVER_LOST for the whole stmt list, but we want the
+      statement causing timeout to get the correct error and the rest to get
+      CR_SERVER_LOST.
     */
-    if (stmt->mysql) set_stmt_errmsg(stmt, net);
+    if (stmt->mysql || net->last_errno == CR_NET_READ_INTERRUPTED ||
+        net->last_errno == CR_NET_WRITE_INTERRUPTED)
+      set_stmt_errmsg(stmt, net);
     return true;
   } else if (mysql->status == MYSQL_STATUS_GET_RESULT)
     stmt->mysql->status = MYSQL_STATUS_STATEMENT_GET_RESULT;
@@ -1974,8 +1982,16 @@ static int stmt_read_row_from_cursor(MYSQL_STMT *stmt, unsigned char **row) {
       /*
         Don't set stmt error if stmt->mysql is NULL, as the error in this case
         has already been set by mysql_prune_stmt_list().
+
+        Special case for CR_NET_(READ|WRITE)_INTERRUPTED because they were
+        added to disambiguate them from CR_SERVER_LOST. mysql_prune_stmt_list
+        sets CR_SERVER_LOST for the whole stmt list, but we want the
+        statement causing timeout to get the correct error and the rest to get
+        CR_SERVER_LOST.
       */
-      if (stmt->mysql) set_stmt_errmsg(stmt, net);
+      if (stmt->mysql || net->last_errno == CR_NET_READ_INTERRUPTED ||
+          net->last_errno == CR_NET_WRITE_INTERRUPTED)
+        set_stmt_errmsg(stmt, net);
       return 1;
     }
     if ((*mysql->methods->read_rows_from_cursor)(stmt)) return 1;
@@ -2577,8 +2593,16 @@ bool STDCALL mysql_stmt_send_long_data(MYSQL_STMT *stmt, uint param_number,
       /*
         Don't set stmt error if stmt->mysql is NULL, as the error in this case
         has already been set by mysql_prune_stmt_list().
+
+        Special case for CR_NET_(READ|WRITE)_INTERRUPTED because they were
+        added to disambiguate them from CR_SERVER_LOST. mysql_prune_stmt_list
+        sets CR_SERVER_LOST for the whole stmt list, but we want the
+        statement causing timeout to get the correct error and the rest to get
+        CR_SERVER_LOST.
       */
-      if (stmt->mysql) set_stmt_errmsg(stmt, &mysql->net);
+      if (stmt->mysql || mysql->net.last_errno == CR_NET_READ_INTERRUPTED ||
+          mysql->net.last_errno == CR_NET_WRITE_INTERRUPTED)
+        set_stmt_errmsg(stmt, &mysql->net);
       return true;
     }
   }
@@ -3957,8 +3981,16 @@ int STDCALL mysql_stmt_store_result(MYSQL_STMT *stmt) {
       /*
         Don't set stmt error if stmt->mysql is NULL, as the error in this case
         has already been set by mysql_prune_stmt_list().
+
+        Special case for CR_NET_(READ|WRITE)_INTERRUPTED because they were
+        added to disambiguate them from CR_SERVER_LOST. mysql_prune_stmt_list
+        sets CR_SERVER_LOST for the whole stmt list, but we want the
+        statement causing timeout to get the correct error and the rest to get
+        CR_SERVER_LOST.
       */
-      if (stmt->mysql) set_stmt_errmsg(stmt, net);
+      if (stmt->mysql || net->last_errno == CR_NET_READ_INTERRUPTED ||
+          net->last_errno == CR_NET_WRITE_INTERRUPTED)
+        set_stmt_errmsg(stmt, net);
       return 1;
     }
   } else if (mysql->status != MYSQL_STATUS_STATEMENT_GET_RESULT) {

mysql-test/include/wait_time_until_connected_again.inc

@@ -12,7 +12,7 @@ while ($mysql_errno)
   # Strangely enough, the server might return "Too many connections"
   # while being shutdown, thus 1040 is an "allowed" error
   # See BUG#36228
-  --error 0,1040,1053,2002,2003,2006,2013,2016,2017
+  --error 0,1040,1053,2002,2003,2006,2013,2016,2017,2071
   show status;
 
   dec $counter;

mysql-test/include/wait_until_connected_again.inc

@@ -40,7 +40,7 @@ while ($mysql_errno)
   # Strangely enough, the server might return "Too many connections"
   # while being shutdown, thus 1040 is an "allowed" error
   # See BUG#36228
-  --error 0,1040,1053,2002,2003,2006,2013,1045,ER_SECURE_TRANSPORT_REQUIRED,2016,2017,ER_CLIENT_INTERACTION_TIMEOUT
+  --error 0,1040,1053,2002,2003,2006,2013,1045,ER_SECURE_TRANSPORT_REQUIRED,2016,2017,2200,ER_CLIENT_INTERACTION_TIMEOUT
   show session status;
   if ($mysql_errno == 1045){
     --let mysql_errno=0