WL#4189

- dynamic configuration support
 - safe process
 - cleanups
 - create new suite for fedarated

mysql-test/lib/My/SafeProcess/Base.pm

@@ -0,0 +1,236 @@
+# -*- cperl -*-
+# Copyright (C) 2004-2006 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; version 2 of the License.
+#
+# 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+# This is a library file used by the Perl version of mysql-test-run,
+# and is part of the translation of the Bourne shell script with the
+# same name.
+
+use strict;
+
+package My::SafeProcess::Base;
+
+#
+# Utility functions for Process management
+#
+
+use Carp;
+use IO::Pipe;
+
+use base qw(Exporter);
+our @EXPORT= qw(create_process);
+
+
+sub winpid {
+  my ($pid)= @_;
+
+  return undef unless $^O eq "cygwin";
+
+  # The child get a new winpid when the exec takes
+  # place, wait for that to happen
+  my $winpid;
+  my $delay= 0;
+  do
+  {
+    # Yield to the child
+    select(undef, undef, undef, $delay);
+    # Increase the delay slightly for each loop
+    $delay += 0.000001;
+
+    $winpid= Cygwin::pid_to_winpid($pid);
+
+  } until ($winpid != $pid);
+
+  return $winpid;
+}
+
+
+
+#
+# safe_fork
+#   Retry a couple of times if fork returns EAGAIN
+#
+sub _safe_fork {
+  my $retries= 5;
+  my $pid;
+
+ FORK:
+  {
+    $pid= fork;
+    if ( not defined($pid)) {
+
+      croak("fork failed after: $!") if (!$retries--);
+
+      warn("fork failed sleep 1 second and redo: $!");
+      sleep(1);
+      redo FORK;
+    }
+  }
+
+  return $pid;
+};
+
+
+#
+# Decode exit status
+#
+sub exit_status {
+  my $self= shift;
+  my $raw= $self->{EXIT_STATUS};
+
+  croak("Can't call exit_status before process has died")
+    unless defined $raw;
+
+  if ($raw & 127)
+  {
+    # Killed by signal
+    my $signal_num=  $raw & 127;
+    my $dumped_core= $raw & 128;
+    return 1; # Return error code
+  }
+  else
+  {
+    # Normal process exit
+    return $raw >> 8;
+  };
+}
+
+
+#
+# Create a new process
+# Return pid of the new process
+#
+sub create_process {
+  my %opts=
+    (
+     @_
+    );
+
+  my $path     = delete($opts{'path'})    or die "path required";
+  my $args     = delete($opts{'args'})    or die "args required";
+  my $input    = delete($opts{'input'});
+  my $output   = delete($opts{'output'});
+  my $error    = delete($opts{'error'});
+
+  my $open_mode= $opts{append} ? ">>" : ">";
+
+  if ($^O eq "MSWin32"){
+
+    #printf STDERR "stdin %d, stdout %d, stderr %d\n",
+    #    fileno STDIN, fileno STDOUT, fileno STDERR;
+
+    # input output redirect
+    my ($oldin, $oldout, $olderr);
+    open $oldin,  '<&', \*STDIN  or die "Failed to save old stdin: $!";
+    open $oldout, '>&', \*STDOUT or die "Failed to save old stdout: $!";
+    open $olderr, '>&', \*STDERR or die "Failed to save old stderr: $!";
+
+    if ( $input ) {
+      if ( ! open(STDIN, "<", $input) ) {
+	croak("can't redirect STDIN to '$input': $!");
+      }
+    }
+
+    if ( $output ) {
+      if ( ! open(STDOUT, $open_mode, $output) ) {
+	croak("can't redirect STDOUT to '$output': $!");
+      }
+    }
+
+    if ( $error ) {
+      if ( $output eq $error ) {
+	if ( ! open(STDERR, ">&STDOUT") ) {
+	  croak("can't dup STDOUT: $!");
+	}
+      }
+      elsif ( ! open(STDERR, $open_mode, $error) ) {
+	croak("can't redirect STDERR to '$error': $!");
+      }
+    }
+
+
+    # Magic use of 'system(1, @args)' to spawn a process
+    # and get a proper Win32 pid
+    unshift (@$args, $path);
+    my $pid= system(1, @$args);
+    if ( $pid == 0 ){
+      print $olderr "create_process failed: $^E\n";
+      die "create_process failed: $^E";
+    }
+
+    # Retore IO redirects
+    open STDERR, '>&', $olderr
+      or croak("unable to reestablish STDERR");
+    open STDOUT, '>&', $oldout
+      or croak("unable to reestablish STDOUT");
+    open STDIN, '<&', $oldin
+      or croak("unable to reestablish STDIN");
+    #printf STDERR "stdin %d, stdout %d, stderr %d\n",
+    #    fileno STDIN, fileno STDOUT, fileno STDERR;
+    return wantarray ? ($pid, $pid) : $pid;
+
+  }
+
+  local $SIG{PIPE}= sub { print STDERR "Got signal $@\n"; };
+  my $pipe= IO::Pipe->new();
+  my $pid= _safe_fork();
+  if ($pid){
+    # Parent
+    $pipe->reader();
+    my $line= <$pipe>; # Wait for child to say it's ready
+    return wantarray ? ($pid, winpid($pid)) : $pid;
+  }
+
+  $SIG{INT}= 'DEFAULT';
+
+  # Make this process it's own process group to be able to kill
+  # it and any childs(that hasn't changed group themself)
+  setpgrp(0,0) if $opts{setpgrp};
+
+  if ( $output and !open(STDOUT, $open_mode, $output) ) {
+    croak("can't redirect STDOUT to '$output': $!");
+  }
+
+  if ( $error ) {
+    if ( defined $output and $output eq $error ) {
+      if ( ! open(STDERR, ">&STDOUT") ) {
+	croak("can't dup STDOUT: $!");
+      }
+    }
+    elsif ( ! open(STDERR, $open_mode, $error) ) {
+      croak("can't redirect STDERR to '$error': $!");
+    }
+  }
+
+  if ( $input ) {
+    if ( ! open(STDIN, "<", $input) ) {
+      croak("can't redirect STDIN to '$input': $!");
+    }
+  }
+
+  # Tell parent to continue
+  $pipe->writer();
+  print $pipe "ready\n";
+
+  if ( !exec($path, @$args) ){
+    croak("Failed to exec '$path': $!");
+  }
+
+  croak("Should never come here");
+
+}
+
+1;
+

mysql-test/lib/My/SafeProcess/safe_kill_win.cc

@@ -0,0 +1,56 @@
+/* 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; version 2 of the License.
+
+   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 */
+
+
+/*
+  Utility program used to signal a safe_process it's time to shutdown
+
+  Usage:
+    safe_kill <pid>
+*/
+
+#include <windows.h>
+#include <stdio.h>
+
+int main(int argc, const char** argv )
+{
+  DWORD pid= -1;
+  HANDLE shutdown_event;
+  char safe_process_name[32]= {0};
+
+  if (argc != 2) {
+    fprintf(stderr, "safe_kill <pid>\n");
+    exit(2);
+  }
+  pid= atoi(argv[1]);
+
+  _snprintf(safe_process_name, sizeof(safe_process_name), "safe_process[%d]", pid);
+
+  /* Open the event to signal */
+  if ((shutdown_event=
+    OpenEvent(EVENT_MODIFY_STATE, FALSE, safe_process_name)) == NULL){
+    fprintf(stderr, "Failed to open shutdown_event\n");
+    exit(1);
+  }
+
+  if(SetEvent(shutdown_event) == 0) {
+    fprintf(stderr, "Failed to signal shutdown_event\n");
+    CloseHandle(shutdown_event);
+    exit(1);
+  }
+  CloseHandle(shutdown_event);
+  exit(0);
+}
+

mysql-test/lib/My/SafeProcess/safe_process.pl

@@ -0,0 +1,141 @@
+#!/usr/bin/perl
+# -*- cperl -*-
+
+use strict;
+use warnings;
+
+use Time::localtime;
+use lib 'lib';
+use My::SafeProcess::Base;
+use POSIX qw(WNOHANG);
+
+###########################################################################
+# Util functions
+###########################################################################
+
+#
+#Print message to stderr
+#
+my $verbose= 0;
+sub message {
+  if ($verbose > 0){
+    my $tm= localtime();
+    my $timestamp= sprintf("%02d%02d%02d %2d:%02d:%02d",
+			   $tm->year % 100, $tm->mon+1, $tm->mday,
+			   $tm->hour, $tm->min, $tm->sec);
+    print STDERR $timestamp, " monitor[$$]: ", @_, "\n";
+  }
+}
+
+
+###########################################################################
+# Main program
+###########################################################################
+
+my $terminated= 0;
+
+# Protect against being killed in the middle
+# of child creation, just set the terminated flag
+# to make sure the child will be killed off
+# when program is ready to do that
+$SIG{TERM}= sub { message("!Got signal @_"); $terminated= 1; };
+$SIG{INT}= sub { message("!Got signal @_"); $terminated= 1; };
+
+my $parent_pid= getppid();
+
+use Getopt::Long;
+GetOptions(
+	   'verbose'            => \$verbose,
+	  ) or die "GetOptions failed";
+shift(@ARGV) if defined($ARGV[0]) and $ARGV[0] eq "--";
+my $path=       shift(@ARGV); # Executable
+
+die "usage:\n" .
+    " safe_process.pl [opts] -- <path> [<args> [...<args_n>]]"
+  unless defined $path;
+
+
+message("started");
+#message("path: '$path'");
+message("parent: $parent_pid");
+
+# Start process to monitor
+my $child_pid=
+  create_process(
+		 path     => $path,
+		 args     => \@ARGV,
+		 setpgrp  => 1,
+		);
+message("Started child $child_pid");
+
+eval {
+  sub handle_signal {
+    $terminated= 1;
+    message("Got signal @_");
+
+    # Ignore all signals
+    foreach my $name (keys %SIG){
+      $SIG{$name}= 'IGNORE';
+    }
+
+    die "signaled\n";
+  };
+  local $SIG{TERM}= \&handle_signal;
+  local $SIG{INT}=  \&handle_signal;
+  local $SIG{CHLD}= sub {
+    message("Got signal @_");
+    kill(9, -$child_pid);
+    my $ret= waitpid($child_pid, 0);
+    if ($? & 127){
+      exit(65); # Killed by signal
+    }
+    exit($? >> 8);
+  };
+
+  # Monitoring loop
+  while(!$terminated) {
+
+    # Check if parent is still alive
+    if (kill(0, $parent_pid) < 1){
+      message("Parent is not alive anymore");
+      last;
+    }
+
+    # Wait for child to terminate but wakeup every
+    # second to also check that parent is still alive
+    my $ret_pid;
+    $ret_pid= waitpid($child_pid, &WNOHANG);
+    if ($ret_pid == $child_pid) {
+      # Process has exited, collect return status
+      my $ret_code= $? >> 8;
+      message("Child exit: $ret_code");
+      # Exit with exit status of the child
+      exit ($ret_code);
+    }
+    sleep(1);
+  }
+};
+if ( $@ ) {
+  # The monitoring loop should have been
+  # broken by handle_signal
+  warn "Unexpected: $@" unless ( $@ =~ /signaled/ );
+}
+
+# Use negative pid in order to kill the whole
+# process group
+#
+my $ret= kill(9, -$child_pid);
+message("Killed child: $child_pid, ret: $ret");
+if ($ret > 0) {
+  message("Killed child: $child_pid");
+  # Wait blocking for the child to return
+  my $ret_pid= waitpid($child_pid, 0);
+  if ($ret_pid != $child_pid){
+    message("unexpected pid $ret_pid returned from waitpid($child_pid)");
+  }
+}
+
+message("DONE!");
+exit (1);
+
+

mysql-test/lib/My/SafeProcess/safe_process_win.cc

@@ -0,0 +1,312 @@
+/* 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; version 2 of the License.
+
+   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 */
+
+
+/*
+  Utility program that encapsulates process creation, monitoring
+  and bulletproof process cleanup
+
+  Usage:
+    safe_process [options to safe_process] -- progname arg1 ... argn
+
+  To safeguard mysqld you would invoke safe_process with a few options
+  for safe_process itself followed by a double dash to indicate start
+  of the command line for the program you really want to start
+
+  $> safe_process --output=output.log -- mysqld --datadir=var/data1 ...
+
+  This would redirect output to output.log and then start mysqld,
+  once it has done that it will continue to monitor the child as well
+  as the parent.
+
+  The safe_process then checks the follwing things:
+  1. Child exits, propagate the childs return code to the parent
+     by exiting with the same return code as the child.
+
+  2. Parent dies, immediately kill the child and exit, thus the
+     parent does not need to properly cleanup any child, it is handled
+     automatically.
+
+  3. Signal's recieced by the process will trigger same action as 2)
+
+  4. The named event "safe_process[pid]" can be signaled and will
+     trigger same action as 2)
+
+  WARNING! Be careful when using ProcessExplorer, since it will open
+           a handle to each process(and maybe also the Job), the process
+           spawned by safe_process will not be closed off when safe_process
+           is killed.
+*/
+
+/* Requires Windows 2000 or higher */
+#define _WIN32_WINNT 0x0500
+
+#include <windows.h>
+#include <stdio.h>
+#include <tlhelp32.h>
+#include <signal.h>
+
+static int verbose= 0;
+static char safe_process_name[32]= {0};
+
+static void message(const char* fmt, ...)
+{
+  if (!verbose)
+    return;
+  va_list args;
+  fprintf(stderr, "%s: ", safe_process_name);
+  va_start(args, fmt);
+  vfprintf(stderr, fmt, args);
+  fprintf(stderr, "\n");
+  va_end(args);
+  fflush(stderr);
+}
+
+
+static void die(const char* fmt, ...)
+{
+  va_list args;
+  fprintf(stderr, "%s: FATAL ERROR, ", safe_process_name);
+  va_start(args, fmt);
+  vfprintf(stderr, fmt, args);
+  fprintf(stderr, "\n");
+  va_end(args);
+  if (int last_err= GetLastError())
+    fprintf(stderr, "error: %d, %s\n", last_err, strerror(last_err));
+  exit(1);
+}
+
+
+DWORD get_parent_pid(DWORD pid)
+{
+  HANDLE snapshot;
+  DWORD parent_pid= -1;
+  PROCESSENTRY32 pe32;
+  pe32.dwSize= sizeof(PROCESSENTRY32);
+
+  snapshot= CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
+  if (snapshot == INVALID_HANDLE_VALUE)
+    die("CreateToolhelp32Snapshot failed");
+
+  if (!Process32First(snapshot, &pe32))
+  {
+    CloseHandle(snapshot);
+    die("Process32First failed");
+  }
+
+  do
+  {
+    if (pe32.th32ProcessID == pid)
+      parent_pid= pe32.th32ParentProcessID;
+  } while(Process32Next( snapshot, &pe32));
+  CloseHandle(snapshot);
+
+  if (parent_pid == -1)
+    die("Could not find parent pid");
+
+  return parent_pid;
+}
+
+
+enum {
+  PARENT,
+  CHILD,
+  EVENT,
+  NUM_HANDLES
+};
+
+
+HANDLE shutdown_event;
+void handle_signal (int signal)
+{
+  message("Got signal: %d", signal);
+  if(SetEvent(shutdown_event) == 0) {
+    /* exit safe_process and (hopefully) kill off the child */
+    die("Failed to SetEvent");
+  }
+}
+
+
+int main(int argc, const char** argv )
+{
+  char child_args[4096]= {0};
+  DWORD pid= GetCurrentProcessId();
+  DWORD parent_pid= get_parent_pid(pid);
+  HANDLE job_handle;
+  HANDLE wait_handles[NUM_HANDLES]= {0};
+  PROCESS_INFORMATION process_info= {0};
+
+  sprintf(safe_process_name, "safe_process[%d]", pid);
+
+  /* Create an event for the signal handler */
+  if ((shutdown_event=
+       CreateEvent(NULL, TRUE, FALSE, safe_process_name)) == NULL)
+    die("Failed to create shutdown_event");
+  wait_handles[EVENT]= shutdown_event;
+
+  signal(SIGINT,   handle_signal);
+  signal(SIGBREAK, handle_signal);
+  signal(SIGTERM,  handle_signal);
+
+  message("Started");
+
+  /* Parse arguments */
+  for (int i= 1; i < argc; i++) {
+    const char* arg= argv[i];
+	char* to= child_args;
+    if (strcmp(arg, "--") == 0 && strlen(arg) == 2) {
+      /* Got the "--" delimiter */
+      if (i >= argc)
+        die("No real args -> nothing to do");
+      /* Copy the remaining args to child_arg */
+      for (int j= i+1; j < argc; j++) {
+        to+= _snprintf(to, child_args + sizeof(child_args) - to, "%s ", argv[j]);
+      }
+      break;
+    } else {
+      if ( strcmp(arg, "--verbose") == 0 )
+        verbose++;
+	  else if ( strncmp(arg, "--parent-pid", 10) == 0 )
+	  {
+	    /* Override parent_pid with a value provided by user */
+		const char* start;
+        if ((start= strstr(arg, "=")) == NULL)
+		  die("Could not find start of option value in '%s'", arg);
+		start++; /* Step past = */
+		if ((parent_pid= atoi(start)) == 0)
+		  die("Invalid value '%s' passed to --parent-id", start);
+	  }
+      else
+        die("Unknown option: %s", arg);
+    }
+  }
+  if (*child_args == '\0')
+    die("nothing to do");
+
+  /* Open a handle to the parent process */
+  message("parent_pid: %d", parent_pid);
+  if (parent_pid == pid)
+    die("parent_pid is equal to own pid!");
+
+  if ((wait_handles[PARENT]=
+       OpenProcess(SYNCHRONIZE, FALSE, parent_pid)) == NULL)
+    die("Failed to open parent process with pid: %d", parent_pid);
+
+  /* Create the child process in a job */
+  JOBOBJECT_EXTENDED_LIMIT_INFORMATION jeli = { 0 };
+  STARTUPINFO                          si   = { 0 };
+  si.cb = sizeof(si);
+
+  /*
+    Create the job object to make it possible to kill the process
+    and all of it's children in one go
+  */
+  if ((job_handle= CreateJobObject(NULL, NULL)) == NULL)
+    die("CreateJobObject failed");
+
+  /*
+    Make all processes associated with the job terminate when the
+    last handle to the job is closed.
+  */
+  jeli.BasicLimitInformation.LimitFlags = JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE;
+  if (SetInformationJobObject(job_handle, JobObjectExtendedLimitInformation,
+                              &jeli, sizeof(jeli)) == 0)
+    message("SetInformationJobObject failed, continue anyway...");
+
+#if 0
+  /* Setup stdin, stdout and stderr redirect */
+  si.dwFlags= STARTF_USESTDHANDLES;
+  si.hStdInput= GetStdHandle(STD_INPUT_HANDLE);
+  si.hStdOutput= GetStdHandle(STD_OUTPUT_HANDLE);
+  si.hStdError= GetStdHandle(STD_ERROR_HANDLE);
+#endif
+
+  /*
+    Create the process suspended to make sure it's assigned to the
+    Job before it creates any process of it's own
+  */
+  if (CreateProcess(NULL, (LPSTR)child_args,
+                    NULL,
+                    NULL,
+                    TRUE, /* inherit handles */
+                    CREATE_SUSPENDED,
+                    NULL,
+                    NULL,
+                    &si,
+                    &process_info) == 0)
+    die("CreateProcess failed");
+
+  if (AssignProcessToJobObject(job_handle, process_info.hProcess) == 0)
+  {
+    TerminateProcess(process_info.hProcess, 200);
+    die("AssignProcessToJobObject failed");
+  }
+  ResumeThread(process_info.hThread);
+  CloseHandle(process_info.hThread);
+
+  wait_handles[CHILD]= process_info.hProcess;
+
+  message("Started child %d", process_info.dwProcessId);
+
+  /* Monitor loop */
+  DWORD child_exit_code= 1;
+  DWORD wait_res= WaitForMultipleObjects(NUM_HANDLES, wait_handles,
+                                         FALSE, INFINITE);
+  switch (wait_res)
+  {
+    case WAIT_OBJECT_0 + PARENT:
+      message("Parent exit");
+      break;
+    case WAIT_OBJECT_0 + CHILD:
+      if (GetExitCodeProcess(wait_handles[CHILD], &child_exit_code) == 0)
+        message("Child exit: could not get exit_code");
+      else
+        message("Child exit: exit_code: %d", child_exit_code);
+      break;
+    case WAIT_OBJECT_0 + EVENT:
+      message("Wake up from shutdown_event");
+      break;
+
+    default:
+      message("Unexpected result %d from WaitForMultipleObjects", wait_res);
+      break;
+  }
+  message("Exiting, child: %d", process_info.dwProcessId);
+
+  if (TerminateJobObject(job_handle, 201) == 0)
+    message("TerminateJobObject failed");
+  CloseHandle(job_handle);
+
+  if (wait_res != WAIT_OBJECT_0 + CHILD)
+  {
+	/* The child has not yet returned, wait for it */
+    message("waiting for child to exit");
+    if ((wait_res= WaitForSingleObject(wait_handles[CHILD], INFINITE)) != WAIT_OBJECT_0)
+	{
+      message("child wait failed: %d", wait_res);
+	}
+	else
+	{
+	  message("child wait succeeded");
+	}
+    /* Child's exit code should now be 201, no need to get it */
+  }
+
+  for (int i= 0; i < NUM_HANDLES; i++)
+    CloseHandle(wait_handles[i]);
+
+  exit(child_exit_code);
+}
+