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