mirror of
https://github.com/percona/percona-toolkit.git
synced 2025-09-02 02:34:19 +00:00
4260 lines
126 KiB
Perl
Executable File
4260 lines
126 KiB
Perl
Executable File
#!/usr/bin/env perl
|
|
|
|
# This program is part of Percona Toolkit: http://www.percona.com/software/
|
|
# See "COPYRIGHT, LICENSE, AND WARRANTY" at the end of this file for legal
|
|
# notices and disclaimers.
|
|
|
|
use strict;
|
|
use warnings FATAL => 'all';
|
|
|
|
# This tool is "fat-packed": most of its dependent modules are embedded
|
|
# in this file. Setting %INC to this file for each module makes Perl aware
|
|
# of this so it will not try to load the module from @INC. See the tool's
|
|
# documentation for a full list of dependencies.
|
|
BEGIN {
|
|
$INC{$_} = __FILE__ for map { (my $pkg = "$_.pm") =~ s!::!/!g; $pkg } (qw(
|
|
ExplainParser
|
|
ExplainTree
|
|
OptionParser
|
|
DSNParser
|
|
Daemon
|
|
Lmo::Utils
|
|
Lmo::Meta
|
|
Lmo::Object
|
|
Lmo::Types
|
|
Lmo
|
|
VersionParser
|
|
));
|
|
}
|
|
|
|
# ###########################################################################
|
|
# Converts text (e.g. saved output) to a "recordset" -- an array of hashrefs
|
|
# -- just like EXPLAIN does for selectall_arrayref({}).
|
|
# ###########################################################################
|
|
package ExplainParser;
|
|
|
|
use strict;
|
|
use warnings FATAL => 'all';
|
|
|
|
sub new {
|
|
bless {}, shift;
|
|
}
|
|
|
|
sub parse_tabular {
|
|
my ( $text, @cols ) = @_;
|
|
my %row;
|
|
my @vals = $text =~ m/\| +([^\|]*?)(?= +\|)/msg;
|
|
return (undef, \@vals) unless @cols;
|
|
@row{@cols} = @vals;
|
|
return (\%row, undef);
|
|
}
|
|
|
|
sub parse_tab_sep {
|
|
my ( $text, @cols ) = @_;
|
|
my %row;
|
|
my @vals = split(/\t/, $text);
|
|
return (undef, \@vals) unless @cols;
|
|
@row{@cols} = @vals;
|
|
return (\%row, undef);
|
|
}
|
|
|
|
sub parse_vertical {
|
|
my ( $text, @cols ) = @_;
|
|
my %row = $text =~ m/^ *(\w+): ([^\n]*) *$/msg;
|
|
return (\%row, undef);
|
|
}
|
|
|
|
sub parse {
|
|
my ($self, $text) = @_;
|
|
my $started = 0;
|
|
my $lines = 0;
|
|
my @cols = ();
|
|
my @result = ();
|
|
|
|
# Detect which kind of input it is
|
|
my ( $line_re, $vals_sub );
|
|
if ( $text =~ m/^\+---/m ) { # standard "tabular" output
|
|
$line_re = qr/^(\| .*)[\r\n]+/m;
|
|
$vals_sub = \&parse_tabular;
|
|
}
|
|
elsif ( $text =~ m/^id\tselect_type\t/m ) { # tab-separated
|
|
$line_re = qr/^(.*?\t.*)[\r\n]+/m;
|
|
$vals_sub = \&parse_tab_sep;
|
|
}
|
|
elsif ( $text =~ m/\*\*\* 1. row/ ) { # "vertical" output
|
|
$line_re = qr/^( *.*?^ *Extra:[^\n]*$)/ms;
|
|
$vals_sub = \&parse_vertical;
|
|
}
|
|
|
|
if ( $line_re ) {
|
|
# Pull it apart into lines and parse them.
|
|
LINE:
|
|
foreach my $line ( $text =~ m/$line_re/g ) {
|
|
my ($row, $cols) = $vals_sub->($line, @cols);
|
|
if ( $row ) {
|
|
foreach my $key ( keys %$row ) {
|
|
if ( !$row->{$key} || $row->{$key} eq 'NULL' ) {
|
|
$row->{$key} = undef;
|
|
}
|
|
}
|
|
push @result, $row;
|
|
}
|
|
else {
|
|
@cols = @$cols;
|
|
}
|
|
}
|
|
}
|
|
|
|
return \@result;
|
|
}
|
|
|
|
# ###########################################################################
|
|
# Converts output of EXPLAIN into a human-readable tree.
|
|
# ###########################################################################
|
|
package ExplainTree;
|
|
|
|
use List::Util qw(max);
|
|
use Data::Dumper;
|
|
|
|
sub new {
|
|
my ( $class, $options ) = @_;
|
|
my $self = bless {}, $class;
|
|
$self->load_options($options);
|
|
return $self;
|
|
}
|
|
|
|
sub load_options {
|
|
my ( $self, $options ) = @_;
|
|
if ( $options && ref $options eq 'HASH' ) {
|
|
@{$self}{keys %$options} = values %$options;
|
|
}
|
|
else {
|
|
delete @{$self}{keys %$self};
|
|
}
|
|
}
|
|
|
|
sub parse {
|
|
my ( $self, $text, $options ) = @_;
|
|
return $self->process(ExplainParser->new->parse($text), $options);
|
|
}
|
|
|
|
# The main method that turns a result set into a tree. Accepts an arrayref of
|
|
# hashrefs which correspond to the rows in EXPLAIN. See the ALGORITHM in the
|
|
# documentation for a small novel about this process.
|
|
sub process {
|
|
my ( $self, $rows, $options ) = @_;
|
|
$self->load_options($options);
|
|
return unless ref $rows eq 'ARRAY' && @$rows;
|
|
|
|
# Pre-process and sanity check the rows.
|
|
my @rows = @$rows;
|
|
foreach my $i ( 0 .. $#rows ) {
|
|
my $row = $rows[$i];
|
|
$row->{rowid} = $i;
|
|
$row->{Extra} ||= '';
|
|
|
|
# The source code says if there are too many tables unioned together, the
|
|
# table column will get truncated, like "<union1,2,3,4...>". If this
|
|
# happens, I've got to bail out. I'm not going to check all the source
|
|
# code for all versions, but in 5.0 it looks like I can get this to happen
|
|
# around table 20.
|
|
die "UNION has too many tables: $row->{table}"
|
|
if $row->{table} && $row->{table} =~ m/\./;
|
|
|
|
if ( !defined $row->{id} ) {
|
|
if ( $row->{table} && (my ($id) = $row->{table} =~ m/^<union(\d+)/) ) {
|
|
$row->{id} = $id;
|
|
}
|
|
else {
|
|
die "Unexpected NULL in id column, please report as a bug";
|
|
}
|
|
}
|
|
}
|
|
|
|
# Re-order the rows so all references are forward.
|
|
my %union_for
|
|
= map { $_->{id} => $_ }
|
|
grep { $_->{select_type} eq 'UNION RESULT' }
|
|
@rows;
|
|
|
|
my $last_id = 0;
|
|
my @reordered;
|
|
foreach my $row ( grep { $_->{select_type} ne 'UNION RESULT' } @rows ) {
|
|
if ( $last_id != $row->{id} && $union_for{$row->{id}} ) {
|
|
push @reordered, $union_for{$row->{id}};
|
|
}
|
|
push @reordered, $row;
|
|
$last_id = $row->{id};
|
|
}
|
|
|
|
# Process the rows recursively.
|
|
my $tree = $self->build_query_plan(@reordered);
|
|
|
|
return $tree;
|
|
}
|
|
|
|
sub build_query_plan {
|
|
my ( $self, @rows ) = @_;
|
|
|
|
if ( !@rows ) {
|
|
die "I got no rows";
|
|
}
|
|
|
|
# Is it a UNION RESULT? Split it up into sub-scopes and recurse.
|
|
if ( $rows[0]->{select_type} eq 'UNION RESULT' ) {
|
|
my $row = shift @rows;
|
|
my @kids;
|
|
my @ids = $row->{table} =~ m/(\d+)/g;
|
|
my $enclosing_scope;
|
|
if ( $rows[0]->{select_type} =~ m/SUBQUERY/ ) {
|
|
$enclosing_scope = $rows[0];
|
|
}
|
|
foreach my $i ( 0 .. $#ids ) {
|
|
my $start = $self->index_of($ids[$i], @rows);
|
|
my $end = $i < $#ids ? $self->index_of($ids[$i + 1], @rows) : @rows;
|
|
push @kids, $self->build_query_plan(splice(@rows, $start, $end - $start));
|
|
}
|
|
$row->{children} = [ @kids ];
|
|
$row->{table} = "union("
|
|
. join(',', map { $self->recursive_table_name($_) || '<none>' } @kids)
|
|
. ")";
|
|
my $tree = $self->transform($row);
|
|
if ( $enclosing_scope ) {
|
|
my $node = $self->transform($enclosing_scope);
|
|
$node->{children} = [ $tree ];
|
|
$tree = $node;
|
|
}
|
|
return $tree;
|
|
}
|
|
|
|
# Are there DERIVED tables? If so, find its children and pull them out of the
|
|
# list under it.
|
|
while ( my ($der) = grep { $_->{table} && $_->{table} =~ m/^<derived\d+>$/ } @rows ) {
|
|
|
|
# Figure out the start and end of the derived scope.
|
|
my ($der_id) = $der->{table} =~ m/^<derived(\d+)>$/;
|
|
my $start = $self->index_of($der_id, @rows);
|
|
my $end = $start;
|
|
while ( $end < @rows && $rows[$end]->{id} >= $der_id ) {
|
|
$end++;
|
|
}
|
|
|
|
# Get the rows that belong to this scope and recurse.
|
|
my @enclosed_scope = splice(@rows, $start, $end - $start);
|
|
my $kids = $self->build_query_plan(@enclosed_scope);
|
|
$der->{children} = [$kids];
|
|
$der->{table} = "derived(" . ($self->recursive_table_name($kids) || '<none>') . ")";
|
|
}
|
|
|
|
# Handle the "normal case." For each node, if the id is the same as the last
|
|
# one, JOIN and continue. If the id is greater, it's a subquery, so should
|
|
# be recursed.
|
|
|
|
# But, filesort/temporary have to be handled specially, because they appear
|
|
# in the first row, even if they are done later. Here are the cases,
|
|
# according to http://s.petrunia.net/blog/?p=24:
|
|
|
|
# ... MySQL has three ways to run a join and produce ordered output:
|
|
# Method EXPLAIN output
|
|
# ################################## ####################################
|
|
# Use index-based access method that no mention of filesort
|
|
# produces ordered output
|
|
# ---------------------------------- ------------------------------------
|
|
# Use filesort() on 1st non-constant "Using filesort" in the first row
|
|
# table
|
|
# ---------------------------------- ------------------------------------
|
|
# Put join result into a temporary "Using temporary; Using filesort" in
|
|
# table and use filesort() on it the first row
|
|
# ---------------------------------- ------------------------------------
|
|
|
|
my $first = shift(@rows);
|
|
|
|
# This is "case three" above.
|
|
my $is_temp_filesort;
|
|
if ( $first->{Extra} =~ m/Using temporary; Using filesort/ ) {
|
|
# The entire join is being placed into a temporary table and filesorted,
|
|
# so I'll make a note of that and apply it afterwards. In the meantime I
|
|
# must remove mention of it from the node so the node doesn't get extra
|
|
# transformations in transform().
|
|
$is_temp_filesort = 1;
|
|
$first->{Extra} =~ s/Using temporary; Using filesort(?:; )?//;
|
|
}
|
|
|
|
# This is "case two" above. Must find first non-constant table and move
|
|
# the filesort() there.
|
|
elsif ( $first->{Extra} =~ m/Using filesort/ && $first->{type} =~ m/^(?:system|const)$/ ) {
|
|
my ( $first_non_const ) = grep { $_->{type} !~ m/^(?:system|const)$/ } @rows;
|
|
if ( $first_non_const ) {
|
|
$first->{Extra} =~ s/Using filesort(?:; )?//;
|
|
$first_non_const->{Extra} .= '; Using filesort';
|
|
}
|
|
}
|
|
|
|
my $scope = $first->{id};
|
|
my $tree = $self->transform($first);
|
|
my $i = 0;
|
|
while ( $i < @rows ) {
|
|
my $row = $rows[$i];
|
|
if ( $row->{id} == $scope ) {
|
|
$tree = {
|
|
type => 'JOIN',
|
|
children => [ $tree, $self->transform($row) ],
|
|
};
|
|
$i++;
|
|
}
|
|
else {
|
|
# It's another kind of "join". Find the enclosing scope boundaries and
|
|
# recurse. The scope starts at $i.
|
|
my $end = $i;
|
|
while ( $end < @rows && $rows[$end]->{id} >= $row->{id} ) {
|
|
$end++;
|
|
}
|
|
my @enclosed_scope = splice(@rows, $i, $end - $i);
|
|
$tree = {
|
|
type => $row->{select_type},
|
|
children => [ $tree, $self->build_query_plan(@enclosed_scope) ],
|
|
};
|
|
# Don't increment the pointer because I just removed rows from @rows.
|
|
# $i++
|
|
}
|
|
}
|
|
|
|
if ( $is_temp_filesort ) {
|
|
$tree = $self->filesort(
|
|
$self->temporary($tree, $self->recursive_table_name($tree)));
|
|
}
|
|
|
|
return $tree;
|
|
}
|
|
|
|
sub transform {
|
|
my ( $self, $row ) = @_;
|
|
|
|
my $sub = $row->{type};
|
|
|
|
# ##################################################################
|
|
# Dispatch to a class method to generate the tree.
|
|
# ##################################################################
|
|
my $no_matching_row = join('|',
|
|
"Impossible (?:WHERE|HAVING|ON)(?: noticed after reading const tables| condition)?",
|
|
'No matching.*row',
|
|
'(?:unique|const) row not found',
|
|
);
|
|
my $node
|
|
= $sub
|
|
? $self->$sub($row)
|
|
: $row->{Extra} =~ m/No tables/
|
|
? { type => ( $row->{select_type} !~ m/^(?:PRIMARY|SIMPLE)$/
|
|
? $row->{select_type}
|
|
: 'DUAL') }
|
|
: $row->{Extra} =~ m/(?:$no_matching_row)/i
|
|
? { type => 'IMPOSSIBLE' }
|
|
: $row->{Extra} =~ m/optimized away/
|
|
? { type => 'CONSTANT' }
|
|
: die "Can't handle " . Dumper($row);
|
|
|
|
my ($warn) = $row->{Extra} =~ m/($no_matching_row)/;
|
|
if ( $warn ) {
|
|
$node->{warning} = $warn;
|
|
}
|
|
|
|
# ##################################################################
|
|
# Apply other tree transformations.
|
|
# ##################################################################
|
|
if ( $row->{Extra} =~ m/Using where/ ) {
|
|
$node = {
|
|
type => 'Filter with WHERE',
|
|
children => [$node],
|
|
};
|
|
}
|
|
|
|
if ( $row->{Extra} =~ m/Using join buffer/ ) {
|
|
$node = {
|
|
type => 'Join buffer',
|
|
children => [$node],
|
|
};
|
|
}
|
|
|
|
if ( $row->{Extra} =~ m/Distinct|Not exists/ ) {
|
|
$node = {
|
|
type => 'Distinct/Not-Exists',
|
|
children => [$node],
|
|
};
|
|
}
|
|
|
|
if ( $row->{Extra} =~ m/Range checked for each record \(\w+ map: ([^\)]+)\)/ ) {
|
|
# (index map: N) is a bitmap of which indexes are used. For example:
|
|
# 0x5 base 16 (or base 10)
|
|
# 0101 base 2
|
|
# 4321 position of bits
|
|
# 3 1 indexes used
|
|
my $bitmap = eval "int($1)"; # Hex to decimal if it begins with '0x'
|
|
$bitmap = unpack("B32", pack("N", $bitmap)); # Convert into binary string of 1/0
|
|
$bitmap =~ s/^0+//; # Remove leading zeros
|
|
$bitmap = reverse $bitmap; # Iterate from left-to-right
|
|
my $possible_keys = join(',',
|
|
grep { substr($bitmap, $_ - 1, 1) }
|
|
( 1 .. length($bitmap) ));
|
|
$node = {
|
|
type => 'Re-evaluate indexes each row',
|
|
possible_keys => $possible_keys,
|
|
children => [$node],
|
|
};
|
|
}
|
|
|
|
if ( $row->{Extra} =~ m/Using filesort/ ) {
|
|
$node = $self->filesort($node);
|
|
}
|
|
|
|
if ( $row->{Extra} =~ m/Using temporary/ ) {
|
|
$node = $self->temporary($node, $row->{table}, 1);
|
|
}
|
|
|
|
# Add some data that will help me keep track of nodes as I manipulate
|
|
# them later
|
|
$node->{id} = $row->{id};
|
|
$node->{rowid} = $row->{rowid};
|
|
|
|
return $node;
|
|
}
|
|
|
|
sub index_of {
|
|
my ( $self, $id, @rows ) = @_;
|
|
my $i = 0;
|
|
foreach my $row ( @rows ) {
|
|
if ( $row->{id} && $row->{id} == $id ) {
|
|
return $i;
|
|
}
|
|
$i++;
|
|
}
|
|
die "Can't find row $id in "
|
|
. join(',', map { $_->{id} || '' } @rows);
|
|
}
|
|
|
|
sub pretty_print {
|
|
my ( $self, $node, $prefix ) = @_;
|
|
$prefix ||= '';
|
|
my $branch = $prefix ? substr($prefix, 0, length($prefix) -3) . '+- ' : '';
|
|
my $output = $branch . $node->{type} . "\n";
|
|
|
|
my @kids;
|
|
if ( $node->{children} ) {
|
|
@kids = reverse @{$node->{children}};
|
|
}
|
|
my $suffix = (@kids > 1) ? '| ' : ' ';
|
|
|
|
foreach my $thing ( qw(table key partitions possible_keys method key_len ref rows warning) ) {
|
|
if ( defined $node->{$thing} ) {
|
|
$output .= $prefix . sprintf('%-14s %s', $thing, $node->{$thing}) . "\n";
|
|
}
|
|
}
|
|
|
|
my $last_child = pop @kids;
|
|
foreach my $child ( @kids ) {
|
|
$output .= $self->pretty_print($child, $prefix . $suffix);
|
|
}
|
|
if ( $last_child ) {
|
|
$output .= $self->pretty_print($last_child, $prefix . ' ');
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
#############################################################################
|
|
# Each method in this section corresponds to a value you will find in the 'type'
|
|
# column in EXPLAIN.
|
|
#############################################################################
|
|
|
|
sub ALL {
|
|
my ( $self, $row ) = @_;
|
|
return {
|
|
type => 'Table scan',
|
|
rows => $row->{rows},
|
|
children => [$self->table($row)],
|
|
};
|
|
}
|
|
|
|
sub fulltext {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Fulltext scan');
|
|
}
|
|
|
|
sub range {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Index range scan');
|
|
}
|
|
|
|
sub index {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Index scan');
|
|
}
|
|
|
|
sub eq_ref {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Unique index lookup');
|
|
}
|
|
|
|
sub ref {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Index lookup');
|
|
}
|
|
|
|
sub ref_or_null {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Index lookup with extra null lookup');
|
|
}
|
|
|
|
sub const {
|
|
my ( $self, $row ) = @_;
|
|
if ( !$row->{key} ) {
|
|
return {
|
|
type => 'Constant table access',
|
|
rows => $row->{rows},
|
|
children => [$self->table($row)]
|
|
}
|
|
}
|
|
return $self->index_access($row, 'Constant index lookup');
|
|
}
|
|
|
|
sub system {
|
|
my ( $self, $row ) = @_;
|
|
return {
|
|
type => 'Constant table access',
|
|
rows => $row->{rows},
|
|
children => [$self->table($row)],
|
|
};
|
|
}
|
|
|
|
sub unique_subquery {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Unique subquery');
|
|
}
|
|
|
|
sub index_subquery {
|
|
my ( $self, $row ) = @_;
|
|
return $self->index_access($row, 'Index subquery');
|
|
}
|
|
|
|
# From the manual: "The Index Merge method is used to retrieve rows with
|
|
# several range scans and to merge their results into one." Therefore each
|
|
# index access should be shown as an index range scan. The unions and
|
|
# intersections can be recursive, as in
|
|
# union(intersect(key1,key2),intersect(key3,key4))
|
|
sub index_merge {
|
|
my ( $self, $row ) = @_;
|
|
my ( $merge_spec )
|
|
= $row->{Extra} =~ m/Using ((?:intersect|union|sort_union)\(.*?\))(?=;|$)/;
|
|
my ($merge, $num) = $self->recurse_index_merge($row, $merge_spec, 0);
|
|
|
|
# index_merge_bookmark_lookup note:
|
|
# From the manual, "If the used indexes don't cover all columns used in the
|
|
# query, full rows are retrieved only when the range conditions for all
|
|
# used keys are satisfied." So a bookmark lookup shouldn't be shown for
|
|
# all indexes; it should be shown from the merge results.
|
|
return $self->bookmark_lookup($merge, $row);
|
|
}
|
|
|
|
# ###########################################################################
|
|
# Helper subroutines.
|
|
# ###########################################################################
|
|
|
|
sub recursive_table_name {
|
|
my ( $self, $node ) = @_;
|
|
if ( $node->{table} ) {
|
|
return $node->{table};
|
|
}
|
|
if ( $node->{key} ) {
|
|
my ( $table ) = $node->{key} =~ m/(.*?)->/;
|
|
return $table;
|
|
}
|
|
if ( $node->{type} eq 'Bookmark lookup' ) {
|
|
return $node->{children}->[1]->{table};
|
|
}
|
|
if ( $node->{type} eq 'IMPOSSIBLE' ) {
|
|
return '<none>';
|
|
}
|
|
if ( $node->{children} ) {
|
|
return join(',',
|
|
grep { $_ }
|
|
map { $self->recursive_table_name($_) }
|
|
@{$node->{children}});
|
|
}
|
|
}
|
|
|
|
# $num is the number of nodes to the left of this node in a depth-first
|
|
# traversal. It lets me figure out which value goes in key_len.
|
|
my $bal; # Workaround for issue 90 (Variable "$bal" will not stay shared).
|
|
sub recurse_index_merge {
|
|
my ( $self, $row, $spec, $num ) = @_;
|
|
my ($type, $args) = $spec =~ m/(intersect|union|sort_union)\((.*)\)$/;
|
|
|
|
my @children;
|
|
|
|
# See 'man perlre' and search for 'matches a parenthesized group'.
|
|
$bal = qr/
|
|
\(
|
|
(?:
|
|
(?> [^()]+ ) # Non-parens without backtracking
|
|
|
|
|
(??{ $bal }) # Group with matching parens
|
|
)*
|
|
\)
|
|
/x;
|
|
|
|
# Extract a thing, followed by balanced parentheses.
|
|
foreach my $child ( $args =~ m/(\w+$bal)/g ) {
|
|
my ( $subtree, $num ) = $self->recurse_index_merge($row, $child, $num);
|
|
push @children, $subtree;
|
|
}
|
|
|
|
if ( !@children ) { # Recursion base case; $args is an index list
|
|
foreach my $idx ( split(/,/, $args) ) {
|
|
my $index_scan = $self->index_access($row, 'Index range scan', $idx);
|
|
$index_scan->{key_len} = ($row->{key_len} =~ m/(\d+)/g)[$num++];
|
|
push @children, $index_scan;
|
|
}
|
|
}
|
|
|
|
return (
|
|
{
|
|
type => 'Index merge',
|
|
method => $type,
|
|
rows => $row->{rows},
|
|
children => \@children,
|
|
},
|
|
$num
|
|
);
|
|
|
|
}
|
|
|
|
sub table {
|
|
my ( $self, $row ) = @_;
|
|
my $node = {
|
|
type => ($row->{table} && $row->{table} =~ m/^(derived|union)\(/)
|
|
? uc $1
|
|
: 'Table',
|
|
table => $row->{table},
|
|
possible_keys => $row->{possible_keys},
|
|
partitions => $row->{partitions},
|
|
};
|
|
if ( $row->{children} ) {
|
|
$node->{children} = $row->{children};
|
|
}
|
|
return $node;
|
|
}
|
|
|
|
sub bookmark_lookup {
|
|
my ( $self, $node, $row ) = @_;
|
|
if ( $row->{Extra} =~ m/Using index/
|
|
|| ( $self->{clustered} && $row->{key} && $row->{key} eq 'PRIMARY' ))
|
|
{
|
|
return $node;
|
|
}
|
|
return {
|
|
type => 'Bookmark lookup',
|
|
children => [ $node, $self->table($row) ],
|
|
};
|
|
}
|
|
|
|
sub filesort {
|
|
my ( $self, $node ) = @_;
|
|
return {
|
|
type => 'Filesort',
|
|
children => [$node],
|
|
};
|
|
}
|
|
|
|
sub temporary {
|
|
my ( $self, $node, $table_name, $is_scan ) = @_;
|
|
$node = {
|
|
type => 'TEMPORARY',
|
|
table => "temporary($table_name)",
|
|
possible_keys => undef,
|
|
partitions => undef,
|
|
children => [$node],
|
|
};
|
|
if ( $is_scan ) {
|
|
$node = {
|
|
type => 'Table scan',
|
|
rows => undef,
|
|
children => [ $node ],
|
|
};
|
|
}
|
|
return $node;
|
|
}
|
|
|
|
sub index_access {
|
|
my ( $self, $row, $type, $key ) = @_;
|
|
my $node = {
|
|
type => $type,
|
|
key => $row->{table} . '->' . ( $key || $row->{key} ),
|
|
possible_keys => $row->{possible_keys},
|
|
partitions => $row->{partitions},
|
|
key_len => $row->{key_len},
|
|
'ref' => $row->{ref},
|
|
rows => $row->{rows},
|
|
};
|
|
if ( $row->{Extra} =~ m/Full scan on NULL key/ ) {
|
|
$node->{warning} = 'Full scan on NULL key';
|
|
}
|
|
if ( $row->{Extra} =~ m/Using index for group-by/ ) {
|
|
$node->{type} = 'Loose index scan';
|
|
}
|
|
# See index_merge_bookmark_lookup note above.
|
|
if ( $row->{type} ne 'index_merge' ) {
|
|
$node = $self->bookmark_lookup($node, $row);
|
|
}
|
|
return $node;
|
|
}
|
|
|
|
# ###########################################################################
|
|
# OptionParser package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/OptionParser.pm
|
|
# t/lib/OptionParser.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package OptionParser;
|
|
|
|
use strict;
|
|
use warnings FATAL => 'all';
|
|
use English qw(-no_match_vars);
|
|
use constant PTDEBUG => $ENV{PTDEBUG} || 0;
|
|
|
|
use List::Util qw(max);
|
|
use Getopt::Long;
|
|
use Data::Dumper;
|
|
|
|
my $POD_link_re = '[LC]<"?([^">]+)"?>';
|
|
|
|
sub new {
|
|
my ( $class, %args ) = @_;
|
|
my @required_args = qw();
|
|
foreach my $arg ( @required_args ) {
|
|
die "I need a $arg argument" unless $args{$arg};
|
|
}
|
|
|
|
my ($program_name) = $PROGRAM_NAME =~ m/([.A-Za-z-]+)$/;
|
|
$program_name ||= $PROGRAM_NAME;
|
|
my $home = $ENV{HOME} || $ENV{HOMEPATH} || $ENV{USERPROFILE} || '.';
|
|
|
|
my %attributes = (
|
|
'type' => 1,
|
|
'short form' => 1,
|
|
'group' => 1,
|
|
'default' => 1,
|
|
'cumulative' => 1,
|
|
'negatable' => 1,
|
|
'repeatable' => 1, # means it can be specified more than once
|
|
);
|
|
|
|
my $self = {
|
|
head1 => 'OPTIONS', # These args are used internally
|
|
skip_rules => 0, # to instantiate another Option-
|
|
item => '--(.*)', # Parser obj that parses the
|
|
attributes => \%attributes, # DSN OPTIONS section. Tools
|
|
parse_attributes => \&_parse_attribs, # don't tinker with these args.
|
|
|
|
%args,
|
|
|
|
strict => 1, # disabled by a special rule
|
|
program_name => $program_name,
|
|
opts => {},
|
|
got_opts => 0,
|
|
short_opts => {},
|
|
defaults => {},
|
|
groups => {},
|
|
allowed_groups => {},
|
|
errors => [],
|
|
rules => [], # desc of rules for --help
|
|
mutex => [], # rule: opts are mutually exclusive
|
|
atleast1 => [], # rule: at least one opt is required
|
|
disables => {}, # rule: opt disables other opts
|
|
defaults_to => {}, # rule: opt defaults to value of other opt
|
|
DSNParser => undef,
|
|
default_files => [
|
|
"/etc/percona-toolkit/percona-toolkit.conf",
|
|
"/etc/percona-toolkit/$program_name.conf",
|
|
"$home/.percona-toolkit.conf",
|
|
"$home/.$program_name.conf",
|
|
],
|
|
types => {
|
|
string => 's', # standard Getopt type
|
|
int => 'i', # standard Getopt type
|
|
float => 'f', # standard Getopt type
|
|
Hash => 'H', # hash, formed from a comma-separated list
|
|
hash => 'h', # hash as above, but only if a value is given
|
|
Array => 'A', # array, similar to Hash
|
|
array => 'a', # array, similar to hash
|
|
DSN => 'd', # DSN
|
|
size => 'z', # size with kMG suffix (powers of 2^10)
|
|
time => 'm', # time, with an optional suffix of s/h/m/d
|
|
},
|
|
};
|
|
|
|
return bless $self, $class;
|
|
}
|
|
|
|
sub get_specs {
|
|
my ( $self, $file ) = @_;
|
|
$file ||= $self->{file} || __FILE__;
|
|
my @specs = $self->_pod_to_specs($file);
|
|
$self->_parse_specs(@specs);
|
|
|
|
open my $fh, "<", $file or die "Cannot open $file: $OS_ERROR";
|
|
my $contents = do { local $/ = undef; <$fh> };
|
|
close $fh;
|
|
if ( $contents =~ m/^=head1 DSN OPTIONS/m ) {
|
|
PTDEBUG && _d('Parsing DSN OPTIONS');
|
|
my $dsn_attribs = {
|
|
dsn => 1,
|
|
copy => 1,
|
|
};
|
|
my $parse_dsn_attribs = sub {
|
|
my ( $self, $option, $attribs ) = @_;
|
|
map {
|
|
my $val = $attribs->{$_};
|
|
if ( $val ) {
|
|
$val = $val eq 'yes' ? 1
|
|
: $val eq 'no' ? 0
|
|
: $val;
|
|
$attribs->{$_} = $val;
|
|
}
|
|
} keys %$attribs;
|
|
return {
|
|
key => $option,
|
|
%$attribs,
|
|
};
|
|
};
|
|
my $dsn_o = new OptionParser(
|
|
description => 'DSN OPTIONS',
|
|
head1 => 'DSN OPTIONS',
|
|
dsn => 0, # XXX don't infinitely recurse!
|
|
item => '\* (.)', # key opts are a single character
|
|
skip_rules => 1, # no rules before opts
|
|
attributes => $dsn_attribs,
|
|
parse_attributes => $parse_dsn_attribs,
|
|
);
|
|
my @dsn_opts = map {
|
|
my $opts = {
|
|
key => $_->{spec}->{key},
|
|
dsn => $_->{spec}->{dsn},
|
|
copy => $_->{spec}->{copy},
|
|
desc => $_->{desc},
|
|
};
|
|
$opts;
|
|
} $dsn_o->_pod_to_specs($file);
|
|
$self->{DSNParser} = DSNParser->new(opts => \@dsn_opts);
|
|
}
|
|
|
|
if ( $contents =~ m/^=head1 VERSION\n\n^(.+)$/m ) {
|
|
$self->{version} = $1;
|
|
PTDEBUG && _d($self->{version});
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
sub DSNParser {
|
|
my ( $self ) = @_;
|
|
return $self->{DSNParser};
|
|
};
|
|
|
|
sub get_defaults_files {
|
|
my ( $self ) = @_;
|
|
return @{$self->{default_files}};
|
|
}
|
|
|
|
sub _pod_to_specs {
|
|
my ( $self, $file ) = @_;
|
|
$file ||= $self->{file} || __FILE__;
|
|
open my $fh, '<', $file or die "Cannot open $file: $OS_ERROR";
|
|
|
|
my @specs = ();
|
|
my @rules = ();
|
|
my $para;
|
|
|
|
local $INPUT_RECORD_SEPARATOR = '';
|
|
while ( $para = <$fh> ) {
|
|
next unless $para =~ m/^=head1 $self->{head1}/;
|
|
last;
|
|
}
|
|
|
|
while ( $para = <$fh> ) {
|
|
last if $para =~ m/^=over/;
|
|
next if $self->{skip_rules};
|
|
chomp $para;
|
|
$para =~ s/\s+/ /g;
|
|
$para =~ s/$POD_link_re/$1/go;
|
|
PTDEBUG && _d('Option rule:', $para);
|
|
push @rules, $para;
|
|
}
|
|
|
|
die "POD has no $self->{head1} section" unless $para;
|
|
|
|
do {
|
|
if ( my ($option) = $para =~ m/^=item $self->{item}/ ) {
|
|
chomp $para;
|
|
PTDEBUG && _d($para);
|
|
my %attribs;
|
|
|
|
$para = <$fh>; # read next paragraph, possibly attributes
|
|
|
|
if ( $para =~ m/: / ) { # attributes
|
|
$para =~ s/\s+\Z//g;
|
|
%attribs = map {
|
|
my ( $attrib, $val) = split(/: /, $_);
|
|
die "Unrecognized attribute for --$option: $attrib"
|
|
unless $self->{attributes}->{$attrib};
|
|
($attrib, $val);
|
|
} split(/; /, $para);
|
|
if ( $attribs{'short form'} ) {
|
|
$attribs{'short form'} =~ s/-//;
|
|
}
|
|
$para = <$fh>; # read next paragraph, probably short help desc
|
|
}
|
|
else {
|
|
PTDEBUG && _d('Option has no attributes');
|
|
}
|
|
|
|
$para =~ s/\s+\Z//g;
|
|
$para =~ s/\s+/ /g;
|
|
$para =~ s/$POD_link_re/$1/go;
|
|
|
|
$para =~ s/\.(?:\n.*| [A-Z].*|\Z)//s;
|
|
PTDEBUG && _d('Short help:', $para);
|
|
|
|
die "No description after option spec $option" if $para =~ m/^=item/;
|
|
|
|
if ( my ($base_option) = $option =~ m/^\[no\](.*)/ ) {
|
|
$option = $base_option;
|
|
$attribs{'negatable'} = 1;
|
|
}
|
|
|
|
push @specs, {
|
|
spec => $self->{parse_attributes}->($self, $option, \%attribs),
|
|
desc => $para
|
|
. (defined $attribs{default} ? " (default $attribs{default})" : ''),
|
|
group => ($attribs{'group'} ? $attribs{'group'} : 'default'),
|
|
attributes => \%attribs
|
|
};
|
|
}
|
|
while ( $para = <$fh> ) {
|
|
last unless $para;
|
|
if ( $para =~ m/^=head1/ ) {
|
|
$para = undef; # Can't 'last' out of a do {} block.
|
|
last;
|
|
}
|
|
last if $para =~ m/^=item /;
|
|
}
|
|
} while ( $para );
|
|
|
|
die "No valid specs in $self->{head1}" unless @specs;
|
|
|
|
close $fh;
|
|
return @specs, @rules;
|
|
}
|
|
|
|
sub _parse_specs {
|
|
my ( $self, @specs ) = @_;
|
|
my %disables; # special rule that requires deferred checking
|
|
|
|
foreach my $opt ( @specs ) {
|
|
if ( ref $opt ) { # It's an option spec, not a rule.
|
|
PTDEBUG && _d('Parsing opt spec:',
|
|
map { ($_, '=>', $opt->{$_}) } keys %$opt);
|
|
|
|
my ( $long, $short ) = $opt->{spec} =~ m/^([\w-]+)(?:\|([^!+=]*))?/;
|
|
if ( !$long ) {
|
|
die "Cannot parse long option from spec $opt->{spec}";
|
|
}
|
|
$opt->{long} = $long;
|
|
|
|
die "Duplicate long option --$long" if exists $self->{opts}->{$long};
|
|
$self->{opts}->{$long} = $opt;
|
|
|
|
if ( length $long == 1 ) {
|
|
PTDEBUG && _d('Long opt', $long, 'looks like short opt');
|
|
$self->{short_opts}->{$long} = $long;
|
|
}
|
|
|
|
if ( $short ) {
|
|
die "Duplicate short option -$short"
|
|
if exists $self->{short_opts}->{$short};
|
|
$self->{short_opts}->{$short} = $long;
|
|
$opt->{short} = $short;
|
|
}
|
|
else {
|
|
$opt->{short} = undef;
|
|
}
|
|
|
|
$opt->{is_negatable} = $opt->{spec} =~ m/!/ ? 1 : 0;
|
|
$opt->{is_cumulative} = $opt->{spec} =~ m/\+/ ? 1 : 0;
|
|
$opt->{is_repeatable} = $opt->{attributes}->{repeatable} ? 1 : 0;
|
|
$opt->{is_required} = $opt->{desc} =~ m/required/ ? 1 : 0;
|
|
|
|
$opt->{group} ||= 'default';
|
|
$self->{groups}->{ $opt->{group} }->{$long} = 1;
|
|
|
|
$opt->{value} = undef;
|
|
$opt->{got} = 0;
|
|
|
|
my ( $type ) = $opt->{spec} =~ m/=(.)/;
|
|
$opt->{type} = $type;
|
|
PTDEBUG && _d($long, 'type:', $type);
|
|
|
|
|
|
$opt->{spec} =~ s/=./=s/ if ( $type && $type =~ m/[HhAadzm]/ );
|
|
|
|
if ( (my ($def) = $opt->{desc} =~ m/default\b(?: ([^)]+))?/) ) {
|
|
$def = defined $def ? $def : 1;
|
|
$def = $def eq 'yes' ? 1 : $def eq 'no' ? 0 : $def;
|
|
$self->{defaults}->{$long} = $def;
|
|
PTDEBUG && _d($long, 'default:', $def);
|
|
}
|
|
|
|
if ( $long eq 'config' ) {
|
|
$self->{defaults}->{$long} = join(',', $self->get_defaults_files());
|
|
}
|
|
|
|
if ( (my ($dis) = $opt->{desc} =~ m/(disables .*)/) ) {
|
|
$disables{$long} = $dis;
|
|
PTDEBUG && _d('Deferring check of disables rule for', $opt, $dis);
|
|
}
|
|
|
|
$self->{opts}->{$long} = $opt;
|
|
}
|
|
else { # It's an option rule, not a spec.
|
|
PTDEBUG && _d('Parsing rule:', $opt);
|
|
push @{$self->{rules}}, $opt;
|
|
my @participants = $self->_get_participants($opt);
|
|
my $rule_ok = 0;
|
|
|
|
if ( $opt =~ m/mutually exclusive|one and only one/ ) {
|
|
$rule_ok = 1;
|
|
push @{$self->{mutex}}, \@participants;
|
|
PTDEBUG && _d(@participants, 'are mutually exclusive');
|
|
}
|
|
if ( $opt =~ m/at least one|one and only one/ ) {
|
|
$rule_ok = 1;
|
|
push @{$self->{atleast1}}, \@participants;
|
|
PTDEBUG && _d(@participants, 'require at least one');
|
|
}
|
|
if ( $opt =~ m/default to/ ) {
|
|
$rule_ok = 1;
|
|
$self->{defaults_to}->{$participants[0]} = $participants[1];
|
|
PTDEBUG && _d($participants[0], 'defaults to', $participants[1]);
|
|
}
|
|
if ( $opt =~ m/restricted to option groups/ ) {
|
|
$rule_ok = 1;
|
|
my ($groups) = $opt =~ m/groups ([\w\s\,]+)/;
|
|
my @groups = split(',', $groups);
|
|
%{$self->{allowed_groups}->{$participants[0]}} = map {
|
|
s/\s+//;
|
|
$_ => 1;
|
|
} @groups;
|
|
}
|
|
if( $opt =~ m/accepts additional command-line arguments/ ) {
|
|
$rule_ok = 1;
|
|
$self->{strict} = 0;
|
|
PTDEBUG && _d("Strict mode disabled by rule");
|
|
}
|
|
|
|
die "Unrecognized option rule: $opt" unless $rule_ok;
|
|
}
|
|
}
|
|
|
|
foreach my $long ( keys %disables ) {
|
|
my @participants = $self->_get_participants($disables{$long});
|
|
$self->{disables}->{$long} = \@participants;
|
|
PTDEBUG && _d('Option', $long, 'disables', @participants);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
sub _get_participants {
|
|
my ( $self, $str ) = @_;
|
|
my @participants;
|
|
foreach my $long ( $str =~ m/--(?:\[no\])?([\w-]+)/g ) {
|
|
die "Option --$long does not exist while processing rule $str"
|
|
unless exists $self->{opts}->{$long};
|
|
push @participants, $long;
|
|
}
|
|
PTDEBUG && _d('Participants for', $str, ':', @participants);
|
|
return @participants;
|
|
}
|
|
|
|
sub opts {
|
|
my ( $self ) = @_;
|
|
my %opts = %{$self->{opts}};
|
|
return %opts;
|
|
}
|
|
|
|
sub short_opts {
|
|
my ( $self ) = @_;
|
|
my %short_opts = %{$self->{short_opts}};
|
|
return %short_opts;
|
|
}
|
|
|
|
sub set_defaults {
|
|
my ( $self, %defaults ) = @_;
|
|
$self->{defaults} = {};
|
|
foreach my $long ( keys %defaults ) {
|
|
die "Cannot set default for nonexistent option $long"
|
|
unless exists $self->{opts}->{$long};
|
|
$self->{defaults}->{$long} = $defaults{$long};
|
|
PTDEBUG && _d('Default val for', $long, ':', $defaults{$long});
|
|
}
|
|
return;
|
|
}
|
|
|
|
sub get_defaults {
|
|
my ( $self ) = @_;
|
|
return $self->{defaults};
|
|
}
|
|
|
|
sub get_groups {
|
|
my ( $self ) = @_;
|
|
return $self->{groups};
|
|
}
|
|
|
|
sub _set_option {
|
|
my ( $self, $opt, $val ) = @_;
|
|
my $long = exists $self->{opts}->{$opt} ? $opt
|
|
: exists $self->{short_opts}->{$opt} ? $self->{short_opts}->{$opt}
|
|
: die "Getopt::Long gave a nonexistent option: $opt";
|
|
$opt = $self->{opts}->{$long};
|
|
if ( $opt->{is_cumulative} ) {
|
|
$opt->{value}++;
|
|
}
|
|
elsif ( ($opt->{type} || '') eq 's' && $val =~ m/^--?(.+)/ ) {
|
|
my $next_opt = $1;
|
|
if ( exists $self->{opts}->{$next_opt}
|
|
|| exists $self->{short_opts}->{$next_opt} ) {
|
|
$self->save_error("--$long requires a string value");
|
|
return;
|
|
}
|
|
else {
|
|
if ($opt->{is_repeatable}) {
|
|
push @{$opt->{value}} , $val;
|
|
}
|
|
else {
|
|
$opt->{value} = $val;
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
if ($opt->{is_repeatable}) {
|
|
push @{$opt->{value}} , $val;
|
|
}
|
|
else {
|
|
$opt->{value} = $val;
|
|
}
|
|
}
|
|
$opt->{got} = 1;
|
|
PTDEBUG && _d('Got option', $long, '=', $val);
|
|
}
|
|
|
|
sub get_opts {
|
|
my ( $self ) = @_;
|
|
|
|
foreach my $long ( keys %{$self->{opts}} ) {
|
|
$self->{opts}->{$long}->{got} = 0;
|
|
$self->{opts}->{$long}->{value}
|
|
= exists $self->{defaults}->{$long} ? $self->{defaults}->{$long}
|
|
: $self->{opts}->{$long}->{is_cumulative} ? 0
|
|
: undef;
|
|
}
|
|
$self->{got_opts} = 0;
|
|
|
|
$self->{errors} = [];
|
|
|
|
if ( @ARGV && $ARGV[0] =~/^--config=/ ) {
|
|
$ARGV[0] = substr($ARGV[0],9);
|
|
$ARGV[0] =~ s/^'(.*)'$/$1/;
|
|
$ARGV[0] =~ s/^"(.*)"$/$1/;
|
|
$self->_set_option('config', shift @ARGV);
|
|
}
|
|
if ( @ARGV && $ARGV[0] eq "--config" ) {
|
|
shift @ARGV;
|
|
$self->_set_option('config', shift @ARGV);
|
|
}
|
|
if ( $self->has('config') ) {
|
|
my @extra_args;
|
|
foreach my $filename ( split(',', $self->get('config')) ) {
|
|
eval {
|
|
push @extra_args, $self->_read_config_file($filename);
|
|
};
|
|
if ( $EVAL_ERROR ) {
|
|
if ( $self->got('config') ) {
|
|
die $EVAL_ERROR;
|
|
}
|
|
elsif ( PTDEBUG ) {
|
|
_d($EVAL_ERROR);
|
|
}
|
|
}
|
|
}
|
|
unshift @ARGV, @extra_args;
|
|
}
|
|
|
|
Getopt::Long::Configure('no_ignore_case', 'bundling');
|
|
GetOptions(
|
|
map { $_->{spec} => sub { $self->_set_option(@_); } }
|
|
grep { $_->{long} ne 'config' } # --config is handled specially above.
|
|
values %{$self->{opts}}
|
|
) or $self->save_error('Error parsing options');
|
|
|
|
if ( exists $self->{opts}->{version} && $self->{opts}->{version}->{got} ) {
|
|
if ( $self->{version} ) {
|
|
print $self->{version}, "\n";
|
|
exit 0;
|
|
}
|
|
else {
|
|
print "Error parsing version. See the VERSION section of the tool's documentation.\n";
|
|
exit 1;
|
|
}
|
|
}
|
|
|
|
if ( exists $self->{opts}->{'buffer-stdout'} && $self->{opts}->{'buffer-stdout'}->{got} ) {
|
|
STDOUT->autoflush(1 - $self->{opts}->{'buffer-stdout'}->{value});
|
|
}
|
|
|
|
if ( @ARGV && $self->{strict} ) {
|
|
$self->save_error("Unrecognized command-line options @ARGV");
|
|
}
|
|
|
|
foreach my $mutex ( @{$self->{mutex}} ) {
|
|
my @set = grep { $self->{opts}->{$_}->{got} } @$mutex;
|
|
if ( @set > 1 ) {
|
|
my $err = join(', ', map { "--$self->{opts}->{$_}->{long}" }
|
|
@{$mutex}[ 0 .. scalar(@$mutex) - 2] )
|
|
. ' and --'.$self->{opts}->{$mutex->[-1]}->{long}
|
|
. ' are mutually exclusive.';
|
|
$self->save_error($err);
|
|
}
|
|
}
|
|
|
|
foreach my $required ( @{$self->{atleast1}} ) {
|
|
my @set = grep { $self->{opts}->{$_}->{got} } @$required;
|
|
if ( @set == 0 ) {
|
|
my $err = join(', ', map { "--$self->{opts}->{$_}->{long}" }
|
|
@{$required}[ 0 .. scalar(@$required) - 2] )
|
|
.' or --'.$self->{opts}->{$required->[-1]}->{long};
|
|
$self->save_error("Specify at least one of $err");
|
|
}
|
|
}
|
|
|
|
$self->_check_opts( keys %{$self->{opts}} );
|
|
$self->{got_opts} = 1;
|
|
return;
|
|
}
|
|
|
|
sub _check_opts {
|
|
my ( $self, @long ) = @_;
|
|
my $long_last = scalar @long;
|
|
while ( @long ) {
|
|
foreach my $i ( 0..$#long ) {
|
|
my $long = $long[$i];
|
|
next unless $long;
|
|
my $opt = $self->{opts}->{$long};
|
|
if ( $opt->{got} ) {
|
|
if ( exists $self->{disables}->{$long} ) {
|
|
my @disable_opts = @{$self->{disables}->{$long}};
|
|
map { $self->{opts}->{$_}->{value} = undef; } @disable_opts;
|
|
PTDEBUG && _d('Unset options', @disable_opts,
|
|
'because', $long,'disables them');
|
|
}
|
|
|
|
if ( exists $self->{allowed_groups}->{$long} ) {
|
|
|
|
my @restricted_groups = grep {
|
|
!exists $self->{allowed_groups}->{$long}->{$_}
|
|
} keys %{$self->{groups}};
|
|
|
|
my @restricted_opts;
|
|
foreach my $restricted_group ( @restricted_groups ) {
|
|
RESTRICTED_OPT:
|
|
foreach my $restricted_opt (
|
|
keys %{$self->{groups}->{$restricted_group}} )
|
|
{
|
|
next RESTRICTED_OPT if $restricted_opt eq $long;
|
|
push @restricted_opts, $restricted_opt
|
|
if $self->{opts}->{$restricted_opt}->{got};
|
|
}
|
|
}
|
|
|
|
if ( @restricted_opts ) {
|
|
my $err;
|
|
if ( @restricted_opts == 1 ) {
|
|
$err = "--$restricted_opts[0]";
|
|
}
|
|
else {
|
|
$err = join(', ',
|
|
map { "--$self->{opts}->{$_}->{long}" }
|
|
grep { $_ }
|
|
@restricted_opts[0..scalar(@restricted_opts) - 2]
|
|
)
|
|
. ' or --'.$self->{opts}->{$restricted_opts[-1]}->{long};
|
|
}
|
|
$self->save_error("--$long is not allowed with $err");
|
|
}
|
|
}
|
|
|
|
}
|
|
elsif ( $opt->{is_required} ) {
|
|
$self->save_error("Required option --$long must be specified");
|
|
}
|
|
|
|
$self->_validate_type($opt);
|
|
if ( $opt->{parsed} ) {
|
|
delete $long[$i];
|
|
}
|
|
else {
|
|
PTDEBUG && _d('Temporarily failed to parse', $long);
|
|
}
|
|
}
|
|
|
|
die "Failed to parse options, possibly due to circular dependencies"
|
|
if @long == $long_last;
|
|
$long_last = @long;
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
sub _validate_type {
|
|
my ( $self, $opt ) = @_;
|
|
return unless $opt;
|
|
|
|
if ( !$opt->{type} ) {
|
|
$opt->{parsed} = 1;
|
|
return;
|
|
}
|
|
|
|
my $val = $opt->{value};
|
|
|
|
if ( $val && $opt->{type} eq 'm' ) { # type time
|
|
PTDEBUG && _d('Parsing option', $opt->{long}, 'as a time value');
|
|
my ( $prefix, $num, $suffix ) = $val =~ m/([+-]?)(\d+)([a-z])?$/;
|
|
if ( !$suffix ) {
|
|
my ( $s ) = $opt->{desc} =~ m/\(suffix (.)\)/;
|
|
$suffix = $s || 's';
|
|
PTDEBUG && _d('No suffix given; using', $suffix, 'for',
|
|
$opt->{long}, '(value:', $val, ')');
|
|
}
|
|
if ( $suffix =~ m/[smhd]/ ) {
|
|
$val = $suffix eq 's' ? $num # Seconds
|
|
: $suffix eq 'm' ? $num * 60 # Minutes
|
|
: $suffix eq 'h' ? $num * 3600 # Hours
|
|
: $num * 86400; # Days
|
|
$opt->{value} = ($prefix || '') . $val;
|
|
PTDEBUG && _d('Setting option', $opt->{long}, 'to', $val);
|
|
}
|
|
else {
|
|
$self->save_error("Invalid time suffix for --$opt->{long}");
|
|
}
|
|
}
|
|
elsif ( $val && $opt->{type} eq 'd' ) { # type DSN
|
|
PTDEBUG && _d('Parsing option', $opt->{long}, 'as a DSN');
|
|
my $prev = {};
|
|
my $from_key = $self->{defaults_to}->{ $opt->{long} };
|
|
if ( $from_key ) {
|
|
PTDEBUG && _d($opt->{long}, 'DSN copies from', $from_key, 'DSN');
|
|
if ( $self->{opts}->{$from_key}->{parsed} ) {
|
|
$prev = $self->{opts}->{$from_key}->{value};
|
|
}
|
|
else {
|
|
PTDEBUG && _d('Cannot parse', $opt->{long}, 'until',
|
|
$from_key, 'parsed');
|
|
return;
|
|
}
|
|
}
|
|
my $defaults = $self->{DSNParser}->parse_options($self);
|
|
if (!$opt->{attributes}->{repeatable}) {
|
|
$opt->{value} = $self->{DSNParser}->parse($val, $prev, $defaults);
|
|
} else {
|
|
my $values = [];
|
|
for my $dsn_string (@$val) {
|
|
push @$values, $self->{DSNParser}->parse($dsn_string, $prev, $defaults);
|
|
}
|
|
$opt->{value} = $values;
|
|
}
|
|
}
|
|
elsif ( $val && $opt->{type} eq 'z' ) { # type size
|
|
PTDEBUG && _d('Parsing option', $opt->{long}, 'as a size value');
|
|
$self->_parse_size($opt, $val);
|
|
}
|
|
elsif ( $opt->{type} eq 'H' || (defined $val && $opt->{type} eq 'h') ) {
|
|
$opt->{value} = { map { $_ => 1 } split(/(?<!\\),\s*/, ($val || '')) };
|
|
}
|
|
elsif ( $opt->{type} eq 'A' || (defined $val && $opt->{type} eq 'a') ) {
|
|
$opt->{value} = [ split(/(?<!\\),\s*/, ($val || '')) ];
|
|
}
|
|
else {
|
|
PTDEBUG && _d('Nothing to validate for option',
|
|
$opt->{long}, 'type', $opt->{type}, 'value', $val);
|
|
}
|
|
|
|
$opt->{parsed} = 1;
|
|
return;
|
|
}
|
|
|
|
sub get {
|
|
my ( $self, $opt ) = @_;
|
|
my $long = (length $opt == 1 ? $self->{short_opts}->{$opt} : $opt);
|
|
die "Option $opt does not exist"
|
|
unless $long && exists $self->{opts}->{$long};
|
|
return $self->{opts}->{$long}->{value};
|
|
}
|
|
|
|
sub got {
|
|
my ( $self, $opt ) = @_;
|
|
my $long = (length $opt == 1 ? $self->{short_opts}->{$opt} : $opt);
|
|
die "Option $opt does not exist"
|
|
unless $long && exists $self->{opts}->{$long};
|
|
return $self->{opts}->{$long}->{got};
|
|
}
|
|
|
|
sub has {
|
|
my ( $self, $opt ) = @_;
|
|
my $long = (length $opt == 1 ? $self->{short_opts}->{$opt} : $opt);
|
|
return defined $long ? exists $self->{opts}->{$long} : 0;
|
|
}
|
|
|
|
sub set {
|
|
my ( $self, $opt, $val ) = @_;
|
|
my $long = (length $opt == 1 ? $self->{short_opts}->{$opt} : $opt);
|
|
die "Option $opt does not exist"
|
|
unless $long && exists $self->{opts}->{$long};
|
|
$self->{opts}->{$long}->{value} = $val;
|
|
return;
|
|
}
|
|
|
|
sub save_error {
|
|
my ( $self, $error ) = @_;
|
|
push @{$self->{errors}}, $error;
|
|
return;
|
|
}
|
|
|
|
sub errors {
|
|
my ( $self ) = @_;
|
|
return $self->{errors};
|
|
}
|
|
|
|
sub usage {
|
|
my ( $self ) = @_;
|
|
warn "No usage string is set" unless $self->{usage}; # XXX
|
|
return "Usage: " . ($self->{usage} || '') . "\n";
|
|
}
|
|
|
|
sub descr {
|
|
my ( $self ) = @_;
|
|
warn "No description string is set" unless $self->{description}; # XXX
|
|
my $descr = ($self->{description} || $self->{program_name} || '')
|
|
. " For more details, please use the --help option, "
|
|
. "or try 'perldoc $PROGRAM_NAME' "
|
|
. "for complete documentation.";
|
|
$descr = join("\n", $descr =~ m/(.{0,80})(?:\s+|$)/g)
|
|
unless $ENV{DONT_BREAK_LINES};
|
|
$descr =~ s/ +$//mg;
|
|
return $descr;
|
|
}
|
|
|
|
sub usage_or_errors {
|
|
my ( $self, $file, $return ) = @_;
|
|
$file ||= $self->{file} || __FILE__;
|
|
|
|
if ( !$self->{description} || !$self->{usage} ) {
|
|
PTDEBUG && _d("Getting description and usage from SYNOPSIS in", $file);
|
|
my %synop = $self->_parse_synopsis($file);
|
|
$self->{description} ||= $synop{description};
|
|
$self->{usage} ||= $synop{usage};
|
|
PTDEBUG && _d("Description:", $self->{description},
|
|
"\nUsage:", $self->{usage});
|
|
}
|
|
|
|
if ( $self->{opts}->{help}->{got} ) {
|
|
print $self->print_usage() or die "Cannot print usage: $OS_ERROR";
|
|
exit 0 unless $return;
|
|
}
|
|
elsif ( scalar @{$self->{errors}} ) {
|
|
print $self->print_errors() or die "Cannot print errors: $OS_ERROR";
|
|
exit 1 unless $return;
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
sub print_errors {
|
|
my ( $self ) = @_;
|
|
my $usage = $self->usage() . "\n";
|
|
if ( (my @errors = @{$self->{errors}}) ) {
|
|
$usage .= join("\n * ", 'Errors in command-line arguments:', @errors)
|
|
. "\n";
|
|
}
|
|
return $usage . "\n" . $self->descr();
|
|
}
|
|
|
|
sub print_usage {
|
|
my ( $self ) = @_;
|
|
die "Run get_opts() before print_usage()" unless $self->{got_opts};
|
|
my @opts = values %{$self->{opts}};
|
|
|
|
my $maxl = max(
|
|
map {
|
|
length($_->{long}) # option long name
|
|
+ ($_->{is_negatable} ? 4 : 0) # "[no]" if opt is negatable
|
|
+ ($_->{type} ? 2 : 0) # "=x" where x is the opt type
|
|
}
|
|
@opts);
|
|
|
|
my $maxs = max(0,
|
|
map {
|
|
length($_)
|
|
+ ($self->{opts}->{$_}->{is_negatable} ? 4 : 0)
|
|
+ ($self->{opts}->{$_}->{type} ? 2 : 0)
|
|
}
|
|
values %{$self->{short_opts}});
|
|
|
|
my $lcol = max($maxl, ($maxs + 3));
|
|
my $rcol = 80 - $lcol - 6;
|
|
my $rpad = ' ' x ( 80 - $rcol );
|
|
|
|
$maxs = max($lcol - 3, $maxs);
|
|
|
|
my $usage = $self->descr() . "\n" . $self->usage();
|
|
|
|
my @groups = reverse sort grep { $_ ne 'default'; } keys %{$self->{groups}};
|
|
push @groups, 'default';
|
|
|
|
foreach my $group ( reverse @groups ) {
|
|
$usage .= "\n".($group eq 'default' ? 'Options' : $group).":\n\n";
|
|
foreach my $opt (
|
|
sort { $a->{long} cmp $b->{long} }
|
|
grep { $_->{group} eq $group }
|
|
@opts )
|
|
{
|
|
my $long = $opt->{is_negatable} ? "[no]$opt->{long}" : $opt->{long};
|
|
my $short = $opt->{short};
|
|
my $desc = $opt->{desc};
|
|
|
|
$long .= $opt->{type} ? "=$opt->{type}" : "";
|
|
|
|
if ( $opt->{type} && $opt->{type} eq 'm' ) {
|
|
my ($s) = $desc =~ m/\(suffix (.)\)/;
|
|
$s ||= 's';
|
|
$desc =~ s/\s+\(suffix .\)//;
|
|
$desc .= ". Optional suffix s=seconds, m=minutes, h=hours, "
|
|
. "d=days; if no suffix, $s is used.";
|
|
}
|
|
$desc = join("\n$rpad", grep { $_ } $desc =~ m/(.{0,$rcol}(?!\W))(?:\s+|(?<=\W)|$)/g);
|
|
$desc =~ s/ +$//mg;
|
|
if ( $short ) {
|
|
$usage .= sprintf(" --%-${maxs}s -%s %s\n", $long, $short, $desc);
|
|
}
|
|
else {
|
|
$usage .= sprintf(" --%-${lcol}s %s\n", $long, $desc);
|
|
}
|
|
}
|
|
}
|
|
|
|
$usage .= "\nOption types: s=string, i=integer, f=float, h/H/a/A=comma-separated list, d=DSN, z=size, m=time\n";
|
|
|
|
if ( (my @rules = @{$self->{rules}}) ) {
|
|
$usage .= "\nRules:\n\n";
|
|
$usage .= join("\n", map { " $_" } @rules) . "\n";
|
|
}
|
|
if ( $self->{DSNParser} ) {
|
|
$usage .= "\n" . $self->{DSNParser}->usage();
|
|
}
|
|
$usage .= "\nOptions and values after processing arguments:\n\n";
|
|
foreach my $opt ( sort { $a->{long} cmp $b->{long} } @opts ) {
|
|
my $val = $opt->{value};
|
|
my $type = $opt->{type} || '';
|
|
my $bool = $opt->{spec} =~ m/^[\w-]+(?:\|[\w-])?!?$/;
|
|
$val = $bool ? ( $val ? 'TRUE' : 'FALSE' )
|
|
: !defined $val ? '(No value)'
|
|
: $type eq 'd' ? $self->{DSNParser}->as_string($val)
|
|
: $type =~ m/H|h/ ? join(',', sort keys %$val)
|
|
: $type =~ m/A|a/ ? join(',', @$val)
|
|
: $val;
|
|
$usage .= sprintf(" --%-${lcol}s %s\n", $opt->{long}, $val);
|
|
}
|
|
return $usage;
|
|
}
|
|
|
|
sub prompt_noecho {
|
|
shift @_ if ref $_[0] eq __PACKAGE__;
|
|
my ( $prompt ) = @_;
|
|
local $OUTPUT_AUTOFLUSH = 1;
|
|
print STDERR $prompt
|
|
or die "Cannot print: $OS_ERROR";
|
|
my $response;
|
|
eval {
|
|
require Term::ReadKey;
|
|
Term::ReadKey::ReadMode('noecho');
|
|
chomp($response = <STDIN>);
|
|
Term::ReadKey::ReadMode('normal');
|
|
print "\n"
|
|
or die "Cannot print: $OS_ERROR";
|
|
};
|
|
if ( $EVAL_ERROR ) {
|
|
die "Cannot read response; is Term::ReadKey installed? $EVAL_ERROR";
|
|
}
|
|
return $response;
|
|
}
|
|
|
|
sub _read_config_file {
|
|
my ( $self, $filename ) = @_;
|
|
open my $fh, "<", $filename or die "Cannot open $filename: $OS_ERROR\n";
|
|
my @args;
|
|
my $prefix = '--';
|
|
my $parse = 1;
|
|
|
|
LINE:
|
|
while ( my $line = <$fh> ) {
|
|
chomp $line;
|
|
next LINE if $line =~ m/^\s*(?:\#|\;|$)/;
|
|
$line =~ s/\s+#.*$//g;
|
|
$line =~ s/^\s+|\s+$//g;
|
|
if ( $line eq '--' ) {
|
|
$prefix = '';
|
|
$parse = 0;
|
|
next LINE;
|
|
}
|
|
|
|
if ( $parse
|
|
&& !$self->has('version-check')
|
|
&& $line =~ /version-check/
|
|
) {
|
|
next LINE;
|
|
}
|
|
|
|
if ( $parse
|
|
&& (my($opt, $arg) = $line =~ m/^\s*([^=\s]+?)(?:\s*=\s*(.*?)\s*)?$/)
|
|
) {
|
|
push @args, grep { defined $_ } ("$prefix$opt", $arg);
|
|
}
|
|
elsif ( $line =~ m/./ ) {
|
|
push @args, $line;
|
|
}
|
|
else {
|
|
die "Syntax error in file $filename at line $INPUT_LINE_NUMBER";
|
|
}
|
|
}
|
|
close $fh;
|
|
return @args;
|
|
}
|
|
|
|
sub read_para_after {
|
|
my ( $self, $file, $regex ) = @_;
|
|
open my $fh, "<", $file or die "Can't open $file: $OS_ERROR";
|
|
local $INPUT_RECORD_SEPARATOR = '';
|
|
my $para;
|
|
while ( $para = <$fh> ) {
|
|
next unless $para =~ m/^=pod$/m;
|
|
last;
|
|
}
|
|
while ( $para = <$fh> ) {
|
|
next unless $para =~ m/$regex/;
|
|
last;
|
|
}
|
|
$para = <$fh>;
|
|
chomp($para);
|
|
close $fh or die "Can't close $file: $OS_ERROR";
|
|
return $para;
|
|
}
|
|
|
|
sub clone {
|
|
my ( $self ) = @_;
|
|
|
|
my %clone = map {
|
|
my $hashref = $self->{$_};
|
|
my $val_copy = {};
|
|
foreach my $key ( keys %$hashref ) {
|
|
my $ref = ref $hashref->{$key};
|
|
$val_copy->{$key} = !$ref ? $hashref->{$key}
|
|
: $ref eq 'HASH' ? { %{$hashref->{$key}} }
|
|
: $ref eq 'ARRAY' ? [ @{$hashref->{$key}} ]
|
|
: $hashref->{$key};
|
|
}
|
|
$_ => $val_copy;
|
|
} qw(opts short_opts defaults);
|
|
|
|
foreach my $scalar ( qw(got_opts) ) {
|
|
$clone{$scalar} = $self->{$scalar};
|
|
}
|
|
|
|
return bless \%clone;
|
|
}
|
|
|
|
sub _parse_size {
|
|
my ( $self, $opt, $val ) = @_;
|
|
|
|
if ( lc($val || '') eq 'null' ) {
|
|
PTDEBUG && _d('NULL size for', $opt->{long});
|
|
$opt->{value} = 'null';
|
|
return;
|
|
}
|
|
|
|
my %factor_for = (k => 1_024, M => 1_048_576, G => 1_073_741_824);
|
|
my ($pre, $num, $factor) = $val =~ m/^([+-])?(\d+)([kMG])?$/;
|
|
if ( defined $num ) {
|
|
if ( $factor ) {
|
|
$num *= $factor_for{$factor};
|
|
PTDEBUG && _d('Setting option', $opt->{y},
|
|
'to num', $num, '* factor', $factor);
|
|
}
|
|
$opt->{value} = ($pre || '') . $num;
|
|
}
|
|
else {
|
|
$self->save_error("Invalid size for --$opt->{long}: $val");
|
|
}
|
|
return;
|
|
}
|
|
|
|
sub _parse_attribs {
|
|
my ( $self, $option, $attribs ) = @_;
|
|
my $types = $self->{types};
|
|
return $option
|
|
. ($attribs->{'short form'} ? '|' . $attribs->{'short form'} : '' )
|
|
. ($attribs->{'negatable'} ? '!' : '' )
|
|
. ($attribs->{'cumulative'} ? '+' : '' )
|
|
. ($attribs->{'type'} ? '=' . $types->{$attribs->{type}} : '' );
|
|
}
|
|
|
|
sub _parse_synopsis {
|
|
my ( $self, $file ) = @_;
|
|
$file ||= $self->{file} || __FILE__;
|
|
PTDEBUG && _d("Parsing SYNOPSIS in", $file);
|
|
|
|
local $INPUT_RECORD_SEPARATOR = ''; # read paragraphs
|
|
open my $fh, "<", $file or die "Cannot open $file: $OS_ERROR";
|
|
my $para;
|
|
1 while defined($para = <$fh>) && $para !~ m/^=head1 SYNOPSIS/;
|
|
die "$file does not contain a SYNOPSIS section" unless $para;
|
|
my @synop;
|
|
for ( 1..2 ) { # 1 for the usage, 2 for the description
|
|
my $para = <$fh>;
|
|
push @synop, $para;
|
|
}
|
|
close $fh;
|
|
PTDEBUG && _d("Raw SYNOPSIS text:", @synop);
|
|
my ($usage, $desc) = @synop;
|
|
die "The SYNOPSIS section in $file is not formatted properly"
|
|
unless $usage && $desc;
|
|
|
|
$usage =~ s/^\s*Usage:\s+(.+)/$1/;
|
|
chomp $usage;
|
|
|
|
$desc =~ s/\n/ /g;
|
|
$desc =~ s/\s{2,}/ /g;
|
|
$desc =~ s/\. ([A-Z][a-z])/. $1/g;
|
|
$desc =~ s/\s+$//;
|
|
|
|
return (
|
|
description => $desc,
|
|
usage => $usage,
|
|
);
|
|
};
|
|
|
|
sub set_vars {
|
|
my ($self, $file) = @_;
|
|
$file ||= $self->{file} || __FILE__;
|
|
|
|
my %user_vars;
|
|
my $user_vars = $self->has('set-vars') ? $self->get('set-vars') : undef;
|
|
if ( $user_vars ) {
|
|
foreach my $var_val ( @$user_vars ) {
|
|
my ($var, $val) = $var_val =~ m/([^\s=]+)=(\S+)/;
|
|
die "Invalid --set-vars value: $var_val\n" unless $var && defined $val;
|
|
$user_vars{$var} = {
|
|
val => $val,
|
|
default => 0,
|
|
};
|
|
}
|
|
}
|
|
|
|
my %default_vars;
|
|
my $default_vars = $self->read_para_after($file, qr/MAGIC_set_vars/);
|
|
if ( $default_vars ) {
|
|
%default_vars = map {
|
|
my $var_val = $_;
|
|
my ($var, $val) = $var_val =~ m/([^\s=]+)=(\S+)/;
|
|
die "Invalid --set-vars value: $var_val\n" unless $var && defined $val;
|
|
$var => {
|
|
val => $val,
|
|
default => 1,
|
|
};
|
|
} split("\n", $default_vars);
|
|
}
|
|
|
|
my %vars = (
|
|
%default_vars, # first the tool's defaults
|
|
%user_vars, # then the user's which overwrite the defaults
|
|
);
|
|
PTDEBUG && _d('--set-vars:', Dumper(\%vars));
|
|
return \%vars;
|
|
}
|
|
|
|
sub _d {
|
|
my ($package, undef, $line) = caller 0;
|
|
@_ = map { (my $temp = $_) =~ s/\n/\n# /g; $temp; }
|
|
map { defined $_ ? $_ : 'undef' }
|
|
@_;
|
|
print STDERR "# $package:$line $PID ", join(' ', @_), "\n";
|
|
}
|
|
|
|
if ( PTDEBUG ) {
|
|
print STDERR '# ', $^X, ' ', $], "\n";
|
|
if ( my $uname = `uname -a` ) {
|
|
$uname =~ s/\s+/ /g;
|
|
print STDERR "# $uname\n";
|
|
}
|
|
print STDERR '# Arguments: ',
|
|
join(' ', map { my $a = "_[$_]_"; $a =~ s/\n/\n# /g; $a; } @ARGV), "\n";
|
|
}
|
|
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End OptionParser package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# DSNParser package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/DSNParser.pm
|
|
# t/lib/DSNParser.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package DSNParser;
|
|
|
|
use strict;
|
|
use warnings FATAL => 'all';
|
|
use English qw(-no_match_vars);
|
|
use constant PTDEBUG => $ENV{PTDEBUG} || 0;
|
|
|
|
use Data::Dumper;
|
|
$Data::Dumper::Indent = 0;
|
|
$Data::Dumper::Quotekeys = 0;
|
|
|
|
my $dsn_sep = qr/(?<!\\),/;
|
|
|
|
eval {
|
|
require DBI;
|
|
};
|
|
my $have_dbi = $EVAL_ERROR ? 0 : 1;
|
|
|
|
sub new {
|
|
my ( $class, %args ) = @_;
|
|
foreach my $arg ( qw(opts) ) {
|
|
die "I need a $arg argument" unless $args{$arg};
|
|
}
|
|
my $self = {
|
|
opts => {} # h, P, u, etc. Should come from DSN OPTIONS section in POD.
|
|
};
|
|
foreach my $opt ( @{$args{opts}} ) {
|
|
if ( !$opt->{key} || !$opt->{desc} ) {
|
|
die "Invalid DSN option: ", Dumper($opt);
|
|
}
|
|
PTDEBUG && _d('DSN option:',
|
|
join(', ',
|
|
map { "$_=" . (defined $opt->{$_} ? ($opt->{$_} || '') : 'undef') }
|
|
keys %$opt
|
|
)
|
|
);
|
|
$self->{opts}->{$opt->{key}} = {
|
|
dsn => $opt->{dsn},
|
|
desc => $opt->{desc},
|
|
copy => $opt->{copy} || 0,
|
|
};
|
|
}
|
|
return bless $self, $class;
|
|
}
|
|
|
|
sub prop {
|
|
my ( $self, $prop, $value ) = @_;
|
|
if ( @_ > 2 ) {
|
|
PTDEBUG && _d('Setting', $prop, 'property');
|
|
$self->{$prop} = $value;
|
|
}
|
|
return $self->{$prop};
|
|
}
|
|
|
|
sub parse {
|
|
my ( $self, $dsn, $prev, $defaults ) = @_;
|
|
if ( !$dsn ) {
|
|
PTDEBUG && _d('No DSN to parse');
|
|
return;
|
|
}
|
|
PTDEBUG && _d('Parsing', $dsn);
|
|
$prev ||= {};
|
|
$defaults ||= {};
|
|
my %given_props;
|
|
my %final_props;
|
|
my $opts = $self->{opts};
|
|
|
|
foreach my $dsn_part ( split($dsn_sep, $dsn) ) {
|
|
$dsn_part =~ s/\\,/,/g;
|
|
if ( my ($prop_key, $prop_val) = $dsn_part =~ m/^(.)=(.*)$/ ) {
|
|
$given_props{$prop_key} = $prop_val;
|
|
}
|
|
else {
|
|
PTDEBUG && _d('Interpreting', $dsn_part, 'as h=', $dsn_part);
|
|
$given_props{h} = $dsn_part;
|
|
}
|
|
}
|
|
|
|
foreach my $key ( keys %$opts ) {
|
|
PTDEBUG && _d('Finding value for', $key);
|
|
$final_props{$key} = $given_props{$key};
|
|
if ( !defined $final_props{$key}
|
|
&& defined $prev->{$key} && $opts->{$key}->{copy} )
|
|
{
|
|
$final_props{$key} = $prev->{$key};
|
|
PTDEBUG && _d('Copying value for', $key, 'from previous DSN');
|
|
}
|
|
if ( !defined $final_props{$key} ) {
|
|
$final_props{$key} = $defaults->{$key};
|
|
PTDEBUG && _d('Copying value for', $key, 'from defaults');
|
|
}
|
|
}
|
|
|
|
foreach my $key ( keys %given_props ) {
|
|
die "Unknown DSN option '$key' in '$dsn'. For more details, "
|
|
. "please use the --help option, or try 'perldoc $PROGRAM_NAME' "
|
|
. "for complete documentation."
|
|
unless exists $opts->{$key};
|
|
}
|
|
if ( (my $required = $self->prop('required')) ) {
|
|
foreach my $key ( keys %$required ) {
|
|
die "Missing required DSN option '$key' in '$dsn'. For more details, "
|
|
. "please use the --help option, or try 'perldoc $PROGRAM_NAME' "
|
|
. "for complete documentation."
|
|
unless $final_props{$key};
|
|
}
|
|
}
|
|
|
|
return \%final_props;
|
|
}
|
|
|
|
sub parse_options {
|
|
my ( $self, $o ) = @_;
|
|
die 'I need an OptionParser object' unless ref $o eq 'OptionParser';
|
|
my $dsn_string
|
|
= join(',',
|
|
map { "$_=".$o->get($_); }
|
|
grep { $o->has($_) && $o->get($_) }
|
|
keys %{$self->{opts}}
|
|
);
|
|
PTDEBUG && _d('DSN string made from options:', $dsn_string);
|
|
return $self->parse($dsn_string);
|
|
}
|
|
|
|
sub as_string {
|
|
my ( $self, $dsn, $props ) = @_;
|
|
return $dsn unless ref $dsn;
|
|
my @keys = $props ? @$props : sort keys %$dsn;
|
|
return join(',',
|
|
map { "$_=" . ($_ eq 'p' ? '...' : $dsn->{$_}) }
|
|
grep {
|
|
exists $self->{opts}->{$_}
|
|
&& exists $dsn->{$_}
|
|
&& defined $dsn->{$_}
|
|
} @keys);
|
|
}
|
|
|
|
sub usage {
|
|
my ( $self ) = @_;
|
|
my $usage
|
|
= "DSN syntax is key=value[,key=value...] Allowable DSN keys:\n\n"
|
|
. " KEY COPY MEANING\n"
|
|
. " === ==== =============================================\n";
|
|
my %opts = %{$self->{opts}};
|
|
foreach my $key ( sort keys %opts ) {
|
|
$usage .= " $key "
|
|
. ($opts{$key}->{copy} ? 'yes ' : 'no ')
|
|
. ($opts{$key}->{desc} || '[No description]')
|
|
. "\n";
|
|
}
|
|
$usage .= "\n If the DSN is a bareword, the word is treated as the 'h' key.\n";
|
|
return $usage;
|
|
}
|
|
|
|
sub get_cxn_params {
|
|
my ( $self, $info ) = @_;
|
|
my $dsn;
|
|
my %opts = %{$self->{opts}};
|
|
my $driver = $self->prop('dbidriver') || '';
|
|
if ( $driver eq 'Pg' ) {
|
|
$dsn = 'DBI:Pg:dbname=' . ( $info->{D} || '' ) . ';'
|
|
. join(';', map { "$opts{$_}->{dsn}=$info->{$_}" }
|
|
grep { defined $info->{$_} }
|
|
qw(h P));
|
|
}
|
|
else {
|
|
$dsn = 'DBI:mysql:' . ( $info->{D} || '' ) . ';'
|
|
. join(';', map { "$opts{$_}->{dsn}=$info->{$_}" }
|
|
grep { defined $info->{$_} }
|
|
qw(F h P S A s))
|
|
. ';mysql_read_default_group=client'
|
|
. ($info->{L} ? ';mysql_local_infile=1' : '');
|
|
}
|
|
PTDEBUG && _d($dsn);
|
|
return ($dsn, $info->{u}, $info->{p});
|
|
}
|
|
|
|
sub fill_in_dsn {
|
|
my ( $self, $dbh, $dsn ) = @_;
|
|
my $vars = $dbh->selectall_hashref('SHOW VARIABLES', 'Variable_name');
|
|
my ($user, $db) = $dbh->selectrow_array('SELECT USER(), DATABASE()');
|
|
$user =~ s/@.*//;
|
|
$dsn->{h} ||= $vars->{hostname}->{Value};
|
|
$dsn->{S} ||= $vars->{'socket'}->{Value};
|
|
$dsn->{P} ||= $vars->{port}->{Value};
|
|
$dsn->{u} ||= $user;
|
|
$dsn->{D} ||= $db;
|
|
}
|
|
|
|
sub get_dbh {
|
|
my ( $self, $cxn_string, $user, $pass, $opts ) = @_;
|
|
$opts ||= {};
|
|
my $defaults = {
|
|
AutoCommit => 0,
|
|
RaiseError => 1,
|
|
PrintError => 0,
|
|
ShowErrorStatement => 1,
|
|
mysql_enable_utf8 => ($cxn_string =~ m/charset=utf8/i ? 1 : 0),
|
|
};
|
|
@{$defaults}{ keys %$opts } = values %$opts;
|
|
if (delete $defaults->{L}) { # L for LOAD DATA LOCAL INFILE, our own extension
|
|
$defaults->{mysql_local_infile} = 1;
|
|
}
|
|
|
|
if ( $opts->{mysql_use_result} ) {
|
|
$defaults->{mysql_use_result} = 1;
|
|
}
|
|
|
|
if ( !$have_dbi ) {
|
|
die "Cannot connect to MySQL because the Perl DBI module is not "
|
|
. "installed or not found. Run 'perl -MDBI' to see the directories "
|
|
. "that Perl searches for DBI. If DBI is not installed, try:\n"
|
|
. " Debian/Ubuntu apt-get install libdbi-perl\n"
|
|
. " RHEL/CentOS yum install perl-DBI\n"
|
|
. " OpenSolaris pkg install pkg:/SUNWpmdbi\n";
|
|
|
|
}
|
|
|
|
my $dbh;
|
|
my $tries = 2;
|
|
while ( !$dbh && $tries-- ) {
|
|
PTDEBUG && _d($cxn_string, ' ', $user, ' ', $pass,
|
|
join(', ', map { "$_=>$defaults->{$_}" } keys %$defaults ));
|
|
|
|
$dbh = eval { DBI->connect($cxn_string, $user, $pass, $defaults) };
|
|
|
|
if ( !$dbh && $EVAL_ERROR ) {
|
|
if ( $EVAL_ERROR =~ m/locate DBD\/mysql/i ) {
|
|
die "Cannot connect to MySQL because the Perl DBD::mysql module is "
|
|
. "not installed or not found. Run 'perl -MDBD::mysql' to see "
|
|
. "the directories that Perl searches for DBD::mysql. If "
|
|
. "DBD::mysql is not installed, try:\n"
|
|
. " Debian/Ubuntu apt-get install libdbd-mysql-perl\n"
|
|
. " RHEL/CentOS yum install perl-DBD-MySQL\n"
|
|
. " OpenSolaris pkg install pkg:/SUNWapu13dbd-mysql\n";
|
|
}
|
|
elsif ( $EVAL_ERROR =~ m/not a compiled character set|character set utf8/ ) {
|
|
PTDEBUG && _d('Going to try again without utf8 support');
|
|
delete $defaults->{mysql_enable_utf8};
|
|
}
|
|
if ( !$tries ) {
|
|
die $EVAL_ERROR;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $cxn_string =~ m/mysql/i ) {
|
|
my $sql;
|
|
|
|
my ($charset) = $cxn_string =~ m/charset=([\w]+)/;
|
|
if ( $charset ) {
|
|
$sql = qq{/*!40101 SET NAMES "$charset"*/};
|
|
PTDEBUG && _d($dbh, $sql);
|
|
eval { $dbh->do($sql) };
|
|
if ( $EVAL_ERROR ) {
|
|
die "Error setting NAMES to $charset: $EVAL_ERROR";
|
|
}
|
|
}
|
|
else {
|
|
my ($mysql_version) = eval { $dbh->selectrow_array('SELECT VERSION()') };
|
|
if ( $EVAL_ERROR ) {
|
|
die "Cannot get MySQL version: $EVAL_ERROR";
|
|
}
|
|
my (undef, $character_set_server) = eval { $dbh->selectrow_array("SHOW VARIABLES LIKE 'character_set_server'") };
|
|
if ( $EVAL_ERROR ) {
|
|
die "Cannot get MySQL var character_set_server: $EVAL_ERROR";
|
|
}
|
|
|
|
if ( $mysql_version =~ m/^(\d+)\.(\d)\.(\d+).*/ ) {
|
|
if ( $1 >= 8 && $character_set_server =~ m/^utf8/ ) {
|
|
$dbh->{mysql_enable_utf8} = 1;
|
|
$charset = $character_set_server;
|
|
my $msg = "MySQL version $mysql_version >= 8 and character_set_server = $character_set_server\n".
|
|
"Setting: SET NAMES $character_set_server";
|
|
PTDEBUG && _d($msg);
|
|
eval { $dbh->do("SET NAMES '$character_set_server'") };
|
|
if ( $EVAL_ERROR ) {
|
|
die "Cannot SET NAMES $character_set_server: $EVAL_ERROR";
|
|
}
|
|
}
|
|
}
|
|
}
|
|
PTDEBUG && _d('Enabling charset for STDOUT');
|
|
if ( $charset && $charset =~ m/^utf8/ ) {
|
|
binmode(STDOUT, ':utf8')
|
|
or die "Can't binmode(STDOUT, ':utf8'): $OS_ERROR";
|
|
binmode(STDERR, ':utf8')
|
|
or die "Can't binmode(STDERR, ':utf8'): $OS_ERROR";
|
|
}
|
|
else {
|
|
binmode(STDOUT) or die "Can't binmode(STDOUT): $OS_ERROR";
|
|
}
|
|
|
|
if ( my $vars = $self->prop('set-vars') ) {
|
|
$self->set_vars($dbh, $vars);
|
|
}
|
|
|
|
$sql = 'SELECT @@SQL_MODE';
|
|
PTDEBUG && _d($dbh, $sql);
|
|
my ($sql_mode) = eval { $dbh->selectrow_array($sql) };
|
|
if ( $EVAL_ERROR ) {
|
|
die "Error getting the current SQL_MODE: $EVAL_ERROR";
|
|
}
|
|
|
|
$sql = 'SET @@SQL_QUOTE_SHOW_CREATE = 1'
|
|
. '/*!40101, @@SQL_MODE=\'NO_AUTO_VALUE_ON_ZERO'
|
|
. ($sql_mode ? ",$sql_mode" : '')
|
|
. '\'*/';
|
|
PTDEBUG && _d($dbh, $sql);
|
|
eval { $dbh->do($sql) };
|
|
if ( $EVAL_ERROR ) {
|
|
die "Error setting SQL_QUOTE_SHOW_CREATE, SQL_MODE"
|
|
. ($sql_mode ? " and $sql_mode" : '')
|
|
. ": $EVAL_ERROR";
|
|
}
|
|
}
|
|
|
|
PTDEBUG && _d('DBH info: ',
|
|
$dbh,
|
|
Dumper($dbh->selectrow_hashref(
|
|
'SELECT DATABASE(), CONNECTION_ID(), VERSION()/*!50038 , @@hostname*/')),
|
|
'Connection info:', $dbh->{mysql_hostinfo},
|
|
'Character set info:', Dumper($dbh->selectall_arrayref(
|
|
"SHOW VARIABLES LIKE 'character_set%'", { Slice => {}})),
|
|
'$DBD::mysql::VERSION:', $DBD::mysql::VERSION,
|
|
'$DBI::VERSION:', $DBI::VERSION,
|
|
);
|
|
|
|
return $dbh;
|
|
}
|
|
|
|
sub get_hostname {
|
|
my ( $self, $dbh ) = @_;
|
|
if ( my ($host) = ($dbh->{mysql_hostinfo} || '') =~ m/^(\w+) via/ ) {
|
|
return $host;
|
|
}
|
|
my ( $hostname, $one ) = $dbh->selectrow_array(
|
|
'SELECT /*!50038 @@hostname, */ 1');
|
|
return $hostname;
|
|
}
|
|
|
|
sub disconnect {
|
|
my ( $self, $dbh ) = @_;
|
|
PTDEBUG && $self->print_active_handles($dbh);
|
|
$dbh->disconnect;
|
|
}
|
|
|
|
sub print_active_handles {
|
|
my ( $self, $thing, $level ) = @_;
|
|
$level ||= 0;
|
|
printf("# Active %sh: %s %s %s\n", ($thing->{Type} || 'undef'), "\t" x $level,
|
|
$thing, (($thing->{Type} || '') eq 'st' ? $thing->{Statement} || '' : ''))
|
|
or die "Cannot print: $OS_ERROR";
|
|
foreach my $handle ( grep {defined} @{ $thing->{ChildHandles} } ) {
|
|
$self->print_active_handles( $handle, $level + 1 );
|
|
}
|
|
}
|
|
|
|
sub copy {
|
|
my ( $self, $dsn_1, $dsn_2, %args ) = @_;
|
|
die 'I need a dsn_1 argument' unless $dsn_1;
|
|
die 'I need a dsn_2 argument' unless $dsn_2;
|
|
my %new_dsn = map {
|
|
my $key = $_;
|
|
my $val;
|
|
if ( $args{overwrite} ) {
|
|
$val = defined $dsn_1->{$key} ? $dsn_1->{$key} : $dsn_2->{$key};
|
|
}
|
|
else {
|
|
$val = defined $dsn_2->{$key} ? $dsn_2->{$key} : $dsn_1->{$key};
|
|
}
|
|
$key => $val;
|
|
} keys %{$self->{opts}};
|
|
return \%new_dsn;
|
|
}
|
|
|
|
sub set_vars {
|
|
my ($self, $dbh, $vars) = @_;
|
|
|
|
return unless $vars;
|
|
|
|
foreach my $var ( sort keys %$vars ) {
|
|
my $val = $vars->{$var}->{val};
|
|
|
|
(my $quoted_var = $var) =~ s/_/\\_/;
|
|
my ($var_exists, $current_val);
|
|
eval {
|
|
($var_exists, $current_val) = $dbh->selectrow_array(
|
|
"SHOW VARIABLES LIKE '$quoted_var'");
|
|
};
|
|
my $e = $EVAL_ERROR;
|
|
if ( $e ) {
|
|
PTDEBUG && _d($e);
|
|
}
|
|
|
|
if ( $vars->{$var}->{default} && !$var_exists ) {
|
|
PTDEBUG && _d('Not setting default var', $var,
|
|
'because it does not exist');
|
|
next;
|
|
}
|
|
|
|
if ( $current_val && $current_val eq $val ) {
|
|
PTDEBUG && _d('Not setting var', $var, 'because its value',
|
|
'is already', $val);
|
|
next;
|
|
}
|
|
|
|
my $sql = "SET SESSION $var=$val";
|
|
PTDEBUG && _d($dbh, $sql);
|
|
eval { $dbh->do($sql) };
|
|
if ( my $set_error = $EVAL_ERROR ) {
|
|
chomp($set_error);
|
|
$set_error =~ s/ at \S+ line \d+//;
|
|
my $msg = "Error setting $var: $set_error";
|
|
if ( $current_val ) {
|
|
$msg .= " The current value for $var is $current_val. "
|
|
. "If the variable is read only (not dynamic), specify "
|
|
. "--set-vars $var=$current_val to avoid this warning, "
|
|
. "else manually set the variable and restart MySQL.";
|
|
}
|
|
warn $msg . "\n\n";
|
|
}
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
sub _d {
|
|
my ($package, undef, $line) = caller 0;
|
|
@_ = map { (my $temp = $_) =~ s/\n/\n# /g; $temp; }
|
|
map { defined $_ ? $_ : 'undef' }
|
|
@_;
|
|
print STDERR "# $package:$line $PID ", join(' ', @_), "\n";
|
|
}
|
|
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End DSNParser package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# Daemon package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/Daemon.pm
|
|
# t/lib/Daemon.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package Daemon;
|
|
|
|
use strict;
|
|
use warnings FATAL => 'all';
|
|
use English qw(-no_match_vars);
|
|
|
|
use constant PTDEBUG => $ENV{PTDEBUG} || 0;
|
|
|
|
use POSIX qw(setsid);
|
|
use Fcntl qw(:DEFAULT);
|
|
|
|
sub new {
|
|
my ($class, %args) = @_;
|
|
my $self = {
|
|
log_file => $args{log_file},
|
|
pid_file => $args{pid_file},
|
|
daemonize => $args{daemonize},
|
|
force_log_file => $args{force_log_file},
|
|
parent_exit => $args{parent_exit},
|
|
pid_file_owner => 0,
|
|
utf8 => $args{utf8} // 0,
|
|
};
|
|
return bless $self, $class;
|
|
}
|
|
|
|
sub run {
|
|
my ($self) = @_;
|
|
|
|
my $daemonize = $self->{daemonize};
|
|
my $pid_file = $self->{pid_file};
|
|
my $log_file = $self->{log_file};
|
|
my $force_log_file = $self->{force_log_file};
|
|
my $parent_exit = $self->{parent_exit};
|
|
my $utf8 = $self->{utf8};
|
|
|
|
PTDEBUG && _d('Starting daemon');
|
|
|
|
if ( $pid_file ) {
|
|
eval {
|
|
$self->_make_pid_file(
|
|
pid => $PID, # parent's pid
|
|
pid_file => $pid_file,
|
|
);
|
|
};
|
|
die "$EVAL_ERROR\n" if $EVAL_ERROR;
|
|
if ( !$daemonize ) {
|
|
$self->{pid_file_owner} = $PID; # parent's pid
|
|
}
|
|
}
|
|
|
|
if ( $daemonize ) {
|
|
defined (my $child_pid = fork()) or die "Cannot fork: $OS_ERROR";
|
|
if ( $child_pid ) {
|
|
PTDEBUG && _d('Forked child', $child_pid);
|
|
$parent_exit->($child_pid) if $parent_exit;
|
|
exit 0;
|
|
}
|
|
|
|
POSIX::setsid() or die "Cannot start a new session: $OS_ERROR";
|
|
chdir '/' or die "Cannot chdir to /: $OS_ERROR";
|
|
|
|
if ( $pid_file ) {
|
|
$self->_update_pid_file(
|
|
pid => $PID, # child's pid
|
|
pid_file => $pid_file,
|
|
);
|
|
$self->{pid_file_owner} = $PID;
|
|
}
|
|
}
|
|
|
|
if ( $daemonize || $force_log_file ) {
|
|
PTDEBUG && _d('Redirecting STDIN to /dev/null');
|
|
close STDIN;
|
|
open STDIN, '/dev/null'
|
|
or die "Cannot reopen STDIN to /dev/null: $OS_ERROR";
|
|
if ( $log_file ) {
|
|
PTDEBUG && _d('Redirecting STDOUT and STDERR to', $log_file);
|
|
close STDOUT;
|
|
open STDOUT, '>>', $log_file
|
|
or die "Cannot open log file $log_file: $OS_ERROR";
|
|
if ( $utf8 ) {
|
|
binmode(STDOUT, ':utf8')
|
|
or die "Can't binmode(STDOUT, ':utf8'): $OS_ERROR";
|
|
}
|
|
|
|
|
|
close STDERR;
|
|
open STDERR, ">&STDOUT"
|
|
or die "Cannot dupe STDERR to STDOUT: $OS_ERROR";
|
|
if ( $utf8 ) {
|
|
binmode(STDERR, ':utf8')
|
|
or die "Can't binmode(STDERR, ':utf8'): $OS_ERROR";
|
|
}
|
|
}
|
|
else {
|
|
if ( -t STDOUT ) {
|
|
PTDEBUG && _d('No log file and STDOUT is a terminal;',
|
|
'redirecting to /dev/null');
|
|
close STDOUT;
|
|
open STDOUT, '>', '/dev/null'
|
|
or die "Cannot reopen STDOUT to /dev/null: $OS_ERROR";
|
|
}
|
|
if ( -t STDERR ) {
|
|
PTDEBUG && _d('No log file and STDERR is a terminal;',
|
|
'redirecting to /dev/null');
|
|
close STDERR;
|
|
open STDERR, '>', '/dev/null'
|
|
or die "Cannot reopen STDERR to /dev/null: $OS_ERROR";
|
|
}
|
|
}
|
|
|
|
$OUTPUT_AUTOFLUSH = 1;
|
|
}
|
|
|
|
PTDEBUG && _d('Daemon running');
|
|
return;
|
|
}
|
|
|
|
sub _make_pid_file {
|
|
my ($self, %args) = @_;
|
|
my @required_args = qw(pid pid_file);
|
|
foreach my $arg ( @required_args ) {
|
|
die "I need a $arg argument" unless $args{$arg};
|
|
};
|
|
my $pid = $args{pid};
|
|
my $pid_file = $args{pid_file};
|
|
|
|
eval {
|
|
sysopen(PID_FH, $pid_file, O_RDWR|O_CREAT|O_EXCL) or die $OS_ERROR;
|
|
print PID_FH $PID, "\n";
|
|
close PID_FH;
|
|
};
|
|
if ( my $e = $EVAL_ERROR ) {
|
|
if ( $e =~ m/file exists/i ) {
|
|
my $old_pid = $self->_check_pid_file(
|
|
pid_file => $pid_file,
|
|
pid => $PID,
|
|
);
|
|
if ( $old_pid ) {
|
|
warn "Overwriting PID file $pid_file because PID $old_pid "
|
|
. "is not running.\n";
|
|
}
|
|
$self->_update_pid_file(
|
|
pid => $PID,
|
|
pid_file => $pid_file
|
|
);
|
|
}
|
|
else {
|
|
die "Error creating PID file $pid_file: $e\n";
|
|
}
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
sub _check_pid_file {
|
|
my ($self, %args) = @_;
|
|
my @required_args = qw(pid_file pid);
|
|
foreach my $arg ( @required_args ) {
|
|
die "I need a $arg argument" unless $args{$arg};
|
|
};
|
|
my $pid_file = $args{pid_file};
|
|
my $pid = $args{pid};
|
|
|
|
PTDEBUG && _d('Checking if PID in', $pid_file, 'is running');
|
|
|
|
if ( ! -f $pid_file ) {
|
|
PTDEBUG && _d('PID file', $pid_file, 'does not exist');
|
|
return;
|
|
}
|
|
|
|
open my $fh, '<', $pid_file
|
|
or die "Error opening $pid_file: $OS_ERROR";
|
|
my $existing_pid = do { local $/; <$fh> };
|
|
chomp($existing_pid) if $existing_pid;
|
|
close $fh
|
|
or die "Error closing $pid_file: $OS_ERROR";
|
|
|
|
if ( $existing_pid ) {
|
|
if ( $existing_pid == $pid ) {
|
|
warn "The current PID $pid already holds the PID file $pid_file\n";
|
|
return;
|
|
}
|
|
else {
|
|
PTDEBUG && _d('Checking if PID', $existing_pid, 'is running');
|
|
my $pid_is_alive = kill 0, $existing_pid;
|
|
if ( $pid_is_alive ) {
|
|
die "PID file $pid_file exists and PID $existing_pid is running\n";
|
|
}
|
|
}
|
|
}
|
|
else {
|
|
die "PID file $pid_file exists but it is empty. Remove the file "
|
|
. "if the process is no longer running.\n";
|
|
}
|
|
|
|
return $existing_pid;
|
|
}
|
|
|
|
sub _update_pid_file {
|
|
my ($self, %args) = @_;
|
|
my @required_args = qw(pid pid_file);
|
|
foreach my $arg ( @required_args ) {
|
|
die "I need a $arg argument" unless $args{$arg};
|
|
};
|
|
my $pid = $args{pid};
|
|
my $pid_file = $args{pid_file};
|
|
|
|
open my $fh, '>', $pid_file
|
|
or die "Cannot open $pid_file: $OS_ERROR";
|
|
print { $fh } $pid, "\n"
|
|
or die "Cannot print to $pid_file: $OS_ERROR";
|
|
close $fh
|
|
or warn "Cannot close $pid_file: $OS_ERROR";
|
|
|
|
return;
|
|
}
|
|
|
|
sub remove_pid_file {
|
|
my ($self, $pid_file) = @_;
|
|
$pid_file ||= $self->{pid_file};
|
|
if ( $pid_file && -f $pid_file ) {
|
|
unlink $self->{pid_file}
|
|
or warn "Cannot remove PID file $pid_file: $OS_ERROR";
|
|
PTDEBUG && _d('Removed PID file');
|
|
}
|
|
else {
|
|
PTDEBUG && _d('No PID to remove');
|
|
}
|
|
return;
|
|
}
|
|
|
|
sub DESTROY {
|
|
my ($self) = @_;
|
|
|
|
if ( $self->{pid_file_owner} == $PID ) {
|
|
$self->remove_pid_file();
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
sub _d {
|
|
my ($package, undef, $line) = caller 0;
|
|
@_ = map { (my $temp = $_) =~ s/\n/\n# /g; $temp; }
|
|
map { defined $_ ? $_ : 'undef' }
|
|
@_;
|
|
print STDERR "# $package:$line $PID ", join(' ', @_), "\n";
|
|
}
|
|
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End Daemon package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# Lmo::Utils package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/Lmo/Utils.pm
|
|
# t/lib/Lmo/Utils.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package Lmo::Utils;
|
|
|
|
use strict;
|
|
use warnings qw( FATAL all );
|
|
require Exporter;
|
|
our (@ISA, @EXPORT, @EXPORT_OK);
|
|
|
|
BEGIN {
|
|
@ISA = qw(Exporter);
|
|
@EXPORT = @EXPORT_OK = qw(
|
|
_install_coderef
|
|
_unimport_coderefs
|
|
_glob_for
|
|
_stash_for
|
|
);
|
|
}
|
|
|
|
{
|
|
no strict 'refs';
|
|
sub _glob_for {
|
|
return \*{shift()}
|
|
}
|
|
|
|
sub _stash_for {
|
|
return \%{ shift() . "::" };
|
|
}
|
|
}
|
|
|
|
sub _install_coderef {
|
|
my ($to, $code) = @_;
|
|
|
|
return *{ _glob_for $to } = $code;
|
|
}
|
|
|
|
sub _unimport_coderefs {
|
|
my ($target, @names) = @_;
|
|
return unless @names;
|
|
my $stash = _stash_for($target);
|
|
foreach my $name (@names) {
|
|
if ($stash->{$name} and defined(&{$stash->{$name}})) {
|
|
delete $stash->{$name};
|
|
}
|
|
}
|
|
}
|
|
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End Lmo::Utils package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# Lmo::Meta package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/Lmo/Meta.pm
|
|
# t/lib/Lmo/Meta.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package Lmo::Meta;
|
|
use strict;
|
|
use warnings qw( FATAL all );
|
|
|
|
my %metadata_for;
|
|
|
|
sub new {
|
|
my $class = shift;
|
|
return bless { @_ }, $class
|
|
}
|
|
|
|
sub metadata_for {
|
|
my $self = shift;
|
|
my ($class) = @_;
|
|
|
|
return $metadata_for{$class} ||= {};
|
|
}
|
|
|
|
sub class { shift->{class} }
|
|
|
|
sub attributes {
|
|
my $self = shift;
|
|
return keys %{$self->metadata_for($self->class)}
|
|
}
|
|
|
|
sub attributes_for_new {
|
|
my $self = shift;
|
|
my @attributes;
|
|
|
|
my $class_metadata = $self->metadata_for($self->class);
|
|
while ( my ($attr, $meta) = each %$class_metadata ) {
|
|
if ( exists $meta->{init_arg} ) {
|
|
push @attributes, $meta->{init_arg}
|
|
if defined $meta->{init_arg};
|
|
}
|
|
else {
|
|
push @attributes, $attr;
|
|
}
|
|
}
|
|
return @attributes;
|
|
}
|
|
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End Lmo::Meta package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# Lmo::Object package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/Lmo/Object.pm
|
|
# t/lib/Lmo/Object.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package Lmo::Object;
|
|
|
|
use strict;
|
|
use warnings qw( FATAL all );
|
|
|
|
use Carp ();
|
|
use Scalar::Util qw(blessed);
|
|
|
|
use Lmo::Meta;
|
|
use Lmo::Utils qw(_glob_for);
|
|
|
|
sub new {
|
|
my $class = shift;
|
|
my $args = $class->BUILDARGS(@_);
|
|
|
|
my $class_metadata = Lmo::Meta->metadata_for($class);
|
|
|
|
my @args_to_delete;
|
|
while ( my ($attr, $meta) = each %$class_metadata ) {
|
|
next unless exists $meta->{init_arg};
|
|
my $init_arg = $meta->{init_arg};
|
|
|
|
if ( defined $init_arg ) {
|
|
$args->{$attr} = delete $args->{$init_arg};
|
|
}
|
|
else {
|
|
push @args_to_delete, $attr;
|
|
}
|
|
}
|
|
|
|
delete $args->{$_} for @args_to_delete;
|
|
|
|
for my $attribute ( keys %$args ) {
|
|
if ( my $coerce = $class_metadata->{$attribute}{coerce} ) {
|
|
$args->{$attribute} = $coerce->($args->{$attribute});
|
|
}
|
|
if ( my $isa_check = $class_metadata->{$attribute}{isa} ) {
|
|
my ($check_name, $check_sub) = @$isa_check;
|
|
$check_sub->($args->{$attribute});
|
|
}
|
|
}
|
|
|
|
while ( my ($attribute, $meta) = each %$class_metadata ) {
|
|
next unless $meta->{required};
|
|
Carp::confess("Attribute ($attribute) is required for $class")
|
|
if ! exists $args->{$attribute}
|
|
}
|
|
|
|
my $self = bless $args, $class;
|
|
|
|
my @build_subs;
|
|
my $linearized_isa = mro::get_linear_isa($class);
|
|
|
|
for my $isa_class ( @$linearized_isa ) {
|
|
unshift @build_subs, *{ _glob_for "${isa_class}::BUILD" }{CODE};
|
|
}
|
|
my @args = %$args;
|
|
for my $sub (grep { defined($_) && exists &$_ } @build_subs) {
|
|
$sub->( $self, @args);
|
|
}
|
|
return $self;
|
|
}
|
|
|
|
sub BUILDARGS {
|
|
shift; # No need for the classname
|
|
if ( @_ == 1 && ref($_[0]) ) {
|
|
Carp::confess("Single parameters to new() must be a HASH ref, not $_[0]")
|
|
unless ref($_[0]) eq ref({});
|
|
return {%{$_[0]}} # We want a new reference, always
|
|
}
|
|
else {
|
|
return { @_ };
|
|
}
|
|
}
|
|
|
|
sub meta {
|
|
my $class = shift;
|
|
$class = Scalar::Util::blessed($class) || $class;
|
|
return Lmo::Meta->new(class => $class);
|
|
}
|
|
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End Lmo::Object package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# Lmo::Types package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/Lmo/Types.pm
|
|
# t/lib/Lmo/Types.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package Lmo::Types;
|
|
|
|
use strict;
|
|
use warnings qw( FATAL all );
|
|
|
|
use Carp ();
|
|
use Scalar::Util qw(looks_like_number blessed);
|
|
|
|
|
|
our %TYPES = (
|
|
Bool => sub { !$_[0] || (defined $_[0] && looks_like_number($_[0]) && $_[0] == 1) },
|
|
Num => sub { defined $_[0] && looks_like_number($_[0]) },
|
|
Int => sub { defined $_[0] && looks_like_number($_[0]) && $_[0] == int($_[0]) },
|
|
Str => sub { defined $_[0] },
|
|
Object => sub { defined $_[0] && blessed($_[0]) },
|
|
FileHandle => sub { local $@; require IO::Handle; fileno($_[0]) && $_[0]->opened },
|
|
|
|
map {
|
|
my $type = /R/ ? $_ : uc $_;
|
|
$_ . "Ref" => sub { ref $_[0] eq $type }
|
|
} qw(Array Code Hash Regexp Glob Scalar)
|
|
);
|
|
|
|
sub check_type_constraints {
|
|
my ($attribute, $type_check, $check_name, $val) = @_;
|
|
( ref($type_check) eq 'CODE'
|
|
? $type_check->($val)
|
|
: (ref $val eq $type_check
|
|
|| ($val && $val eq $type_check)
|
|
|| (exists $TYPES{$type_check} && $TYPES{$type_check}->($val)))
|
|
)
|
|
|| Carp::confess(
|
|
qq<Attribute ($attribute) does not pass the type constraint because: >
|
|
. qq<Validation failed for '$check_name' with value >
|
|
. (defined $val ? Lmo::Dumper($val) : 'undef') )
|
|
}
|
|
|
|
sub _nested_constraints {
|
|
my ($attribute, $aggregate_type, $type) = @_;
|
|
|
|
my $inner_types;
|
|
if ( $type =~ /\A(ArrayRef|Maybe)\[(.*)\]\z/ ) {
|
|
$inner_types = _nested_constraints($1, $2);
|
|
}
|
|
else {
|
|
$inner_types = $TYPES{$type};
|
|
}
|
|
|
|
if ( $aggregate_type eq 'ArrayRef' ) {
|
|
return sub {
|
|
my ($val) = @_;
|
|
return unless ref($val) eq ref([]);
|
|
|
|
if ($inner_types) {
|
|
for my $value ( @{$val} ) {
|
|
return unless $inner_types->($value)
|
|
}
|
|
}
|
|
else {
|
|
for my $value ( @{$val} ) {
|
|
return unless $value && ($value eq $type
|
|
|| (Scalar::Util::blessed($value) && $value->isa($type)));
|
|
}
|
|
}
|
|
return 1;
|
|
};
|
|
}
|
|
elsif ( $aggregate_type eq 'Maybe' ) {
|
|
return sub {
|
|
my ($value) = @_;
|
|
return 1 if ! defined($value);
|
|
if ($inner_types) {
|
|
return unless $inner_types->($value)
|
|
}
|
|
else {
|
|
return unless $value eq $type
|
|
|| (Scalar::Util::blessed($value) && $value->isa($type));
|
|
}
|
|
return 1;
|
|
}
|
|
}
|
|
else {
|
|
Carp::confess("Nested aggregate types are only implemented for ArrayRefs and Maybe");
|
|
}
|
|
}
|
|
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End Lmo::Types package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# Lmo package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/Lmo.pm
|
|
# t/lib/Lmo.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
BEGIN {
|
|
$INC{"Lmo.pm"} = __FILE__;
|
|
package Lmo;
|
|
our $VERSION = '0.30_Percona'; # Forked from 0.30 of Mo.
|
|
|
|
|
|
use strict;
|
|
use warnings qw( FATAL all );
|
|
|
|
use Carp ();
|
|
use Scalar::Util qw(looks_like_number blessed);
|
|
|
|
use Lmo::Meta;
|
|
use Lmo::Object;
|
|
use Lmo::Types;
|
|
|
|
use Lmo::Utils;
|
|
|
|
my %export_for;
|
|
sub import {
|
|
warnings->import(qw(FATAL all));
|
|
strict->import();
|
|
|
|
my $caller = scalar caller(); # Caller's package
|
|
my %exports = (
|
|
extends => \&extends,
|
|
has => \&has,
|
|
with => \&with,
|
|
override => \&override,
|
|
confess => \&Carp::confess,
|
|
);
|
|
|
|
$export_for{$caller} = \%exports;
|
|
|
|
for my $keyword ( keys %exports ) {
|
|
_install_coderef "${caller}::$keyword" => $exports{$keyword};
|
|
}
|
|
|
|
if ( !@{ *{ _glob_for "${caller}::ISA" }{ARRAY} || [] } ) {
|
|
@_ = "Lmo::Object";
|
|
goto *{ _glob_for "${caller}::extends" }{CODE};
|
|
}
|
|
}
|
|
|
|
sub extends {
|
|
my $caller = scalar caller();
|
|
for my $class ( @_ ) {
|
|
_load_module($class);
|
|
}
|
|
_set_package_isa($caller, @_);
|
|
_set_inherited_metadata($caller);
|
|
}
|
|
|
|
sub _load_module {
|
|
my ($class) = @_;
|
|
|
|
(my $file = $class) =~ s{::|'}{/}g;
|
|
$file .= '.pm';
|
|
{ local $@; eval { require "$file" } } # or warn $@;
|
|
return;
|
|
}
|
|
|
|
sub with {
|
|
my $package = scalar caller();
|
|
require Role::Tiny;
|
|
for my $role ( @_ ) {
|
|
_load_module($role);
|
|
_role_attribute_metadata($package, $role);
|
|
}
|
|
Role::Tiny->apply_roles_to_package($package, @_);
|
|
}
|
|
|
|
sub _role_attribute_metadata {
|
|
my ($package, $role) = @_;
|
|
|
|
my $package_meta = Lmo::Meta->metadata_for($package);
|
|
my $role_meta = Lmo::Meta->metadata_for($role);
|
|
|
|
%$package_meta = (%$role_meta, %$package_meta);
|
|
}
|
|
|
|
sub has {
|
|
my $names = shift;
|
|
my $caller = scalar caller();
|
|
|
|
my $class_metadata = Lmo::Meta->metadata_for($caller);
|
|
|
|
for my $attribute ( ref $names ? @$names : $names ) {
|
|
my %args = @_;
|
|
my $method = ($args{is} || '') eq 'ro'
|
|
? sub {
|
|
Carp::confess("Cannot assign a value to a read-only accessor at reader ${caller}::${attribute}")
|
|
if $#_;
|
|
return $_[0]{$attribute};
|
|
}
|
|
: sub {
|
|
return $#_
|
|
? $_[0]{$attribute} = $_[1]
|
|
: $_[0]{$attribute};
|
|
};
|
|
|
|
$class_metadata->{$attribute} = ();
|
|
|
|
if ( my $type_check = $args{isa} ) {
|
|
my $check_name = $type_check;
|
|
|
|
if ( my ($aggregate_type, $inner_type) = $type_check =~ /\A(ArrayRef|Maybe)\[(.*)\]\z/ ) {
|
|
$type_check = Lmo::Types::_nested_constraints($attribute, $aggregate_type, $inner_type);
|
|
}
|
|
|
|
my $check_sub = sub {
|
|
my ($new_val) = @_;
|
|
Lmo::Types::check_type_constraints($attribute, $type_check, $check_name, $new_val);
|
|
};
|
|
|
|
$class_metadata->{$attribute}{isa} = [$check_name, $check_sub];
|
|
my $orig_method = $method;
|
|
$method = sub {
|
|
$check_sub->($_[1]) if $#_;
|
|
goto &$orig_method;
|
|
};
|
|
}
|
|
|
|
if ( my $builder = $args{builder} ) {
|
|
my $original_method = $method;
|
|
$method = sub {
|
|
$#_
|
|
? goto &$original_method
|
|
: ! exists $_[0]{$attribute}
|
|
? $_[0]{$attribute} = $_[0]->$builder
|
|
: goto &$original_method
|
|
};
|
|
}
|
|
|
|
if ( my $code = $args{default} ) {
|
|
Carp::confess("${caller}::${attribute}'s default is $code, but should be a coderef")
|
|
unless ref($code) eq 'CODE';
|
|
my $original_method = $method;
|
|
$method = sub {
|
|
$#_
|
|
? goto &$original_method
|
|
: ! exists $_[0]{$attribute}
|
|
? $_[0]{$attribute} = $_[0]->$code
|
|
: goto &$original_method
|
|
};
|
|
}
|
|
|
|
if ( my $role = $args{does} ) {
|
|
my $original_method = $method;
|
|
$method = sub {
|
|
if ( $#_ ) {
|
|
Carp::confess(qq<Attribute ($attribute) doesn't consume a '$role' role">)
|
|
unless Scalar::Util::blessed($_[1]) && eval { $_[1]->does($role) }
|
|
}
|
|
goto &$original_method
|
|
};
|
|
}
|
|
|
|
if ( my $coercion = $args{coerce} ) {
|
|
$class_metadata->{$attribute}{coerce} = $coercion;
|
|
my $original_method = $method;
|
|
$method = sub {
|
|
if ( $#_ ) {
|
|
return $original_method->($_[0], $coercion->($_[1]))
|
|
}
|
|
goto &$original_method;
|
|
}
|
|
}
|
|
|
|
_install_coderef "${caller}::$attribute" => $method;
|
|
|
|
if ( $args{required} ) {
|
|
$class_metadata->{$attribute}{required} = 1;
|
|
}
|
|
|
|
if ($args{clearer}) {
|
|
_install_coderef "${caller}::$args{clearer}"
|
|
=> sub { delete shift->{$attribute} }
|
|
}
|
|
|
|
if ($args{predicate}) {
|
|
_install_coderef "${caller}::$args{predicate}"
|
|
=> sub { exists shift->{$attribute} }
|
|
}
|
|
|
|
if ($args{handles}) {
|
|
_has_handles($caller, $attribute, \%args);
|
|
}
|
|
|
|
if (exists $args{init_arg}) {
|
|
$class_metadata->{$attribute}{init_arg} = $args{init_arg};
|
|
}
|
|
}
|
|
}
|
|
|
|
sub _has_handles {
|
|
my ($caller, $attribute, $args) = @_;
|
|
my $handles = $args->{handles};
|
|
|
|
my $ref = ref $handles;
|
|
my $kv;
|
|
if ( $ref eq ref [] ) {
|
|
$kv = { map { $_,$_ } @{$handles} };
|
|
}
|
|
elsif ( $ref eq ref {} ) {
|
|
$kv = $handles;
|
|
}
|
|
elsif ( $ref eq ref qr// ) {
|
|
Carp::confess("Cannot delegate methods based on a Regexp without a type constraint (isa)")
|
|
unless $args->{isa};
|
|
my $target_class = $args->{isa};
|
|
$kv = {
|
|
map { $_, $_ }
|
|
grep { $_ =~ $handles }
|
|
grep { !exists $Lmo::Object::{$_} && $target_class->can($_) }
|
|
grep { !$export_for{$target_class}->{$_} }
|
|
keys %{ _stash_for $target_class }
|
|
};
|
|
}
|
|
else {
|
|
Carp::confess("handles for $ref not yet implemented");
|
|
}
|
|
|
|
while ( my ($method, $target) = each %{$kv} ) {
|
|
my $name = _glob_for "${caller}::$method";
|
|
Carp::confess("You cannot overwrite a locally defined method ($method) with a delegation")
|
|
if defined &$name;
|
|
|
|
my ($target, @curried_args) = ref($target) ? @$target : $target;
|
|
*$name = sub {
|
|
my $self = shift;
|
|
my $delegate_to = $self->$attribute();
|
|
my $error = "Cannot delegate $method to $target because the value of $attribute";
|
|
Carp::confess("$error is not defined") unless $delegate_to;
|
|
Carp::confess("$error is not an object (got '$delegate_to')")
|
|
unless Scalar::Util::blessed($delegate_to) || (!ref($delegate_to) && $delegate_to->can($target));
|
|
return $delegate_to->$target(@curried_args, @_);
|
|
}
|
|
}
|
|
}
|
|
|
|
sub _set_package_isa {
|
|
my ($package, @new_isa) = @_;
|
|
my $package_isa = \*{ _glob_for "${package}::ISA" };
|
|
@{*$package_isa} = @new_isa;
|
|
}
|
|
|
|
sub _set_inherited_metadata {
|
|
my $class = shift;
|
|
my $class_metadata = Lmo::Meta->metadata_for($class);
|
|
my $linearized_isa = mro::get_linear_isa($class);
|
|
my %new_metadata;
|
|
|
|
for my $isa_class (reverse @$linearized_isa) {
|
|
my $isa_metadata = Lmo::Meta->metadata_for($isa_class);
|
|
%new_metadata = (
|
|
%new_metadata,
|
|
%$isa_metadata,
|
|
);
|
|
}
|
|
%$class_metadata = %new_metadata;
|
|
}
|
|
|
|
sub unimport {
|
|
my $caller = scalar caller();
|
|
my $target = caller;
|
|
_unimport_coderefs($target, keys %{$export_for{$caller}});
|
|
}
|
|
|
|
sub Dumper {
|
|
require Data::Dumper;
|
|
local $Data::Dumper::Indent = 0;
|
|
local $Data::Dumper::Sortkeys = 0;
|
|
local $Data::Dumper::Quotekeys = 0;
|
|
local $Data::Dumper::Terse = 1;
|
|
|
|
Data::Dumper::Dumper(@_)
|
|
}
|
|
|
|
BEGIN {
|
|
if ($] >= 5.010) {
|
|
{ local $@; require mro; }
|
|
}
|
|
else {
|
|
local $@;
|
|
eval {
|
|
require MRO::Compat;
|
|
} or do {
|
|
*mro::get_linear_isa = *mro::get_linear_isa_dfs = sub {
|
|
no strict 'refs';
|
|
|
|
my $classname = shift;
|
|
|
|
my @lin = ($classname);
|
|
my %stored;
|
|
foreach my $parent (@{"$classname\::ISA"}) {
|
|
my $plin = mro::get_linear_isa_dfs($parent);
|
|
foreach (@$plin) {
|
|
next if exists $stored{$_};
|
|
push(@lin, $_);
|
|
$stored{$_} = 1;
|
|
}
|
|
}
|
|
return \@lin;
|
|
};
|
|
}
|
|
}
|
|
}
|
|
|
|
sub override {
|
|
my ($methods, $code) = @_;
|
|
my $caller = scalar caller;
|
|
|
|
for my $method ( ref($methods) ? @$methods : $methods ) {
|
|
my $full_method = "${caller}::${method}";
|
|
*{_glob_for $full_method} = $code;
|
|
}
|
|
}
|
|
|
|
}
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End Lmo package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# VersionParser package
|
|
# This package is a copy without comments from the original. The original
|
|
# with comments and its test file can be found in the GitHub repository at,
|
|
# lib/VersionParser.pm
|
|
# t/lib/VersionParser.t
|
|
# See https://github.com/percona/percona-toolkit for more information.
|
|
# ###########################################################################
|
|
{
|
|
package VersionParser;
|
|
|
|
use Lmo;
|
|
use Scalar::Util qw(blessed);
|
|
use English qw(-no_match_vars);
|
|
use constant PTDEBUG => $ENV{PTDEBUG} || 0;
|
|
|
|
use overload (
|
|
'""' => "version",
|
|
'<=>' => "cmp",
|
|
'cmp' => "cmp",
|
|
fallback => 1,
|
|
);
|
|
|
|
use Carp ();
|
|
|
|
has major => (
|
|
is => 'ro',
|
|
isa => 'Int',
|
|
required => 1,
|
|
);
|
|
|
|
has [qw( minor revision )] => (
|
|
is => 'ro',
|
|
isa => 'Num',
|
|
);
|
|
|
|
has flavor => (
|
|
is => 'ro',
|
|
isa => 'Str',
|
|
default => sub { 'Unknown' },
|
|
);
|
|
|
|
has innodb_version => (
|
|
is => 'ro',
|
|
isa => 'Str',
|
|
default => sub { 'NO' },
|
|
);
|
|
|
|
sub series {
|
|
my $self = shift;
|
|
return $self->_join_version($self->major, $self->minor);
|
|
}
|
|
|
|
sub version {
|
|
my $self = shift;
|
|
return $self->_join_version($self->major, $self->minor, $self->revision);
|
|
}
|
|
|
|
sub is_in {
|
|
my ($self, $target) = @_;
|
|
|
|
return $self eq $target;
|
|
}
|
|
|
|
sub _join_version {
|
|
my ($self, @parts) = @_;
|
|
|
|
return join ".", map { my $c = $_; $c =~ s/^0\./0/; $c } grep defined, @parts;
|
|
}
|
|
sub _split_version {
|
|
my ($self, $str) = @_;
|
|
my @version_parts = map { s/^0(?=\d)/0./; $_ } $str =~ m/(\d+)/g;
|
|
return @version_parts[0..2];
|
|
}
|
|
|
|
sub normalized_version {
|
|
my ( $self ) = @_;
|
|
my $result = sprintf('%d%02d%02d', map { $_ || 0 } $self->major,
|
|
$self->minor,
|
|
$self->revision);
|
|
PTDEBUG && _d($self->version, 'normalizes to', $result);
|
|
return $result;
|
|
}
|
|
|
|
sub comment {
|
|
my ( $self, $cmd ) = @_;
|
|
my $v = $self->normalized_version();
|
|
|
|
return "/*!$v $cmd */"
|
|
}
|
|
|
|
my @methods = qw(major minor revision);
|
|
sub cmp {
|
|
my ($left, $right) = @_;
|
|
my $right_obj = (blessed($right) && $right->isa(ref($left)))
|
|
? $right
|
|
: ref($left)->new($right);
|
|
|
|
my $retval = 0;
|
|
for my $m ( @methods ) {
|
|
last unless defined($left->$m) && defined($right_obj->$m);
|
|
$retval = $left->$m <=> $right_obj->$m;
|
|
last if $retval;
|
|
}
|
|
return $retval;
|
|
}
|
|
|
|
sub BUILDARGS {
|
|
my $self = shift;
|
|
|
|
if ( @_ == 1 ) {
|
|
my %args;
|
|
if ( blessed($_[0]) && $_[0]->can("selectrow_hashref") ) {
|
|
PTDEBUG && _d("VersionParser got a dbh, trying to get the version");
|
|
my $dbh = $_[0];
|
|
local $dbh->{FetchHashKeyName} = 'NAME_lc';
|
|
my $query = eval {
|
|
$dbh->selectall_arrayref(q/SHOW VARIABLES LIKE 'version%'/, { Slice => {} })
|
|
};
|
|
if ( $query ) {
|
|
$query = { map { $_->{variable_name} => $_->{value} } @$query };
|
|
@args{@methods} = $self->_split_version($query->{version});
|
|
$args{flavor} = delete $query->{version_comment}
|
|
if $query->{version_comment};
|
|
}
|
|
elsif ( eval { ($query) = $dbh->selectrow_array(q/SELECT VERSION()/) } ) {
|
|
@args{@methods} = $self->_split_version($query);
|
|
}
|
|
else {
|
|
Carp::confess("Couldn't get the version from the dbh while "
|
|
. "creating a VersionParser object: $@");
|
|
}
|
|
$args{innodb_version} = eval { $self->_innodb_version($dbh) };
|
|
}
|
|
elsif ( !ref($_[0]) ) {
|
|
@args{@methods} = $self->_split_version($_[0]);
|
|
}
|
|
|
|
for my $method (@methods) {
|
|
delete $args{$method} unless defined $args{$method};
|
|
}
|
|
@_ = %args if %args;
|
|
}
|
|
|
|
return $self->SUPER::BUILDARGS(@_);
|
|
}
|
|
|
|
sub _innodb_version {
|
|
my ( $self, $dbh ) = @_;
|
|
return unless $dbh;
|
|
my $innodb_version = "NO";
|
|
|
|
my ($innodb) =
|
|
grep { $_->{engine} =~ m/InnoDB/i }
|
|
map {
|
|
my %hash;
|
|
@hash{ map { lc $_ } keys %$_ } = values %$_;
|
|
\%hash;
|
|
}
|
|
@{ $dbh->selectall_arrayref("SHOW ENGINES", {Slice=>{}}) };
|
|
if ( $innodb ) {
|
|
PTDEBUG && _d("InnoDB support:", $innodb->{support});
|
|
if ( $innodb->{support} =~ m/YES|DEFAULT/i ) {
|
|
my $vars = $dbh->selectrow_hashref(
|
|
"SHOW VARIABLES LIKE 'innodb_version'");
|
|
$innodb_version = !$vars ? "BUILTIN"
|
|
: ($vars->{Value} || $vars->{value});
|
|
}
|
|
else {
|
|
$innodb_version = $innodb->{support}; # probably DISABLED or NO
|
|
}
|
|
}
|
|
|
|
PTDEBUG && _d("InnoDB version:", $innodb_version);
|
|
return $innodb_version;
|
|
}
|
|
|
|
sub _d {
|
|
my ($package, undef, $line) = caller 0;
|
|
@_ = map { (my $temp = $_) =~ s/\n/\n# /g; $temp; }
|
|
map { defined $_ ? $_ : 'undef' }
|
|
@_;
|
|
print STDERR "# $package:$line $PID ", join(' ', @_), "\n";
|
|
}
|
|
|
|
no Lmo;
|
|
1;
|
|
}
|
|
# ###########################################################################
|
|
# End VersionParser package
|
|
# ###########################################################################
|
|
|
|
# ###########################################################################
|
|
# This is a combination of modules and programs in one -- a runnable module.
|
|
# http://www.perl.com/pub/a/2006/07/13/lightning-articles.html?page=last
|
|
# Or, look it up in the Camel book on pages 642 and 643 in the 3rd edition.
|
|
#
|
|
# Check at the end of this package for the call to main() which actually runs
|
|
# the program.
|
|
# ###########################################################################
|
|
package pt_visual_explain;
|
|
|
|
use English qw(-no_match_vars);
|
|
use Getopt::Long;
|
|
use Data::Dumper;
|
|
$Data::Dumper::Indent = 1;
|
|
$Data::Dumper::Quotekeys = 0;
|
|
|
|
use constant PTDEBUG => $ENV{PTDEBUG} || 0;
|
|
|
|
sub main {
|
|
@ARGV = @_; # set global ARGV for this package
|
|
|
|
# #######################################################################
|
|
# Get configuration information and parse command line options.
|
|
# #######################################################################
|
|
my $o = new OptionParser();
|
|
$o->get_specs();
|
|
$o->get_opts();
|
|
|
|
my $dp = $o->DSNParser();
|
|
$dp->prop('set-vars', $o->set_vars());
|
|
|
|
$o->usage_or_errors();
|
|
|
|
# ########################################################################
|
|
# If --pid, check it first since we'll die if it already exits.
|
|
# ########################################################################
|
|
my $daemon;
|
|
if ( my $pid_file = $o->get('pid') ) {
|
|
# We're not daemoninzing, it just handles PID stuff. Keep $daemon
|
|
# in the the scope of main() because when it's destroyed it automatically
|
|
# removes the PID file.
|
|
$daemon = new Daemon(
|
|
pid_file => $pid_file,
|
|
daemonize => 0,
|
|
);
|
|
$daemon->run();
|
|
}
|
|
|
|
# #######################################################################
|
|
# Get ready to do the main work.
|
|
# #######################################################################
|
|
# Magically read STDIN or files in @ARGV
|
|
my $text = do { local $INPUT_RECORD_SEPARATOR = undef; <>; };
|
|
my $rows;
|
|
|
|
if ( $o->got('connect') ) { # Connect to the database.
|
|
if ( $o->got('ask-pass') && !$o->got('password') ) {
|
|
$o->set('password', OptionParser::prompt_noecho("Enter password: "));
|
|
}
|
|
|
|
my $dsn = $dp->parse_options($o);
|
|
my $dbh = $dp->get_dbh($dp->get_cxn_params($dsn), { AutoCommit => 1 } );
|
|
|
|
my $vp = VersionParser->new($dbh);
|
|
if ( $vp->cmp('8.0') < 0 || $vp->flavor() =~ m/maria/i ) {
|
|
$text =~ s{^.*?select}{EXPLAIN /*!50115 PARTITIONS*/ SELECT}is;
|
|
} else {
|
|
$text =~ s{^.*?select}{EXPLAIN SELECT}is;
|
|
}
|
|
$rows = $dbh->selectall_arrayref($text, { Slice => {} } );
|
|
$dbh->disconnect();
|
|
}
|
|
else {
|
|
$rows = ExplainParser->new->parse($text);
|
|
}
|
|
|
|
# #######################################################################
|
|
# Do the main work.
|
|
# #######################################################################
|
|
my $et = ExplainTree->new();
|
|
my $tree = $et->process($rows, { clustered => $o->get('clustered-pk') });
|
|
if ( $tree ) {
|
|
print $o->get('format') eq 'dump' ? Dumper($tree)
|
|
: $et->pretty_print($tree);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
# ############################################################################
|
|
# Run the program.
|
|
# ############################################################################
|
|
if ( !caller ) { exit main(@ARGV); }
|
|
|
|
1; # Because this is a module as well as a script.
|
|
|
|
# ############################################################################
|
|
# Documentation.
|
|
# ############################################################################
|
|
|
|
=pod
|
|
|
|
=head1 NAME
|
|
|
|
pt-visual-explain - Format EXPLAIN output as a tree.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
Usage: pt-visual-explain [OPTIONS] [FILES]
|
|
|
|
pt-visual-explain transforms EXPLAIN output into a tree representation of
|
|
the query plan. If FILE is given, input is read from the file(s). With no
|
|
FILE, or when FILE is -, read standard input.
|
|
|
|
Examples:
|
|
|
|
pt-visual-explain <file_containing_explain_output>
|
|
|
|
pt-visual-explain -c <file_containing_query>
|
|
|
|
mysql -e "explain select * from mysql.user" | pt-visual-explain
|
|
|
|
=head1 RISKS
|
|
|
|
Percona Toolkit is mature, proven in the real world, and well tested,
|
|
but all database tools can pose a risk to the system and the database
|
|
server. Before using this tool, please:
|
|
|
|
=over
|
|
|
|
=item * Read the tool's documentation
|
|
|
|
=item * Review the tool's known L<"BUGS">
|
|
|
|
=item * Test the tool on a non-production server
|
|
|
|
=item * Backup your production server and verify the backups
|
|
|
|
=back
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
pt-visual-explain reverse-engineers MySQL's EXPLAIN output into a query
|
|
execution plan, which it then formats as a left-deep tree -- the same way the
|
|
plan is represented inside MySQL. It is possible to do this by hand, or to read
|
|
EXPLAIN's output directly, but it requires patience and expertise. Many people
|
|
find a tree representation more understandable.
|
|
|
|
You can pipe input into pt-visual-explain or specify a filename at the
|
|
command line, including the magical '-' filename, which will read from standard
|
|
input. It can do two things with the input: parse it for something that looks
|
|
like EXPLAIN output, or connect to a MySQL instance and run EXPLAIN on the
|
|
input.
|
|
|
|
When parsing its input, pt-visual-explain understands three formats: tabular
|
|
like that shown in the mysql command-line client, vertical like that created by
|
|
using the \G line terminator in the mysql command-line client, and tab
|
|
separated. It ignores any lines it doesn't know how to parse.
|
|
|
|
When executing the input, pt-visual-explain replaces everything in the input
|
|
up to the first SELECT keyword with 'EXPLAIN SELECT,' and then executes the
|
|
result. You must specify L<"--connect"> to execute the input as a query.
|
|
|
|
Either way, it builds a tree from the result set and prints it to standard
|
|
output. For the following query,
|
|
|
|
select * from sakila.film_actor join sakila.film using(film_id);
|
|
|
|
pt-visual-explain generates this query plan:
|
|
|
|
JOIN
|
|
+- Bookmark lookup
|
|
| +- Table
|
|
| | table film_actor
|
|
| | possible_keys idx_fk_film_id
|
|
| +- Index lookup
|
|
| key film_actor->idx_fk_film_id
|
|
| possible_keys idx_fk_film_id
|
|
| key_len 2
|
|
| ref sakila.film.film_id
|
|
| rows 2
|
|
+- Table scan
|
|
rows 952
|
|
+- Table
|
|
table film
|
|
possible_keys PRIMARY
|
|
|
|
The query plan is left-deep, depth-first search, and the tree's root is the
|
|
output node -- the last step in the execution plan. In other words, read it
|
|
like this:
|
|
|
|
=over
|
|
|
|
=item 1
|
|
|
|
Table scan the 'film' table, which accesses an estimated 952 rows.
|
|
|
|
=item 2
|
|
|
|
For each row, find matching rows by doing an index lookup into the
|
|
film_actor->idx_fk_film_id index with the value from sakila.film.film_id, then a
|
|
bookmark lookup into the film_actor table.
|
|
|
|
=back
|
|
|
|
For more information on how to read EXPLAIN output, please see
|
|
L<http://dev.mysql.com/doc/en/explain.html>.
|
|
|
|
=head1 MODULES
|
|
|
|
This program is actually a runnable module, not just an ordinary Perl script.
|
|
In fact, there are two modules embedded in it. This makes unit testing easy,
|
|
but it also makes it easy for you to use the parsing and tree-building
|
|
functionality if you want.
|
|
|
|
The ExplainParser package accepts a string and parses whatever it thinks looks
|
|
like EXPLAIN output from it. The synopsis is as follows:
|
|
|
|
require "pt-visual-explain";
|
|
my $p = ExplainParser->new();
|
|
my $rows = $p->parse("some text");
|
|
# $rows is an arrayref of hashrefs.
|
|
|
|
The ExplainTree package accepts a set of rows and turns it into a tree. For
|
|
convenience, you can also have it delegate to ExplainParser and parse text for
|
|
you. Here's the synopsis:
|
|
|
|
require "pt-visual-explain";
|
|
my $e = ExplainTree->new();
|
|
my $tree = $e->parse("some text", \%options);
|
|
my $output = $e->pretty_print($tree);
|
|
print $tree;
|
|
|
|
=head1 ALGORITHM
|
|
|
|
This section explains the algorithm that converts EXPLAIN into a tree. You may
|
|
be interested in reading this if you want to understand EXPLAIN more fully, or
|
|
trying to figure out how this works, but otherwise this section will probably
|
|
not make your life richer.
|
|
|
|
The tree can be built by examining the id, select_type, and table columns of
|
|
each row.
|
|
|
|
The id column is the sequential number of the select. This does not indicate
|
|
nesting; it just comes from counting SELECT from the left of the SQL statement.
|
|
It's like capturing parentheses in a regular expression.
|
|
|
|
If two adjacent rows have the same id value, they are joined with the standard
|
|
single-sweep multi-join method.
|
|
|
|
The select_type column tells a) that a new sub-scope has opened b) what kind
|
|
of relationship the row has to the previous row c) what kind of operation the
|
|
row represents.
|
|
|
|
=over
|
|
|
|
=item *
|
|
|
|
SIMPLE means there are no subqueries or unions in the whole query.
|
|
|
|
=item *
|
|
|
|
PRIMARY means there are, but this is the outermost SELECT.
|
|
|
|
=item *
|
|
|
|
[DEPENDENT] UNION means this result is UNIONed with the previous result (not
|
|
row; a result might encompass more than one row).
|
|
|
|
=item *
|
|
|
|
UNION RESULT terminates a set of UNIONed results.
|
|
|
|
=item *
|
|
|
|
[DEPENDENT|UNCACHEABLE] SUBQUERY means a new sub-scope is opening. This is the
|
|
kind of subquery that happens in a WHERE clause, SELECT list or whatnot; it does
|
|
not return a so-called "derived table."
|
|
|
|
=item *
|
|
|
|
DERIVED is a subquery in the FROM clause.
|
|
|
|
=back
|
|
|
|
Tables that are JOINed all have the same select_type. For example, if you JOIN
|
|
three tables inside a dependent subquery, they'll all say the same thing:
|
|
DEPENDENT SUBQUERY.
|
|
|
|
The table column usually specifies the table name or alias, but may also say
|
|
<derivedN> or <unionN,N...N>. If it says <derivedN>, the row represents an
|
|
access to the temporary table that holds the result of the subquery whose id is
|
|
N. If it says <unionN,..N> it's the same thing, but it refers to the results it
|
|
UNIONs together.
|
|
|
|
Finally, order matters. If a row's id is less than the one before it,
|
|
that means it is dependent on something other than the one before it. For
|
|
example,
|
|
|
|
explain select
|
|
(select 1 from sakila.film),
|
|
(select 2 from sakila.film_actor),
|
|
(select 3 from sakila.actor);
|
|
|
|
| id | select_type | table |
|
|
+----+-------------+------------+
|
|
| 1 | PRIMARY | NULL |
|
|
| 4 | SUBQUERY | actor |
|
|
| 3 | SUBQUERY | film_actor |
|
|
| 2 | SUBQUERY | film |
|
|
|
|
If the results were in order 2-3-4, that would mean 3 is a subquery of
|
|
2, 4 is a subquery of 3. As it is, this means 4 is a subquery of the nearest
|
|
previous recent row with a smaller id, which is 1. Likewise for 3 and 2.
|
|
|
|
This structure is hard to programmatically build into a tree for the same reason
|
|
it's hard to understand by inspection: there are both forward and backward
|
|
references. <derivedN> is a forward reference to selectN, while <unionM,N> is a
|
|
backward reference to selectM and selectN. That makes recursion and other
|
|
tree-building algorithms hard to get right (NOTE: after implementation, I now
|
|
see how it would be possible to deal with both forward and backward references,
|
|
but I have no motivation to change something that works). Consider the
|
|
following:
|
|
|
|
select * from (
|
|
select 1 from sakila.actor as actor_1
|
|
union
|
|
select 1 from sakila.actor as actor_2
|
|
) as der_1
|
|
union
|
|
select * from (
|
|
select 1 from sakila.actor as actor_3
|
|
union all
|
|
select 1 from sakila.actor as actor_4
|
|
) as der_2;
|
|
|
|
| id | select_type | table |
|
|
+------+--------------+------------+
|
|
| 1 | PRIMARY | <derived2> |
|
|
| 2 | DERIVED | actor_1 |
|
|
| 3 | UNION | actor_2 |
|
|
| NULL | UNION RESULT | <union2,3> |
|
|
| 4 | UNION | <derived5> |
|
|
| 5 | DERIVED | actor_3 |
|
|
| 6 | UNION | actor_4 |
|
|
| NULL | UNION RESULT | <union5,6> |
|
|
| NULL | UNION RESULT | <union1,4> |
|
|
|
|
This would be a lot easier to work with if it looked like this (we've
|
|
bracketed the id on rows we moved):
|
|
|
|
| id | select_type | table |
|
|
+------+--------------+------------+
|
|
| [1] | UNION RESULT | <union1,4> |
|
|
| 1 | PRIMARY | <derived2> |
|
|
| [2] | UNION RESULT | <union2,3> |
|
|
| 2 | DERIVED | actor_1 |
|
|
| 3 | UNION | actor_2 |
|
|
| 4 | UNION | <derived5> |
|
|
| [5] | UNION RESULT | <union5,6> |
|
|
| 5 | DERIVED | actor_3 |
|
|
| 6 | UNION | actor_4 |
|
|
|
|
In fact, why not re-number all the ids, so the PRIMARY row becomes 2, and so on?
|
|
That would make it even easier to read. Unfortunately that would also have the
|
|
effect of destroying the meaning of the id column, which is important to
|
|
preserve in the final tree. Also, though it makes it easier to read, it doesn't
|
|
make it easier to manipulate programmatically; so it's fine to leave them
|
|
numbered as they are.
|
|
|
|
The goal of re-ordering is to make it easier to figure out which rows are
|
|
children of which rows in the execution plan. Given the reordered list and some
|
|
row whose table is <union...> or <derived>, it is easy to find the beginning of
|
|
the slice of rows that should be child nodes in the tree: you just look for the
|
|
first row whose ID is the same as the first number in the table.
|
|
|
|
The next question is how to find the last row that should be a child node of a
|
|
UNION or DERIVED. We'll start with DERIVED, because the solution makes UNION
|
|
easy.
|
|
|
|
Consider how MySQL numbers the SELECTs sequentially according to their position
|
|
in the SQL, left-to-right. Since a DERIVED table encloses everything within it
|
|
in a scope, which becomes a temporary table, there are only two things to think
|
|
about: its child subqueries and unions (if any), and its next siblings in the
|
|
scope that encloses it. Its children will all have an id greater than it does,
|
|
by definition, so any later rows with a smaller id terminate the scope.
|
|
|
|
Here's an example. The middle derived table here has a subquery and a UNION to
|
|
make it a little more complex for the example.
|
|
|
|
explain select 1
|
|
from (
|
|
select film_id from sakila.film limit 1
|
|
) as der_1
|
|
join (
|
|
select film_id, actor_id, (select count(*) from sakila.rental) as r
|
|
from sakila.film_actor limit 1
|
|
union all
|
|
select 1, 1, 1 from sakila.film_actor as dummy
|
|
) as der_2 using (film_id)
|
|
join (
|
|
select actor_id from sakila.actor limit 1
|
|
) as der_3 using (actor_id);
|
|
|
|
Here's the output of EXPLAIN:
|
|
|
|
| id | select_type | table |
|
|
| 1 | PRIMARY | <derived2> |
|
|
| 1 | PRIMARY | <derived6> |
|
|
| 1 | PRIMARY | <derived3> |
|
|
| 6 | DERIVED | actor |
|
|
| 3 | DERIVED | film_actor |
|
|
| 4 | SUBQUERY | rental |
|
|
| 5 | UNION | dummy |
|
|
| NULL | UNION RESULT | <union3,5> |
|
|
| 2 | DERIVED | film |
|
|
|
|
The siblings all have id 1, and the middle one we care about is derived3.
|
|
(Notice MySQL doesn't execute them in the order they are defined, which is fine).
|
|
Now notice that MySQL prints out the rows in the opposite order the subqueries
|
|
were defined: 6, 3, 2. It always seems to do this, and there might be other
|
|
methods of finding the scope boundaries including looking for the lower boundary
|
|
of the next largest sibling, but this is a good enough heuristic. We are forced
|
|
to rely on it for non-DERIVED subqueries, so we rely on it here too. Therefore,
|
|
we decide that everything greater than or equal to 3 belongs to the DERIVED
|
|
scope.
|
|
|
|
The rule for UNION is simple: they consume the entire enclosing scope, and to
|
|
find the component parts of each one, you find each part's beginning as referred
|
|
to in the <unionN,...> definition, and its end is either just before the next
|
|
one, or if it's the last part, the end is the end of the scope.
|
|
|
|
This is only simple because UNION consumes the entire scope, which is either the
|
|
entire statement, or the scope of a DERIVED table. This is because a UNION
|
|
cannot be a sibling of another UNION or a table, DERIVED or not. (Try writing
|
|
such a statement if you don't see it intuitively). Therefore, you can just find
|
|
the enclosing scope's boundaries, and the rest is easy. Notice in the example
|
|
above, the UNION is over <union3,5>, which includes the row with id 4 -- it
|
|
includes every row between 3 and 5.
|
|
|
|
Finally, there are non-derived subqueries to deal with as well. In this case we
|
|
can't look at siblings to find the end of the scope as we did for DERIVED. We
|
|
have to trust that MySQL executes depth-first. Here's an example:
|
|
|
|
explain
|
|
select actor_id,
|
|
(
|
|
select count(film_id)
|
|
+ (select count(*) from sakila.film)
|
|
from sakila.film join sakila.film_actor using(film_id)
|
|
where exists(
|
|
select * from sakila.actor
|
|
where sakila.actor.actor_id = sakila.film_actor.actor_id
|
|
)
|
|
)
|
|
from sakila.actor;
|
|
|
|
| id | select_type | table |
|
|
| 1 | PRIMARY | actor |
|
|
| 2 | SUBQUERY | film |
|
|
| 2 | SUBQUERY | film_actor |
|
|
| 4 | DEPENDENT SUBQUERY | actor |
|
|
| 3 | SUBQUERY | film |
|
|
|
|
In order, the tree should be built like this:
|
|
|
|
=over
|
|
|
|
=item *
|
|
|
|
See row 1.
|
|
|
|
=item *
|
|
|
|
See row 2. It's a higher id than 1, so it's a subquery, along with every other
|
|
row whose id is greater than 2.
|
|
|
|
=item *
|
|
|
|
Inside this scope, see 2 and 2 and JOIN them. See 4. It's a higher id than 2,
|
|
so it's again a subquery; recurse. After that, see 3, which is also higher;
|
|
recurse.
|
|
|
|
=back
|
|
|
|
But the only reason the nested subquery didn't include select 3 is because
|
|
select 4 came first. In other words, if EXPLAIN looked like this,
|
|
|
|
| id | select_type | table |
|
|
| 1 | PRIMARY | actor |
|
|
| 2 | SUBQUERY | film |
|
|
| 2 | SUBQUERY | film_actor |
|
|
| 3 | SUBQUERY | film |
|
|
| 4 | DEPENDENT SUBQUERY | actor |
|
|
|
|
I would be forced to assume upon seeing select 3 that select 4 is a subquery
|
|
of it, rather than just being the next sibling in the enclosing scope.
|
|
|
|
UNION is a little more complicated than just "the entire scope is a UNION,"
|
|
because the UNION might itself be inside an enclosing scope that's only
|
|
indicated by the first item inside the UNION. There are only three kinds of
|
|
enclosing scopes: UNION, DERIVED, and SUBQUERY. A UNION can't enclose a UNION,
|
|
and a DERIVED has its own "scope markers," but a SUBQUERY in earlier versions
|
|
could wholly enclose a UNION, like this strange example on the empty table t1:
|
|
|
|
explain select * from t1 where not exists(
|
|
(select t11.i from t1 t11) union (select t12.i from t1 t12));
|
|
|
|
| id | select_type | table | Extra |
|
|
+------+--------------+------------+--------------------------------+
|
|
| 1 | PRIMARY | t1 | const row not found |
|
|
| 2 | SUBQUERY | NULL | No tables used |
|
|
| 3 | SUBQUERY | NULL | no matching row in const table |
|
|
| 4 | UNION | t12 | const row not found |
|
|
| NULL | UNION RESULT | <union2,4> | |
|
|
|
|
The UNION's backward references might make it look like the UNION encloses the
|
|
subquery, but studying the query makes it clear this isn't the case. So when a
|
|
UNION's first row says SUBQUERY, it is this special case that we cannot repeat
|
|
starting from MySQL 5.7.
|
|
|
|
Armed with this knowledge, it's possible to use recursion to turn the
|
|
parent-child relationship between all the rows into a tree representing the
|
|
execution plan.
|
|
|
|
MySQL prints the rows in execution order, even the forward and backward
|
|
references. At any given scope, the rows are processed as a left-deep tree.
|
|
MySQL does not do "bushy" execution plans. It begins with a table, finds a
|
|
matching row in the next table, and continues till the last table, when it emits
|
|
a row. When it runs out, it backtracks till it can find the next row and
|
|
repeats. There are subtleties of course, but this is the basic plan. This is
|
|
why MySQL transforms all RIGHT OUTER JOINs into LEFT OUTER JOINs and cannot do
|
|
FULL OUTER JOIN.
|
|
|
|
This means in any given scope, say
|
|
|
|
| id | select_type | table |
|
|
| 1 | SIMPLE | tbl1 |
|
|
| 1 | SIMPLE | tbl2 |
|
|
| 1 | SIMPLE | tbl3 |
|
|
|
|
The execution plan looks like a depth-first traversal of this tree:
|
|
|
|
JOIN
|
|
/ \
|
|
JOIN tbl3
|
|
/ \
|
|
tbl1 tbl2
|
|
|
|
The JOIN might not be a JOIN. It might be a subquery, for example. This comes
|
|
from the type column of EXPLAIN. The documentation says this is a "join type,"
|
|
but "access type" may be more accurate, because it's "how MySQL accesses rows."
|
|
|
|
pt-visual-explain decorates the tree significantly more than just turning
|
|
rows into nodes. Each node may get a series of transformations that turn it
|
|
into a subtree of more than one node. For example, an index scan not marked
|
|
with 'Using index' must do a bookmark lookup into the table rows; that is a
|
|
three-node subtree. However, after the above node-ordering and scoping stuff,
|
|
the rest of the process is pretty simple.
|
|
|
|
=head1 OPTIONS
|
|
|
|
This tool accepts additional command-line arguments. Refer to the
|
|
L<"SYNOPSIS"> and usage information for details.
|
|
|
|
=over
|
|
|
|
=item --ask-pass
|
|
|
|
Prompt for a password when connecting to MySQL.
|
|
|
|
=item --[no]buffer-stdout
|
|
|
|
default: yes
|
|
|
|
Enables STDOUT buffering. Disable this option if you want to see live progress
|
|
when using output post-processing tools such as C<tee> or C<kubectl logs>.
|
|
|
|
=item --charset
|
|
|
|
short form: -A; type: string
|
|
|
|
Default character set. If the value is utf8, sets Perl's binmode on
|
|
STDOUT to utf8, passes the mysql_enable_utf8 option to DBD::mysql, and
|
|
runs SET NAMES UTF8 after connecting to MySQL. Any other value sets
|
|
binmode on STDOUT without the utf8 layer, and runs SET NAMES after
|
|
connecting to MySQL.
|
|
|
|
=item --clustered-pk
|
|
|
|
Assume that PRIMARY KEY index accesses don't need to do a bookmark lookup to
|
|
retrieve rows. This is the case for InnoDB.
|
|
|
|
=item --config
|
|
|
|
type: Array
|
|
|
|
Read this comma-separated list of config files; if specified, this must be the
|
|
first option on the command line.
|
|
|
|
=item --connect
|
|
|
|
short form: -c
|
|
|
|
Treat input as a query, and obtain EXPLAIN output by connecting to a MySQL
|
|
instance and running EXPLAIN on the query. When this option is given,
|
|
pt-visual-explain uses the other connection-specific options such as
|
|
L<"--user"> to connect to the MySQL instance. If you have a .my.cnf file,
|
|
it will read it, so you may not need to specify any connection-specific
|
|
options.
|
|
|
|
=item --database
|
|
|
|
short form: -D; type: string
|
|
|
|
Connect to this database.
|
|
|
|
=item --defaults-file
|
|
|
|
short form: -F; type: string
|
|
|
|
Only read mysql options from the given file. You must give an absolute
|
|
pathname.
|
|
|
|
=item --format
|
|
|
|
type: string; default: tree
|
|
|
|
Set output format.
|
|
|
|
The default is a terse pretty-printed tree. The valid values are:
|
|
|
|
Value Meaning
|
|
===== ================================================
|
|
tree Pretty-printed terse tree.
|
|
dump Data::Dumper output (see Data::Dumper for more).
|
|
|
|
=item --help
|
|
|
|
Show help and exit.
|
|
|
|
=item --host
|
|
|
|
short form: -h; type: string
|
|
|
|
Connect to host.
|
|
|
|
=item --mysql_ssl
|
|
|
|
short form: -s; type: int
|
|
|
|
Create SSL MySQL connection.
|
|
|
|
=item --password
|
|
|
|
short form: -p; type: string
|
|
|
|
Password to use when connecting.
|
|
If password contains commas they must be escaped with a backslash: "exam\,ple"
|
|
|
|
=item --pid
|
|
|
|
type: string
|
|
|
|
Create the given PID file. The tool won't start if the PID file already
|
|
exists and the PID it contains is different than the current PID. However,
|
|
if the PID file exists and the PID it contains is no longer running, the
|
|
tool will overwrite the PID file with the current PID. The PID file is
|
|
removed automatically when the tool exits.
|
|
|
|
=item --port
|
|
|
|
short form: -P; type: int
|
|
|
|
Port number to use for connection.
|
|
|
|
=item --set-vars
|
|
|
|
type: Array
|
|
|
|
Set the MySQL variables in this comma-separated list of C<variable=value> pairs.
|
|
|
|
By default, the tool sets:
|
|
|
|
=for comment ignore-pt-internal-value
|
|
MAGIC_set_vars
|
|
|
|
wait_timeout=10000
|
|
|
|
Variables specified on the command line override these defaults. For
|
|
example, specifying C<--set-vars wait_timeout=500> overrides the defaultvalue of C<10000>.
|
|
|
|
The tool prints a warning and continues if a variable cannot be set.
|
|
|
|
=item --socket
|
|
|
|
short form: -S; type: string
|
|
|
|
Socket file to use for connection.
|
|
|
|
=item --user
|
|
|
|
short form: -u; type: string
|
|
|
|
User for login if not current user.
|
|
|
|
=item --version
|
|
|
|
Show version and exit.
|
|
|
|
=back
|
|
|
|
=head1 DSN OPTIONS
|
|
|
|
These DSN options are used to create a DSN. Each option is given like
|
|
C<option=value>. The options are case-sensitive, so P and p are not the
|
|
same option. There cannot be whitespace before or after the C<=> and
|
|
if the value contains whitespace it must be quoted. DSN options are
|
|
comma-separated. See the L<percona-toolkit> manpage for full details.
|
|
|
|
=over
|
|
|
|
=item * A
|
|
|
|
dsn: charset; copy: yes
|
|
|
|
Default character set.
|
|
|
|
=item * D
|
|
|
|
dsn: database; copy: yes
|
|
|
|
Default database.
|
|
|
|
=item * F
|
|
|
|
dsn: mysql_read_default_file; copy: yes
|
|
|
|
Only read default options from the given file
|
|
|
|
=item * h
|
|
|
|
dsn: host; copy: yes
|
|
|
|
Connect to host.
|
|
|
|
=item * p
|
|
|
|
dsn: password; copy: yes
|
|
|
|
Password to use when connecting.
|
|
If password contains commas they must be escaped with a backslash: "exam\,ple"
|
|
|
|
=item * P
|
|
|
|
dsn: port; copy: yes
|
|
|
|
Port number to use for connection.
|
|
|
|
=item * S
|
|
|
|
dsn: mysql_socket; copy: yes
|
|
|
|
Socket file to use for connection.
|
|
|
|
=item * u
|
|
|
|
dsn: user; copy: yes
|
|
|
|
User for login if not current user.
|
|
|
|
=item * s
|
|
|
|
dsn: mysql_ssl; copy: yes
|
|
|
|
Create SSL connection
|
|
|
|
=back
|
|
|
|
=head1 ENVIRONMENT
|
|
|
|
The environment variable C<PTDEBUG> enables verbose debugging output to STDERR.
|
|
To enable debugging and capture all output to a file, run the tool like:
|
|
|
|
PTDEBUG=1 pt-visual-explain ... > FILE 2>&1
|
|
|
|
Be careful: debugging output is voluminous and can generate several megabytes
|
|
of output.
|
|
|
|
=head1 ATTENTION
|
|
|
|
Using <PTDEBUG> might expose passwords. When debug is enabled, all command line
|
|
parameters are shown in the output.
|
|
|
|
=head1 SYSTEM REQUIREMENTS
|
|
|
|
You need Perl, DBI, DBD::mysql, and some core packages that ought to be
|
|
installed in any reasonably new version of Perl.
|
|
|
|
=head1 BUGS
|
|
|
|
For a list of known bugs, see L<https://jira.percona.com/projects/PT/issues>.
|
|
|
|
Please report bugs at L<https://jira.percona.com/projects/PT>.
|
|
Include the following information in your bug report:
|
|
|
|
=over
|
|
|
|
=item * Complete command-line used to run the tool
|
|
|
|
=item * Tool L<"--version">
|
|
|
|
=item * MySQL version of all servers involved
|
|
|
|
=item * Output from the tool including STDERR
|
|
|
|
=item * Input files (log/dump/config files, etc.)
|
|
|
|
=back
|
|
|
|
If possible, include debugging output by running the tool with C<PTDEBUG>;
|
|
see L<"ENVIRONMENT">.
|
|
|
|
=head1 DOWNLOADING
|
|
|
|
Visit L<http://www.percona.com/software/percona-toolkit/> to download the
|
|
latest release of Percona Toolkit. Or, get the latest release from the
|
|
command line:
|
|
|
|
wget percona.com/get/percona-toolkit.tar.gz
|
|
|
|
wget percona.com/get/percona-toolkit.rpm
|
|
|
|
wget percona.com/get/percona-toolkit.deb
|
|
|
|
You can also get individual tools from the latest release:
|
|
|
|
wget percona.com/get/TOOL
|
|
|
|
Replace C<TOOL> with the name of any tool.
|
|
|
|
=head1 AUTHORS
|
|
|
|
Baron Schwartz
|
|
|
|
=head1 ABOUT PERCONA TOOLKIT
|
|
|
|
This tool is part of Percona Toolkit, a collection of advanced command-line
|
|
tools for MySQL developed by Percona. Percona Toolkit was forked from two
|
|
projects in June, 2011: Maatkit and Aspersa. Those projects were created by
|
|
Baron Schwartz and primarily developed by him and Daniel Nichter. Visit
|
|
L<http://www.percona.com/software/> to learn about other free, open-source
|
|
software from Percona.
|
|
|
|
=head1 COPYRIGHT, LICENSE, AND WARRANTY
|
|
|
|
This program is copyright 2011-2024 Percona LLC and/or its affiliates,
|
|
2007-2011 Baron Schwartz.
|
|
|
|
THIS PROGRAM IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
|
|
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
|
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; OR the Perl Artistic License. On UNIX and similar
|
|
systems, you can issue `man perlgpl' or `man perlartistic' to read these
|
|
licenses.
|
|
|
|
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.
|
|
|
|
=head1 VERSION
|
|
|
|
pt-visual-explain 3.7.0
|
|
|
|
=cut
|