ctdb/common/ctdb_util.c

   1 /*
   2    ctdb utility code
   3
   4    Copyright (C) Andrew Tridgell  2006
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "includes.h"
  21 #include "tdb.h"
  22 #include "system/network.h"
  23 #include "system/filesys.h"
  24 #include "system/wait.h"
  25 #include "../include/ctdb_private.h"
  26
  27 /*
  28   return error string for last error
  29 */
  30 const char *ctdb_errstr(struct ctdb_context *ctdb)
  31 {
  32         return ctdb->err_msg;
  33 }
  34
  35
  36 /*
  37   remember an error message
  38 */
  39 void ctdb_set_error(struct ctdb_context *ctdb, const char *fmt, ...)
  40 {
  41         va_list ap;
  42         talloc_free(ctdb->err_msg);
  43         va_start(ap, fmt);
  44         ctdb->err_msg = talloc_vasprintf(ctdb, fmt, ap);
  45         DEBUG(DEBUG_ERR,("ctdb error: %s\n", ctdb->err_msg));
  46         va_end(ap);
  47 }
  48
  49 /*
  50   a fatal internal error occurred - no hope for recovery
  51 */
  52 void ctdb_fatal(struct ctdb_context *ctdb, const char *msg)
  53 {
  54         DEBUG(DEBUG_ALERT,("ctdb fatal error: %s\n", msg));
  55         abort();
  56 }
  57
  58 /*
  59   like ctdb_fatal() but a core/backtrace would not be useful
  60 */
  61 void ctdb_die(struct ctdb_context *ctdb, const char *msg)
  62 {
  63         DEBUG(DEBUG_ALERT,("ctdb exiting with error: %s\n", msg));
  64         exit(1);
  65 }
  66
  67 /* Invoke an external program to do some sort of tracing on the CTDB
  68  * process.  This might block for a little while.  The external
  69  * program is specified by the environment variable
  70  * CTDB_EXTERNAL_TRACE.  This program should take one argument: the
  71  * pid of the process to trace.  Commonly, the program would be a
  72  * wrapper script around gcore.
  73  */
  74 void ctdb_external_trace(void)
  75 {
  76         int ret;
  77         const char * t = getenv("CTDB_EXTERNAL_TRACE");
  78         char * cmd;
  79
  80         if (t == NULL) {
  81                 return;
  82         }
  83
  84         cmd = talloc_asprintf(NULL, "%s %lu", t, (unsigned long) getpid());
  85         DEBUG(DEBUG_WARNING,("begin external trace: %s\n", cmd));
  86         ret = system(cmd);
  87         if (ret == -1) {
  88                 DEBUG(DEBUG_ERR,
  89                       ("external trace command \"%s\" failed\n", cmd));
  90         }
  91         DEBUG(DEBUG_WARNING,("end external trace: %s\n", cmd));
  92         talloc_free(cmd);
  93 }
  94
  95 /*
  96   parse a IP:port pair
  97 */
  98 int ctdb_parse_address(struct ctdb_context *ctdb,
  99                        TALLOC_CTX *mem_ctx, const char *str,
 100                        struct ctdb_address *address)
 101 {
 102         struct servent *se;
 103
 104         setservent(0);
 105         se = getservbyname("ctdb", "tcp");
 106         endservent();
 107
 108         address->address = talloc_strdup(mem_ctx, str);
 109         CTDB_NO_MEMORY(ctdb, address->address);
 110
 111         if (se == NULL) {
 112                 address->port = CTDB_PORT;
 113         } else {
 114                 address->port = ntohs(se->s_port);
 115         }
 116         return 0;
 117 }
 118
 119
 120 /*
 121   check if two addresses are the same
 122 */
 123 bool ctdb_same_address(struct ctdb_address *a1, struct ctdb_address *a2)
 124 {
 125         return strcmp(a1->address, a2->address) == 0 && a1->port == a2->port;
 126 }
 127
 128
 129 /*
 130   hash function for mapping data to a VNN - taken from tdb
 131 */
 132 uint32_t ctdb_hash(const TDB_DATA *key)
 133 {
 134         return tdb_jenkins_hash(discard_const(key));
 135 }
 136
 137 /*
 138   a type checking varient of idr_find
 139  */
 140 static void *_idr_find_type(struct idr_context *idp, int id, const char *type, const char *location)
 141 {
 142         void *p = idr_find(idp, id);
 143         if (p && talloc_check_name(p, type) == NULL) {
 144                 DEBUG(DEBUG_ERR,("%s idr_find_type expected type %s  but got %s\n",
 145                          location, type, talloc_get_name(p)));
 146                 return NULL;
 147         }
 148         return p;
 149 }
 150
 151 uint32_t ctdb_reqid_new(struct ctdb_context *ctdb, void *state)
 152 {
 153         int id = idr_get_new_above(ctdb->idr, state, ctdb->lastid+1, INT_MAX);
 154         if (id < 0) {
 155                 DEBUG(DEBUG_DEBUG, ("Reqid wrap!\n"));
 156                 id = idr_get_new(ctdb->idr, state, INT_MAX);
 157         }
 158         ctdb->lastid = id;
 159         return id;
 160 }
 161
 162 void *_ctdb_reqid_find(struct ctdb_context *ctdb, uint32_t reqid, const char *type, const char *location)
 163 {
 164         void *p;
 165
 166         p = _idr_find_type(ctdb->idr, reqid, type, location);
 167         if (p == NULL) {
 168                 DEBUG(DEBUG_WARNING, ("Could not find idr:%u\n",reqid));
 169         }
 170
 171         return p;
 172 }
 173
 174
 175 void ctdb_reqid_remove(struct ctdb_context *ctdb, uint32_t reqid)
 176 {
 177         int ret;
 178
 179         ret = idr_remove(ctdb->idr, reqid);
 180         if (ret != 0) {
 181                 DEBUG(DEBUG_ERR, ("Removing idr that does not exist\n"));
 182         }
 183 }
 184
 185
 186 static uint32_t ctdb_marshall_record_size(TDB_DATA key,
 187                                           struct ctdb_ltdb_header *header,
 188                                           TDB_DATA data)
 189 {
 190         return offsetof(struct ctdb_rec_data, data) + key.dsize +
 191                data.dsize + (header ? sizeof(*header) : 0);
 192 }
 193
 194 static void ctdb_marshall_record_copy(struct ctdb_rec_data *rec,
 195                                       uint32_t reqid,
 196                                       TDB_DATA key,
 197                                       struct ctdb_ltdb_header *header,
 198                                       TDB_DATA data,
 199                                       uint32_t length)
 200 {
 201         uint32_t offset;
 202
 203         rec->length = length;
 204         rec->reqid = reqid;
 205         rec->keylen = key.dsize;
 206         memcpy(&rec->data[0], key.dptr, key.dsize);
 207         offset = key.dsize;
 208
 209         if (header) {
 210                 rec->datalen = data.dsize + sizeof(*header);
 211                 memcpy(&rec->data[offset], header, sizeof(*header));
 212                 offset += sizeof(*header);
 213         } else {
 214                 rec->datalen = data.dsize;
 215         }
 216         memcpy(&rec->data[offset], data.dptr, data.dsize);
 217 }
 218
 219 /*
 220   form a ctdb_rec_data record from a key/data pair
 221
 222   note that header may be NULL. If not NULL then it is included in the data portion
 223   of the record
 224  */
 225 struct ctdb_rec_data *ctdb_marshall_record(TALLOC_CTX *mem_ctx, uint32_t reqid,
 226                                            TDB_DATA key,
 227                                            struct ctdb_ltdb_header *header,
 228                                            TDB_DATA data)
 229 {
 230         size_t length;
 231         struct ctdb_rec_data *d;
 232
 233         length = ctdb_marshall_record_size(key, header, data);
 234
 235         d = (struct ctdb_rec_data *)talloc_size(mem_ctx, length);
 236         if (d == NULL) {
 237                 return NULL;
 238         }
 239
 240         ctdb_marshall_record_copy(d, reqid, key, header, data, length);
 241         return d;
 242 }
 243
 244
 245 /* helper function for marshalling multiple records */
 246 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
 247                                                struct ctdb_marshall_buffer *m,
 248                                                uint64_t db_id,
 249                                                uint32_t reqid,
 250                                                TDB_DATA key,
 251                                                struct ctdb_ltdb_header *header,
 252                                                TDB_DATA data)
 253 {
 254         struct ctdb_rec_data *r;
 255         struct ctdb_marshall_buffer *m2;
 256         uint32_t length, offset;
 257
 258         length = ctdb_marshall_record_size(key, header, data);
 259
 260         if (m == NULL) {
 261                 offset = offsetof(struct ctdb_marshall_buffer, data);
 262                 m2 = talloc_zero_size(mem_ctx, offset + length);
 263         } else {
 264                 offset = talloc_get_size(m);
 265                 m2 = talloc_realloc_size(mem_ctx, m, offset + length);
 266         }
 267         if (m2 == NULL) {
 268                 TALLOC_FREE(m);
 269                 return NULL;
 270         }
 271
 272         if (m == NULL) {
 273                 m2->db_id = db_id;
 274         }
 275
 276         r = (struct ctdb_rec_data *)((uint8_t *)m2 + offset);
 277         ctdb_marshall_record_copy(r, reqid, key, header, data, length);
 278         m2->count++;
 279
 280         return m2;
 281 }
 282
 283 /* we've finished marshalling, return a data blob with the marshalled records */
 284 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m)
 285 {
 286         TDB_DATA data;
 287         data.dptr = (uint8_t *)m;
 288         data.dsize = talloc_get_size(m);
 289         return data;
 290 }
 291
 292 /*
 293    loop over a marshalling buffer
 294
 295      - pass r==NULL to start
 296      - loop the number of times indicated by m->count
 297 */
 298 struct ctdb_rec_data *ctdb_marshall_loop_next(struct ctdb_marshall_buffer *m, struct ctdb_rec_data *r,
 299                                               uint32_t *reqid,
 300                                               struct ctdb_ltdb_header *header,
 301                                               TDB_DATA *key, TDB_DATA *data)
 302 {
 303         if (r == NULL) {
 304                 r = (struct ctdb_rec_data *)&m->data[0];
 305         } else {
 306                 r = (struct ctdb_rec_data *)(r->length + (uint8_t *)r);
 307         }
 308
 309         if (reqid != NULL) {
 310                 *reqid = r->reqid;
 311         }
 312
 313         if (key != NULL) {
 314                 key->dptr   = &r->data[0];
 315                 key->dsize  = r->keylen;
 316         }
 317         if (data != NULL) {
 318                 data->dptr  = &r->data[r->keylen];
 319                 data->dsize = r->datalen;
 320                 if (header != NULL) {
 321                         data->dptr += sizeof(*header);
 322                         data->dsize -= sizeof(*header);
 323                 }
 324         }
 325
 326         if (header != NULL) {
 327                 if (r->datalen < sizeof(*header)) {
 328                         return NULL;
 329                 }
 330                 memcpy(header, &r->data[r->keylen], sizeof(*header));
 331         }
 332
 333         return r;
 334 }
 335
 336 /*
 337    This is used to canonicalize a ctdb_sock_addr structure.
 338 */
 339 void ctdb_canonicalize_ip(const ctdb_sock_addr *ip, ctdb_sock_addr *cip)
 340 {
 341         char prefix[12] = { 0,0,0,0,0,0,0,0,0,0,0xff,0xff };
 342
 343         memcpy(cip, ip, sizeof (*cip));
 344
 345         if ( (ip->sa.sa_family == AF_INET6)
 346         && !memcmp(&ip->ip6.sin6_addr, prefix, 12)) {
 347                 memset(cip, 0, sizeof(*cip));
 348 #ifdef HAVE_SOCK_SIN_LEN
 349                 cip->ip.sin_len = sizeof(*cip);
 350 #endif
 351                 cip->ip.sin_family = AF_INET;
 352                 cip->ip.sin_port   = ip->ip6.sin6_port;
 353                 memcpy(&cip->ip.sin_addr, &ip->ip6.sin6_addr.s6_addr[12], 4);
 354         }
 355 }
 356
 357 bool ctdb_same_ip(const ctdb_sock_addr *tip1, const ctdb_sock_addr *tip2)
 358 {
 359         ctdb_sock_addr ip1, ip2;
 360
 361         ctdb_canonicalize_ip(tip1, &ip1);
 362         ctdb_canonicalize_ip(tip2, &ip2);
 363
 364         if (ip1.sa.sa_family != ip2.sa.sa_family) {
 365                 return false;
 366         }
 367
 368         switch (ip1.sa.sa_family) {
 369         case AF_INET:
 370                 return ip1.ip.sin_addr.s_addr == ip2.ip.sin_addr.s_addr;
 371         case AF_INET6:
 372                 return !memcmp(&ip1.ip6.sin6_addr.s6_addr[0],
 373                                 &ip2.ip6.sin6_addr.s6_addr[0],
 374                                 16);
 375         default:
 376                 DEBUG(DEBUG_ERR, (__location__ " CRITICAL Can not compare sockaddr structures of type %u\n", ip1.sa.sa_family));
 377                 return false;
 378         }
 379
 380         return true;
 381 }
 382
 383 /*
 384   compare two ctdb_sock_addr structures
 385  */
 386 bool ctdb_same_sockaddr(const ctdb_sock_addr *ip1, const ctdb_sock_addr *ip2)
 387 {
 388         return ctdb_same_ip(ip1, ip2) && ip1->ip.sin_port == ip2->ip.sin_port;
 389 }
 390
 391 char *ctdb_addr_to_str(ctdb_sock_addr *addr)
 392 {
 393         static char cip[128] = "";
 394
 395         switch (addr->sa.sa_family) {
 396         case AF_INET:
 397                 inet_ntop(addr->ip.sin_family, &addr->ip.sin_addr, cip, sizeof(cip));
 398                 break;
 399         case AF_INET6:
 400                 inet_ntop(addr->ip6.sin6_family, &addr->ip6.sin6_addr, cip, sizeof(cip));
 401                 break;
 402         default:
 403                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 404                 ctdb_external_trace();
 405         }
 406
 407         return cip;
 408 }
 409
 410 unsigned ctdb_addr_to_port(ctdb_sock_addr *addr)
 411 {
 412         switch (addr->sa.sa_family) {
 413         case AF_INET:
 414                 return ntohs(addr->ip.sin_port);
 415                 break;
 416         case AF_INET6:
 417                 return ntohs(addr->ip6.sin6_port);
 418                 break;
 419         default:
 420                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 421         }
 422
 423         return 0;
 424 }
 425
 426
 427 const char *ctdb_eventscript_call_names[] = {
 428         "init",
 429         "setup",
 430         "startup",
 431         "startrecovery",
 432         "recovered",
 433         "takeip",
 434         "releaseip",
 435         "stopped",
 436         "monitor",
 437         "status",
 438         "shutdown",
 439         "reload",
 440         "updateip",
 441         "ipreallocated"
 442 };
 443
 444 /* Runstate handling */
 445 static struct {
 446         enum ctdb_runstate runstate;
 447         const char * label;
 448 } runstate_map[] = {
 449         { CTDB_RUNSTATE_UNKNOWN, "UNKNOWN" },
 450         { CTDB_RUNSTATE_INIT, "INIT" },
 451         { CTDB_RUNSTATE_SETUP, "SETUP" },
 452         { CTDB_RUNSTATE_FIRST_RECOVERY, "FIRST_RECOVERY" },
 453         { CTDB_RUNSTATE_STARTUP, "STARTUP" },
 454         { CTDB_RUNSTATE_RUNNING, "RUNNING" },
 455         { CTDB_RUNSTATE_SHUTDOWN, "SHUTDOWN" },
 456         { -1, NULL },
 457 };
 458
 459 const char *runstate_to_string(enum ctdb_runstate runstate)
 460 {
 461         int i;
 462         for (i=0; runstate_map[i].label != NULL ; i++) {
 463                 if (runstate_map[i].runstate == runstate) {
 464                         return runstate_map[i].label;
 465                 }
 466         }
 467
 468         return runstate_map[0].label;
 469 }
 470
 471 enum ctdb_runstate runstate_from_string(const char *label)
 472 {
 473         int i;
 474         for (i=0; runstate_map[i].label != NULL; i++) {
 475                 if (strcasecmp(runstate_map[i].label, label) == 0) {
 476                         return runstate_map[i].runstate;
 477                 }
 478         }
 479
 480         return CTDB_RUNSTATE_UNKNOWN;
 481 }
 482
 483 void ctdb_set_runstate(struct ctdb_context *ctdb, enum ctdb_runstate runstate)
 484 {
 485         if (runstate <= ctdb->runstate) {
 486                 ctdb_fatal(ctdb, "runstate must always increase");
 487         }
 488
 489         DEBUG(DEBUG_NOTICE,("Set runstate to %s (%d)\n",
 490                             runstate_to_string(runstate), runstate));
 491         ctdb->runstate = runstate;
 492 }