instance.cc 16.5 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"
unknown's avatar
unknown committed
24
#include "log.h"
25
#include "instance_map.h"
26
#include "priv.h"
unknown's avatar
unknown committed
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
  case -1:
unknown's avatar
unknown committed
159 160
    log_info("cannot create a new process to start instance '%s'.",
             (const char *) instance_options->instance_name);
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    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;
unknown's avatar
unknown committed
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;
unknown's avatar
unknown committed
185
  for (int i= 0; instance_options->argv[i] != 0; i++)
186
  {
unknown's avatar
unknown committed
187 188 189
    strcat(cmdline, "\"");
    strcat(cmdline, instance_options->argv[i]);
    strcat(cmdline, "\" ");
190 191 192 193
  }

  /* Start the child process */
  BOOL result=
unknown's avatar
unknown committed
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
                  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;

unknown's avatar
unknown committed
255 256
  log_info("starting instance '%s'...",
           (const char *) instance_name_buff);
257 258

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

  /* 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;
}


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

295

296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
/*
  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()
{
311 312 313 314 315 316
  /* clear crash flag */
  pthread_mutex_lock(&LOCK_instance);
  crashed= 0;
  pthread_mutex_unlock(&LOCK_instance);


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

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    /*
      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");
337 338
      return ER_CANNOT_START_INSTANCE;
    }
339 340

    return 0;
341 342 343 344 345 346
  }

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

347 348 349
/*
  The method sets the crash flag and wakes all waiters on
  COND_instance_stopped and COND_guardian
unknown's avatar
unknown committed
350

351 352
  SYNOPSYS
    set_crash_flag_n_wake_all()
unknown's avatar
unknown committed
353

354 355 356 357
  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.
358

359 360 361
  RETURN
    Function returns no value
*/
362

363
void Instance::set_crash_flag_n_wake_all()
364 365 366 367 368 369 370 371 372 373 374 375 376 377
{
  /* 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);
378 379 380
}


381

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


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


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

unknown's avatar
unknown committed
405

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

  if (options.mysqld_port)
417
    port= options.mysqld_port_val;
unknown's avatar
unknown committed
418 419 420 421

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

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

426
  pthread_mutex_lock(&LOCK_instance);
427 428

  mysql_init(&mysql);
429
  /* try to connect to a server with a fake username/password pair */
430 431 432 433
  if (mysql_real_connect(&mysql, LOCAL_HOST, username,
                         password,
                         NullS, port,
                         socket, 0))
434
  {
435
    /*
436 437
      We have successfully connected to the server using fake
      username/password. Write a warning to the logfile.
438
    */
unknown's avatar
unknown committed
439 440 441
    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.");
442
    pthread_mutex_unlock(&LOCK_instance);
443
    return_val= TRUE;                           /* server is alive */
444
  }
445
  else
unknown's avatar
unknown committed
446 447
    return_val= test(!strncmp(access_denied_message, mysql_error(&mysql),
                              sizeof(access_denied_message) - 1));
448 449

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

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


/*
  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()
{
470
  struct timespec timeout;
471
  uint waitchild= (uint)  DEFAULT_SHUTDOWN_DELAY;
472

473 474 475 476
  if (is_running())
  {
    if (options.shutdown_delay_val)
      waitchild= options.shutdown_delay_val;
477

478 479
    kill_instance(SIGTERM);
    /* sleep on condition to wait for SIGCHLD */
480

481 482 483 484
    timeout.tv_sec= time(NULL) + waitchild;
    timeout.tv_nsec= 0;
    if (pthread_mutex_lock(&LOCK_instance))
      return ER_STOP_INSTANCE;
485

486 487 488
    while (options.get_pid() != 0)              /* while server isn't stopped */
    {
      int status;
489

490 491 492 493 494 495
      status= pthread_cond_timedwait(&COND_instance_stopped,
                                     &LOCK_instance,
                                     &timeout);
      if (status == ETIMEDOUT || status == ETIME)
        break;
    }
496

497
    pthread_mutex_unlock(&LOCK_instance);
498

499
    kill_instance(SIGKILL);
500

501 502
    return 0;
  }
503 504 505 506

  return ER_INSTANCE_IS_NOT_STARTED;
}

507 508 509 510
#ifdef __WIN__

BOOL SafeTerminateProcess(HANDLE hProcess, UINT uExitCode)
{
unknown's avatar
unknown committed
511
  DWORD dwTID, dwCode, dwErr= 0;
512 513 514 515
  HANDLE hProcessDup= INVALID_HANDLE_VALUE;
  HANDLE hRT= NULL;
  HINSTANCE hKernel= GetModuleHandle("Kernel32");
  BOOL bSuccess= FALSE;
516

517
  BOOL bDup= DuplicateHandle(GetCurrentProcess(),
unknown's avatar
unknown committed
518
                             hProcess, GetCurrentProcess(), &hProcessDup,
519
                             PROCESS_ALL_ACCESS, FALSE, 0);
520 521 522

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

unknown's avatar
unknown committed
528
    pfnExitProc= GetProcAddress(hKernel, "ExitProcess");
529

unknown's avatar
unknown committed
530 531 532
    hRT= CreateRemoteThread((bDup) ? hProcessDup : hProcess, NULL, 0,
                            (LPTHREAD_START_ROUTINE)pfnExitProc,
                            (PVOID)uExitCode, 0, &dwTID);
533

unknown's avatar
unknown committed
534 535
    if (hRT == NULL)
      dwErr= GetLastError();
536 537
  }
  else
unknown's avatar
unknown committed
538
    dwErr= ERROR_PROCESS_ABORTED;
539

540
  if (hRT)
541
  {
unknown's avatar
unknown committed
542 543 544
    // Must wait process to terminate to
    // guarantee that it has exited...
    WaitForSingleObject((bDup) ? hProcessDup : hProcess, INFINITE);
545

unknown's avatar
unknown committed
546 547
    CloseHandle(hRT);
    bSuccess= TRUE;
548 549
  }

550
  if (bDup)
unknown's avatar
unknown committed
551
    CloseHandle(hProcessDup);
552

553
  if (!bSuccess)
unknown's avatar
unknown committed
554
    SetLastError(dwErr);
555 556

  return bSuccess;
unknown's avatar
unknown committed
557
}
558 559 560

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

570 571 572 573 574 575
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 */
  {
576 577 578 579 580
    if (kill(pid, signum) == 0)
    {
      /* Kill suceeded */
      if (signum == SIGKILL)      /* really killed instance with SIGKILL */
      {
unknown's avatar
unknown committed
581 582
        log_error("The instance '%s' is being stopped forcibly. Normally"
                  "it should not happen. Probably the instance has been"
583
                  "hanging. You should also check your IM setup",
unknown's avatar
unknown committed
584
                  (const char *) options.instance_name);
585 586 587 588
        /* After sucessful hard kill the pidfile need to be removed */
        options.unlink_pidfile();
      }
    }
589 590 591 592
  }
  return;
}

593 594 595 596 597 598 599 600 601
/*
  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);
}
602 603


unknown's avatar
unknown committed
604
int Instance::complete_initialization(Instance_map *instance_map_arg,
605
                                      const char *mysqld_path,
unknown's avatar
unknown committed
606
                                      uint instance_type)
607 608
{
  instance_map= instance_map_arg;
unknown's avatar
unknown committed
609
  return options.complete_initialization(mysqld_path, instance_type);
610
}