perldebguts

СОДЕРЖАНИЕ

• ИМЯ
• ОПИСАНИЕ
• Внутренности отладчика
  • Написание собственного отладчика
    • Переменные среды
    • Внутренние переменные отладчика
    • Функции настройки отладчика
• Примеры вывода списка кадров
• Отладка регулярных выражений
  • Вывод на этапе компиляции
  • Типы узлов
  • Вывод во время выполнения
• Отладка использования памяти Perl
  • Использование $ENV{PERL_DEBUG_MSTATS}
• СМОТРИТЕ ТАКЖЕ

ИМЯ

perldebguts - Подробности Perl отладчика

ОПИСАНИЕ

Это не perldebug, которое рассказывает, как использовать отладчик. Данная страница руководства описывает низкоуровневые детали внутренних механизмов отладчика, которые могут быть сложными, а иногда и непонятными для тех, кто не очень хорошо знаком с внутренностями Perl. Предупреждение читателю.

Внутренности отладчика

Perl имеет специальные отладочные крючки на этапе компиляции и во время выполнения, используемые для создания отладочных сред. Эти крючки не следует путать с командой perl -Dxxx, описанной в perlrun, которая доступна только если специальная версия Perl скомпилирована в соответствии с инструкциями в файле INSTALL в дереве исходных кодов Perl.

Например, каждый раз, когда вы вызываете встроенную в Perl функцию caller из пакета DB, аргументы, с которыми был вызван соответствующий кадр стека, копируются в массив @DB::args. Эти механизмы активируются при вызове Perl с переключателем -d. В частности, активируются следующие дополнительные функции (см. "$^P" в perlvar):

• Perl вставляет содержимое $ENV{PERL5DB} (или BEGIN {require 'perl5db.pl'}, если оно отсутствует) перед первой строкой вашей программы.

• Каждый массив @{"_<$filename"} содержит строки из $filename для файла, скомпилированного Perl. То же самое верно для строк, содержащих подпрограммы или которые в данный момент выполняются. Путь к файлу $filename для eval строк выглядит как (eval 34).

  Значения в этом массиве имеют магическое поведение в числовом контексте: они равны нулю только если строка не может быть точкой прерывания.

• Каждый хэш %{"_<$filename"} содержит точки останова и действия, связанные с номером строки. Отдельные элементы (в отличие от всего хэша) можно установить. Perl заботится только о булевых значениях «истина», хотя значения, используемые perl5db.pl, имеют вид "$break_condition\0$action".

  То же самое верно для обработанных строк, содержащих подпрограммы или которые в данный момент выполняются. Путь к файлу $filename для eval строк выглядит как (eval 34).

• Каждый скаляр ${"_<$filename"} содержит $filename. Это также верно для обработанных строк, содержащих подпрограммы или которые в данный момент выполняются. $filename для eval строк выглядит как (eval 34).

• После компиляции каждого файла require, но перед его выполнением, вызывается DB::postponed(*{"_<$filename"}), если подпрограмма DB::postponed существует. Здесь $filename — это расширенное имя require файла, как указано в значениях %INC.

• После компиляции каждой подпрограммы subname, проверяется наличие $DB::postponed{subname}. Если этот ключ существует, DB::postponed(subname) вызывается, если подпрограмма DB::postponed также существует.

• Поддерживается хэш %DB::sub, ключами которого являются имена подпрограмм, а значениями — filename:startline-endline. filename имеет вид (eval 34) для подпрограмм, определенных внутри eval.

• Когда выполнение вашей программы достигает точки, где может быть точка останова, подпрограмма DB::DB() вызывается, если какие-либо из переменных $DB::trace, $DB::single, или $DB::signal имеют значение «истина». Эти переменные не localруются. Эта функция отключена при выполнении внутри DB::DB(), включая функции, вызываемые из нее, если $^D & (1<<30) не имеет значение «ложь».

• Когда выполнение программы достигает вызова подпрограммы, вместо этого выполняется &DB::sub(args), при этом $DB::sub устанавливается для идентификации вызываемой подпрограммы. (Это не происходит, если вызывающая подпрограмма была скомпилирована в пакете DB.) $DB::sub обычно содержит имя вызываемой подпрограммы, если она имеет имя, по которому её можно найти. В противном случае $DB::sub будет содержать ссылку на вызываемую подпрограмму. В любом случае, подпрограмма &DB::sub может использовать $DB::sub как ссылку для вызова вызываемой подпрограммы, что она обычно и захочет сделать.

  Если вызов относится к подпрограмме lvalue, и &DB::lsub определено, &DB::lsub(args) вызывается вместо этого, в противном случае используется &DB::sub(args).

• Когда выполнение программы использует goto для входа в не-XS подпрограмму, и бит 0x80 установлен в $^P, вызывается &DB::goto, а $DB::sub устанавливается для идентификации входящей подпрограммы. Вызов &DB::goto не заменяет goto; запрошенная подпрограмма всё равно будет вызвана после возвращения &DB::goto. $DB::sub обычно содержит имя входящей подпрограммы, если оно есть. В противном случае, $DB::sub будет содержать ссылку на входящую подпрограмму. В отличие от вызова &DB::sub, нет гарантии, что $DB::sub можно использовать как ссылку для работы с входящей подпрограммой.

Обратите внимание, что если &DB::sub нуждается во внешних данных для работы, без них вызов подпрограммы невозможен. Например, стандартный отладчик &DB::sub зависит от переменной $DB::deep (она определяет, сколько уровней рекурсии вглубь отладчика можно пройти перед обязательным прерыванием). Если $DB::deep не определено, вызов подпрограмм невозможен, даже если &DB::sub существует.

Написание собственного отладчика

Переменные среды

Переменная среды PERL5DB может использоваться для определения отладчика. Например, минимальный «рабочий» отладчик (он фактически ничего не делает) состоит из одной строки:

sub DB::DB {}

Его можно легко определить так:

$ PERL5DB="sub DB::DB {}" perl -d your-script

Другой краткий, но немного более полезный отладчик можно создать всего одной строкой:

sub DB::DB {print ++$i; scalar <STDIN>}

Этот отладчик выводит число, которое увеличивается для каждой встреченной команды и ждёт нажатия клавиши Enter, прежде чем перейти к следующей команде.

Следующий отладчик фактически полезен:

{
  package DB;
  sub DB  {}
  sub sub {print ++$i, " $sub\n"; &$sub}
}

Он выводит порядковый номер каждого вызова подпрограммы и имя вызываемой подпрограммы. Обратите внимание, что &DB::sub компилируется в пакет DB с помощью директивы package.

При запуске отладчик читает ваш файл настроек (./.perldb или ~/.perldb под Unix), который может задать важные параметры. (Здесь также может быть определена подпрограмма (&afterinit); она выполняется после завершения инициализации отладчика.)

После чтения файла настроек отладчик считывает переменную среды PERLDB_OPTS и использует её для установки параметров отладчика. Содержимое этой переменной обрабатывается так, как если бы это был аргумент команды отладчика o ... (см. в "Настраиваемые параметры" в perldebug).

Внутренние переменные отладчика

В дополнение к файловым и подпрограммным переменным, упомянутым выше, отладчик также поддерживает различные внутренние магические переменные.

• @DB::dbline — псевдоним для @{"::_<current_file"}, который содержит строки текущего выбранного файла (скомпилированного Perl), либо явным образом выбранного с помощью команды отладчика f, либо неявно в процессе выполнения.

  Значения в этом массиве имеют магическое поведение в числовом контексте: они равны нулю только если строка не может быть точкой прерывания.

• %DB::dbline — псевдоним для %{"::_<current_file"}, который содержит точки останова и действия, связанные с номером строки в текущем выбранном файле, либо явным образом выбранного с помощью команды отладчика f, либо неявно в процессе выполнения.

  Как отмечалось ранее, отдельные элементы (в отличие от всего хэша) можно установить. Perl заботится только о булевых значениях «истина», хотя значения, используемые perl5db.pl, имеют вид "$break_condition\0$action".

Функции настройки отладчика

Предлагаются некоторые функции для упрощения настройки.

• См. "Настраиваемые параметры" в perldebug для описания параметров, анализируемых функцией DB::parse_options(string).

• DB::dump_trace(skip[,count]) пропускает указанное количество кадров и возвращает список, содержащий информацию о вызывающих кадрах (всех, если count отсутствует). Каждый элемент — ссылка на хэш с ключами context (либо ., $, или @), sub (имя подпрограммы или информация о eval), args (undef или ссылка на массив), file, и line.

• DB::print_trace(FH, skip[, count[, short]]) выводит отформатированную информацию о вызывающих кадрах. Эти две последние функции могут быть удобными аргументами для команд <, <<.

Обратите внимание, что любые переменные и функции, не задокументированные в этом руководстве (или в perldebug) считаются предназначенными для внутреннего использования и могут быть изменены без предварительного уведомления.

Примеры вывода списка кадров

Опция frame может использоваться для управления выводом информации о кадрах. Например, сравните этот трассировочный вывод:

$ perl -de 42
Stack dump during die enabled outside of evals.

Loading DB routines from perl5db.pl patch level 0.94
Emacs support available.

Enter h or 'h h' for help.

main::(-e:1):   0
  DB<1> sub foo { 14 }

  DB<2> sub bar { 3 }

  DB<3> t print foo() * bar()
main::((eval 172):3):   print foo() + bar();
main::foo((eval 168):2):
main::bar((eval 170):2):
42

с этим, после установки опции o frame=2:

  DB<4> o f=2
               frame = '2'
  DB<5> t print foo() * bar()
3:      foo() * bar()
entering main::foo
 2:     sub foo { 14 };
exited main::foo
entering main::bar
 2:     sub bar { 3 };
exited main::bar
42

В качестве демонстрации ниже представлен трудоёмный список, полученный при установке переменной окружения PERLDB_OPTS в значение f=n N и запуске perl -d -V из командной строки. Приведены примеры использования различных значений n, чтобы дать вам представление о различиях настроек. Несмотря на его длину, это неполный список, а только выдержки.

1. entering main::BEGIN
    entering Config::BEGIN
     Package lib/Exporter.pm.
     Package lib/Carp.pm.
    Package lib/Config.pm.
    entering Config::TIEHASH
    entering Exporter::import
     entering Exporter::export
   entering Config::myconfig
    entering Config::FETCH
    entering Config::FETCH
    entering Config::FETCH
    entering Config::FETCH

2. entering main::BEGIN
    entering Config::BEGIN
     Package lib/Exporter.pm.
     Package lib/Carp.pm.
    exited Config::BEGIN
    Package lib/Config.pm.
    entering Config::TIEHASH
    exited Config::TIEHASH
    entering Exporter::import
     entering Exporter::export
     exited Exporter::export
    exited Exporter::import
   exited main::BEGIN
   entering Config::myconfig
    entering Config::FETCH
    exited Config::FETCH
    entering Config::FETCH
    exited Config::FETCH
    entering Config::FETCH

3. in  $=main::BEGIN() from /dev/null:0
    in  $=Config::BEGIN() from lib/Config.pm:2
     Package lib/Exporter.pm.
     Package lib/Carp.pm.
    Package lib/Config.pm.
    in  $=Config::TIEHASH('Config') from lib/Config.pm:644
    in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
     in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from li
   in  @=Config::myconfig() from /dev/null:0
    in  $=Config::FETCH(ref(Config), 'package') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'baserev') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'PERL_VERSION') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'PERL_SUBVERSION') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'osname') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'osvers') from lib/Config.pm:574

4. in  $=main::BEGIN() from /dev/null:0
    in  $=Config::BEGIN() from lib/Config.pm:2
     Package lib/Exporter.pm.
     Package lib/Carp.pm.
    out $=Config::BEGIN() from lib/Config.pm:0
    Package lib/Config.pm.
    in  $=Config::TIEHASH('Config') from lib/Config.pm:644
    out $=Config::TIEHASH('Config') from lib/Config.pm:644
    in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
     in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/
     out $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/
    out $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
   out $=main::BEGIN() from /dev/null:0
   in  @=Config::myconfig() from /dev/null:0
    in  $=Config::FETCH(ref(Config), 'package') from lib/Config.pm:574
    out $=Config::FETCH(ref(Config), 'package') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'baserev') from lib/Config.pm:574
    out $=Config::FETCH(ref(Config), 'baserev') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'PERL_VERSION') from lib/Config.pm:574
    out $=Config::FETCH(ref(Config), 'PERL_VERSION') from lib/Config.pm:574
    in  $=Config::FETCH(ref(Config), 'PERL_SUBVERSION') from lib/Config.pm:574

5. in  $=main::BEGIN() from /dev/null:0
    in  $=Config::BEGIN() from lib/Config.pm:2
     Package lib/Exporter.pm.
     Package lib/Carp.pm.
    out $=Config::BEGIN() from lib/Config.pm:0
    Package lib/Config.pm.
    in  $=Config::TIEHASH('Config') from lib/Config.pm:644
    out $=Config::TIEHASH('Config') from lib/Config.pm:644
    in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
     in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/E
     out $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/E
    out $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
   out $=main::BEGIN() from /dev/null:0
   in  @=Config::myconfig() from /dev/null:0
    in  $=Config::FETCH('Config=HASH(0x1aa444)', 'package') from lib/Config.pm:574
    out $=Config::FETCH('Config=HASH(0x1aa444)', 'package') from lib/Config.pm:574
    in  $=Config::FETCH('Config=HASH(0x1aa444)', 'baserev') from lib/Config.pm:574
    out $=Config::FETCH('Config=HASH(0x1aa444)', 'baserev') from lib/Config.pm:574

6. in  $=CODE(0x15eca4)() from /dev/null:0
    in  $=CODE(0x182528)() from lib/Config.pm:2
     Package lib/Exporter.pm.
    out $=CODE(0x182528)() from lib/Config.pm:0
    scalar context return from CODE(0x182528): undef
    Package lib/Config.pm.
    in  $=Config::TIEHASH('Config') from lib/Config.pm:628
    out $=Config::TIEHASH('Config') from lib/Config.pm:628
    scalar context return from Config::TIEHASH:   empty hash
    in  $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
     in  $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/Exporter.pm:171
     out $=Exporter::export('Config', 'main', 'myconfig', 'config_vars') from lib/Exporter.pm:171
     scalar context return from Exporter::export: ''
    out $=Exporter::import('Config', 'myconfig', 'config_vars') from /dev/null:0
    scalar context return from Exporter::import: ''

Во всех представленных выше случаях отступы строк показывают дерево вызовов. Если бит 2 переменной frame установлен, при выходе из подпрограммы также печатается строка. Если бит 4 установлен, аргументы выводятся вместе с информацией о вызывающей функции. Если бит 8 установлен, аргументы выводятся даже если они связаны или являются ссылками. Если бит 16 установлен, выводится также возвращаемое значение.

При компиляции пакета печатается строка подобного вида

Package lib/Carp.pm.

с правильными отступами.

Отладка регулярных выражений

Существует два способа включения отладочной информации для регулярных выражений.

Если ваш perl скомпилирован с -DDEBUGGING, можно использовать флаг -Dr в командной строке, и -Drv для более подробной информации.

В противном случае можно использовать use re 'debug', которое оказывает влияние как во время компиляции, так и во время выполнения. Начиная с Perl 5.9.5, этот псевдоним имеет лексическую область видимости.

Вывод во время компиляции

Отладочный вывод во время компиляции выглядит так:

Compiling REx '[bc]d(ef*g)+h[ij]k$'
size 45 Got 364 bytes for offset annotations.
first at 1
rarest char g at 0
rarest char d at 0
   1: ANYOF[bc](12)
  12: EXACT <d>(14)
  14: CURLYX[0] {1,32767}(28)
  16:   OPEN1(18)
  18:     EXACT <e>(20)
  20:     STAR(23)
  21:       EXACT <f>(0)
  23:     EXACT <g>(25)
  25:   CLOSE1(27)
  27:   WHILEM[1/1](0)
  28: NOTHING(29)
  29: EXACT <h>(31)
  31: ANYOF[ij](42)
  42: EXACT <k>(44)
  44: EOL(45)
  45: END(0)
anchored 'de' at 1 floating 'gh' at 3..2147483647 (checking floating) 
      stclass 'ANYOF[bc]' minlen 7 
Offsets: [45]
	1[4] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 5[1]
	0[0] 12[1] 0[0] 6[1] 0[0] 7[1] 0[0] 9[1] 8[1] 0[0] 10[1] 0[0]
	11[1] 0[0] 12[0] 12[0] 13[1] 0[0] 14[4] 0[0] 0[0] 0[0] 0[0]
	0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 18[1] 0[0] 19[1] 20[0]  
Omitting $` $& $' support.

Первая строка показывает предварительно скомпилированную форму регулярного выражения. Вторая показывает размер скомпилированной формы (в условных единицах, обычно 4-байтовых словах) и общее количество байтов, выделенных для таблицы смещений/длин, обычно 4+size*8. Следующая строка показывает метку id первого узла, выполняющего поиск совпадения.

Строка

anchored 'de' at 1 floating 'gh' at 3..2147483647 (checking floating) 
      stclass 'ANYOF[bc]' minlen 7 

(разбитая на две строки выше) содержит информацию об оптимизаторе. В приведённом примере оптимизатор обнаружил, что совпадение должно содержать подстроку de со смещением 1, плюс подстроку gh со смещением где-то между 3 и бесконечностью. Более того, при проверке на наличие этих подстрок (чтобы быстро отказаться от невозможных совпадений), Perl проверит подстроку gh перед проверкой подстроки de. Оптимизатор также может использовать информацию о том, что совпадение начинается (в узле с first id) с класса символов, и ни одна строка короче 7 символов не может совпадать.

Поля, представляющие интерес, которые могут появляться в этой строке,

anchored СТРОКА at ПОЗ

floating СТРОКА at ПОЗ1..ПОЗ2

См. выше.

matching floating/anchored

Какую подстроку проверять первой.

minlen

Минимальная длина совпадения.

stclass ТИП

Тип первого узла совпадения.

noscan

Не искать найденные подстроки.

isall

Означает, что информация об оптимизаторе — всё, что содержит регулярное выражение, и поэтому не нужно входить в движок регулярных выражений.

GPOS

Устанавливается, если шаблон содержит \G.

plus

Устанавливается, если шаблон начинается с повторяющегося символа (как в x+y).

implicit

Устанавливается, если шаблон начинается с .*.

with eval

Устанавливается, если шаблон содержит группы eval, такие как (?{ code }) и (??{ code }).

anchored(TYPE)

Если шаблон может совпасть только в нескольких местах, причём TYPE представляет собой SBOL, MBOL, или GPOS. См. таблицу ниже.

Если подстрока известна как совпадающая только в конце строки, за ней может следовать $, как в floating 'k'$.

Информация, специфичная для оптимизатора, используется для того, чтобы избежать входа (медленный) движок регулярных выражений в строки, которые точно не будут совпадать. Если флаг isall установлен, вызов движка регулярных выражений может быть предотвращён даже в том случае, когда оптимизатор нашёл подходящее место для совпадения.

Над разделом оптимизации находится список узлов скомпилированной формы регулярного выражения. Каждая строка имеет формат

id: ТИП ДОПОЛНИТЕЛЬНАЯ-ИНФОРМАЦИЯ (следующий-id)

Типы узлов

Вот текущие возможные типы с краткими описаниями:

# TYPE arg-description [regnode-struct-suffix] [longjump-len] DESCRIPTION

# Exit points

END              no         End of program.
SUCCEED          no         Return from a subroutine, basically.

# Line Start Anchors:
SBOL             no         Match "" at beginning of line: /^/, /\A/
MBOL             no         Same, assuming multiline: /^/m

# Line End Anchors:
SEOL             no         Match "" at end of line: /$/
MEOL             no         Same, assuming multiline: /$/m
EOS              no         Match "" at end of string: /\z/

# Match Start Anchors:
GPOS             no         Matches where last m//g left off.

# Word Boundary Opcodes:
BOUND            no         Like BOUNDA for non-utf8, otherwise like
                            BOUNDU
BOUNDL           no         Like BOUND/BOUNDU, but \w and \W are
                            defined by current locale
BOUNDU           no         Match "" at any boundary of a given type
                            using /u rules.
BOUNDA           no         Match "" at any boundary between \w\W or
                            \W\w, where \w is [_a-zA-Z0-9]
NBOUND           no         Like NBOUNDA for non-utf8, otherwise like
                            BOUNDU
NBOUNDL          no         Like NBOUND/NBOUNDU, but \w and \W are
                            defined by current locale
NBOUNDU          no         Match "" at any non-boundary of a given
                            type using using /u rules.
NBOUNDA          no         Match "" betweeen any \w\w or \W\W, where
                            \w is [_a-zA-Z0-9]

# [Special] alternatives:
REG_ANY          no         Match any one character (except newline).
SANY             no         Match any one character.
ANYOF            sv         Match character in (or not in) this class,
                 charclass  single char match only
ANYOFD           sv         Like ANYOF, but /d is in effect
                 charclass
ANYOFL           sv         Like ANYOF, but /l is in effect
                 charclass
ANYOFPOSIXL      sv         Like ANYOFL, but matches [[:posix:]]
                 charclass_ classes
                 posixl

ANYOFH           sv 1       Like ANYOF, but only has "High" matches,
                            none in the bitmap; the flags field
                            contains the lowest matchable UTF-8 start
                            byte
ANYOFHb          sv 1       Like ANYOFH, but all matches share the same
                            UTF-8 start byte, given in the flags field
ANYOFHr          sv 1       Like ANYOFH, but the flags field contains
                            packed bounds for all matchable UTF-8 start
                            bytes.
ANYOFHs          sv:str 1   Like ANYOFHb, but has a string field that
                            gives the leading matchable UTF-8 bytes;
                            flags field is len
ANYOFR           packed 1   Matches any character in the range given by
                            its packed args: upper 12 bits is the max
                            delta from the base lower 20; the flags
                            field contains the lowest matchable UTF-8
                            start byte
ANYOFRb          packed 1   Like ANYOFR, but all matches share the same
                            UTF-8 start byte, given in the flags field

ANYOFHbbm        none bbm   Like ANYOFHb, but only for 2-byte UTF-8
                            characters; uses a bitmap to match the
                            continuation byte

ANYOFM           byte 1     Like ANYOF, but matches an invariant byte
                            as determined by the mask and arg
NANYOFM          byte 1     complement of ANYOFM

# POSIX Character Classes:
POSIXD           none       Some [[:class:]] under /d; the FLAGS field
                            gives which one
POSIXL           none       Some [[:class:]] under /l; the FLAGS field
                            gives which one
POSIXU           none       Some [[:class:]] under /u; the FLAGS field
                            gives which one
POSIXA           none       Some [[:class:]] under /a; the FLAGS field
                            gives which one
NPOSIXD          none       complement of POSIXD, [[:^class:]]
NPOSIXL          none       complement of POSIXL, [[:^class:]]
NPOSIXU          none       complement of POSIXU, [[:^class:]]
NPOSIXA          none       complement of POSIXA, [[:^class:]]

CLUMP            no         Match any extended grapheme cluster
                            sequence

# Alternation

# BRANCH        The set of branches constituting a single choice are
#               hooked together with their "next" pointers, since
#               precedence prevents anything being concatenated to
#               any individual branch.  The "next" pointer of the last
#               BRANCH in a choice points to the thing following the
#               whole choice.  This is also where the final "next"
#               pointer of each individual branch points; each branch
#               starts with the operand node of a BRANCH node.
#
BRANCH           node 1     Match this alternative, or the next...

# Literals

EXACT            str        Match this string (flags field is the
                            length).

# In a long string node, the U32 argument is the length, and is
# immediately followed by the string.
LEXACT           len:str 1  Match this long string (preceded by length;
                            flags unused).
EXACTL           str        Like EXACT, but /l is in effect (used so
                            locale-related warnings can be checked for)
EXACTF           str        Like EXACT, but match using /id rules;
                            (string not UTF-8, ASCII folded; non-ASCII
                            not)
EXACTFL          str        Like EXACT, but match using /il rules;
                            (string not likely to be folded)
EXACTFU          str        Like EXACT, but match using /iu rules;
                            (string folded)

EXACTFAA         str        Like EXACT, but match using /iaa rules;
                            (string folded except MICRO in non-UTF8
                            patterns; doesn't contain SHARP S unless
                            UTF-8; folded length <= unfolded)
EXACTFAA_NO_TRIE str        Like EXACTFAA, (string not UTF-8, folded
                            except: MICRO, SHARP S; folded length <=
                            unfolded, not currently trie-able)

EXACTFUP         str        Like EXACT, but match using /iu rules;
                            (string not UTF-8, folded except MICRO:
                            hence Problematic)

EXACTFLU8        str        Like EXACTFU, but use /il, UTF-8, (string
                            is folded, and everything in it is above
                            255
EXACT_REQ8       str        Like EXACT, but only UTF-8 encoded targets
                            can match
LEXACT_REQ8      len:str 1  Like LEXACT, but only UTF-8 encoded targets
                            can match
EXACTFU_REQ8     str        Like EXACTFU, but only UTF-8 encoded
                            targets can match

EXACTFU_S_EDGE   str        /di rules, but nothing in it precludes /ui,
                            except begins and/or ends with [Ss];
                            (string not UTF-8; compile-time only)

# New charclass like patterns
LNBREAK          none       generic newline pattern

# Trie Related

# Behave the same as A|LIST|OF|WORDS would. The '..C' variants
# have inline charclass data (ascii only), the 'C' store it in the
# structure.

TRIE             trie 1     Match many EXACT(F[ALU]?)? at once.
                            flags==type
TRIEC            trie       Same as TRIE, but with embedded charclass
                 charclass  data

AHOCORASICK      trie 1     Aho Corasick stclass. flags==type
AHOCORASICKC     trie       Same as AHOCORASICK, but with embedded
                 charclass  charclass data

# Do nothing types

NOTHING          no         Match empty string.
# A variant of above which delimits a group, thus stops optimizations
TAIL             no         Match empty string. Can jump here from
                            outside.

# Loops

# STAR,PLUS    '?', and complex '*' and '+', are implemented as
#               circular BRANCH structures.  Simple cases
#               (one character per match) are implemented with STAR
#               and PLUS for speed and to minimize recursive plunges.
#
STAR             node       Match this (simple) thing 0 or more times:
                            /A{0,}B/ where A is width 1 char
PLUS             node       Match this (simple) thing 1 or more times:
                            /A{1,}B/ where A is width 1 char

CURLY            sv 3       Match this (simple) thing {n,m} times:
                            /A{m,n}B/ where A is width 1 char
CURLYN           no 3       Capture next-after-this simple thing:
                            /(A){m,n}B/ where A is width 1 char
CURLYM           no 3       Capture this medium-complex thing {n,m}
                            times: /(A){m,n}B/ where A is fixed-length
CURLYX           sv 3       Match/Capture this complex thing {n,m}
                            times.

# This terminator creates a loop structure for CURLYX
WHILEM           no         Do curly processing and see if rest
                            matches.

# Buffer related

# OPEN,CLOSE,GROUPP     ...are numbered at compile time.
OPEN             num 1      Mark this point in input as start of #n.
CLOSE            num 1      Close corresponding OPEN of #n.
SROPEN           none       Same as OPEN, but for script run
SRCLOSE          none       Close preceding SROPEN

REF              num 2      Match some already matched string
REFF             num 2      Match already matched string, using /di
                            rules.
REFFL            num 2      Match already matched string, using /li
                            rules.
REFFU            num 2      Match already matched string, usng /ui.
REFFA            num 2      Match already matched string, using /aai
                            rules.

# Named references.  Code in regcomp.c assumes that these all are after
# the numbered references
REFN             no-sv 2    Match some already matched string
REFFN            no-sv 2    Match already matched string, using /di
                            rules.
REFFLN           no-sv 2    Match already matched string, using /li
                            rules.
REFFUN           num 2      Match already matched string, using /ui
                            rules.
REFFAN           num 2      Match already matched string, using /aai
                            rules.

# Support for long RE
LONGJMP          off 1 1    Jump far away.
BRANCHJ          off 2 1    BRANCH with long offset.

# Special Case Regops
IFMATCH          off 1 1    Succeeds if the following matches; non-zero
                            flags "f", next_off "o" means lookbehind
                            assertion starting "f..(f-o)" characters
                            before current
UNLESSM          off 1 1    Fails if the following matches; non-zero
                            flags "f", next_off "o" means lookbehind
                            assertion starting "f..(f-o)" characters
                            before current
SUSPEND          off 1 1    "Independent" sub-RE.
IFTHEN           off 1 1    Switch, should be preceded by switcher.
GROUPP           num 1      Whether the group matched.

# The heavy worker

EVAL             evl/flags  Execute some Perl code.
                 2

# Modifiers

MINMOD           no         Next operator is not greedy.
LOGICAL          no         Next opcode should set the flag only.

# This is not used yet
RENUM            off 1 1    Group with independently numbered parens.

# Regex Subroutines
GOSUB            num/ofs 2  recurse to paren arg1 at (signed) ofs arg2

# Special conditionals
GROUPPN          no-sv 1    Whether the group matched.
INSUBP           num 1      Whether we are in a specific recurse.
DEFINEP          none 1     Never execute directly.

# Backtracking Verbs
ENDLIKE          none       Used only for the type field of verbs
OPFAIL           no-sv 1    Same as (?!), but with verb arg
ACCEPT           no-sv/num  Accepts the current matched string, with
                 2          verbar

# Verbs With Arguments
VERB             no-sv 1    Used only for the type field of verbs
PRUNE            no-sv 1    Pattern fails at this startpoint if no-
                            backtracking through this
MARKPOINT        no-sv 1    Push the current location for rollback by
                            cut.
SKIP             no-sv 1    On failure skip forward (to the mark)
                            before retrying
COMMIT           no-sv 1    Pattern fails outright if backtracking
                            through this
CUTGROUP         no-sv 1    On failure go to the next alternation in
                            the group

# Control what to keep in $&.
KEEPS            no         $& begins here.

# Validate that lookbehind IFMATCH and UNLESSM end at the right place
LOOKBEHIND_END   no         Return from lookbehind (IFMATCH/UNLESSM)
                            and validate position

# SPECIAL  REGOPS

# This is not really a node, but an optimized away piece of a "long"
# node.  To simplify debugging output, we mark it as if it were a node
OPTIMIZED        off        Placeholder for dump.

# Special opcode with the property that no opcode in a compiled program
# will ever be of this type. Thus it can be used as a flag value that
# no other opcode has been seen. END is used similarly, in that an END
# node cant be optimized. So END implies "unoptimizable" and PSEUDO
# mean "not seen anything to optimize yet".
PSEUDO           off        Pseudo opcode for internal use.

REGEX_SET        depth p    Regex set, temporary node used in pre-
                            optimization compilation

После информации об оптимизаторе следует дамп таблицы смещений/длин, здесь разбит на несколько строк:

Offsets: [45]
	1[4] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 5[1]
	0[0] 12[1] 0[0] 6[1] 0[0] 7[1] 0[0] 9[1] 8[1] 0[0] 10[1] 0[0]
	11[1] 0[0] 12[0] 12[0] 13[1] 0[0] 14[4] 0[0] 0[0] 0[0] 0[0]
	0[0] 0[0] 0[0] 0[0] 0[0] 0[0] 18[1] 0[0] 19[1] 20[0]  

Первая строка указывает, что таблица смещений/длин содержит 45 записей. Каждая запись — пара целых чисел, обозначаемых offset[length]. Записи нумеруются, начиная с 1, так что запись #1 здесь — 1[4], а запись #12 — 5[1]. 1[4] указывает, что узел с меткой 1: (соответствующий 1: ANYOF[bc]) начинается с позиции символа 1 в предварительно скомпилированной форме регулярного выражения и имеет длину 4 символа. 5[1] в позиции 12 указывает, что узел с меткой 12: (соответствующий 12: EXACT <d>) начинается с позиции символа 5 в предварительно скомпилированной форме регулярного выражения и имеет длину 1 символ. 12[1] в позиции 14 указывает, что узел с меткой 14: (соответствующий 14: CURLYX[0] {1,32767}) начинается с позиции символа 12 в предварительно скомпилированной форме регулярного выражения и имеет длину 1 символ — то есть, он соответствует символу + в предварительно скомпилированном регулярном выражении.

0[0] элементы указывают, что соответствующий узел отсутствует.

Вывод во время выполнения

Прежде всего, при поиске совпадения может не быть никакого вывода во время выполнения, даже если отладка включена. Это означает, что движок регулярных выражений никогда не был запущен, и вся работа была выполнена оптимизатором.

Если движок регулярных выражений был запущен, вывод может выглядеть так:

  Matching '[bc]d(ef*g)+h[ij]k$' against 'abcdefg__gh__'
    Setting an EVAL scope, savestack=3
     2 <ab> <cdefg__gh_>    |  1: ANYOF
     3 <abc> <defg__gh_>    | 11: EXACT <d>
     4 <abcd> <efg__gh_>    | 13: CURLYX {1,32767}
     4 <abcd> <efg__gh_>    | 26:   WHILEM
				0 out of 1..32767  cc=effff31c
     4 <abcd> <efg__gh_>    | 15:     OPEN1
     4 <abcd> <efg__gh_>    | 17:     EXACT <e>
     5 <abcde> <fg__gh_>    | 19:     STAR
			     EXACT <f> can match 1 times out of 32767...
    Setting an EVAL scope, savestack=3
     6 <bcdef> <g__gh__>    | 22:       EXACT <g>
     7 <bcdefg> <__gh__>    | 24:       CLOSE1
     7 <bcdefg> <__gh__>    | 26:       WHILEM
				    1 out of 1..32767  cc=effff31c
    Setting an EVAL scope, savestack=12
     7 <bcdefg> <__gh__>    | 15:         OPEN1
     7 <bcdefg> <__gh__>    | 17:         EXACT <e>
       restoring \1 to 4(4)..7
				    failed, try continuation...
     7 <bcdefg> <__gh__>    | 27:         NOTHING
     7 <bcdefg> <__gh__>    | 28:         EXACT <h>
				    failed...
				failed...

Наиболее важная информация в выводе относится к конкретному узлу скомпилированного регулярного выражения, который в настоящее время проверяется относительно целевой строки. Формат этих строк

смещение-строки <предшествующая-строка> <последующая-строка> |ID: ТИП

Информация ТИП имеет отступ относительно уровня отката. Другая случайная информация вставляется вперемежку.

Отладка использования памяти Perl

Perl — расточительный транжира, когда дело доходит до использования памяти. Существует поговорка, что для оценки использования памяти Perl, предположите разумный алгоритм выделения памяти, умножьте эту оценку на 10, и, хотя вы можете промахнуться, по крайней мере, вы не будете так поражены. Это не совсем так, но может дать хорошее представление о происходящем.

Предположим, что целое число не может занимать меньше 20 байтов, число с плавающей точкой — меньше 24 байтов, строка — меньше 32 байтов (все эти примеры предполагают 32-битные архитектуры, результаты на 64-битных архитектурах значительно хуже). Если к переменной обращаются двумя из трёх способов (которые требуют целого числа, числа с плавающей точкой или строки), отпечаток памяти может увеличиться ещё на 20 байтов. Неэффективная реализация malloc(3) может значительно увеличить эти числа.

На другом конце шкалы объявление, подобное

sub foo;

может занимать до 500 байтов памяти, в зависимости от версии Perl, которую вы используете.

Эмпирические оценки раздутия кода из исходного до скомпилированного кода указывают на восьмикратное увеличение. Это означает, что скомпилированная форма разумного (обычно комментированного, с правильными отступами и т. д.) кода займёт примерно в восемь раз больше места в памяти, чем код занимал на диске.

Переключатель командной строки -DL устарел с момента появления Perl 5.6.0 (он был доступен только при построении Perl с -DDEBUGGING). Переключатель использовался для отслеживания выделений памяти Perl и возможных утечек памяти. В наши дни вместо этого рекомендуется использовать инструменты отладки malloc, такие как Purify или valgrind. См. также "PERL_MEM_LOG" в perlhacktips.

Один из способов узнать, сколько памяти используется структурами данных Perl, — установить модуль Devel::Size из CPAN: он даёт вам минимальное количество байтов, необходимое для хранения конкретной структуры данных. Обратите внимание на разницу между size() и total_size().

Если Perl был скомпилирован с использованием malloc Perl, можно проанализировать использование памяти Perl, установив $ENV{PERL_DEBUG_MSTATS}.

Использование $ENV{PERL_DEBUG_MSTATS}

Если ваш perl использует malloc() Perl и был скомпилирован с необходимыми переключателями (это значение по умолчанию), он выведет статистику использования памяти после компиляции вашего кода, когда $ENV{PERL_DEBUG_MSTATS} > 1, и перед завершением программы, когда $ENV{PERL_DEBUG_MSTATS} >= 1. Формат отчёта аналогичен следующему примеру:

 $ PERL_DEBUG_MSTATS=2 perl -e "require Carp"
 Memory allocation statistics after compilation: (buckets 4(4)..8188(8192)
    14216 free:   130   117    28     7     9   0   2     2   1 0 0
		437    61    36     0     5
    60924 used:   125   137   161    55     7   8   6    16   2 0 1
		 74   109   304    84    20
 Total sbrk(): 77824/21:119. Odd ends: pad+heads+chain+tail: 0+636+0+2048.
 Memory allocation statistics after execution:   (buckets 4(4)..8188(8192)
    30888 free:   245    78    85    13     6   2   1     3   2 0 1
		315   162    39    42    11
   175816 used:   265   176  1112   111    26  22  11    27   2 1 1
		196   178  1066   798    39
 Total sbrk(): 215040/47:145. Odd ends: pad+heads+chain+tail: 0+2192+0+6144.

Можно запросить такую статистику в произвольные моменты выполнения, используя функцию mstat() из стандартного модуля Devel::Peek.

Вот некоторое объяснение этого формата:

buckets SMALLEST(APPROX)..GREATEST(APPROX)

В Perl, функция malloc() использует буферизованные выделения. Каждый запрос округляется до ближайшего доступного размера буфера, и буфер берется из пула буферов этого размера.

Строка выше описывает пределы буферов, которые используются в настоящее время. Каждый буфер имеет два размера: занимаемое место в памяти и максимальный размер пользовательских данных, которые могут поместиться в этот буфер. Предположим, в приведенном выше примере наименьший буфер имеет размер 4. Наибольший буфер будет иметь полезный размер 8188, а занимаемое место в памяти составит 8192.

В Perl, скомпилированном для отладки, некоторые буферы могут иметь отрицательный полезный размер. Это означает, что эти буферы не могут (и не будут) использоваться. Для больших буферов занимаемое место в памяти может быть на одну страницу больше, чем степень двойки. В этом случае соответствующая степень двойки отображается в поле APPROX.

Освобожденные/Используемые

1 или 2 строки чисел, следующие за этим, соответствуют количеству буферов каждого размера между SMALLEST и GREATEST. В первой строке размеры (размеры занимаемой памяти) буферов являются степенями двойки — или, возможно, на одну страницу больше. Во второй строке, если она присутствует, размеры занимаемой памяти буферов находятся между размерами занимаемой памяти двух "верхних" буферов.

Например, предположим, что в предыдущем примере размеры занимаемой памяти были:

   free:    8     16    32    64    128  256 512 1024 2048 4096 8192
	   4     12    24    48    80

В не-DEBUGGING Perl, буферы, начиная с 128, имеют 4-байтовый накладной расход, и, следовательно, буфер длиной 8192 может занимать до 8188 байт выделений.

Total sbrk(): SBRKed/SBRKs:CONTINUOUS

Первые два поля содержат общее количество памяти, выделенное функцией sbrk(2) в Perl, и количество используемых вызовов sbrk(2). Третье число представляет собой то, как Perl понимает непрерывность возвращаемых блоков. Пока это число положительно, malloc() будет предполагать, что sbrk(2) вероятно обеспечит непрерывную память.

Память, выделенная внешними библиотеками, не учитывается.

pad: 0

Количество памяти, выделенное с помощью sbrk(2), необходимое для выравнивания буферов.

heads: 2192

Хотя накладные расходы на память больших буферов хранятся внутри буфера, для меньших буферов они хранятся в отдельных областях. Это поле содержит общий размер этих областей.

chain: 0

Функция malloc() может захотеть разделить больший буфер на более мелкие. Если только часть освобожденного буфера остается неразделенной, остальное хранится как элемент связанного списка. Это поле содержит общий размер этих фрагментов.

tail: 6144

Для минимизации числа вызовов sbrk(2), malloc() запрашивает больше памяти. Это поле содержит размер еще не используемой части, которая выделена с помощью sbrk(2), но никогда не использовалась.

См. также

perldebug, perl5db.pl, perlguts, perlrun, re и Devel::DProf.