9.2 PHP中的资源类型

通常情况下，像{资源}这类复合类型的数据都会占用大量的硬件资源，比如内存、CPU以及网络带宽。对于使用频率超级高的数据库链接，我们可以获取一个长链接，使其不会在脚本结束后自动销毁，一旦创建便可以在各个请求中直接使用，从而减少每次创建它的消耗。Mysql的长链接在PHP内核中其实就是一种持久{资源}。Memory Allocation前面的章节里我们接触了emalloc()之类的以e开头的内存管理函数，通过它们申请的内存都会被内核自动的进行垃圾回收的操作。而对于一个持久{资源}来说，我们是绝对不希望它在脚本结束后被回收的。

假设我们需要在我们的{资源}中同时保存文件名和文件句柄两个数据，现在我们就需要自己定义个结构了：

  1. typedef struct _php_sample_descriptor_data
  2. {
  3.     char *filename;
  4.     FILE *fp;
  5. }php_sample_descriptor_data;

当然，因为结构变了(之前是个FILE*)，我们之前的代码也需要跟着改动。这里还没有涉及到持久{资源}，仅仅是换了一种{资源}结构

  1. static void php_sample_descriptor_dtor(zend_rsrc_list_entry *rsrc TSRMLS_DC)
  2. {
  3.     php_sample_descriptor_data *fdata = (php_sample_descriptor_data*)rsrc->ptr;
  4.     fclose(fdata->fp);
  5.     efree(fdata->filename);
  6.     efree(fdata);
  7. }
  8. PHP_FUNCTION(sample_fopen)
  9. {
  10.     php_sample_descriptor_data *fdata;
  11.     FILE *fp;
  12.     char *filename, *mode;
  13.     int filename_len, mode_len;
  14.     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss",&filename, &filename_len,&mode, &mode_len) == FAILURE)
  15.     {
  16.         RETURN_NULL();
  17.     }
  18.     if (!filename_len || !mode_len) {
  19.         php_error_docref(NULL TSRMLS_CC, E_WARNING,"Invalid filename or mode length");
  20.         RETURN_FALSE;
  21.     }
  22.     fp = fopen(filename, mode);
  23.     if (!fp)
  24.     {
  25.         php_error_docref(NULL TSRMLS_CC, E_WARNING,"Unable to open %s using mode %s",filename, mode);
  26.         RETURN_FALSE;
  27.     }
  28.     fdata = emalloc(sizeof(php_sample_descriptor_data));
  29.     fdata->fp = fp;
  30.     fdata->filename = estrndup(filename, filename_len);
  31.     ZEND_REGISTER_RESOURCE(return_value, fdata,le_sample_descriptor);
  32. }
  33. PHP_FUNCTION(sample_fwrite)
  34. {
  35.     php_sample_descriptor_data *fdata;
  36.     zval *file_resource;
  37.     char *data;
  38.     int data_len;
  39.     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "rs",&file_resource, &data, &data_len) == FAILURE )
  40.     {
  41.         RETURN_NULL();
  42.     }
  43.     ZEND_FETCH_RESOURCE(fdata, php_sample_descriptor_data*,&file_resource, -1,PHP_SAMPLE_DESCRIPTOR_RES_NAME, le_sample_descriptor);
  44.     RETURN_LONG(fwrite(data, 1, data_len, fdata->fp));
  45. }

我们这里没有重写sample_fclose()函数，你可以尝试着自己实现它。
现在编译运行，所有代码的结果都非常正确，我们还可以在内核中获取每个{资源}对应的文件名称了。

  1. PHP_FUNCTION(sample_fname)
  2. {
  3.     php_sample_descriptor_data *fdata;
  4.     zval *file_resource;
  5.     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r",&file_resource) == FAILURE )
  6.     {
  7.         RETURN_NULL();
  8.     }
  9.     ZEND_FETCH_RESOURCE(fdata, php_sample_descriptor_data*,&file_resource, -1,PHP_SAMPLE_DESCRIPTOR_RES_NAME, le_sample_descriptor);
  10.     RETURN_STRING(fdata->filename, 1);
  11. }

现在，Persistent Resources来了！

Delayed Destruction

在前面我们删除一个{资源}的时候，其实是去EG(regular_list)中将其删掉，EG(regular_list)存储着所有的只用在当前请求的{资源}。

持久{资源},存储在另一个HashTable中：EG(persistent_list)。其与EG(regular_list)有个明显的区别，那就是它每个值的索引都是字符串类型的，而且它的每个值也不会在每次请求结束后被释放掉，只能我们手动通过zend_hash_del()来删除，或者在进程结束后类似于MSHUTDOWN阶段将EG(persistent_list)整体清除，最常见的情景便是操作系统关闭了Web Server。EG(persistent_list)对其元素也有自己的dtor回调函数，和EG(regular_list)一样，它将根据其值的类型去调用不同的回调函数，我们这一次注册回调函数的时候，需要用到zend_register_list_destructors_ex()函数的第二个参数，第一个则被赋成NULL。在底层的实现中，持久的和regular{资源}是分别在不同的地方存储的，也分别拥有各自不同的释放函数。但在我们为脚本提供的函数中，却希望能够封装这种差异，从而使我们的用户使用起来更加方便快捷。

  1. static int le_sample_descriptor_persist;
  3. static void php_sample_descriptor_dtor_persistent(zend_rsrc_list_entry *rsrc TSRMLS_DC)
  4. {
  5.     php_sample_descriptor_data *fdata = (php_sample_descriptor_data*)rsrc->ptr;
  6.     fclose(fdata->fp);
  7.     pefree(fdata->filename, 1);
  8.     pefree(fdata, 1);
  9. }
  11. PHP_MINIT_FUNCTION(sample)
  12. {
  13.     le_sample_descriptor = zend_register_list_destructors_ex(php_sample_descriptor_dtor, NULL,PHP_SAMPLE_DESCRIPTOR_RES_NAME, module_number);
  14.     le_sample_descriptor_persist =zend_register_list_destructors_ex(NULL, php_sample_descriptor_dtor_persistent,PHP_SAMPLE_DESCRIPTOR_RES_NAME, module_number);
  15.     return SUCCESS;
  16. }

我们并没有为这两种{资源}起不同的名字，以防使用户产生疑惑。现在我们的PHP扩展中引进了一种新的{资源}，所以我们需要改写一下上面的函数，尽量使用户使用时感觉不到这种差异。

  1. //sample_fopen()
  2. PHP_FUNCTION(sample_fopen)
  3. {
  4.     php_sample_descriptor_data *fdata;
  5.     FILE *fp;
  6.     char *filename, *mode;
  7.     int filename_len, mode_len;
  8.     zend_bool persist = 0;
  10.     //类比一下mysql_connect函数的最后一个参数。
  11.     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC,"ss|b",&filename, &filename_len, &mode, &mode_len,&persist) == FAILURE)
  12.     {
  13.         RETURN_NULL();
  14.     }
  15.     if (!filename_len || !mode_len)
  16.     {
  17.         php_error_docref(NULL TSRMLS_CC, E_WARNING,"Invalid filename or mode length");
  18.         RETURN_FALSE;
  19.     }
  21.     fp = fopen(filename, mode);
  22.     if (!fp)
  23.     {
  24.         php_error_docref(NULL TSRMLS_CC, E_WARNING,"Unable to open %s using mode %s",filename, mode);
  25.         RETURN_FALSE;
  26.     }
  28.     if (!persist)
  29.     {
  30.         fdata = emalloc(sizeof(php_sample_descriptor_data));
  31.         fdata->filename = estrndup(filename, filename_len);
  32.         fdata->fp = fp;
  33.         ZEND_REGISTER_RESOURCE(return_value, fdata,le_sample_descriptor);
  34.     }
  35.     else
  36.     {
  37.         list_entry le;
  38.         char *hash_key;
  39.         int hash_key_len;
  41.         fdata =pemalloc(sizeof(php_sample_descriptor_data),1);
  42.         fdata->filename = pemalloc(filename_len + 1, 1);
  43.         memcpy(fdata->filename, filename, filename_len + 1);
  44.         fdata->fp = fp;
  46.         //在EG(regular_list中存一份)
  47.         ZEND_REGISTER_RESOURCE(return_value, fdata,le_sample_descriptor_persist);
  49.         //在EG(persistent_list)中再存一份
  50.         le.type = le_sample_descriptor_persist;
  51.         le.ptr = fdata;
  52.         hash_key_len = spprintf(&hash_key, 0,"sample_descriptor:%s:%s", filename, mode);
  53.         zend_hash_update(&EG(persistent_list),hash_key, hash_key_len + 1,(void*)&le, sizeof(list_entry), NULL);
  54.         efree(hash_key);
  55.     }
  56. }

在持久{资源}时，因为我们在EG(regular_list)中也保存了一份，所以脚本中我们资源类型的变量在实现中仍然是保存着一个resource ID，我们可以用它来进行之前章节所做的工作。将其添加到EG(persistent_list)中时，我们进行的操作流程几乎和ZEND_REGISTER_RESOURCE()宏函数一样，唯一的不同便是索引由之前的数字类型换成了字符串类型。当一个保存在EG(regular_list)中的持久{资源}被脚本释放时，内核会在EG(regular_list)寻找它对应的dtor函数，但它找到的是NULL，因为我们在使用zend_register_list_destructors_ex()函数声明这种资源类型时，第一个参数的值为NULL。所以此时这个{资源}不会被任何dtor函数调用，可以继续存在于内存中，任脚本流逝，请求更迭。当web server的进程执行完毕后，内核会扫描EG(persistent_list)的dtor，并调用我们已经定义好的释放函数。在我们定义的释放函数中，一定要记得使用pfree函数来释放内存，而不是efree。

Reuse

创建持久{资源}的目的是为了使用它，而不是让它来浪费内存的，我们再次重写一下sample_open()函数，这一次我们将检测需要创建的资源是否已经在persistent_list中存在了。

  1. PHP_FUNCTION(sample_fopen)
  2. {
  3.     php_sample_descriptor_data *fdata;
  4.     FILE *fp;
  5.     char *filename, *mode, *hash_key;
  6.     int filename_len, mode_len, hash_key_len;
  7.     zend_bool persist = 0;
  8.     list_entry *existing_file;
  9.     if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC,"ss|b",&filename, &filename_len, &mode, &mode_len,&persist) == FAILURE)
  10.     {
  11.         RETURN_NULL();
  12.     }
  14.     if (!filename_len || !mode_len)
  15.     {
  16.         php_error_docref(NULL TSRMLS_CC, E_WARNING,"Invalid filename or mode length");
  17.         RETURN_FALSE;
  18.     }
  20.     //看看是否已经存在，如果已经存在就直接使用，不再创建
  21.     hash_key_len = spprintf(&hash_key, 0,"sample_descriptor:%s:%s", filename, mode);
  22.     if (zend_hash_find(&EG(persistent_list), hash_key,hash_key_len + 1, (void **)&existing_file) == SUCCESS)
  23.     {
  24.         //存在一个，直接使用！
  25.         ZEND_REGISTER_RESOURCE(return_value,existing_file->ptr, le_sample_descriptor_persist);
  26.         efree(hash_key);
  27.         return;
  28.     }
  30.     fp = fopen(filename, mode);
  31.     if (!fp)
  32.     {
  33.         php_error_docref(NULL TSRMLS_CC, E_WARNING,"Unable to open %s using mode %s",filename, mode);
  34.         RETURN_FALSE;
  35.     }
  36.     if (!persist)
  37.     {
  38.         fdata = emalloc(sizeof(php_sample_descriptor_data));
  39.         fdata->filename = estrndup(filename, filename_len);
  40.         fdata->fp = fp;
  41.         ZEND_REGISTER_RESOURCE(return_value, fdata,le_sample_descriptor);
  42.     }
  43.     else
  44.     {
  45.         list_entry le;
  46.         fdata =pemalloc(sizeof(php_sample_descriptor_data),1);
  47.         fdata->filename = pemalloc(filename_len + 1, 1);
  48.         memcpy(fdata->filename, filename, filename_len + 1);
  49.         fdata->fp = fp;
  50.         ZEND_REGISTER_RESOURCE(return_value, fdata,le_sample_descriptor_persist);
  52.         /* Store a copy in the persistent_list */
  53.         le.type = le_sample_descriptor_persist;
  54.         le.ptr = fdata;
  56.         //hash_key在上面已经被创建了
  57.         zend_hash_update(&EG(persistent_list),hash_key, hash_key_len + 1,(void*)&le, sizeof(list_entry), NULL);
  58.     }
  59.     efree(hash_key);
  60. }

因为所有的PHP扩展都共用同一个HashTable来保存持久{资源}，所以我们在为{资源}的索引起名时，一定要唯一，同时必须简单，方便我们在其它的函数中构造出来。

Liveness Checking and Early Departure

一旦我们打开一个本地文件，便可以一直占有它的操作句柄，保证随时可以打开它。但是对于一些存在于远程计算机上的资源，比如mysql链接、http链接，虽然我们仍然握着与服务器的链接，但是这个链接在服务器端可能已经被关闭了，在本地我们就无法再用它来做一些有价值的工作了。

所以，当我们使用{资源}，尤其是持久{资源}时，一定要保证获取出来的{资源}仍然是有效的、可以使用的。如果它失效了，我们必须将其从persistent list中移除。下面就是一个检测socket有效性的例子：

  1. if (zend_hash_find(&EG(persistent_list), hash_key,hash_key_len + 1, (void**)&socket) == SUCCESS)
  2. {
  3.     if (php_sample_socket_is_alive(socket->ptr))
  4.     {
  5.         ZEND_REGISTER_RESOURCE(return_value,socket->ptr, le_sample_socket);
  6.         return;
  7.     }
  8.     zend_hash_del(&EG(persistent_list),hash_key, hash_key_len + 1);
  9. }

如你所见，{资源}失效后，我们只要把它从HashTable中删除就行了，这一步操作同样会激活我们设置的回调函数。On completion of this code block, the function will be in the same state it would have been if no resource had been found in the persistent list.

Agnostic Retrieval

现在我们已经可以创建资源类型并生成新的资源，还能将持久{资源}与平常{资源}使用的差异性封装起来。但是如果用户对一个持久{资源}调用sample_fwrite()时候并不会正常工作，先想一下内核是如何通过一个数字所以在regular_list中获取最终资源的。

  1. ZEND_FETCH_RESOURCE(
  2.     fdata,
  3.     php_sample_descriptor_data*,
  4.     &file_resource,
  5.     -1,
  6.     PHP_SAMPLE_DESCRIPTOR_RES_NAME,
  7.     le_sample_descriptor
  8. );

le_sample_descriptor可以保证你获取到的资源确实是这种类型的，绝不会出现你想要一个文件句柄，却返回给你一个mysql链接的情况。这种验证是必须的，但有时你又想绕过这种验证，因为我们放在persistenst_list中的{资源}是le_sample_descruotor_persist类型的，所以当我们把它复制到regular_list中时，它也是le_sample_descructor_persist的，所以如果我们想获取它，貌似只有两种方法，要么修改类型，要么再写一个新的sample_write_persistent函数的实现。或者极端一些，在sample_write函数里进行复杂的判断。但是如果sample_write()函数能同时接收它们两种类型的{资源}多好啊….

事情没有这么复杂，我们确实可以在sample_write()函数里获取{资源}时候同时指定两种类型。那就是使用ZEND_FETCH_RESOURCE2()宏函数，它与ZEND_FETCH_RESOURCE()宏函数的唯一区别就是它可以接收两种类型参数。

  1. ZEND_FETCH_RESOURCE2(
  2.     fdata,
  3.     php_sample_descriptor_data*,
  4.     &file_resource,
  5.     -1,
  6.     PHP_SAMPLE_DESCRIPTOR_RES_NAME,
  7.     le_sample_descriptor,
  8.     le_sample_descriptor_persist
  9. );

现在，只要resource ID对应的最终资源类型是persistent或者non-persistent的一种便可以正常通过验证了。

什么，你想设置三种甚至更多的类型？!!那你只能直接使用zend_fetch_resource()函数了。

  1. //一种类型的
  2. fp = (FILE*) zend_fetch_resource(
  3.         &file_descriptor TSRMLS_CC, 
  4.         -1,
  5.         PHP_SAMPLE_DESCRIPTOR_RES_NAME, 
  6.         NULL,
  7.         1, 
  8.         le_sample_descriptor
  9. );
  10. ZEND_VERIFY_RESOURCE(fp);

想看看ZEND_FETCH_RESOURCE2()宏函数的实现么？

  1. //两种类型的
  2. fp = (FILE*) zend_fetch_resource(
  3.         &file_descriptor TSRMLS_CC, 
  4.         -1,
  5.         PHP_SAMPLE_DESCRIPTOR_RES_NAME, 
  6.         NULL,
  7.         2, 
  8.         le_sample_descriptor, 
  9.         le_sample_descriptor_persist
  10. );
  11. ZEND_VERIFY_RESOURCE(fp);

再给力一些，三种类型的：

  1. fp = (FILE*) zend_fetch_resource(
  2.     &file_descriptor TSRMLS_CC, 
  3.     -1,
  4.     PHP_SAMPLE_DESCRIPTOR_RES_NAME, 
  5.     NULL,
  6.     3, 
  7.     le_sample_descriptor, 
  8.     le_sample_descriptor_persist,
  9.     le_sample_othertype
  10. );
  11. ZEND_VERIFY_RESOURCE(fp);

话都说到这份上了，你肯定知道四种、五种、更多种类型的应该怎么调用了。