instance.cc 16.4 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.h"
22

23
#include "mysql_manager_error.h"
petr@mysql.com's avatar
petr@mysql.com committed
24
#include "log.h"
25
#include "instance_map.h"
26
#include "priv.h"
27
#include "portability.h"
28
#ifndef __WIN__
29
#include <sys/wait.h>
30
#endif
31
#include <my_sys.h>
32
#include <signal.h>
33
#include <m_string.h>
34
#include <mysql.h>
35

36 37 38 39

static void start_and_monitor_instance(Instance_options *old_instance_options,
                                       Instance_map *instance_map);

40
#ifndef __WIN__
41 42 43 44 45
typedef pid_t My_process_info;
#else
typedef PROCESS_INFORMATION My_process_info;
#endif

46 47 48 49 50 51 52
/*
  Proxy thread is a simple way to avoid all pitfalls of the threads
  implementation in the OS (e.g. LinuxThreads). With such a thread we
  don't have to process SIGCHLD, which is a tricky business if we want
  to do it in a portable way.
*/

53
pthread_handler_t proxy(void *arg)
54 55
{
  Instance *instance= (Instance *) arg;
56 57
  start_and_monitor_instance(&instance->options,
                             instance->get_map());
58 59 60
  return 0;
}

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 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 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
/*
  Wait for an instance

  SYNOPSYS
    wait_process()
    pi                   Pointer to the process information structure
                         (platform-dependent).

  RETURN
   0  -  Success
   1  -  Error
*/

#ifndef __WIN__
static int wait_process(My_process_info *pi)
{
  /*
    Here we wait for the child created. This process differs for systems
    running LinuxThreads and POSIX Threads compliant systems. This is because
    according to POSIX we could wait() for a child in any thread of the
    process. While LinuxThreads require that wait() is called by the thread,
    which created the child.
    On the other hand we could not expect mysqld to return the pid, we
    got in from fork(), to wait4() fucntion when running on LinuxThreads.
    This is because MySQL shutdown thread is not the one, which was created
    by our fork() call.
    So basically we have two options: whether the wait() call returns only in
    the creator thread, but we cannot use waitpid() since we have no idea
    which pid we should wait for (in fact it should be the pid of shutdown
    thread, but we don't know this one). Or we could use waitpid(), but
    couldn't use wait(), because it could return in any wait() in the program.
  */
  if (linuxthreads)
    wait(NULL);                               /* LinuxThreads were detected */
  else
    waitpid(*pi, NULL, 0);

  return 0;
}
#else
static int wait_process(My_process_info *pi)
{
  /* Wait until child process exits. */
  WaitForSingleObject(pi->hProcess, INFINITE);

  DWORD exitcode;
  ::GetExitCodeProcess(pi->hProcess, &exitcode);

  /* Close process and thread handles. */
  CloseHandle(pi->hProcess);
  CloseHandle(pi->hThread);

  /*
    GetExitCodeProces returns zero on failure. We should revert this value
    to report an error.
  */
  return (!exitcode);
}
#endif


/*
  Launch an instance

  SYNOPSYS
    start_process()
    instance_options     Pointer to the options of the instance to be
                         launched.
    pi                   Pointer to the process information structure
                         (platform-dependent).

  RETURN
   0  -  Success
   1  -  Cannot create an instance
*/

#ifndef __WIN__
static int start_process(Instance_options *instance_options,
                         My_process_info *pi)
{
141
#ifndef __QNX__
142
  *pi= fork();
143 144 145 146 147 148 149 150 151
#else
  /*
     On QNX one cannot use fork() in multithreaded environment and we
     should use spawn() or one of it's siblings instead.
     Here we use spawnv(), which  is a combination of fork() and execv()
     in one call. It returns the pid of newly created process (>0) or -1
  */
  *pi= spawnv(P_NOWAIT, instance_options->mysqld_path, instance_options->argv);
#endif
152 153

  switch (*pi) {
154
  case 0:                                       /* never happens on QNX */
155 156 157
    execv(instance_options->mysqld_path, instance_options->argv);
    /* exec never returns */
    exit(1);
158 159
  case -1:
    log_info("cannot create a new process to start instance %s",
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
             instance_options->instance_name);
    return 1;
  }
  return 0;
}
#else
static int start_process(Instance_options *instance_options,
                         My_process_info *pi)
{
  STARTUPINFO si;

  ZeroMemory(&si, sizeof(STARTUPINFO));
  si.cb= sizeof(STARTUPINFO);
  ZeroMemory(pi, sizeof(PROCESS_INFORMATION));

  int cmdlen= 0;
176 177 178 179 180 181 182
  for (int i= 0; instance_options->argv[i] != 0; i++)
    cmdlen+= strlen(instance_options->argv[i]) + 3;
  cmdlen++;   /* make room for the null */

  char *cmdline= new char[cmdlen];
  if (cmdline == NULL)
    return 1;
183 184
    
  cmdline[0]= 0;
185
  for (int i= 0; instance_options->argv[i] != 0; i++)
186
  {
187 188 189
    strcat(cmdline, "\"");
    strcat(cmdline, instance_options->argv[i]);
    strcat(cmdline, "\" ");
190 191 192 193
  }

  /* Start the child process */
  BOOL result=
194
    CreateProcess(NULL,          /* Put it all in cmdline */
195 196 197 198 199 200 201 202 203 204 205 206 207 208 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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
                  cmdline,       /* Command line */
                  NULL,          /* Process handle not inheritable */
                  NULL,          /* Thread handle not inheritable */
                  FALSE,         /* Set handle inheritance to FALSE */
                  0,             /* No creation flags */
                  NULL,          /* Use parent's environment block */
                  NULL,          /* Use parent's starting directory */
                  &si,           /* Pointer to STARTUPINFO structure */
                  pi);           /* Pointer to PROCESS_INFORMATION structure */
  delete cmdline;

  return (!result);
}
#endif

/*
  Fork child, exec an instance and monitor it.

  SYNOPSYS
    start_and_monitor_instance()
    old_instance_options   Pointer to the options of the instance to be
                           launched. This info is likely to become obsolete
                           when function returns from wait_process()
    instance_map           Pointer to the instance_map. We use it to protect
                           the instance from deletion, while we are working
                           with it.

  DESCRIPTION
    Fork a child, then exec and monitor it. When the child is dead,
    find appropriate instance (for this purpose we save its name),
    set appropriate flags and wake all threads waiting for instance
    to stop.

  RETURN
    Function returns no value
*/

static void start_and_monitor_instance(Instance_options *old_instance_options,
                                       Instance_map *instance_map)
{
  enum { MAX_INSTANCE_NAME_LEN= 512 };
  char instance_name_buff[MAX_INSTANCE_NAME_LEN];
  uint instance_name_len;
  Instance *current_instance;
  My_process_info process_info;

  /*
    Lock instance map to guarantee that no instances are deleted during
    strmake() and execv() calls.
  */
  instance_map->lock();

  /*
    Save the instance name in the case if Instance object we
    are using is destroyed. (E.g. by "FLUSH INSTANCES")
  */
  strmake(instance_name_buff, old_instance_options->instance_name,
          MAX_INSTANCE_NAME_LEN - 1);
  instance_name_len= old_instance_options->instance_name_len;

  log_info("starting instance %s", instance_name_buff);

  if (start_process(old_instance_options, &process_info))
serg@serg.mylan's avatar
serg@serg.mylan committed
258 259
  {
    instance_map->unlock();
260
    return;                                     /* error is logged */
serg@serg.mylan's avatar
serg@serg.mylan committed
261
  }
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283

  /* allow users to delete instances */
  instance_map->unlock();

  /* don't check for return value */
  wait_process(&process_info);

  current_instance= instance_map->find(instance_name_buff, instance_name_len);

  if (current_instance)
    current_instance->set_crash_flag_n_wake_all();

  return;
}


Instance_map *Instance::get_map()
{
  return instance_map;
}


284 285
void Instance::remove_pid()
{
petr@mysql.com's avatar
petr@mysql.com committed
286 287 288 289 290 291
  int pid;
  if ((pid= options.get_pid()) != 0)          /* check the pidfile */
    if (options.unlink_pidfile())             /* remove stalled pidfile */
      log_error("cannot remove pidfile for instance %i, this might be \
                since IM lacks permmissions or hasn't found the pidifle",
                options.instance_name);
292 293
}

294

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
/*
  The method starts an instance.

  SYNOPSYS
    start()

  RETURN
    0                             ok
    ER_CANNOT_START_INSTANCE      Cannot start instance
    ER_INSTANCE_ALREADY_STARTED   The instance on the specified port/socket
                                  is already started
*/

int Instance::start()
{
310 311 312 313 314 315
  /* clear crash flag */
  pthread_mutex_lock(&LOCK_instance);
  crashed= 0;
  pthread_mutex_unlock(&LOCK_instance);


316 317
  if (!is_running())
  {
318
    remove_pid();
319

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
    /*
      No need to monitor this thread in the Thread_registry, as all
      instances are to be stopped during shutdown.
    */
    pthread_t proxy_thd_id;
    pthread_attr_t proxy_thd_attr;
    int rc;

    pthread_attr_init(&proxy_thd_attr);
    pthread_attr_setdetachstate(&proxy_thd_attr, PTHREAD_CREATE_DETACHED);
    rc= pthread_create(&proxy_thd_id, &proxy_thd_attr, proxy,
                       this);
    pthread_attr_destroy(&proxy_thd_attr);
    if (rc)
    {
      log_error("Instance::start(): pthread_create(proxy) failed");
336 337
      return ER_CANNOT_START_INSTANCE;
    }
338 339

    return 0;
340 341 342 343 344 345
  }

  /* the instance is started already */
  return ER_INSTANCE_ALREADY_STARTED;
}

346 347 348
/*
  The method sets the crash flag and wakes all waiters on
  COND_instance_stopped and COND_guardian
petr@mysql.com's avatar
petr@mysql.com committed
349

350 351
  SYNOPSYS
    set_crash_flag_n_wake_all()
petr@mysql.com's avatar
petr@mysql.com committed
352

353 354 355 356
  DESCRIPTION
    The method is called when an instance is crashed or terminated.
    In the former case it might indicate that guardian probably should
    restart it.
357

358 359 360
  RETURN
    Function returns no value
*/
361

362
void Instance::set_crash_flag_n_wake_all()
363 364 365 366 367 368 369 370 371 372 373 374 375 376
{
  /* set instance state to crashed */
  pthread_mutex_lock(&LOCK_instance);
  crashed= 1;
  pthread_mutex_unlock(&LOCK_instance);

  /*
    Wake connection threads waiting for an instance to stop. This
    is needed if a user issued command to stop an instance via
    mysql connection. This is not the case if Guardian stop the thread.
  */
  pthread_cond_signal(&COND_instance_stopped);
  /* wake guardian */
  pthread_cond_signal(&instance_map->guardian->COND_guardian);
377 378 379
}


380

381 382 383
Instance::Instance(): crashed(0)
{
  pthread_mutex_init(&LOCK_instance, 0);
384
  pthread_cond_init(&COND_instance_stopped, 0);
385 386 387
}


388 389
Instance::~Instance()
{
390
  pthread_cond_destroy(&COND_instance_stopped);
391
  pthread_mutex_destroy(&LOCK_instance);
392 393 394 395 396 397 398 399 400 401
}


int Instance::is_crashed()
{
  int val;
  pthread_mutex_lock(&LOCK_instance);
  val= crashed;
  pthread_mutex_unlock(&LOCK_instance);
  return val;
402 403
}

petr@mysql.com's avatar
petr@mysql.com committed
404

405 406
bool Instance::is_running()
{
407
  MYSQL mysql;
petr@mysql.com's avatar
petr@mysql.com committed
408 409
  uint port= 0;
  const char *socket= NULL;
petr@mysql.com's avatar
petr@mysql.com committed
410 411 412
  static const char *password= "check_connection";
  static const char *username= "MySQL_Instance_Manager";
  static const char *access_denied_message= "Access denied for user";
413
  bool return_val;
petr@mysql.com's avatar
petr@mysql.com committed
414 415

  if (options.mysqld_port)
416
    port= options.mysqld_port_val;
petr@mysql.com's avatar
petr@mysql.com committed
417 418 419 420

  if (options.mysqld_socket)
    socket= strchr(options.mysqld_socket, '=') + 1;

421 422 423 424
  /* no port was specified => instance falled back to default value */
  if (!options.mysqld_port && !options.mysqld_socket)
    port= SERVER_DEFAULT_PORT;

425
  pthread_mutex_lock(&LOCK_instance);
426 427

  mysql_init(&mysql);
428
  /* try to connect to a server with a fake username/password pair */
429 430 431 432
  if (mysql_real_connect(&mysql, LOCAL_HOST, username,
                         password,
                         NullS, port,
                         socket, 0))
433
  {
434
    /*
435 436
      We have successfully connected to the server using fake
      username/password. Write a warning to the logfile.
437 438 439 440
    */
    log_info("The Instance Manager was able to log into you server \
             with faked compiled-in password while checking server status. \
             Looks like something is wrong.");
441
    pthread_mutex_unlock(&LOCK_instance);
442
    return_val= TRUE;                           /* server is alive */
443
  }
444
  else
petr@mysql.com's avatar
petr@mysql.com committed
445 446
    return_val= test(!strncmp(access_denied_message, mysql_error(&mysql),
                              sizeof(access_denied_message) - 1));
447 448

  mysql_close(&mysql);
449
  pthread_mutex_unlock(&LOCK_instance);
450 451

  return return_val;
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
}


/*
  Stop an instance.

  SYNOPSYS
    stop()

  RETURN:
    0                            ok
    ER_INSTANCE_IS_NOT_STARTED   Looks like the instance it is not started
    ER_STOP_INSTANCE             mysql_shutdown reported an error
*/

int Instance::stop()
{
469
  struct timespec timeout;
470
  uint waitchild= (uint)  DEFAULT_SHUTDOWN_DELAY;
471

472 473
  if (options.shutdown_delay_val)
    waitchild= options.shutdown_delay_val;
474

475 476
  kill_instance(SIGTERM);
  /* sleep on condition to wait for SIGCHLD */
477

478 479 480 481
  timeout.tv_sec= time(NULL) + waitchild;
  timeout.tv_nsec= 0;
  if (pthread_mutex_lock(&LOCK_instance))
    goto err;
482

483 484 485
  while (options.get_pid() != 0)              /* while server isn't stopped */
  {
    int status;
486

487
    status= pthread_cond_timedwait(&COND_instance_stopped,
488 489
                                   &LOCK_instance,
                                   &timeout);
monty@mysql.com's avatar
monty@mysql.com committed
490
    if (status == ETIMEDOUT || status == ETIME)
491 492
      break;
  }
493

494
  pthread_mutex_unlock(&LOCK_instance);
495

496
  kill_instance(SIGKILL);
497

498
  return 0;
499 500 501 502 503 504

  return ER_INSTANCE_IS_NOT_STARTED;
err:
  return ER_STOP_INSTANCE;
}

505 506 507 508
#ifdef __WIN__

BOOL SafeTerminateProcess(HANDLE hProcess, UINT uExitCode)
{
petr@mysql.com's avatar
petr@mysql.com committed
509
  DWORD dwTID, dwCode, dwErr= 0;
510 511 512 513
  HANDLE hProcessDup= INVALID_HANDLE_VALUE;
  HANDLE hRT= NULL;
  HINSTANCE hKernel= GetModuleHandle("Kernel32");
  BOOL bSuccess= FALSE;
514

515
  BOOL bDup= DuplicateHandle(GetCurrentProcess(),
petr@mysql.com's avatar
petr@mysql.com committed
516
                             hProcess, GetCurrentProcess(), &hProcessDup,
517
                             PROCESS_ALL_ACCESS, FALSE, 0);
518 519 520

  // Detect the special case where the process is
  // already dead...
521
  if (GetExitCodeProcess((bDup) ? hProcessDup : hProcess, &dwCode) &&
petr@mysql.com's avatar
petr@mysql.com committed
522
      (dwCode == STILL_ACTIVE))
523
  {
petr@mysql.com's avatar
petr@mysql.com committed
524
    FARPROC pfnExitProc;
525

petr@mysql.com's avatar
petr@mysql.com committed
526
    pfnExitProc= GetProcAddress(hKernel, "ExitProcess");
527

petr@mysql.com's avatar
petr@mysql.com committed
528 529 530
    hRT= CreateRemoteThread((bDup) ? hProcessDup : hProcess, NULL, 0,
                            (LPTHREAD_START_ROUTINE)pfnExitProc,
                            (PVOID)uExitCode, 0, &dwTID);
531

petr@mysql.com's avatar
petr@mysql.com committed
532 533
    if (hRT == NULL)
      dwErr= GetLastError();
534 535
  }
  else
petr@mysql.com's avatar
petr@mysql.com committed
536
    dwErr= ERROR_PROCESS_ABORTED;
537

538
  if (hRT)
539
  {
petr@mysql.com's avatar
petr@mysql.com committed
540 541 542
    // Must wait process to terminate to
    // guarantee that it has exited...
    WaitForSingleObject((bDup) ? hProcessDup : hProcess, INFINITE);
543

petr@mysql.com's avatar
petr@mysql.com committed
544 545
    CloseHandle(hRT);
    bSuccess= TRUE;
546 547
  }

548
  if (bDup)
petr@mysql.com's avatar
petr@mysql.com committed
549
    CloseHandle(hProcessDup);
550

551
  if (!bSuccess)
petr@mysql.com's avatar
petr@mysql.com committed
552
    SetLastError(dwErr);
553 554

  return bSuccess;
petr@mysql.com's avatar
petr@mysql.com committed
555
}
556 557 558

int kill(pid_t pid, int signum)
{
559
  HANDLE processhandle= ::OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid);
560 561 562 563 564 565 566
  if (signum == SIGTERM)
    ::SafeTerminateProcess(processhandle, 0);
  else
    ::TerminateProcess(processhandle, -1);
  return 0;
}
#endif
567

568 569 570 571 572 573 574 575 576 577 578 579 580
void Instance::kill_instance(int signum)
{
  pid_t pid;
  /* if there are no pid, everything seems to be fine */
  if ((pid= options.get_pid()) != 0)            /* get pid from pidfile */
  {
    /*
      If we cannot kill mysqld, then it has propably crashed.
      Let us try to remove staled pidfile and return successfully
      as mysqld is probably stopped.
    */
    if (!kill(pid, signum))
      options.unlink_pidfile();
petr@mysql.com's avatar
petr@mysql.com committed
581 582 583 584 585
    else if (signum == SIGKILL)      /* really killed instance with SIGKILL */
      log_error("The instance %s is being stopped forsibly. Normally \
                it should not happed. Probably the instance has been \
                hanging. You should also check your IM setup",
                options.instance_name);
586 587 588 589
  }
  return;
}

590 591 592 593 594 595 596 597 598
/*
  We execute this function to initialize instance parameters.
  Return value: 0 - ok. 1 - unable to init DYNAMIC_ARRAY.
*/

int Instance::init(const char *name_arg)
{
  return options.init(name_arg);
}
599 600


601
int Instance::complete_initialization(Instance_map *instance_map_arg,
602
                                      const char *mysqld_path,
petr@mysql.com's avatar
petr@mysql.com committed
603
                                      uint instance_type)
604 605
{
  instance_map= instance_map_arg;
petr@mysql.com's avatar
petr@mysql.com committed
606
  return options.complete_initialization(mysqld_path, instance_type);
607
}