unify mtr handling of debuggers

"debugger" is anything that wraps execution of a target
binary (mysqld or mysqltest). Currently the list includes:
gdb, ddd, dbx, lldb, valgrind, strace, ktrace, rr,
devenv, windbg, vsjitdebugger.

for every debugger xxx, mtr will recognize four options:
--xxx, --boot-xxx, --manual-xxx, --client-xxx.
They all support an optional "=string" argument. String
being a semicolon-separated list of commands (e.g. for gdb)
or one (not semicolon-separated) command line of options
(e.g. for valgrind). Or both (e.g. --gdb='-quiet -nh;info files'

In embedded both --xxx and --client-xxx work.

Functionality changed/removed:
* --rr-args is gone
* --rr-dir is gone
* --manual-debug is gone
* --debugger={devenv|vc|windbg|vc_express|vsjitdebugger} is gone
* --strace-option is gone
* --stracer={strace|ktrace} is gone
* --valgrind only enables it for the server, not for everything
* --valgrind-all is gone
* --valgrind-mysqltest is gone
* --valgrind-mysqld is gone
* --valgrind-options is gone
* --valgrind-option is gone
* --valgrind-path is gone
* --callgrind is gone
* one cannot combine --valgrind --gdb anymore
* valgrind report doesn't add a fake test line to the output
* vc and vcexpress on windows are no longer supported

Author: vuvova

mysql-test/lib/My/Debugger.pm

@@ -0,0 +1,247 @@
+package My::Debugger;
+
+use strict;
+use warnings;
+use Text::Wrap;
+use Cwd;
+
+# 1. options to support:
+#       --xxx[=ARGS]
+#       --manual-xxx[=ARGS]
+#       --client-xxx[=ARGS]
+#       --boot-xxx[=ARGS]
+#       TODO --manual-client-xxx[=ARGS]
+#       TODO --manual-boot-xxx[=ARGS]
+#       TODO --exec-xxx[=ARGS] (for $ENV{MYSQL}, etc)
+#
+#       ARGS is a semicolon-separated list of commands for the
+#       command file. If the first command starts from '-' it'll
+#       be for a command line, not for a command file.
+#
+# 2. terminal to use: xterm
+#       TODO MTR_TERM="xterm -title {title} -e {command}"
+#
+# 3. debugger combinations are *not allowed*
+#       (thus no --valgrind --gdb)
+#
+# 4. variables for the command line / file templates:
+#       {vardir}   -> vardir
+#       {exe} -> /path/to/binary/to/execute
+#       {args} -> command-line arguments, "-quoted
+#       {input}
+#       {type} -> client, mysqld.1, etc
+#       {script} -> vardir/tmp/{debugger}init.$type
+#       {log} -> vardir/log/$type.{debugger}
+#       {options} -> user options for the debugger.
+#
+#  if {options} isn't used, they're auto-placed before {exe}
+#     or at the end if no {exe}
+
+my %debuggers = (
+  gdb => {
+    term => 1,
+    options => '-x {script} {exe}',
+    script => 'set args {args} < {input}',
+  },
+  ddd => {
+    options => '--command {script} {exe}',
+    script => 'set args {args} < {input}',
+  },
+  dbx => {
+    term => 1,
+    options => '-c "stop in main; run {exe} {args} < {input}"',
+  },
+  devenv => {
+    options => '/debugexe {exe} {args}',
+  },
+  windbg => {
+    options => '{exe} {args}',
+  },
+  lldb => {
+    term => 1,
+    options => '-s {script} {exe}',
+    script => 'process launch --stop-at-entry {args}',
+  },
+  valgrind => {
+    options => '--tool=memcheck --show-reachable=yes --leak-check=yes --num-callers=16 --quiet --suppressions='.cwd().'/valgrind.supp {exe} {args} --loose-wait-for-pos-timeout=1500',
+    pre => sub {
+      my $debug_libraries_path= "/usr/lib/debug";
+      $ENV{LD_LIBRARY_PATH} .= ":$debug_libraries_path" if -d $debug_libraries_path;
+    }
+  },
+  strace => {
+    options => '-f -o {log} {exe} {args}',
+  },
+  rr => {
+    options => 'record -o {log} {exe} {args}',
+    pre => sub {
+      ::mtr_error('rr requires kernel.perf_event_paranoid <= 1')
+        if ::mtr_grab_file('/proc/sys/kernel/perf_event_paranoid') > 1;
+    }
+  },
+
+  # aliases
+  vsjitdebugger => 'windbg',
+  ktrace => 'strace',
+);
+
+my %opts;
+my %opt_vals;
+my $help = "\n\nOptions for running debuggers\n\n";
+
+for my $k (sort keys %debuggers) {
+  my $v = $debuggers{$k};
+  $v = $debuggers{$k} = $debuggers{$v} if not ref $v; # resolve aliases
+
+  sub register_opt($$) {
+    my ($name, $msg) = @_;
+    $opts{"$name=s"} = \$opt_vals{$name};
+    $help .= wrap(sprintf("  %-23s", $name), ' 'x25, "$msg under $name\n");
+  }
+
+  $v->{script} = '' unless $v->{script};
+  $v->{options} =~ s/(\{exe\}|$)/ {options} $&/ unless $v->{options} =~ /\{options\}/;
+
+  register_opt "$k" => "Start mysqld";
+  register_opt "client-$k" => "Start mysqltest client";
+  register_opt "boot-$k" => "Start bootstrap server";
+  register_opt "manual-$k" => "Before running test(s) let user manually start mysqld";
+}
+
+sub subst($%) {
+  use warnings FATAL => 'uninitialized';
+  my ($templ, %vars) = @_;
+  $templ =~ s/\{(\w+)\}/$vars{$1}/g;
+  $templ;
+}
+
+sub do_args($$$$$) {
+  my ($args, $exe, $input, $type, $opt) = @_;
+  my $k = $opt =~ /^(?:client|boot|manual)-(.*)$/ ? $1 : $opt;
+  my $v = $debuggers{$k};
+
+  # on windows mtr args are quoted (for system), otherwise not (for exec)
+  sub quote($) { $_[0] =~ / / ? "\"$_[0]\"" : $_[0] }
+  sub unquote($) { $_[0] =~ s/^"(.*)"$/$1/; $_[0] }
+  sub quote_from_mtr($) { ::IS_WINDOWS ? $_[0] : quote($_[0]) }
+  sub unquote_for_mtr($) { ::IS_WINDOWS ? $_[0] : unquote($_[0]) }
+
+  my %vars = (
+    vardir => $::opt_vardir,
+    exe => $$exe,
+    args => join(' ', map { quote_from_mtr $_ } @$$args, '--gdb'),
+    input => $input,
+    script => "$::opt_vardir/tmp/${k}init.$type",
+    log => "$::opt_vardir/log/$type.$k",
+    options => '',
+  );
+  my @params = split /;/, $opt_vals{$opt};
+  $vars{options} = shift @params  if @params and $params[0] =~ /^-/;
+
+  my $script = join "\n", @params;
+  if ($v->{script}) {
+    ::mtr_tofile($vars{script}, subst($v->{script}, %vars)."\n".$script);
+  } elsif ($script) {
+    die "$k is not using a script file, nowhere to write the script \n---\n$script\n---\n";
+  }
+
+  my $options = subst($v->{options}, %vars);
+  @$$args = map { unquote_for_mtr $_ } $options =~ /("[^"]+"|\S+)/g;
+
+  if ($opt =~ /^manual-/) {
+    print "\nTo start $k for $type, type in another window:\n";
+    print "$k $options\n";
+    $$exe= undef; # Indicate the exe should not be started
+  } elsif ($v->{term}) {
+    unshift @$$args, '-title', $type, '-e', $k;
+    $$exe = 'xterm';
+  } else {
+    $$exe = $k;
+  }
+}
+
+sub options() { %opts }
+sub help() { $help }
+
+sub fix_options(@) {
+  my $re=join '|', keys %opts;
+  $re =~ s/=s//g;
+  map { $_ . (/^--($re)$/ and '=;') } @_;
+}
+
+sub pre_setup() {
+  my $used;
+  for my $k (keys %debuggers) {
+    for my $opt ($k, "manual-$k", "boot-$k", "client-$k") {
+      if ($opt_vals{$opt})
+      {
+        $used = 1;
+        if ($debuggers{$k}->{pre}) {
+          $debuggers{$k}->{pre}->();
+          delete $debuggers{$k}->{pre};
+        }
+      }
+    }
+  }
+
+  if ($used) {
+    $ENV{ASAN_OPTIONS}= 'abort_on_error=1:'.($ENV{ASAN_OPTIONS} || '');
+    ::mtr_error("Can't use --extern when using debugger") if $ENV{USE_RUNNING_SERVER};
+
+    $::opt_retry= 1;
+    $::opt_retry_failure= 1;
+    $::opt_testcase_timeout= 7 * 24 * 60; # in minutes
+    $::opt_suite_timeout= 7 * 24 * 60;    # in minutes
+    $::opt_shutdown_timeout= 24 * 60 *60; # in seconds
+    $::opt_start_timeout= 24 * 60 * 60;   # in seconds
+  }
+}
+
+sub setup_boot_args($$$) {
+  my ($args, $exe, $input) = @_;
+  my $found;
+
+  for my $k (keys %debuggers) {
+    if ($opt_vals{"boot-$k"}) {
+      die "--boot-$k and --$found cannot be used at the same time\n" if $found;
+
+      $found="boot-$k";
+      do_args($args, $exe, $input, 'bootstrap', $found);
+    }
+  }
+}
+
+sub setup_client_args($$) {
+  my ($args, $exe) = @_;
+  my $found;
+  my $embedded = $::opt_embedded_server ? ' with --embedded' : '';
+
+  for my $k (keys %debuggers) {
+    my @opt_names=("client-$k");
+    push @opt_names, $k if $embedded;
+    for my $opt (@opt_names) {
+      if ($opt_vals{$opt}) {
+        die "--$opt and --$found cannot be used at the same time$embedded\n" if $found;
+        $found=$opt;
+        do_args($args, $exe, ::IS_WINDOWS ? 'NUL' : '/dev/null', 'client', $found);
+      }
+    }
+  }
+}
+
+sub setup_args($$$) {
+  my ($args, $exe, $type) = @_;
+  my $found;
+
+  for my $k (keys %debuggers) {
+    for my $opt ($k, "manual-$k") {
+      if ($opt_vals{$opt}) {
+        die "--$opt and --$found cannot be used at the same time\n" if $found;
+        $found=$opt;
+        do_args($args, $exe, ::IS_WINDOWS ? 'NUL' : '/dev/null', $type, $found);
+      }
+    }
+  }
+}
+
+1;