release/src/router/mysql/mysql-test/lib/v1/mtr_im.pl

   1 # -*- cperl -*-
   2 # Copyright (c) 2006 MySQL AB, 2008 Sun Microsystems, Inc.
   3 # Use is subject to license terms.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; version 2 of the License.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 # This is a library file used by the Perl version of mysql-test-run,
  19 # and is part of the translation of the Bourne shell script with the
  20 # same name.
  21
  22 use strict;
  23
  24 # Private IM-related operations.
  25
  26 sub mtr_im_kill_process ($$$$);
  27 sub mtr_im_load_pids ($);
  28 sub mtr_im_terminate ($);
  29 sub mtr_im_check_alive ($);
  30 sub mtr_im_check_main_alive ($);
  31 sub mtr_im_check_angel_alive ($);
  32 sub mtr_im_check_mysqlds_alive ($);
  33 sub mtr_im_check_mysqld_alive ($);
  34 sub mtr_im_cleanup ($);
  35 sub mtr_im_rm_file ($);
  36 sub mtr_im_errlog ($);
  37 sub mtr_im_kill ($);
  38 sub mtr_im_wait_for_connection ($$$);
  39 sub mtr_im_wait_for_mysqld($$$);
  40
  41 # Public IM-related operations.
  42
  43 sub mtr_im_start ($$);
  44 sub mtr_im_stop ($);
  45
  46 ##############################################################################
  47 #
  48 #  Private operations.
  49 #
  50 ##############################################################################
  51
  52 sub mtr_im_kill_process ($$$$) {
  53   my $pid_lst= shift;
  54   my $signal= shift;
  55   my $total_retries= shift;
  56   my $timeout= shift;
  57
  58   my %pids;
  59
  60   foreach my $pid ( @{$pid_lst} )
  61   {
  62     $pids{$pid}= 1;
  63   }
  64
  65   for ( my $cur_attempt= 1; $cur_attempt <= $total_retries; ++$cur_attempt )
  66   {
  67     foreach my $pid ( keys %pids )
  68     {
  69       mtr_debug("Sending $signal to $pid...");
  70
  71       kill($signal, $pid);
  72
  73       unless ( kill (0, $pid) )
  74       {
  75         mtr_debug("Process $pid died.");
  76         delete $pids{$pid};
  77       }
  78     }
  79
  80     return if scalar keys %pids == 0;
  81
  82     mtr_debug("Sleeping $timeout second(s) waiting for processes to die...");
  83
  84     sleep($timeout);
  85   }
  86
  87   mtr_debug("Process(es) " .
  88             join(' ', keys %pids) .
  89             " is still alive after $total_retries " .
  90             "of sending signal $signal.");
  91 }
  92
  93 ###########################################################################
  94
  95 sub mtr_im_load_pids($) {
  96   my $im= shift;
  97
  98   mtr_debug("Loading PID files...");
  99
 100   # Obtain mysqld-process pids.
 101
 102   my $instances = $im->{'instances'};
 103
 104   for ( my $idx= 0; $idx < 2; ++$idx )
 105   {
 106     mtr_debug("IM-guarded mysqld[$idx] PID file: '" .
 107               $instances->[$idx]->{'path_pid'} . "'.");
 108
 109     my $mysqld_pid;
 110
 111     if ( -r $instances->[$idx]->{'path_pid'} )
 112     {
 113       $mysqld_pid= mtr_get_pid_from_file($instances->[$idx]->{'path_pid'});
 114       mtr_debug("IM-guarded mysqld[$idx] PID: $mysqld_pid.");
 115     }
 116     else
 117     {
 118       $mysqld_pid= undef;
 119       mtr_debug("IM-guarded mysqld[$idx]: no PID file.");
 120     }
 121
 122     $instances->[$idx]->{'pid'}= $mysqld_pid;
 123   }
 124
 125   # Re-read Instance Manager PIDs from the file, since during tests Instance
 126   # Manager could have been restarted, so its PIDs could have been changed.
 127
 128   #   - IM-main
 129
 130   mtr_debug("IM-main PID file: '$im->{path_pid}'.");
 131
 132   if ( -f $im->{'path_pid'} )
 133   {
 134     $im->{'pid'} =
 135       mtr_get_pid_from_file($im->{'path_pid'});
 136
 137     mtr_debug("IM-main PID: $im->{pid}.");
 138   }
 139   else
 140   {
 141     mtr_debug("IM-main: no PID file.");
 142     $im->{'pid'}= undef;
 143   }
 144
 145   #   - IM-angel
 146
 147   mtr_debug("IM-angel PID file: '$im->{path_angel_pid}'.");
 148
 149   if ( -f $im->{'path_angel_pid'} )
 150   {
 151     $im->{'angel_pid'} =
 152       mtr_get_pid_from_file($im->{'path_angel_pid'});
 153
 154     mtr_debug("IM-angel PID: $im->{'angel_pid'}.");
 155   }
 156   else
 157   {
 158     mtr_debug("IM-angel: no PID file.");
 159     $im->{'angel_pid'} = undef;
 160   }
 161 }
 162
 163 ###########################################################################
 164
 165 sub mtr_im_terminate($) {
 166   my $im= shift;
 167
 168   # Load pids from pid-files. We should do it first of all, because IM deletes
 169   # them on shutdown.
 170
 171   mtr_im_load_pids($im);
 172
 173   mtr_debug("Shutting Instance Manager down...");
 174
 175   # Ignoring SIGCHLD so that all children could rest in peace.
 176
 177   start_reap_all();
 178
 179   # Send SIGTERM to IM-main.
 180
 181   if ( defined $im->{'pid'} )
 182   {
 183     mtr_debug("IM-main pid: $im->{pid}.");
 184     mtr_debug("Stopping IM-main...");
 185
 186     mtr_im_kill_process([ $im->{'pid'} ], 'TERM', 10, 1);
 187   }
 188   else
 189   {
 190     mtr_debug("IM-main pid: n/a.");
 191   }
 192
 193   # If IM-angel was alive, wait for it to die.
 194
 195   if ( defined $im->{'angel_pid'} )
 196   {
 197     mtr_debug("IM-angel pid: $im->{'angel_pid'}.");
 198     mtr_debug("Waiting for IM-angel to die...");
 199
 200     my $total_attempts= 10;
 201
 202     for ( my $cur_attempt=1; $cur_attempt <= $total_attempts; ++$cur_attempt )
 203     {
 204       unless ( kill (0, $im->{'angel_pid'}) )
 205       {
 206         mtr_debug("IM-angel died.");
 207         last;
 208       }
 209
 210       sleep(1);
 211     }
 212   }
 213   else
 214   {
 215     mtr_debug("IM-angel pid: n/a.");
 216   }
 217
 218   stop_reap_all();
 219
 220   # Re-load PIDs.
 221
 222   mtr_im_load_pids($im);
 223 }
 224
 225 ###########################################################################
 226
 227 sub mtr_im_check_alive($) {
 228   my $im= shift;
 229
 230   mtr_debug("Checking whether IM-components are alive...");
 231
 232   return 1 if mtr_im_check_main_alive($im);
 233
 234   return 1 if mtr_im_check_angel_alive($im);
 235
 236   return 1 if mtr_im_check_mysqlds_alive($im);
 237
 238   return 0;
 239 }
 240
 241 ###########################################################################
 242
 243 sub mtr_im_check_main_alive($) {
 244   my $im= shift;
 245
 246   # Check that the process, that we know to be IM's, is dead.
 247
 248   if ( defined $im->{'pid'} )
 249   {
 250     if ( kill (0, $im->{'pid'}) )
 251     {
 252       mtr_debug("IM-main (PID: $im->{pid}) is alive.");
 253       return 1;
 254     }
 255     else
 256     {
 257       mtr_debug("IM-main (PID: $im->{pid}) is dead.");
 258     }
 259   }
 260   else
 261   {
 262     mtr_debug("No PID file for IM-main.");
 263   }
 264
 265   # Check that IM does not accept client connections.
 266
 267   if ( mtr_ping_port($im->{'port'}) )
 268   {
 269     mtr_debug("IM-main (port: $im->{port}) " .
 270               "is accepting connections.");
 271
 272     mtr_im_errlog("IM-main is accepting connections on port " .
 273                   "$im->{port}, but there is no " .
 274                   "process information.");
 275     return 1;
 276   }
 277   else
 278   {
 279     mtr_debug("IM-main (port: $im->{port}) " .
 280               "does not accept connections.");
 281     return 0;
 282   }
 283 }
 284
 285 ###########################################################################
 286
 287 sub mtr_im_check_angel_alive($) {
 288   my $im= shift;
 289
 290   # Check that the process, that we know to be the Angel, is dead.
 291
 292   if ( defined $im->{'angel_pid'} )
 293   {
 294     if ( kill (0, $im->{'angel_pid'}) )
 295     {
 296       mtr_debug("IM-angel (PID: $im->{angel_pid}) is alive.");
 297       return 1;
 298     }
 299     else
 300     {
 301       mtr_debug("IM-angel (PID: $im->{angel_pid}) is dead.");
 302       return 0;
 303     }
 304   }
 305   else
 306   {
 307     mtr_debug("No PID file for IM-angel.");
 308     return 0;
 309   }
 310 }
 311
 312 ###########################################################################
 313
 314 sub mtr_im_check_mysqlds_alive($) {
 315   my $im= shift;
 316
 317   mtr_debug("Checking for IM-guarded mysqld instances...");
 318
 319   my $instances = $im->{'instances'};
 320
 321   for ( my $idx= 0; $idx < 2; ++$idx )
 322   {
 323     mtr_debug("Checking mysqld[$idx]...");
 324
 325     return 1
 326       if mtr_im_check_mysqld_alive($instances->[$idx]);
 327   }
 328 }
 329
 330 ###########################################################################
 331
 332 sub mtr_im_check_mysqld_alive($) {
 333   my $mysqld_instance= shift;
 334
 335   # Check that the process is dead.
 336
 337   if ( defined $mysqld_instance->{'pid'} )
 338   {
 339     if ( kill (0, $mysqld_instance->{'pid'}) )
 340     {
 341       mtr_debug("Mysqld instance (PID: $mysqld_instance->{pid}) is alive.");
 342       return 1;
 343     }
 344     else
 345     {
 346       mtr_debug("Mysqld instance (PID: $mysqld_instance->{pid}) is dead.");
 347     }
 348   }
 349   else
 350   {
 351     mtr_debug("No PID file for mysqld instance.");
 352   }
 353
 354   # Check that mysqld does not accept client connections.
 355
 356   if ( mtr_ping_port($mysqld_instance->{'port'}) )
 357   {
 358     mtr_debug("Mysqld instance (port: $mysqld_instance->{port}) " .
 359               "is accepting connections.");
 360
 361     mtr_im_errlog("Mysqld is accepting connections on port " .
 362                   "$mysqld_instance->{port}, but there is no " .
 363                   "process information.");
 364     return 1;
 365   }
 366   else
 367   {
 368     mtr_debug("Mysqld instance (port: $mysqld_instance->{port}) " .
 369               "does not accept connections.");
 370     return 0;
 371   }
 372 }
 373
 374 ###########################################################################
 375
 376 sub mtr_im_cleanup($) {
 377   my $im= shift;
 378
 379   mtr_im_rm_file($im->{'path_pid'});
 380   mtr_im_rm_file($im->{'path_sock'});
 381
 382   mtr_im_rm_file($im->{'path_angel_pid'});
 383
 384   for ( my $idx= 0; $idx < 2; ++$idx )
 385   {
 386     mtr_im_rm_file($im->{'instances'}->[$idx]->{'path_pid'});
 387     mtr_im_rm_file($im->{'instances'}->[$idx]->{'path_sock'});
 388   }
 389 }
 390
 391 ###########################################################################
 392
 393 sub mtr_im_rm_file($)
 394 {
 395   my $file_path= shift;
 396
 397   if ( -f $file_path )
 398   {
 399     mtr_debug("Removing '$file_path'...");
 400
 401     unless ( unlink($file_path) )
 402     {
 403       mtr_warning("Can not remove '$file_path'.")
 404     }
 405   }
 406   else
 407   {
 408     mtr_debug("File '$file_path' does not exist already.");
 409   }
 410 }
 411
 412 ###########################################################################
 413
 414 sub mtr_im_errlog($) {
 415   my $msg= shift;
 416
 417   # Complain in error log so that a warning will be shown.
 418   #
 419   # TODO: unless BUG#20761 is fixed, we will print the warning to stdout, so
 420   # that it can be seen on console and does not produce pushbuild error.
 421
 422   # my $errlog= "$opt_vardir/log/mysql-test-run.pl.err";
 423   #
 424   # open (ERRLOG, ">>$errlog") ||
 425   #   mtr_error("Can not open error log ($errlog)");
 426   #
 427   # my $ts= localtime();
 428   # print ERRLOG
 429   #   "Warning: [$ts] $msg\n";
 430   #
 431   # close ERRLOG;
 432
 433   my $ts= localtime();
 434   print "Warning: [$ts] $msg\n";
 435 }
 436
 437 ###########################################################################
 438
 439 sub mtr_im_kill($) {
 440   my $im= shift;
 441
 442   # Re-load PIDs. That can be useful because some processes could have been
 443   # restarted.
 444
 445   mtr_im_load_pids($im);
 446
 447   # Ignoring SIGCHLD so that all children could rest in peace.
 448
 449   start_reap_all();
 450
 451   # Kill IM-angel first of all.
 452
 453   if ( defined $im->{'angel_pid'} )
 454   {
 455     mtr_debug("Killing IM-angel (PID: $im->{angel_pid})...");
 456     mtr_im_kill_process([ $im->{'angel_pid'} ], 'KILL', 10, 1)
 457   }
 458   else
 459   {
 460     mtr_debug("IM-angel is dead.");
 461   }
 462
 463   # Re-load PIDs again.
 464
 465   mtr_im_load_pids($im);
 466
 467   # Kill IM-main.
 468
 469   if ( defined $im->{'pid'} )
 470   {
 471     mtr_debug("Killing IM-main (PID: $im->pid})...");
 472     mtr_im_kill_process([ $im->{'pid'} ], 'KILL', 10, 1);
 473   }
 474   else
 475   {
 476     mtr_debug("IM-main is dead.");
 477   }
 478
 479   # Re-load PIDs again.
 480
 481   mtr_im_load_pids($im);
 482
 483   # Kill guarded mysqld instances.
 484
 485   my @mysqld_pids;
 486
 487   mtr_debug("Collecting PIDs of mysqld instances to kill...");
 488
 489   for ( my $idx= 0; $idx < 2; ++$idx )
 490   {
 491     my $pid= $im->{'instances'}->[$idx]->{'pid'};
 492
 493     unless ( defined $pid )
 494     {
 495       next;
 496     }
 497
 498     mtr_debug("  - IM-guarded mysqld[$idx] PID: $pid.");
 499
 500     push (@mysqld_pids, $pid);
 501   }
 502
 503   if ( scalar @mysqld_pids > 0 )
 504   {
 505     mtr_debug("Killing IM-guarded mysqld instances...");
 506     mtr_im_kill_process(\@mysqld_pids, 'KILL', 10, 1);
 507   }
 508
 509   # That's all.
 510
 511   stop_reap_all();
 512 }
 513
 514 ##############################################################################
 515
 516 sub mtr_im_wait_for_connection($$$) {
 517   my $im= shift;
 518   my $total_attempts= shift;
 519   my $connect_timeout= shift;
 520
 521   mtr_debug("Waiting for IM on port $im->{port} " .
 522             "to start accepting connections...");
 523
 524   for ( my $cur_attempt= 1; $cur_attempt <= $total_attempts; ++$cur_attempt )
 525   {
 526     mtr_debug("Trying to connect to IM ($cur_attempt of $total_attempts)...");
 527
 528     if ( mtr_ping_port($im->{'port'}) )
 529     {
 530       mtr_debug("IM is accepting connections " .
 531                 "on port $im->{port}.");
 532       return 1;
 533     }
 534
 535     mtr_debug("Sleeping $connect_timeout...");
 536     sleep($connect_timeout);
 537   }
 538
 539   mtr_debug("IM does not accept connections " .
 540             "on port $im->{port} after " .
 541             ($total_attempts * $connect_timeout) . " seconds.");
 542
 543   return 0;
 544 }
 545
 546 ##############################################################################
 547
 548 sub mtr_im_wait_for_mysqld($$$) {
 549   my $mysqld= shift;
 550   my $total_attempts= shift;
 551   my $connect_timeout= shift;
 552
 553   mtr_debug("Waiting for IM-guarded mysqld on port $mysqld->{port} " .
 554             "to start accepting connections...");
 555
 556   for ( my $cur_attempt= 1; $cur_attempt <= $total_attempts; ++$cur_attempt )
 557   {
 558     mtr_debug("Trying to connect to mysqld " .
 559               "($cur_attempt of $total_attempts)...");
 560
 561     if ( mtr_ping_port($mysqld->{'port'}) )
 562     {
 563       mtr_debug("Mysqld is accepting connections " .
 564                 "on port $mysqld->{port}.");
 565       return 1;
 566     }
 567
 568     mtr_debug("Sleeping $connect_timeout...");
 569     sleep($connect_timeout);
 570   }
 571
 572   mtr_debug("Mysqld does not accept connections " .
 573             "on port $mysqld->{port} after " .
 574             ($total_attempts * $connect_timeout) . " seconds.");
 575
 576   return 0;
 577 }
 578
 579 ##############################################################################
 580 #
 581 #  Public operations.
 582 #
 583 ##############################################################################
 584
 585 sub mtr_im_start($$) {
 586   my $im = shift;
 587   my $opts = shift;
 588
 589   mtr_debug("Starting Instance Manager...");
 590
 591   my $args;
 592   mtr_init_args(\$args);
 593   mtr_add_arg($args, "--defaults-file=%s", $im->{'defaults_file'});
 594
 595   foreach my $opt ( @{$opts} )
 596   {
 597     mtr_add_arg($args, $opt);
 598   }
 599
 600   $im->{'spawner_pid'} =
 601     mtr_spawn(
 602       $::exe_im,                        # path to the executable
 603       $args,                            # cmd-line args
 604       '',                               # stdin
 605       $im->{'path_log'},                # stdout
 606       $im->{'path_err'},                # stderr
 607       '',                               # pid file path (not used)
 608       { append_log_file => 1 }          # append log files
 609       );
 610
 611   unless ( $im->{'spawner_pid'} )
 612   {
 613     mtr_error('Could not start Instance Manager.')
 614   }
 615
 616   # Instance Manager can be run in daemon mode. In this case, it creates
 617   # several processes and the parent process, created by mtr_spawn(), exits just
 618   # after start. So, we have to obtain Instance Manager PID from the PID file.
 619
 620   mtr_debug("Waiting for IM to create PID file (" .
 621             "path: '$im->{path_pid}'; " .
 622             "timeout: $im->{start_timeout})...");
 623
 624   unless ( sleep_until_file_created($im->{'path_pid'},
 625                                     $im->{'start_timeout'},
 626                                     -1) ) # real PID is still unknown
 627   {
 628     mtr_debug("IM has not created PID file in $im->{start_timeout} secs.");
 629     mtr_debug("Aborting test suite...");
 630
 631     mtr_kill_leftovers();
 632
 633     mtr_report("IM has not created PID file in $im->{start_timeout} secs.");
 634     return 0;
 635   }
 636
 637   $im->{'pid'}= mtr_get_pid_from_file($im->{'path_pid'});
 638
 639   mtr_debug("Instance Manager started. PID: $im->{pid}.");
 640
 641   # Wait until we can connect to IM.
 642
 643   my $IM_CONNECT_TIMEOUT= 30;
 644
 645   unless ( mtr_im_wait_for_connection($im,
 646                                       $IM_CONNECT_TIMEOUT, 1) )
 647   {
 648     mtr_debug("Can not connect to Instance Manager " .
 649               "in $IM_CONNECT_TIMEOUT seconds after start.");
 650     mtr_debug("Aborting test suite...");
 651
 652     mtr_kill_leftovers();
 653
 654     mtr_report("Can not connect to Instance Manager " .
 655                "in $IM_CONNECT_TIMEOUT seconds after start.");
 656     return 0;
 657   }
 658
 659   # Wait for IM to start guarded instances:
 660   #   - wait for PID files;
 661
 662   mtr_debug("Waiting for guarded mysqlds instances to create PID files...");
 663
 664   for ( my $idx= 0; $idx < 2; ++$idx )
 665   {
 666     my $mysqld= $im->{'instances'}->[$idx];
 667
 668     if ( exists $mysqld->{'nonguarded'} )
 669     {
 670       next;
 671     }
 672
 673     mtr_debug("Waiting for mysqld[$idx] to create PID file (" .
 674               "path: '$mysqld->{path_pid}'; " .
 675               "timeout: $mysqld->{start_timeout})...");
 676
 677     unless ( sleep_until_file_created($mysqld->{'path_pid'},
 678                                       $mysqld->{'start_timeout'},
 679                                       -1) ) # real PID is still unknown
 680     {
 681       mtr_debug("mysqld[$idx] has not created PID file in " .
 682                  "$mysqld->{start_timeout} secs.");
 683       mtr_debug("Aborting test suite...");
 684
 685       mtr_kill_leftovers();
 686
 687       mtr_report("mysqld[$idx] has not created PID file in " .
 688                  "$mysqld->{start_timeout} secs.");
 689       return 0;
 690     }
 691
 692     mtr_debug("PID file for mysqld[$idx] ($mysqld->{path_pid} created.");
 693   }
 694
 695   # Wait until we can connect to guarded mysqld-instances
 696   # (in other words -- wait for IM to start guarded instances).
 697
 698   mtr_debug("Waiting for guarded mysqlds to start accepting connections...");
 699
 700   for ( my $idx= 0; $idx < 2; ++$idx )
 701   {
 702     my $mysqld= $im->{'instances'}->[$idx];
 703
 704     if ( exists $mysqld->{'nonguarded'} )
 705     {
 706       next;
 707     }
 708
 709     mtr_debug("Waiting for mysqld[$idx] to accept connection...");
 710
 711     unless ( mtr_im_wait_for_mysqld($mysqld, 30, 1) )
 712     {
 713       mtr_debug("Can not connect to mysqld[$idx] " .
 714                 "in $IM_CONNECT_TIMEOUT seconds after start.");
 715       mtr_debug("Aborting test suite...");
 716
 717       mtr_kill_leftovers();
 718
 719       mtr_report("Can not connect to mysqld[$idx] " .
 720                  "in $IM_CONNECT_TIMEOUT seconds after start.");
 721       return 0;
 722     }
 723
 724     mtr_debug("mysqld[$idx] started.");
 725   }
 726
 727   mtr_debug("Instance Manager and its components are up and running.");
 728
 729   return 1;
 730 }
 731
 732 ##############################################################################
 733
 734 sub mtr_im_stop($) {
 735   my $im= shift;
 736
 737   mtr_debug("Stopping Instance Manager...");
 738
 739   # Try graceful shutdown.
 740
 741   mtr_im_terminate($im);
 742
 743   # Check that all processes died.
 744
 745   unless ( mtr_im_check_alive($im) )
 746   {
 747     mtr_debug("Instance Manager has been stopped successfully.");
 748     mtr_im_cleanup($im);
 749     return 1;
 750   }
 751
 752   # Instance Manager don't want to die. We should kill it.
 753
 754   mtr_im_errlog("Instance Manager did not shutdown gracefully.");
 755
 756   mtr_im_kill($im);
 757
 758   # Check again that all IM-related processes have been killed.
 759
 760   my $im_is_alive= mtr_im_check_alive($im);
 761
 762   mtr_im_cleanup($im);
 763
 764   if ( $im_is_alive )
 765   {
 766     mtr_debug("Can not kill Instance Manager or its children.");
 767     return 0;
 768   }
 769
 770   mtr_debug("Instance Manager has been killed successfully.");
 771   return 1;
 772 }
 773
 774 ###########################################################################
 775
 776 1;