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