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