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 "lib/tevent/tevent.h"
  22 #include "lib/tdb/include/tdb.h"
  23 #include "system/network.h"
  24 #include "system/filesys.h"
  25 #include "system/wait.h"
  26 #include "system/shmem.h"
  27 #include "../include/ctdb_private.h"
  28
  29 int LogLevel = DEBUG_NOTICE;
  30 int this_log_level = 0;
  31
  32 /*
  33   return error string for last error
  34 */
  35 const char *ctdb_errstr(struct ctdb_context *ctdb)
  36 {
  37         return ctdb->err_msg;
  38 }
  39
  40
  41 /*
  42   remember an error message
  43 */
  44 void ctdb_set_error(struct ctdb_context *ctdb, const char *fmt, ...)
  45 {
  46         va_list ap;
  47         talloc_free(ctdb->err_msg);
  48         va_start(ap, fmt);
  49         ctdb->err_msg = talloc_vasprintf(ctdb, fmt, ap);
  50         DEBUG(DEBUG_ERR,("ctdb error: %s\n", ctdb->err_msg));
  51         va_end(ap);
  52 }
  53
  54 /*
  55   a fatal internal error occurred - no hope for recovery
  56 */
  57 void ctdb_fatal(struct ctdb_context *ctdb, const char *msg)
  58 {
  59         DEBUG(DEBUG_ALERT,("ctdb fatal error: %s\n", msg));
  60         abort();
  61 }
  62
  63 /*
  64   parse a IP:port pair
  65 */
  66 int ctdb_parse_address(struct ctdb_context *ctdb,
  67                        TALLOC_CTX *mem_ctx, const char *str,
  68                        struct ctdb_address *address)
  69 {
  70         struct servent *se;
  71
  72         setservent(0);
  73         se = getservbyname("ctdb", "tcp");
  74         endservent();
  75
  76         address->address = talloc_strdup(mem_ctx, str);
  77         CTDB_NO_MEMORY(ctdb, address->address);
  78
  79         if (se == NULL) {
  80                 address->port = CTDB_PORT;
  81         } else {
  82                 address->port = ntohs(se->s_port);
  83         }
  84         return 0;
  85 }
  86
  87
  88 /*
  89   check if two addresses are the same
  90 */
  91 bool ctdb_same_address(struct ctdb_address *a1, struct ctdb_address *a2)
  92 {
  93         return strcmp(a1->address, a2->address) == 0 && a1->port == a2->port;
  94 }
  95
  96
  97 /*
  98   hash function for mapping data to a VNN - taken from tdb
  99 */
 100 uint32_t ctdb_hash(const TDB_DATA *key)
 101 {
 102         return tdb_jenkins_hash(discard_const(key));
 103 }
 104
 105 /*
 106   a type checking varient of idr_find
 107  */
 108 static void *_idr_find_type(struct idr_context *idp, int id, const char *type, const char *location)
 109 {
 110         void *p = idr_find(idp, id);
 111         if (p && talloc_check_name(p, type) == NULL) {
 112                 DEBUG(DEBUG_ERR,("%s idr_find_type expected type %s  but got %s\n",
 113                          location, type, talloc_get_name(p)));
 114                 return NULL;
 115         }
 116         return p;
 117 }
 118
 119 uint32_t ctdb_reqid_new(struct ctdb_context *ctdb, void *state)
 120 {
 121         int id = idr_get_new_above(ctdb->idr, state, ctdb->lastid+1, INT_MAX);
 122         if (id < 0) {
 123                 DEBUG(DEBUG_DEBUG, ("Reqid wrap!\n"));
 124                 id = idr_get_new(ctdb->idr, state, INT_MAX);
 125         }
 126         ctdb->lastid = id;
 127         return id;
 128 }
 129
 130 void *_ctdb_reqid_find(struct ctdb_context *ctdb, uint32_t reqid, const char *type, const char *location)
 131 {
 132         void *p;
 133
 134         p = _idr_find_type(ctdb->idr, reqid, type, location);
 135         if (p == NULL) {
 136                 DEBUG(DEBUG_WARNING, ("Could not find idr:%u\n",reqid));
 137         }
 138
 139         return p;
 140 }
 141
 142
 143 void ctdb_reqid_remove(struct ctdb_context *ctdb, uint32_t reqid)
 144 {
 145         int ret;
 146
 147         ret = idr_remove(ctdb->idr, reqid);
 148         if (ret != 0) {
 149                 DEBUG(DEBUG_ERR, ("Removing idr that does not exist\n"));
 150         }
 151 }
 152
 153
 154 /*
 155   form a ctdb_rec_data record from a key/data pair
 156
 157   note that header may be NULL. If not NULL then it is included in the data portion
 158   of the record
 159  */
 160 struct ctdb_rec_data *ctdb_marshall_record(TALLOC_CTX *mem_ctx, uint32_t reqid,
 161                                            TDB_DATA key,
 162                                            struct ctdb_ltdb_header *header,
 163                                            TDB_DATA data)
 164 {
 165         size_t length;
 166         struct ctdb_rec_data *d;
 167
 168         length = offsetof(struct ctdb_rec_data, data) + key.dsize +
 169                 data.dsize + (header?sizeof(*header):0);
 170         d = (struct ctdb_rec_data *)talloc_size(mem_ctx, length);
 171         if (d == NULL) {
 172                 return NULL;
 173         }
 174         d->length = length;
 175         d->reqid = reqid;
 176         d->keylen = key.dsize;
 177         memcpy(&d->data[0], key.dptr, key.dsize);
 178         if (header) {
 179                 d->datalen = data.dsize + sizeof(*header);
 180                 memcpy(&d->data[key.dsize], header, sizeof(*header));
 181                 memcpy(&d->data[key.dsize+sizeof(*header)], data.dptr, data.dsize);
 182         } else {
 183                 d->datalen = data.dsize;
 184                 memcpy(&d->data[key.dsize], data.dptr, data.dsize);
 185         }
 186         return d;
 187 }
 188
 189
 190 /* helper function for marshalling multiple records */
 191 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
 192                                                struct ctdb_marshall_buffer *m,
 193                                                uint64_t db_id,
 194                                                uint32_t reqid,
 195                                                TDB_DATA key,
 196                                                struct ctdb_ltdb_header *header,
 197                                                TDB_DATA data)
 198 {
 199         struct ctdb_rec_data *r;
 200         size_t m_size, r_size;
 201         struct ctdb_marshall_buffer *m2;
 202
 203         r = ctdb_marshall_record(mem_ctx, reqid, key, header, data);
 204         if (r == NULL) {
 205                 talloc_free(m);
 206                 return NULL;
 207         }
 208
 209         if (m == NULL) {
 210                 m = talloc_zero_size(mem_ctx, offsetof(struct ctdb_marshall_buffer, data));
 211                 if (m == NULL) {
 212                         return NULL;
 213                 }
 214                 m->db_id = db_id;
 215         }
 216
 217         m_size = talloc_get_size(m);
 218         r_size = talloc_get_size(r);
 219
 220         m2 = talloc_realloc_size(mem_ctx, m,  m_size + r_size);
 221         if (m2 == NULL) {
 222                 talloc_free(m);
 223                 return NULL;
 224         }
 225
 226         memcpy(m_size + (uint8_t *)m2, r, r_size);
 227
 228         talloc_free(r);
 229
 230         m2->count++;
 231
 232         return m2;
 233 }
 234
 235 /* we've finished marshalling, return a data blob with the marshalled records */
 236 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m)
 237 {
 238         TDB_DATA data;
 239         data.dptr = (uint8_t *)m;
 240         data.dsize = talloc_get_size(m);
 241         return data;
 242 }
 243
 244 /*
 245    loop over a marshalling buffer
 246
 247      - pass r==NULL to start
 248      - loop the number of times indicated by m->count
 249 */
 250 struct ctdb_rec_data *ctdb_marshall_loop_next(struct ctdb_marshall_buffer *m, struct ctdb_rec_data *r,
 251                                               uint32_t *reqid,
 252                                               struct ctdb_ltdb_header *header,
 253                                               TDB_DATA *key, TDB_DATA *data)
 254 {
 255         if (r == NULL) {
 256                 r = (struct ctdb_rec_data *)&m->data[0];
 257         } else {
 258                 r = (struct ctdb_rec_data *)(r->length + (uint8_t *)r);
 259         }
 260
 261         if (reqid != NULL) {
 262                 *reqid = r->reqid;
 263         }
 264
 265         if (key != NULL) {
 266                 key->dptr   = &r->data[0];
 267                 key->dsize  = r->keylen;
 268         }
 269         if (data != NULL) {
 270                 data->dptr  = &r->data[r->keylen];
 271                 data->dsize = r->datalen;
 272                 if (header != NULL) {
 273                         data->dptr += sizeof(*header);
 274                         data->dsize -= sizeof(*header);
 275                 }
 276         }
 277
 278         if (header != NULL) {
 279                 if (r->datalen < sizeof(*header)) {
 280                         return NULL;
 281                 }
 282                 *header = *(struct ctdb_ltdb_header *)&r->data[r->keylen];
 283         }
 284
 285         return r;
 286 }
 287
 288 /*
 289   if possible, make this task very high priority
 290  */
 291 void ctdb_high_priority(struct ctdb_context *ctdb)
 292 {
 293         errno = 0;
 294         if (nice(-20) == -1 && errno != 0) {
 295                 DEBUG(DEBUG_WARNING,("Unable to renice self: %s\n",
 296                                      strerror(errno)));
 297         } else {
 298                 DEBUG(DEBUG_NOTICE,("Scheduler says I'm nice: %i\n",
 299                                     getpriority(PRIO_PROCESS, getpid())));
 300         }
 301 }
 302
 303 /*
 304   make ourselves slightly nicer: eg. a ctdb child.
 305  */
 306 void ctdb_reduce_priority(struct ctdb_context *ctdb)
 307 {
 308         errno = 0;
 309         if (nice(10) == -1 && errno != 0) {
 310                 DEBUG(DEBUG_WARNING,("Unable to lower priority: %s\n",
 311                                      strerror(errno)));
 312         }
 313 }
 314
 315 void set_nonblocking(int fd)
 316 {
 317         unsigned v;
 318         v = fcntl(fd, F_GETFL, 0);
 319         fcntl(fd, F_SETFL, v | O_NONBLOCK);
 320 }
 321
 322 void set_close_on_exec(int fd)
 323 {
 324         unsigned v;
 325         v = fcntl(fd, F_GETFD, 0);
 326         fcntl(fd, F_SETFD, v | FD_CLOEXEC);
 327 }
 328
 329
 330 bool parse_ipv4(const char *s, unsigned port, struct sockaddr_in *sin)
 331 {
 332         sin->sin_family = AF_INET;
 333         sin->sin_port   = htons(port);
 334
 335         if (inet_pton(AF_INET, s, &sin->sin_addr) != 1) {
 336                 DEBUG(DEBUG_ERR, (__location__ " Failed to translate %s into sin_addr\n", s));
 337                 return false;
 338         }
 339
 340         return true;
 341 }
 342
 343 static bool parse_ipv6(const char *s, const char *ifaces, unsigned port, ctdb_sock_addr *saddr)
 344 {
 345         saddr->ip6.sin6_family   = AF_INET6;
 346         saddr->ip6.sin6_port     = htons(port);
 347         saddr->ip6.sin6_flowinfo = 0;
 348         saddr->ip6.sin6_scope_id = 0;
 349
 350         if (inet_pton(AF_INET6, s, &saddr->ip6.sin6_addr) != 1) {
 351                 DEBUG(DEBUG_ERR, (__location__ " Failed to translate %s into sin6_addr\n", s));
 352                 return false;
 353         }
 354
 355         if (ifaces && IN6_IS_ADDR_LINKLOCAL(&saddr->ip6.sin6_addr)) {
 356                 if (strchr(ifaces, ',')) {
 357                         DEBUG(DEBUG_ERR, (__location__ " Link local address %s "
 358                                           "is specified for multiple ifaces %s\n",
 359                                           s, ifaces));
 360                         return false;
 361                 }
 362                 saddr->ip6.sin6_scope_id = if_nametoindex(ifaces);
 363         }
 364
 365         return true;
 366 }
 367 /*
 368   parse a ip:port pair
 369  */
 370 bool parse_ip_port(const char *addr, ctdb_sock_addr *saddr)
 371 {
 372         TALLOC_CTX *tmp_ctx = talloc_new(NULL);
 373         char *s, *p;
 374         unsigned port;
 375         char *endp = NULL;
 376         bool ret;
 377
 378         s = talloc_strdup(tmp_ctx, addr);
 379         if (s == NULL) {
 380                 DEBUG(DEBUG_ERR, (__location__ " Failed strdup()\n"));
 381                 talloc_free(tmp_ctx);
 382                 return false;
 383         }
 384
 385         p = rindex(s, ':');
 386         if (p == NULL) {
 387                 DEBUG(DEBUG_ERR, (__location__ " This addr: %s does not contain a port number\n", s));
 388                 talloc_free(tmp_ctx);
 389                 return false;
 390         }
 391
 392         port = strtoul(p+1, &endp, 10);
 393         if (endp == NULL || *endp != 0) {
 394                 /* trailing garbage */
 395                 DEBUG(DEBUG_ERR, (__location__ " Trailing garbage after the port in %s\n", s));
 396                 talloc_free(tmp_ctx);
 397                 return false;
 398         }
 399         *p = 0;
 400
 401
 402         /* now is this a ipv4 or ipv6 address ?*/
 403         ret = parse_ip(s, NULL, port, saddr);
 404
 405         talloc_free(tmp_ctx);
 406         return ret;
 407 }
 408
 409 /*
 410   parse an ip
 411  */
 412 bool parse_ip(const char *addr, const char *ifaces, unsigned port, ctdb_sock_addr *saddr)
 413 {
 414         char *p;
 415         bool ret;
 416
 417         /* now is this a ipv4 or ipv6 address ?*/
 418         p = index(addr, ':');
 419         if (p == NULL) {
 420                 ret = parse_ipv4(addr, port, &saddr->ip);
 421         } else {
 422                 ret = parse_ipv6(addr, ifaces, port, saddr);
 423         }
 424
 425         return ret;
 426 }
 427
 428 /*
 429   parse a ip/mask pair
 430  */
 431 bool parse_ip_mask(const char *str, const char *ifaces, ctdb_sock_addr *addr, unsigned *mask)
 432 {
 433         TALLOC_CTX *tmp_ctx = talloc_new(NULL);
 434         char *s, *p;
 435         char *endp = NULL;
 436         bool ret;
 437
 438         ZERO_STRUCT(*addr);
 439         s = talloc_strdup(tmp_ctx, str);
 440         if (s == NULL) {
 441                 DEBUG(DEBUG_ERR, (__location__ " Failed strdup()\n"));
 442                 talloc_free(tmp_ctx);
 443                 return false;
 444         }
 445
 446         p = rindex(s, '/');
 447         if (p == NULL) {
 448                 DEBUG(DEBUG_ERR, (__location__ " This addr: %s does not contain a mask\n", s));
 449                 talloc_free(tmp_ctx);
 450                 return false;
 451         }
 452
 453         *mask = strtoul(p+1, &endp, 10);
 454         if (endp == NULL || *endp != 0) {
 455                 /* trailing garbage */
 456                 DEBUG(DEBUG_ERR, (__location__ " Trailing garbage after the mask in %s\n", s));
 457                 talloc_free(tmp_ctx);
 458                 return false;
 459         }
 460         *p = 0;
 461
 462
 463         /* now is this a ipv4 or ipv6 address ?*/
 464         ret = parse_ip(s, ifaces, 0, addr);
 465
 466         talloc_free(tmp_ctx);
 467         return ret;
 468 }
 469
 470 /*
 471    This is used to canonicalize a ctdb_sock_addr structure.
 472 */
 473 void ctdb_canonicalize_ip(const ctdb_sock_addr *ip, ctdb_sock_addr *cip)
 474 {
 475         char prefix[12] = { 0,0,0,0,0,0,0,0,0,0,0xff,0xff };
 476
 477         memcpy(cip, ip, sizeof (*cip));
 478
 479         if ( (ip->sa.sa_family == AF_INET6)
 480         && !memcmp(&ip->ip6.sin6_addr, prefix, 12)) {
 481                 memset(cip, 0, sizeof(*cip));
 482 #ifdef HAVE_SOCK_SIN_LEN
 483                 cip->ip.sin_len = sizeof(*cip);
 484 #endif
 485                 cip->ip.sin_family = AF_INET;
 486                 cip->ip.sin_port   = ip->ip6.sin6_port;
 487                 memcpy(&cip->ip.sin_addr, &ip->ip6.sin6_addr.s6_addr32[3], 4);
 488         }
 489 }
 490
 491 bool ctdb_same_ip(const ctdb_sock_addr *tip1, const ctdb_sock_addr *tip2)
 492 {
 493         ctdb_sock_addr ip1, ip2;
 494
 495         ctdb_canonicalize_ip(tip1, &ip1);
 496         ctdb_canonicalize_ip(tip2, &ip2);
 497
 498         if (ip1.sa.sa_family != ip2.sa.sa_family) {
 499                 return false;
 500         }
 501
 502         switch (ip1.sa.sa_family) {
 503         case AF_INET:
 504                 return ip1.ip.sin_addr.s_addr == ip2.ip.sin_addr.s_addr;
 505         case AF_INET6:
 506                 return !memcmp(&ip1.ip6.sin6_addr.s6_addr[0],
 507                                 &ip2.ip6.sin6_addr.s6_addr[0],
 508                                 16);
 509         default:
 510                 DEBUG(DEBUG_ERR, (__location__ " CRITICAL Can not compare sockaddr structures of type %u\n", ip1.sa.sa_family));
 511                 return false;
 512         }
 513
 514         return true;
 515 }
 516
 517 /*
 518   compare two ctdb_sock_addr structures
 519  */
 520 bool ctdb_same_sockaddr(const ctdb_sock_addr *ip1, const ctdb_sock_addr *ip2)
 521 {
 522         return ctdb_same_ip(ip1, ip2) && ip1->ip.sin_port == ip2->ip.sin_port;
 523 }
 524
 525 char *ctdb_addr_to_str(ctdb_sock_addr *addr)
 526 {
 527         static char cip[128] = "";
 528
 529         switch (addr->sa.sa_family) {
 530         case AF_INET:
 531                 inet_ntop(addr->ip.sin_family, &addr->ip.sin_addr, cip, sizeof(cip));
 532                 break;
 533         case AF_INET6:
 534                 inet_ntop(addr->ip6.sin6_family, &addr->ip6.sin6_addr, cip, sizeof(cip));
 535                 break;
 536         default:
 537                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 538         }
 539
 540         return cip;
 541 }
 542
 543 unsigned ctdb_addr_to_port(ctdb_sock_addr *addr)
 544 {
 545         switch (addr->sa.sa_family) {
 546         case AF_INET:
 547                 return ntohs(addr->ip.sin_port);
 548                 break;
 549         case AF_INET6:
 550                 return ntohs(addr->ip6.sin6_port);
 551                 break;
 552         default:
 553                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 554         }
 555
 556         return 0;
 557 }
 558
 559 void ctdb_block_signal(int signum)
 560 {
 561         sigset_t set;
 562         sigemptyset(&set);
 563         sigaddset(&set,signum);
 564         sigprocmask(SIG_BLOCK,&set,NULL);
 565 }
 566
 567 void ctdb_unblock_signal(int signum)
 568 {
 569         sigset_t set;
 570         sigemptyset(&set);
 571         sigaddset(&set,signum);
 572         sigprocmask(SIG_UNBLOCK,&set,NULL);
 573 }
 574
 575 struct debug_levels debug_levels[] = {
 576         {DEBUG_EMERG,   "EMERG"},
 577         {DEBUG_ALERT,   "ALERT"},
 578         {DEBUG_CRIT,    "CRIT"},
 579         {DEBUG_ERR,     "ERR"},
 580         {DEBUG_WARNING, "WARNING"},
 581         {DEBUG_NOTICE,  "NOTICE"},
 582         {DEBUG_INFO,    "INFO"},
 583         {DEBUG_DEBUG,   "DEBUG"},
 584         {0, NULL}
 585 };
 586
 587 const char *get_debug_by_level(int32_t level)
 588 {
 589         int i;
 590
 591         for (i=0; debug_levels[i].description != NULL; i++) {
 592                 if (debug_levels[i].level == level) {
 593                         return debug_levels[i].description;
 594                 }
 595         }
 596         return "Unknown";
 597 }
 598
 599 int32_t get_debug_by_desc(const char *desc)
 600 {
 601         int i;
 602
 603         for (i=0; debug_levels[i].description != NULL; i++) {
 604                 if (!strcmp(debug_levels[i].description, desc)) {
 605                         return debug_levels[i].level;
 606                 }
 607         }
 608
 609         return DEBUG_ERR;
 610 }
 611
 612 /* we don't lock future pages here; it would increase the chance that
 613  * we'd fail to mmap later on. */
 614 void ctdb_lockdown_memory(struct ctdb_context *ctdb)
 615 {
 616 #ifdef HAVE_MLOCKALL
 617         /* Extra stack, please! */
 618         char dummy[10000];
 619         memset(dummy, 0, sizeof(dummy));
 620
 621         if (ctdb->valgrinding) {
 622                 return;
 623         }
 624
 625         /* Avoid compiler optimizing out dummy. */
 626         mlock(dummy, sizeof(dummy));
 627         if (mlockall(MCL_CURRENT) != 0) {
 628                 DEBUG(DEBUG_WARNING,("Failed to lock memory: %s'\n",
 629                                      strerror(errno)));
 630         }
 631 #endif
 632 }
 633
 634 const char *ctdb_eventscript_call_names[] = {
 635         "init",
 636         "setup",
 637         "startup",
 638         "startrecovery",
 639         "recovered",
 640         "takeip",
 641         "releaseip",
 642         "stopped",
 643         "monitor",
 644         "status",
 645         "shutdown",
 646         "reload",
 647         "updateip",
 648         "ipreallocated"
 649 };