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 "system/shmem.h"
  26 #include "../include/ctdb_private.h"
  27
  28 int LogLevel = DEBUG_NOTICE;
  29 int this_log_level = 0;
  30
  31 /*
  32   return error string for last error
  33 */
  34 const char *ctdb_errstr(struct ctdb_context *ctdb)
  35 {
  36         return ctdb->err_msg;
  37 }
  38
  39
  40 /*
  41   remember an error message
  42 */
  43 void ctdb_set_error(struct ctdb_context *ctdb, const char *fmt, ...)
  44 {
  45         va_list ap;
  46         talloc_free(ctdb->err_msg);
  47         va_start(ap, fmt);
  48         ctdb->err_msg = talloc_vasprintf(ctdb, fmt, ap);
  49         DEBUG(DEBUG_ERR,("ctdb error: %s\n", ctdb->err_msg));
  50         va_end(ap);
  51 }
  52
  53 /*
  54   a fatal internal error occurred - no hope for recovery
  55 */
  56 void ctdb_fatal(struct ctdb_context *ctdb, const char *msg)
  57 {
  58         DEBUG(DEBUG_ALERT,("ctdb fatal error: %s\n", msg));
  59         abort();
  60 }
  61
  62 /*
  63   like ctdb_fatal() but a core/backtrace would not be useful
  64 */
  65 void ctdb_die(struct ctdb_context *ctdb, const char *msg)
  66 {
  67         DEBUG(DEBUG_ALERT,("ctdb exiting with error: %s\n", msg));
  68         exit(1);
  69 }
  70
  71 /* Invoke an external program to do some sort of tracing on the CTDB
  72  * process.  This might block for a little while.  The external
  73  * program is specified by the environment variable
  74  * CTDB_EXTERNAL_TRACE.  This program should take one argument: the
  75  * pid of the process to trace.  Commonly, the program would be a
  76  * wrapper script around gcore.
  77  */
  78 void ctdb_external_trace(void)
  79 {
  80
  81         const char * t = getenv("CTDB_EXTERNAL_TRACE");
  82         char * cmd;
  83
  84         if (t == NULL) {
  85                 return;
  86         }
  87
  88         cmd = talloc_asprintf(NULL, "%s %lu", t, (unsigned long) getpid());
  89         DEBUG(DEBUG_WARNING,("begin external trace: %s\n", cmd));
  90         system(cmd);
  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 /*
 187   form a ctdb_rec_data record from a key/data pair
 188
 189   note that header may be NULL. If not NULL then it is included in the data portion
 190   of the record
 191  */
 192 struct ctdb_rec_data *ctdb_marshall_record(TALLOC_CTX *mem_ctx, uint32_t reqid,
 193                                            TDB_DATA key,
 194                                            struct ctdb_ltdb_header *header,
 195                                            TDB_DATA data)
 196 {
 197         size_t length;
 198         struct ctdb_rec_data *d;
 199
 200         length = offsetof(struct ctdb_rec_data, data) + key.dsize +
 201                 data.dsize + (header?sizeof(*header):0);
 202         d = (struct ctdb_rec_data *)talloc_size(mem_ctx, length);
 203         if (d == NULL) {
 204                 return NULL;
 205         }
 206         d->length = length;
 207         d->reqid = reqid;
 208         d->keylen = key.dsize;
 209         memcpy(&d->data[0], key.dptr, key.dsize);
 210         if (header) {
 211                 d->datalen = data.dsize + sizeof(*header);
 212                 memcpy(&d->data[key.dsize], header, sizeof(*header));
 213                 memcpy(&d->data[key.dsize+sizeof(*header)], data.dptr, data.dsize);
 214         } else {
 215                 d->datalen = data.dsize;
 216                 memcpy(&d->data[key.dsize], data.dptr, data.dsize);
 217         }
 218         return d;
 219 }
 220
 221
 222 /* helper function for marshalling multiple records */
 223 struct ctdb_marshall_buffer *ctdb_marshall_add(TALLOC_CTX *mem_ctx,
 224                                                struct ctdb_marshall_buffer *m,
 225                                                uint64_t db_id,
 226                                                uint32_t reqid,
 227                                                TDB_DATA key,
 228                                                struct ctdb_ltdb_header *header,
 229                                                TDB_DATA data)
 230 {
 231         struct ctdb_rec_data *r;
 232         size_t m_size, r_size;
 233         struct ctdb_marshall_buffer *m2;
 234
 235         r = ctdb_marshall_record(mem_ctx, reqid, key, header, data);
 236         if (r == NULL) {
 237                 talloc_free(m);
 238                 return NULL;
 239         }
 240
 241         if (m == NULL) {
 242                 m = talloc_zero_size(mem_ctx, offsetof(struct ctdb_marshall_buffer, data));
 243                 if (m == NULL) {
 244                         return NULL;
 245                 }
 246                 m->db_id = db_id;
 247         }
 248
 249         m_size = talloc_get_size(m);
 250         r_size = talloc_get_size(r);
 251
 252         m2 = talloc_realloc_size(mem_ctx, m,  m_size + r_size);
 253         if (m2 == NULL) {
 254                 talloc_free(m);
 255                 return NULL;
 256         }
 257
 258         memcpy(m_size + (uint8_t *)m2, r, r_size);
 259
 260         talloc_free(r);
 261
 262         m2->count++;
 263
 264         return m2;
 265 }
 266
 267 /* we've finished marshalling, return a data blob with the marshalled records */
 268 TDB_DATA ctdb_marshall_finish(struct ctdb_marshall_buffer *m)
 269 {
 270         TDB_DATA data;
 271         data.dptr = (uint8_t *)m;
 272         data.dsize = talloc_get_size(m);
 273         return data;
 274 }
 275
 276 /*
 277    loop over a marshalling buffer
 278
 279      - pass r==NULL to start
 280      - loop the number of times indicated by m->count
 281 */
 282 struct ctdb_rec_data *ctdb_marshall_loop_next(struct ctdb_marshall_buffer *m, struct ctdb_rec_data *r,
 283                                               uint32_t *reqid,
 284                                               struct ctdb_ltdb_header *header,
 285                                               TDB_DATA *key, TDB_DATA *data)
 286 {
 287         if (r == NULL) {
 288                 r = (struct ctdb_rec_data *)&m->data[0];
 289         } else {
 290                 r = (struct ctdb_rec_data *)(r->length + (uint8_t *)r);
 291         }
 292
 293         if (reqid != NULL) {
 294                 *reqid = r->reqid;
 295         }
 296
 297         if (key != NULL) {
 298                 key->dptr   = &r->data[0];
 299                 key->dsize  = r->keylen;
 300         }
 301         if (data != NULL) {
 302                 data->dptr  = &r->data[r->keylen];
 303                 data->dsize = r->datalen;
 304                 if (header != NULL) {
 305                         data->dptr += sizeof(*header);
 306                         data->dsize -= sizeof(*header);
 307                 }
 308         }
 309
 310         if (header != NULL) {
 311                 if (r->datalen < sizeof(*header)) {
 312                         return NULL;
 313                 }
 314                 *header = *(struct ctdb_ltdb_header *)&r->data[r->keylen];
 315         }
 316
 317         return r;
 318 }
 319
 320 /*
 321    This is used to canonicalize a ctdb_sock_addr structure.
 322 */
 323 void ctdb_canonicalize_ip(const ctdb_sock_addr *ip, ctdb_sock_addr *cip)
 324 {
 325         char prefix[12] = { 0,0,0,0,0,0,0,0,0,0,0xff,0xff };
 326
 327         memcpy(cip, ip, sizeof (*cip));
 328
 329         if ( (ip->sa.sa_family == AF_INET6)
 330         && !memcmp(&ip->ip6.sin6_addr, prefix, 12)) {
 331                 memset(cip, 0, sizeof(*cip));
 332 #ifdef HAVE_SOCK_SIN_LEN
 333                 cip->ip.sin_len = sizeof(*cip);
 334 #endif
 335                 cip->ip.sin_family = AF_INET;
 336                 cip->ip.sin_port   = ip->ip6.sin6_port;
 337                 memcpy(&cip->ip.sin_addr, &ip->ip6.sin6_addr.s6_addr[12], 4);
 338         }
 339 }
 340
 341 bool ctdb_same_ip(const ctdb_sock_addr *tip1, const ctdb_sock_addr *tip2)
 342 {
 343         ctdb_sock_addr ip1, ip2;
 344
 345         ctdb_canonicalize_ip(tip1, &ip1);
 346         ctdb_canonicalize_ip(tip2, &ip2);
 347
 348         if (ip1.sa.sa_family != ip2.sa.sa_family) {
 349                 return false;
 350         }
 351
 352         switch (ip1.sa.sa_family) {
 353         case AF_INET:
 354                 return ip1.ip.sin_addr.s_addr == ip2.ip.sin_addr.s_addr;
 355         case AF_INET6:
 356                 return !memcmp(&ip1.ip6.sin6_addr.s6_addr[0],
 357                                 &ip2.ip6.sin6_addr.s6_addr[0],
 358                                 16);
 359         default:
 360                 DEBUG(DEBUG_ERR, (__location__ " CRITICAL Can not compare sockaddr structures of type %u\n", ip1.sa.sa_family));
 361                 return false;
 362         }
 363
 364         return true;
 365 }
 366
 367 /*
 368   compare two ctdb_sock_addr structures
 369  */
 370 bool ctdb_same_sockaddr(const ctdb_sock_addr *ip1, const ctdb_sock_addr *ip2)
 371 {
 372         return ctdb_same_ip(ip1, ip2) && ip1->ip.sin_port == ip2->ip.sin_port;
 373 }
 374
 375 char *ctdb_addr_to_str(ctdb_sock_addr *addr)
 376 {
 377         static char cip[128] = "";
 378
 379         switch (addr->sa.sa_family) {
 380         case AF_INET:
 381                 inet_ntop(addr->ip.sin_family, &addr->ip.sin_addr, cip, sizeof(cip));
 382                 break;
 383         case AF_INET6:
 384                 inet_ntop(addr->ip6.sin6_family, &addr->ip6.sin6_addr, cip, sizeof(cip));
 385                 break;
 386         default:
 387                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 388                 ctdb_external_trace();
 389         }
 390
 391         return cip;
 392 }
 393
 394 unsigned ctdb_addr_to_port(ctdb_sock_addr *addr)
 395 {
 396         switch (addr->sa.sa_family) {
 397         case AF_INET:
 398                 return ntohs(addr->ip.sin_port);
 399                 break;
 400         case AF_INET6:
 401                 return ntohs(addr->ip6.sin6_port);
 402                 break;
 403         default:
 404                 DEBUG(DEBUG_ERR, (__location__ " ERROR, unknown family %u\n", addr->sa.sa_family));
 405         }
 406
 407         return 0;
 408 }
 409
 410 struct debug_levels debug_levels[] = {
 411         {DEBUG_EMERG,   "EMERG"},
 412         {DEBUG_ALERT,   "ALERT"},
 413         {DEBUG_CRIT,    "CRIT"},
 414         {DEBUG_ERR,     "ERR"},
 415         {DEBUG_WARNING, "WARNING"},
 416         {DEBUG_NOTICE,  "NOTICE"},
 417         {DEBUG_INFO,    "INFO"},
 418         {DEBUG_DEBUG,   "DEBUG"},
 419         {0, NULL}
 420 };
 421
 422 const char *get_debug_by_level(int32_t level)
 423 {
 424         int i;
 425
 426         for (i=0; debug_levels[i].description != NULL; i++) {
 427                 if (debug_levels[i].level == level) {
 428                         return debug_levels[i].description;
 429                 }
 430         }
 431         return "Unknown";
 432 }
 433
 434 int32_t get_debug_by_desc(const char *desc)
 435 {
 436         int i;
 437
 438         for (i=0; debug_levels[i].description != NULL; i++) {
 439                 if (!strcasecmp(debug_levels[i].description, desc)) {
 440                         return debug_levels[i].level;
 441                 }
 442         }
 443
 444         return DEBUG_ERR;
 445 }
 446
 447 /* we don't lock future pages here; it would increase the chance that
 448  * we'd fail to mmap later on. */
 449 void ctdb_lockdown_memory(struct ctdb_context *ctdb)
 450 {
 451 #if defined(HAVE_MLOCKALL) && !defined(_AIX_)
 452         /* Extra stack, please! */
 453         char dummy[10000];
 454         memset(dummy, 0, sizeof(dummy));
 455
 456         if (ctdb->valgrinding) {
 457                 return;
 458         }
 459
 460         /* Ignore when running in local daemons mode */
 461         if (getuid() != 0) {
 462                 return;
 463         }
 464
 465         /* Avoid compiler optimizing out dummy. */
 466         mlock(dummy, sizeof(dummy));
 467         if (mlockall(MCL_CURRENT) != 0) {
 468                 DEBUG(DEBUG_WARNING,("Failed to lockdown memory: %s'\n",
 469                                      strerror(errno)));
 470         }
 471 #endif
 472 }
 473
 474 const char *ctdb_eventscript_call_names[] = {
 475         "init",
 476         "setup",
 477         "startup",
 478         "startrecovery",
 479         "recovered",
 480         "takeip",
 481         "releaseip",
 482         "stopped",
 483         "monitor",
 484         "status",
 485         "shutdown",
 486         "reload",
 487         "updateip",
 488         "ipreallocated"
 489 };
 490
 491 /* Runstate handling */
 492 static struct {
 493         enum ctdb_runstate runstate;
 494         const char * label;
 495 } runstate_map[] = {
 496         { CTDB_RUNSTATE_UNKNOWN, "UNKNOWN" },
 497         { CTDB_RUNSTATE_INIT, "INIT" },
 498         { CTDB_RUNSTATE_SETUP, "SETUP" },
 499         { CTDB_RUNSTATE_FIRST_RECOVERY, "FIRST_RECOVERY" },
 500         { CTDB_RUNSTATE_STARTUP, "STARTUP" },
 501         { CTDB_RUNSTATE_RUNNING, "RUNNING" },
 502         { CTDB_RUNSTATE_SHUTDOWN, "SHUTDOWN" },
 503         { -1, NULL },
 504 };
 505
 506 const char *runstate_to_string(enum ctdb_runstate runstate)
 507 {
 508         int i;
 509         for (i=0; runstate_map[i].label != NULL ; i++) {
 510                 if (runstate_map[i].runstate == runstate) {
 511                         return runstate_map[i].label;
 512                 }
 513         }
 514
 515         return runstate_map[0].label;
 516 }
 517
 518 enum ctdb_runstate runstate_from_string(const char *label)
 519 {
 520         int i;
 521         for (i=0; runstate_map[i].label != NULL; i++) {
 522                 if (strcasecmp(runstate_map[i].label, label) == 0) {
 523                         return runstate_map[i].runstate;
 524                 }
 525         }
 526
 527         return CTDB_RUNSTATE_UNKNOWN;
 528 }
 529
 530 void ctdb_set_runstate(struct ctdb_context *ctdb, enum ctdb_runstate runstate)
 531 {
 532         if (runstate <= ctdb->runstate) {
 533                 ctdb_fatal(ctdb, "runstate must always increase");
 534         }
 535
 536         DEBUG(DEBUG_NOTICE,("Set runstate to %s (%d)\n",
 537                             runstate_to_string(runstate), runstate));
 538         ctdb->runstate = runstate;
 539 }
 540
 541 void ctdb_mkdir_p_or_die(struct ctdb_context *ctdb, const char *dir, int mode)
 542 {
 543         int ret;
 544
 545         ret = mkdir_p(dir, mode);
 546         if (ret != 0) {
 547                 DEBUG(DEBUG_ALERT,
 548                       ("ctdb exiting with error: "
 549                        "failed to create directory \"%s\" (%s)\n",
 550                        dir, strerror(errno)));
 551                 exit(1);
 552         }
 553 }