instance_options.cc 17.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* Copyright (C) 2004 MySQL AB

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

17
#if defined(__GNUC__) && defined(USE_PRAGMA_IMPLEMENTATION)
18 19 20 21
#pragma implementation
#endif

#include "instance_options.h"
22

23
#include <my_global.h>
24 25 26
#include <my_sys.h>
#include <m_string.h>

27 28 29 30 31 32 33
#include <signal.h>

#include "buffer.h"
#include "instance.h"
#include "log.h"
#include "parse_output.h"
#include "priv.h"
34 35 36 37 38


/* Create "mysqld ..." command in the buffer */

static inline int create_mysqld_command(Buffer *buf,
39 40
                                        const LEX_STRING *mysqld_path,
                                        const LEX_STRING *option)
41 42 43 44 45
{
  int position= 0;

  if (buf->get_size()) /* malloc succeeded */
  {
unknown's avatar
unknown committed
46
#ifdef __WIN__
47
    buf->append(position++, "\"", 1);
unknown's avatar
unknown committed
48
#endif
49 50
    buf->append(position, mysqld_path->str, mysqld_path->length);
    position+= mysqld_path->length;
unknown's avatar
unknown committed
51
#ifdef __WIN__
52
    buf->append(position++, "\"", 1);
unknown's avatar
unknown committed
53
#endif
54
    /* here the '\0' character is copied from the option string */
55
    buf->append(position, option->str, option->length + 1);
56

unknown's avatar
unknown committed
57
    return buf->is_error();
58
  }
unknown's avatar
unknown committed
59
  return 1;
60 61
}

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
static inline bool is_path_separator(char ch)
{
#if defined(__WIN__) || defined(__NETWARE__)
  /* On windows and netware more delimiters are possible */
  return ch == FN_LIBCHAR || ch == FN_DEVCHAR || ch == '/';
#else
  return ch == FN_LIBCHAR;                      /* Unixes */
#endif
}


static char *find_last_path_separator(char *path, uint length)
{
  while (length)
  {
    if (is_path_separator(path[length]))
      return path + length;
    length--;
  }
  return NULL; /* No path separator found */
}


85

86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
bool Instance_options::is_option_im_specific(const char *option_name)
{
  static const char *IM_SPECIFIC_OPTIONS[] =
  {
    "nonguarded",
    "mysqld-path",
    "shutdown-delay",
    NULL
  };

  for (int i= 0; IM_SPECIFIC_OPTIONS[i]; ++i)
  {
    if (!strcmp(option_name, IM_SPECIFIC_OPTIONS[i]))
      return TRUE;
  }

  return FALSE;
}


Instance_options::Instance_options()
  :mysqld_version(NULL), mysqld_socket(NULL), mysqld_datadir(NULL),
  mysqld_pid_file(NULL), mysqld_port(NULL), mysqld_port_val(0),
  nonguarded(NULL), shutdown_delay(NULL), shutdown_delay_val(0),
  filled_default_options(0)
{
  mysqld_path.str= NULL;
  mysqld_path.length= 0;

unknown's avatar
unknown committed
115 116 117
  mysqld_real_path.str= NULL;
  mysqld_real_path.length= 0;

118 119 120 121
  memset(logs, 0, sizeof(logs));
}


122 123 124 125 126 127 128
/*
  Get compiled-in value of default_option

  SYNOPSYS
    get_default_option()
    result            buffer to put found value
    result_len        buffer size
unknown's avatar
unknown committed
129
    option_name       the name of the option, prefixed with "--"
130 131 132 133 134 135 136 137 138 139

  DESCRIPTION

   Get compile-in value of requested option from server

  RETURN
    0 - ok
    1 - error occured
*/

unknown's avatar
unknown committed
140

141 142
int Instance_options::get_default_option(char *result, size_t result_len,
                                         const char *option_name)
143
{
144
  int rc= 1;
145
  LEX_STRING verbose_option=
146
    { C_STRING_WITH_LEN(" --no-defaults --verbose --help") };
147

148 149
  /* reserve space for the path + option + final '\0' */
  Buffer cmd(mysqld_path.length + verbose_option.length + 1);
150

151
  if (create_mysqld_command(&cmd, &mysqld_path, &verbose_option))
152 153 154 155
    goto err;

  /* +2 eats first "--" from the option string (E.g. "--datadir") */
  rc= parse_output_and_get_value(cmd.buffer, option_name + 2,
unknown's avatar
unknown committed
156
                                 result, result_len, GET_VALUE);
157
err:
unknown's avatar
unknown committed
158
  return rc;
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
}


/*
  Fill mysqld_version option (used at initialization stage)

  SYNOPSYS
    fill_instance_version()

  DESCRIPTION

  Get mysqld version string from "mysqld --version" output.

  RETURN
    0 - ok
    1 - error occured
*/

int Instance_options::fill_instance_version()
{
179 180
  char result[MAX_VERSION_LENGTH];
  LEX_STRING version_option=
181
    { C_STRING_WITH_LEN(" --no-defaults --version") };
182
  int rc= 1;
183
  Buffer cmd(mysqld_path.length + version_option.length + 1);
184

185
  if (create_mysqld_command(&cmd, &mysqld_path, &version_option))
186 187
    goto err;

188
  bzero(result, MAX_VERSION_LENGTH);
189

190 191
  rc= parse_output_and_get_value(cmd.buffer, "Ver", result,
                                 MAX_VERSION_LENGTH, GET_LINE);
192 193 194

  if (*result != '\0')
  {
195
    char *start;
196 197
    /* chop the newline from the end of the version string */
    result[strlen(result) - NEWLINE_LEN]= '\0';
198 199 200 201
    /* trim leading whitespaces */
    start= result;
    while (my_isspace(default_charset_info, *start))
      ++start;
202

203
    mysqld_version= strdup_root(&alloc, start);
204 205
  }
err:
206 207
  if (rc)
    log_error("fill_instance_version: Failed to get version of '%s'",
208
              mysqld_path.str);
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
  return rc;
}


/*
  Fill mysqld_real_path

  SYNOPSYS
    fill_mysqld_real_path()

  DESCRIPTION

  Get the real path to mysqld from "mysqld --help" output.
  Will print the realpath of mysqld between "Usage: " and "[OPTIONS]"

  This is needed if the mysqld_path variable is pointing at a
  script(for example libtool) or a symlink.

  RETURN
    0 - ok
    1 - error occured
*/

int Instance_options::fill_mysqld_real_path()
{
  char result[FN_REFLEN];
unknown's avatar
unknown committed
235
  LEX_STRING help_option=
236
    { C_STRING_WITH_LEN(" --no-defaults --help") };
237
  int rc= 1;
unknown's avatar
unknown committed
238
  Buffer cmd(mysqld_path.length + help_option.length);
239

unknown's avatar
unknown committed
240
  if (create_mysqld_command(&cmd, &mysqld_path, &help_option))
241 242 243 244 245 246 247 248 249 250 251 252 253 254
    goto err;

  bzero(result, FN_REFLEN);

  rc= parse_output_and_get_value(cmd.buffer, "Usage: ",
                                 result, FN_REFLEN,
                                 GET_LINE);

  if (*result != '\0')
  {
    char* options_str;
    /* chop the path of at [OPTIONS] */
    if ((options_str= strstr(result, "[OPTIONS]")))
      *options_str= '\0';
unknown's avatar
unknown committed
255 256
    mysqld_real_path.str= strdup_root(&alloc, result);
    mysqld_real_path.length= strlen(mysqld_real_path.str);
257 258 259 260
  }
err:
  if (rc)
    log_error("fill_mysqld_real_path: Failed to get real path of mysqld");
unknown's avatar
unknown committed
261
  return rc;
262 263 264
}


unknown's avatar
unknown committed
265
/*
266
  Fill various log options
unknown's avatar
unknown committed
267 268

  SYNOPSYS
269
    fill_log_options()
unknown's avatar
unknown committed
270 271 272

  DESCRIPTION

273 274 275
  Compute paths to enabled log files. If the path is not specified in the
  instance explicitly (I.e. log=/home/user/mysql.log), we try to guess the
  file name and placement.
unknown's avatar
unknown committed
276 277 278 279 280 281

  RETURN
    0 - ok
    1 - error occured
*/

282 283 284
int Instance_options::fill_log_options()
{
  Buffer buff;
unknown's avatar
unknown committed
285
  enum { MAX_LOG_OPTION_LENGTH= 256 };
286 287 288 289 290 291 292
  char datadir[MAX_LOG_OPTION_LENGTH];
  char hostname[MAX_LOG_OPTION_LENGTH];
  uint hostname_length;
  struct log_files_st
  {
    const char *name;
    uint length;
unknown's avatar
unknown committed
293
    char **value;
294
    const char *default_suffix;
unknown's avatar
unknown committed
295
  } logs_st[]=
296
  {
297 298 299
    {"--log-error", 11, &(logs[IM_LOG_ERROR]), ".err"},
    {"--log", 5, &(logs[IM_LOG_GENERAL]), ".log"},
    {"--log-slow-queries", 18, &(logs[IM_LOG_SLOW]), "-slow.log"},
300 301 302 303 304 305 306
    {NULL, 0, NULL, NULL}
  };
  struct log_files_st *log_files;

  /* compute hostname and datadir for the instance */
  if (mysqld_datadir == NULL)
  {
unknown's avatar
unknown committed
307
    if (get_default_option(datadir, MAX_LOG_OPTION_LENGTH, "--datadir"))
308 309
      goto err;
  }
unknown's avatar
unknown committed
310 311 312
  else
  {
    /* below is safe, as --datadir always has a value */
313
    strmake(datadir, mysqld_datadir, MAX_LOG_OPTION_LENGTH - 1);
unknown's avatar
unknown committed
314
  }
315 316 317 318 319 320 321 322

  if (gethostname(hostname,sizeof(hostname)-1) < 0)
    strmov(hostname, "mysql");

  hostname[MAX_LOG_OPTION_LENGTH - 1]= 0; /* Safety */
  hostname_length= strlen(hostname);


unknown's avatar
unknown committed
323
  for (log_files= logs_st; log_files->name; log_files++)
324
  {
unknown's avatar
unknown committed
325
    for (int i=0; (argv[i] != 0); i++)
326
    {
unknown's avatar
unknown committed
327
      if (!strncmp(argv[i], log_files->name, log_files->length))
328 329 330 331 332 333 334
      {
        /*
          This is really log_files->name option if and only if it is followed
          by '=', '\0' or space character. This way we can distinguish such
          options as '--log' and '--log-bin'. This is checked in the following
          two statements.
        */
unknown's avatar
unknown committed
335 336
        if (argv[i][log_files->length] == '\0' ||
            my_isspace(default_charset_info, argv[i][log_files->length]))
337 338 339 340 341 342 343
        {
          char full_name[MAX_LOG_OPTION_LENGTH];

          fn_format(full_name, hostname, datadir, "",
                    MY_UNPACK_FILENAME | MY_SAFE_PATH);


unknown's avatar
unknown committed
344
          if ((MAX_LOG_OPTION_LENGTH - strlen(full_name)) <=
345 346 347
              strlen(log_files->default_suffix))
            goto err;

unknown's avatar
unknown committed
348 349
          strmov(full_name + strlen(full_name), log_files->default_suffix);

unknown's avatar
unknown committed
350 351 352 353 354 355
          /*
            If there were specified two identical logfiles options,
            we would loose some memory in MEM_ROOT here. However
            this situation is not typical.
          */
          *(log_files->value)= strdup_root(&alloc, full_name);
356 357
        }

unknown's avatar
unknown committed
358
        if (argv[i][log_files->length] == '=')
359 360 361
        {
          char full_name[MAX_LOG_OPTION_LENGTH];

unknown's avatar
unknown committed
362
          fn_format(full_name, argv[i] +log_files->length + 1,
363 364
                    datadir, "", MY_UNPACK_FILENAME | MY_SAFE_PATH);

unknown's avatar
unknown committed
365
          if (!(*(log_files->value)= strdup_root(&alloc, full_name)))
366 367 368 369 370 371 372 373 374 375 376 377
            goto err;
        }
      }
    }
  }

  return 0;
err:
  return 1;
}


unknown's avatar
unknown committed
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
/*
  Get the full pid file name with path

  SYNOPSYS
    get_pid_filaname()
    result            buffer to sotre the pidfile value

  IMPLEMENTATION
    Get the data directory, then get the pid filename
    (which is always set for an instance), then load the
    full path with my_load_path(). It takes into account
    whether it is already an absolute path or it should be
    prefixed with the datadir and so on.

  RETURN
    0 - ok
    1 - error occured
*/

unknown's avatar
unknown committed
397
int Instance_options::get_pid_filename(char *result)
398 399 400
{
  char datadir[MAX_PATH_LEN];

unknown's avatar
unknown committed
401
  if (mysqld_datadir == NULL)
unknown's avatar
unknown committed
402 403 404 405 406
  {
    /* we might get an error here if we have wrong path to the mysqld binary */
    if (get_default_option(datadir, sizeof(datadir), "--datadir"))
      return 1;
  }
407
  else
408
    strxnmov(datadir, MAX_PATH_LEN - 1, mysqld_datadir, "/", NullS);
409 410

  /* get the full path to the pidfile */
411
  my_load_path(result, mysqld_pid_file, datadir);
unknown's avatar
unknown committed
412
  return 0;
413 414 415 416 417
}


int Instance_options::unlink_pidfile()
{
418
  return unlink(pid_file_with_path);
419 420 421 422 423
}


pid_t Instance_options::get_pid()
{
424
  FILE *pid_file_stream;
425 426

  /* get the pid */
unknown's avatar
unknown committed
427 428
  if ((pid_file_stream= my_fopen(pid_file_with_path,
                                O_RDONLY | O_BINARY, MYF(0))) != NULL)
429 430 431
  {
    pid_t pid;

432 433
    if (fscanf(pid_file_stream, "%i", &pid) != 1)
      pid= -1;
434 435 436
    my_fclose(pid_file_stream, MYF(0));
    return pid;
  }
unknown's avatar
unknown committed
437
  return 0;
438 439 440
}


441
int Instance_options::complete_initialization(const char *default_path)
442
{
unknown's avatar
unknown committed
443
  int arg_idx;
444
  const char *tmp;
unknown's avatar
unknown committed
445
  char *end;
446
  char bin_name_firstchar;
447

448
  if (!mysqld_path.str)
449
  {
450 451 452 453 454
    /*
      Need to copy the path to allocated memory, as convert_dirname() might
      need to change it
    */
    if (!(mysqld_path.str= alloc_root(&alloc, strlen(default_path) + 1)))
455
      goto err;
456
    strcpy(mysqld_path.str, default_path);
457
  }
458

459
  mysqld_path.length= strlen(mysqld_path.str);
460

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  /*
    If we found path with no slashes (end == NULL), we should not call
    convert_dirname() at all. As we have got relative path to the binary.
    That is, user supposes that mysqld resides in the same dir as
    mysqlmanager.
  */
  if ((end= find_last_path_separator(mysqld_path.str, mysqld_path.length)))
  {
    bin_name_firstchar= end[1];

    /*
      Below we will conver the path to mysqld in the case, it was given
      in a format of another OS (e.g. uses '/' instead of '\' etc).
      Here we strip the path to get rid of the binary name ("mysqld"),
      we do it by removing first letter of the binary name (e.g. 'm'
      in "mysqld"). Later we put it back.
    */
    end[1]= 0;

    /* convert dirname to the format of current OS */
    convert_dirname((char*)mysqld_path.str, mysqld_path.str, NullS);

    /* put back the first character of the binary name*/
    end[1]= bin_name_firstchar;
  }

487
  if (mysqld_port)
488
    mysqld_port_val= atoi(mysqld_port);
489 490 491 492

  if (shutdown_delay)
    shutdown_delay_val= atoi(shutdown_delay);

493
  if (!(tmp= strdup_root(&alloc, "--no-defaults")))
494 495
    goto err;

496
  if (!mysqld_pid_file)
497
  {
498 499
    char pidfilename[MAX_PATH_LEN];
    char hostname[MAX_PATH_LEN];
500 501 502 503 504

    /*
      If we created only one istance [mysqld], because no config. files were
      found, we would like to model mysqld pid file values.
    */
505

506
    if (!gethostname(hostname, sizeof(hostname) - 1))
unknown's avatar
unknown committed
507
    {
508 509
      if (Instance::is_mysqld_compatible_name(&instance_name))
        strxnmov(pidfilename, MAX_PATH_LEN - 1, hostname, ".pid", NullS);
510
      else
511 512
        strxnmov(pidfilename, MAX_PATH_LEN - 1, instance_name.str, "-",
                 hostname, ".pid", NullS);
unknown's avatar
unknown committed
513
    }
514
    else
unknown's avatar
unknown committed
515
    {
516 517
      if (Instance::is_mysqld_compatible_name(&instance_name))
        strxnmov(pidfilename, MAX_PATH_LEN - 1, "mysql", ".pid", NullS);
unknown's avatar
unknown committed
518
      else
519 520
        strxnmov(pidfilename, MAX_PATH_LEN - 1, instance_name.str, ".pid",
                 NullS);
unknown's avatar
unknown committed
521
    }
522

523 524 525
    Named_value option((char *) "pid-file", pidfilename);

    set_option(&option);
526 527
  }

unknown's avatar
unknown committed
528 529
  if (get_pid_filename(pid_file_with_path))
    goto err;
530

531
  /* we need to reserve space for the final zero + possible default options */
unknown's avatar
unknown committed
532
  if (!(argv= (char**)
533
        alloc_root(&alloc, (get_num_options() + 1
unknown's avatar
unknown committed
534 535
                            + MAX_NUMBER_OF_DEFAULT_OPTIONS) * sizeof(char*))))
    goto err;
536
  filled_default_options= 0;
537 538

  /* the path must be first in the argv */
539
  if (add_to_argv(mysqld_path.str))
540 541 542 543
    goto err;

  if (add_to_argv(tmp))
    goto err;
544

unknown's avatar
unknown committed
545
  arg_idx= filled_default_options;
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
  for (int opt_idx= 0; opt_idx < get_num_options(); ++opt_idx)
  {
    char option_str[MAX_OPTION_STR_LEN];
    Named_value option= get_option(opt_idx);

    if (is_option_im_specific(option.get_name()))
      continue;

    char *ptr= strxnmov(option_str, MAX_OPTION_LEN + 3, "--", option.get_name(),
                        NullS);

    if (option.get_value()[0])
      strxnmov(ptr, MAX_OPTION_LEN + 2, "=", option.get_value(), NullS);

    argv[arg_idx++]= strdup_root(&alloc, option_str);
  }

  argv[arg_idx]= 0;
564

565
  if (fill_log_options() || fill_mysqld_real_path() || fill_instance_version())
566
    goto err;
567

568 569 570 571 572 573 574
  return 0;

err:
  return 1;
}


575 576 577 578 579 580
bool Instance_options::set_option(Named_value *option)
{
  bool err_status;
  int idx= find_option(option->get_name());
  char *option_name_str;
  char *option_value_str;
581

582 583
  if (!(option_name_str= Named_value::alloc_str(option->get_name())))
    return TRUE;
584

585 586 587 588 589
  if (!(option_value_str= Named_value::alloc_str(option->get_value())))
  {
    Named_value::free_str(&option_name_str);
    return TRUE;
  }
590

591
  Named_value option_copy(option_name_str, option_value_str);
592

593 594 595 596
  if (idx < 0)
    err_status= options.add_element(&option_copy);
  else
    err_status= options.replace_element(idx, &option_copy);
597

598 599 600 601 602 603 604 605 606 607
  if (!err_status)
    update_var(option_copy.get_name(), option_copy.get_value());
  else
    option_copy.free();

  return err_status;
}


void Instance_options::unset_option(const char *option_name)
608
{
609 610 611 612
  int idx= find_option(option_name);

  if (idx < 0)
    return; /* the option has not been set. */
613

614 615 616 617 618 619 620 621
  options.remove_element(idx);

  update_var(option_name, NULL);
}


void Instance_options::update_var(const char *option_name,
                                  const char *option_value)
622
{
623
  struct options_st
624
  {
unknown's avatar
unknown committed
625
    const char *name;
626 627 628
    uint name_len;
    const char **var;
  } options_def[]=
629
  {
630 631 632 633 634 635 636 637
    {"socket",          6,  &mysqld_socket},
    {"port",            4,  &mysqld_port},
    {"datadir",         7,  &mysqld_datadir},
    {"pid-file",        8,  &mysqld_pid_file},
    {"nonguarded",      10, &nonguarded},
    {"mysqld-path",     11, (const char **) &mysqld_path.str},
    {"shutdown-delay",  14, &shutdown_delay},
    {NULL, 0, NULL}
unknown's avatar
unknown committed
638
  };
639

640 641 642 643 644 645 646 647 648
  for (options_st *opt= options_def; opt->name; ++opt)
  {
    if (!strncmp(opt->name, option_name, opt->name_len))
    {
      *(opt->var)= option_value;
      break;
    }
  }
}
649

650

651 652 653 654 655 656 657
int Instance_options::find_option(const char *option_name)
{
  for (int i= 0; i < get_num_options(); i++)
  {
    if (!strcmp(get_option(i).get_name(), option_name))
      return i;
  }
658

659
  return -1;
660 661
}

unknown's avatar
unknown committed
662

663 664
int Instance_options::add_to_argv(const char* option)
{
unknown's avatar
unknown committed
665
  DBUG_ASSERT(filled_default_options < MAX_NUMBER_OF_DEFAULT_OPTIONS);
666

unknown's avatar
unknown committed
667
  if (option)
unknown's avatar
unknown committed
668
    argv[filled_default_options++]= (char*) option;
669 670 671
  return 0;
}

672 673

/* function for debug purposes */
674 675 676
void Instance_options::print_argv()
{
  int i;
677 678 679 680

  printf("printing out an instance %s argv:\n",
         (const char *) instance_name.str);

681 682 683 684
  for (i=0; argv[i] != NULL; i++)
    printf("argv: %s\n", argv[i]);
}

685 686 687 688 689 690

/*
  We execute this function to initialize some options.
  Return value: 0 - ok. 1 - unable to allocate memory.
*/

691
int Instance_options::init(const LEX_STRING *instance_name_arg)
692
{
693
  instance_name.length= instance_name_arg->length;
694 695 696

  init_alloc_root(&alloc, MEM_ROOT_BLOCK_SIZE, 0);

697
  if (options.init())
unknown's avatar
unknown committed
698
    goto err;
699

700 701
  if (!(instance_name.str= strmake_root(&alloc, instance_name_arg->str,
                                        instance_name_arg->length)))
702 703 704 705 706 707 708 709 710 711 712 713 714
    goto err;

  return 0;

err:
  return 1;
}


Instance_options::~Instance_options()
{
  free_root(&alloc, MYF(0));
}