vld工具——PHP扩展——查看opcode

vld工具——PHP扩展——查看opcode

VLD（Vulcan Logic Dumper）是一个在Zend引擎中，以挂钩的方式实现的用于输出PHP脚本生成的中间代码（执行单元）的扩展。它可以在一定程序上查看Zend引擎内部的一些实现原理，是我们学习PHP源码的必备良器。它的作者是Derick Rethans, 除了VLD扩展，我们常用的XDebug扩展的也有该牛人的身影。

VLD扩展是一个开源的项目，在这里可以下载到最新的版本。 *nix系统下直接configue,make,make install生成。win 系统下是下载DLL文件。注意要与使用的php版本对应。win的DLL文件只从php5.3版本才此扩展。但Win下使用VC6.0编译生成dll文件。

*nix系统下，下载与安装VLD

# wget http://pecl.php.net/get/vld-0.11.2.tgz
# tar zxvf vld-0.11.2.tgz
# cd ./vld-0.11.2
# /usr/local/php/bin/phpize 或者直接phpize
# ./configure --with-php-config=/usr/local/php/bin/php-config --enable-vld
# make && make install

---------------------------------

编辑php.ini文件激活vld扩展：
php.ini位置 #cd /usr/local/php/lib
增加 extension=vld.so

重启Apache：# /usr/local/apache2/bin/apachectl restart

---------------------------------

查看phpinfo()信息

至此,VLD就安装完了。

测试例子（一）

写个简单的test.php

<?php 
$a='123'; 
echo $a; 
?>

# php -dvld.active=1 ./test.php

如果没有设置php环境变量的话

#/usr/local/php/bin/php -dvld.active=1 test.php

如上为VLD输出的PHP代码生成的中间代码的信息，说明如下：

Branch analysis from position 这条信息多在分析数组时使用。
Return found 是否返回，这个基本上有都有。
filename 分析的文件名
function name 函数名，针对每个函数VLD都会生成一段如上的独立的信息，这里显示当前函数的名称
number of ops 生成的操作数
compiled vars 编译期间的变量，这些变量是在PHP5后添加的，它是一个缓存优化。这样的变量在PHP源码中以IS_CV标记。
op list 生成的中间代码的变量列表

使用-dvld.active参数输出的是VLD默认设置，如果想看更加详细的内容。可以使用-dvld.verbosity参数。

#php -dvld.active=1 -dvld.verbosity=3 text.php

-dvld.verbosity=3是VLD在当前版本可以显示的最详细的信息.

如果我们只是想要看输出的中间代码，并不想执行这段PHP代码，可以使用-dvld.execute=0来禁用代码的执行

#php -dvld.active=1 -dvld.execute=0 text.php

VLD扩展的参数列表：

-dvld.active 是否在执行PHP时激活VLD挂钩，默认为0，表示禁用。可以使用-dvld.active=1启用。
-dvld.skip_prepend 是否跳过php.ini配置文件中auto_prepend_file指定的文件，默认为0，即不跳过包含的文件，显示这些包含的文件中的代码所生成的中间代码。此参数生效有一个前提条件：-dvld.execute=0
-dvld.skip_append 是否跳过php.ini配置文件中auto_append_file指定的文件，默认为0，即不跳过包含的文件，显示这些包含的文件中的代码所生成的中间代码。此参数生效有一个前提条件：-dvld.execute=0
-dvld.execute 是否执行这段PHP脚本，默认值为1，表示执行。可以使用-dvld.execute=0，表示只显示中间代码，不执行生成的中间代码。
-dvld.format 是否以自定义的格式显示，默认为0，表示否。可以使用-dvld.format=1，表示以自己定义的格式显示。这里自定义的格式输出是以-dvld.col_sep指定的参数间隔
-dvld.col_sep 在-dvld.format参数启用时此函数才会有效，默认为 “t”。
-dvld.verbosity 是否显示更详细的信息，默认为1，其值可以为0,1,2,3 其实比0小的也可以，只是效果和0一样，比如0.1之类，但是负数除外，负数和效果和3的效果一样比3大的值也是可以的，只是效果和3一样。
-dvld.save_dir 指定文件输出的路径，默认路径为/tmp。
-dvld.save_paths 控制是否输出文件，默认为0，表示不输出文件
-dvld.dump_paths 控制输出的内容，现在只有0和1两种情况，默认为1,输出内容

使用VLD比较代码差异

代码text1.php

<?php 
$var = 111;
$str = "AAA " . $var . " BBB"; 
?>

代码text2.php

<?php 
$var = 111;
$str = "AAA $var BBB"; 
?>

从结果很清晰的看出第一段代码比第二段代码多了concat

第一个连接操作，将“test string begin ”和$var连接起来，得到“AAA 111”，然后再执行第二个连接操作，将上一个操作得到的结果“AAA 111”和” BBB”连接起来，并将结果存储在另一个临时变量，最后将第二个连接操作的结果赋值给$str。

连接操作对应的opcode为ZEND_CONCAT，对于所给的两个操作数，其最终通过concat_function函数将两个字符串连接起来，如果所给的变量的类型不是字符串，则会通过zend_make_printable_zval将其转换成字符串。concat_function函数会根据两个字符串的长度重新分配内存，并执行两次拷贝操作，将两个字符串拷贝到新的内存空间。这里针对两个字符串相同的情况有一个特殊处理。

if (result==op1) {	/* special case, perform operations on result */ 
	uint res_len = Z_STRLEN_P(op1) + Z_STRLEN_P(op2);
 
	Z_STRVAL_P(result) = erealloc(Z_STRVAL_P(result), res_len+1);
 
	memcpy(Z_STRVAL_P(result)+Z_STRLEN_P(result), Z_STRVAL_P(op2), Z_STRLEN_P(op2));
	Z_STRVAL_P(result)[res_len]=0;
	Z_STRLEN_P(result) = res_len;
} else {
	Z_STRLEN_P(result) = Z_STRLEN_P(op1) + Z_STRLEN_P(op2);
	Z_STRVAL_P(result) = (char *) emalloc(Z_STRLEN_P(result) + 1);
	memcpy(Z_STRVAL_P(result), Z_STRVAL_P(op1), Z_STRLEN_P(op1));
	memcpy(Z_STRVAL_P(result)+Z_STRLEN_P(op1), Z_STRVAL_P(op2), Z_STRLEN_P(op2));
	Z_STRVAL_P(result)[Z_STRLEN_P(result)] = 0;
	Z_TYPE_P(result) = IS_STRING;
}

而直接在字符串中插入变量，其所有的操作都是添加操作，将字符串添加到返回值，将变量添加到返回值，
所有的结果返回都是在一个临时变量中，如我们的示例，首先会将”AAA “添加到临时变量，然后将临时变量和$var变量添加到临时变量，之后将临时变量和” BBB”添加到临时变量，最后将此此时变量赋值给$str。这里添加将字符串添加到临时变量，其对应的opcode为ZEND_ADD_STRING，将变量添加到临时变量，其对应的opcode为ZEND_ADD_VAR，虽然这两个操作的opcode不同，但其最终调用都是add_string_to_string，他们所不同的调用此函数的第三个参数，一个是操作码存储的ZVAL变量，一个是通过变更列表获取的ZVAL变量。

测试例子（二）

看一个简单的例子,假如存在t.php文件，其内容如下：

<?php 
$a = 10; 
echo $a; 
?>

在命令行下使用VLD扩展显示信息。

php -dvld.active=1 t.php

-dvld.active=1表示激活VLD扩展，使用VLD扩展输出中间代码，此命令在CMD中输出信息为：

Branch analysis from position: 0
Return found
filename:       D:workxamppxamppphpt.php
function name:  (null)
number of ops:  5
compiled vars:  !0 = $a
line     # *  op                           fetch          ext  return  operands
---------------------------------------------------------------------------------
   2     0  >   EXT_STMT
         1      ASSIGN                                                   !0, 10
   3     2      EXT_STMT
         3      ECHO                                                     !0
   4     4    > RETURN                                                   1
branch: #  0; line:     2-    4; sop:     0; eop:     4
path #1: 0,
10

如上为VLD输出的PHP代码生成的中间代码的信息，说明如下：

Branch analysis from position 这条信息多在分析数组时使用。
Return found 是否返回，这个基本上有都有。
filename 分析的文件名
function name 函数名，针对每个函数VLD都会生成一段如上的独立的信息，这里显示当前函数的名称
number of ops 生成的操作数
compiled vars 编译期间的变量，这些变量是在PHP5后添加的，它是一个缓存优化。这样的变量在PHP源码中以IS_CV标记。
op list 生成的中间代码的变量列表

使用-dvld.active参数输出的是VLD默认设置，如果想看更加详细的内容。可以使用-dvld.verbosity参数。

php -dvld.active=1 -dvld.verbosity=3 t.php

-dvld.verbosity=3或更大的值的效果都是一样的，它们是VLD在当前版本可以显示的最详细的信息了，包括各个中间代码的操作数等。显示结果如下：

Finding entry points
Branch analysis from position: 0
Add 0
Add 1
Add 2
Add 3
Add 4
Return found
filename:       D:workxamppxamppphpt.php
function name:  (null)
number of ops:  5
compiled vars:  !0 = $a
line     # *  op                           fetch          ext  return  operands
--------------------------------------------------------------------------------
-
   2     0  >   EXT_STMT                                          RES[  IS_UNUSED  ]         OP1[  IS_UNUSED  ] OP2[  IS_UNUSED  ]
         1      ASSIGN                                                    OP1[IS_CV !0 ] OP2[ ,  IS_CONST (0) 10 ]
   3     2      EXT_STMT                                          RES[  IS_UNUSED  ]         OP1[  IS_UNUSED  ] OP2[  IS_UNUSED  ]
         3      ECHO                                                      OP1[IS_CV !0 ]
         4    > RETURN                                                    OP1[IS_CONST (0) 1 ]
branch: #  0; line:     2-    3; sop:     0; eop:     4
path #1: 0,
10

以上的信息与没有加-dvld.verbosity=3的输出相比，多了Add 字段，还有中间代码的操作数的类型，如IS_CV,IS_CONST等。 PHP代码中的$a = 10; 其中10的类型为IS_CONST, $a作为一个编译期间的一个缓存变量存在，其类型为IS_CV。

如果我们只是想要看输出的中间代码，并不想执行这段PHP代码，可以使用-dvld.execute=0来禁用代码的执行。

php -dvld.active=1 -dvld.execute=0 t.php

运行这个命令，你会发现这与最开始的输出有一点点不同，它没有输出10。除了直接在屏幕上输出以外，VLD扩展还支持输出.dot文件，如下的命令：

php -dvld.active=1 -dvld.save_dir='D:tmp' -dvld.save_paths=1 -dvld.dump_paths=1 t.php

以上的命令的意思是将生成的中间代码的一些信息输出在D:/tmp/paths.dot文件中。 -dvld.save_dir指定文件输出的路径，-dvld.save_paths控制是否输出文件，-dvld.dump_paths控制输出的内容，现在只有0和1两种情况。输出的文件名已经在程序中硬编码为paths.dot。这三个参数是相互依赖的关系，一般都会同时出现。

总结一下，VLD扩展的参数列表：

-dvld.active 是否在执行PHP时激活VLD挂钩，默认为0，表示禁用。可以使用-dvld.active=1启用。
-dvld.skip_prepend 是否跳过php.ini配置文件中auto_prepend_file指定的文件，默认为0，即不跳过包含的文件，显示这些包含的文件中的代码所生成的中间代码。此参数生效有一个前提条件：-dvld.execute=0
-dvld.skip_append 是否跳过php.ini配置文件中auto_append_file指定的文件，默认为0，即不跳过包含的文件，显示这些包含的文件中的代码所生成的中间代码。此参数生效有一个前提条件：-dvld.execute=0
-dvld.execute 是否执行这段PHP脚本，默认值为1，表示执行。可以使用-dvld.execute=0，表示只显示中间代码，不执行生成的中间代码。
-dvld.format 是否以自定义的格式显示，默认为0，表示否。可以使用-dvld.format=1，表示以自己定义的格式显示。这里自定义的格式输出是以-dvld.col_sep指定的参数间隔
-dvld.col_sep 在-dvld.format参数启用时此函数才会有效，默认为 “t”。
-dvld.verbosity 是否显示更详细的信息，默认为1，其值可以为0,1,2,3 其实比0小的也可以，只是效果和0一样，比如0.1之类，但是负数除外，负数和效果和3的效果一样比3大的值也是可以的，只是效果和3一样。
-dvld.save_dir 指定文件输出的路径，默认路径为/tmp。
-dvld.save_paths 控制是否输出文件，默认为0，表示不输出文件
-dvld.dump_paths 控制输出的内容，现在只有0和1两种情况，默认为1,输出内容

使用VC6.0生成VLD扩展——win 系统下

环境：VC6.0
源码：php5.2.9源码包（可以去http://www.php.net/下载），解压，我的是解压在D盘根目录下。
Vld源码包（可以去http://pecl.php.net/package/vld/0.9.1下载），解压

生成过程如下：

1、在Windows平台启动 VC++ 6.0, 【文件】（File）->【新建】（New）, 在【工程】（Project）中选择【Win32 Dynamic-Link Library】, 填写上【工程名称】（Project Name）和【位置】（Location）,如图1所示：

图1

2、点击确定后，在第二屏选中【一个空的DLL工程】（An empty DLL project）, 点【完成】Finish，完成创建。此时会可能会弹出一个信息框，点击确定。

3、把解压后的vld源码中的vld文件夹下面的所有文件拷贝到到工程所在的目录（D:php-5.2.9extvld）;

4、选择左侧的【Source Files】，点击右键，选择【添加文件到目录】，将D:php-5.2.9extvld目录下的所有C文件添加到此目录，如图2所示;

图2

5、同样选择【Header Files】，添加所有的头文件到目录。如图3所示：

图3

6、修改工程设置，选择【工程】（Project）->【设置】（Settings）->【C/C++】，在【工程选项】（Project Options:）的最后加上 /Tc，在预处理程序定义中添加如下宏定义：ZEND_DEBUG=0,COMPILE_DL_VLD,ZTS=1,ZEND_WIN32,PHP_WIN32,HAVE_VLD=1

如果你需要编译其它扩展，请将COMPILE_DL_VLD 和 HAVE_VLD=1，后面的 “VLD” 改成和你要创建的工程名一致。

如图4所示：

图4

7、选择【连接】（Link），在【对象/库模块】(Object/library modules)添加php5ts.lib，注意要以空格格开;

8、选择【工具】(Tools)->【选项】(Options)->【目录】（Directories），在【目录】（Show directories for:）下拉框中选择 “Library files”，在【路径】（Directories）中添加 D:php-5.2.9 （即 php5ts.lib 所在目录）；如图5所示：

在【目录】（Show directories for:）下拉框中选择 “Include files”
在【路径】（Directories）中添加 D:PHP-5.2.9 （即 ext、regex、win32 所在目录）
在【路径】（Directories）中添加 D:PHP-5.2.9MAIN
在【路径】（Directories）中添加D:PHP-5.2.9ZEND
在【路径】（Directories）中添加 D:PHP-5.2.9TSRM

图6

9、选择【组建】->【编译】，此时可能会出现报错。
在php_vld.h文件的59行存在三个莫名其妙的点，将他们去掉就可以了。

10、选择【组建】->【组建】。成功！

在扩展下的Debug目录（D:php-5.2.9extvldDebug）下有一个生成的dll文件。这就是我们所要的东东了！