[通译][php扩展和嵌入式]第8章-资源数据类型

static int le_sample_descriptor_persist;

接着扩充你的MINIT函数, 增加一个资源注册, 使用新的用于持久化分配结构的dtor函数:

static void php_sample_descriptor_dtor_persistent(                    zend_rsrc_list_entry *rsrc TSRMLS_DC){    php_sample_descriptor_data *fdata =                (php_sample_descriptor_data*)rsrc->ptr;    fclose(fdata->fp);    pefree(fdata->filename, 1);    pefree(fdata, 1);}PHP_MINIT_FUNCTION(sample){    le_sample_descriptor =     zend_register_list_destructors_ex(            php_sample_descriptor_dtor, NULL,            PHP_SAMPLE_DESCRIPTOR_RES_NAME, module_number);    le_sample_descriptor_persist =                        zend_register_list_destructors_ex(            NULL, php_sample_descriptor_dtor_persistent,            PHP_SAMPLE_DESCRIPTOR_RES_NAME, module_number);    return SUCCESS;}

通过给这两个资源类型相同的名字, 它们的不同对于终端用户就是透明的. 在内部, 只有一种在请求清理过程会调用php_sample_descriptor_dtor; 另外一个, 你马上会看到, 它将和webserver的进程或线程保持相同的生命周期.

持久化注册

现在相应的清理函数已经到位了, 是时候创建一些可用的资源结构了. 通常会使用两个独立的函数, 在内部映射到同一个实现上, 但是这可能会使得已经很混杂的主题更加混乱, 所以我们这里只是在sample_fopen()中增加一个布尔类型的参数来完成这件事.

PHP_FUNCTION(sample_fopen){    php_sample_descriptor_data *fdata;    FILE *fp;    char *filename, *mode;    int filename_len, mode_len;    zend_bool persist = 0;    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC,"ss|b",                &filename, &filename_len, &mode, &mode_len,                &persist) == FAILURE) {        RETURN_NULL();    }    if (!filename_len || !mode_len) {        php_error_docref(NULL TSRMLS_CC, E_WARNING,                "Invalid filename or mode length");        RETURN_FALSE;    }    fp = fopen(filename, mode);    if (!fp) {        php_error_docref(NULL TSRMLS_CC, E_WARNING,                "Unable to open %s using mode %s",                filename, mode);        RETURN_FALSE;    }    if (!persist) {        fdata = emalloc(sizeof(php_sample_descriptor_data));        fdata->filename = estrndup(filename, filename_len);        fdata->fp = fp;        ZEND_REGISTER_RESOURCE(return_value, fdata,                                le_sample_descriptor);    } else {        list_entry le;        char *hash_key;        int hash_key_len;        fdata =pemalloc(sizeof(php_sample_descriptor_data),1);        fdata->filename = pemalloc(filename_len + 1, 1);        memcpy(data->filename, filename, filename_len + 1);        fdata->fp = fp;        ZEND_REGISTER_RESOURCE(return_value, fdata,                        le_sample_descriptor_persist);        /* 在persistent_list中保存一份拷贝 */        le.type = le_sample_descriptor_persist;        le.ptr = fdata;        hash_key_len = spprintf(&hash_key, 0,                "sample_descriptor:%s:%s", filename, mode);        zend_hash_update(&EG(persistent_list),            hash_key, hash_key_len + 1,            (void*)&le, sizeof(list_entry), NULL);        efree(hash_key);    }}

这个函数的核心部分现在你应该已经很熟悉了. 打开一个文件, 将它的名字存储到新分配的内存中, 将它注册为请求特有的资源ID并设置到return_value中. 这一次新的知识点是第二部分, 但它也并不完全陌生.

这里, 你实际上做的事情和ZEND_REGISTER_RESOURCE()所做的基本一致; 不过, 这里不再是获取一个数值索引放到每个请求特有的列表(EG(regular_list))中, 而是赋值给了一个关联key(可以使用它在未来的请求中重新获取资源), 将它放到了持久化列表中, 这个持久化列表(EG(persistent_list))并不会在每个请求结束后被清理.

当这样的一个持久化描述符资源结束其生命周期时, EG(regular_list)的dtor函数将会检查已注册的析构器列表, 发现le_sample_descriptor_persist的(非持久化)析构器为NULL, 因此不做任何事(即不进行释放操作). 这使得FILE *指针和它的char *名字字符串可以在下一个请求中安全的使用.

当资源最终从EG(persistent_list)中移除时(由于进程或线程终止, 或者由于你的扩展有意的移除), 引擎会查找持久化析构器. 由于这个资源类型定义了持久化析构器, 因此它将会被正确的调用pefree()释放原来由pemalloc()分配的内存.

重用

将一个资源条目的拷贝放到persistent_list中, 除了延长执行时间, 占用内存以及文件锁资源, 不会有任何好处, 除非你在后续的请求中以某种方式重用它.

这就是hash_key的来由. 当sample_fopen()被调用时, 无论是持久化或非持久化方式, 你的函数都可以使用请求的文件名和模式参数重新创建hash_key, 并在打开文件之前尝试从persistent_list中使用hash_key查找该资源.

PHP_FUNCTION(sample_fopen){    php_sample_descriptor_data *fdata;    FILE *fp;    char *filename, *mode, *hash_key;    int filename_len, mode_len, hash_key_len;    zend_bool persist = 0;    list_entry *existing_file;    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC,"ss|b",                &filename, &filename_len, &mode, &mode_len,                &persist) == FAILURE) {        RETURN_NULL();    }    if (!filename_len || !mode_len) {        php_error_docref(NULL TSRMLS_CC, E_WARNING,                "Invalid filename or mode length");        RETURN_FALSE;    }    /* 尝试查找已经打开的文件 */    hash_key_len = spprintf(&hash_key, 0,            "sample_descriptor:%s:%s", filename, mode);    if (zend_hash_find(&EG(persistent_list), hash_key,            hash_key_len + 1, (void **)&existing_file) == SUCCESS) {        /* There's already a file open, return that! */        ZEND_REGISTER_RESOURCE(return_value,            existing_file->ptr, le_sample_descriptor_persist);        efree(hash_key);        return;    }    fp = fopen(filename, mode);    if (!fp) {        php_error_docref(NULL TSRMLS_CC, E_WARNING,                "Unable to open %s using mode %s",                filename, mode);        RETURN_FALSE;    }    if (!persist) {        fdata = emalloc(sizeof(php_sample_descriptor_data));        fdata->filename = estrndup(filename, filename_len);        fdata->fp = fp;        ZEND_REGISTER_RESOURCE(return_value, fdata,                                le_sample_descriptor);    } else {        list_entry le;        fdata =pemalloc(sizeof(php_sample_descriptor_data),1);        fdata->filename = pemalloc(filename_len + 1, 1);        memcpy(data->filename, filename, filename_len + 1);        fdata->fp = fp;        ZEND_REGISTER_RESOURCE(return_value, fdata,                        le_sample_descriptor_persist);        /* 存储一份拷贝到persistent_list */        le.type = le_sample_descriptor_persist;        le.ptr = fdata;        /* hash_key现在已经创建了 */        zend_hash_update(&EG(persistent_list),            hash_key, hash_key_len + 1,            (void*)&le, sizeof(list_entry), NULL);    }    efree(hash_key);}

因为所有的扩展都使用同一个持久化HashTable存储它们的资源, 因此选择唯一的可复现的hash_key非常重要. sample_fopen()中使用了一种常见的方式: 使用扩展和资源类型名字作为前缀, 接着是创建的资源的关键信息.

活性检查和提前离开

尽管你打开一个文件并无限期的保持打开是安全的, 但是对于其他资源类型则不然, 尤其是远程网络资源可能会变得不可用, 尤其是在请求间长时间不使用时.

因此在取回一个持久化资源时, 对它的可用性检查就非常重要. 如果资源不再可用, 就必须从持久化列表中移除, 并且应该继续以没有找到已分配资源(持久化)的逻辑执行.

下面的假想代码块在持久化列表中的套接字上执行了一个活性检查:

if (zend_hash_find(&EG(persistent_list), hash_key,        hash_key_len + 1, (void**)&socket) == SUCCESS) {    if (php_sample_socket_is_alive(socket->ptr)) {        ZEND_REGISTER_RESOURCE(return_value,                    socket->ptr, le_sample_socket);        return;    }    zend_hash_del(&EG(persistent_list),                            hash_key, hash_key_len + 1);}

ZEND_FETCH_RESOURCE(fdata, php_sample_descriptor_data*,    &file_resource, -1, PHP_SAMPLE_DESCRIPTOR_RES_NAME,    le_sample_descriptor);

ZEND_FETCH_RESOURCE2(fdata, php_sample_descriptor_data*,    &file_resource, -1, PHP_SAMPLE_DESCRIPTOR_RES_NAME,    le_sample_descriptor, le_sample_descriptor_persist);

fp = (FILE*) zend_fetch_resource(&file_descriptor TSRMLS_CC, -1,    PHP_SAMPLE_DESCRIPTOR_RES_NAME, NULL,    1, le_sample_descriptor);ZEND_VERIFY_RESOURCE(fp);

fp = (FILE*) zend_fetch_resource(&file_descriptor TSRMLS_CC, -1,    PHP_SAMPLE_DESCRIPTOR_RES_NAME, NULL,    2, le_sample_descriptor, le_sample_descriptor_persist);ZEND_VERIFY_RESOURCE(fp);

fp = (FILE*) zend_fetch_resource(&file_descriptor TSRMLS_CC, -1,    PHP_SAMPLE_DESCRIPTOR_RES_NAME, NULL,    3, le_sample_descriptor, le_sample_descriptor_persist,    le_sample_othertype);ZEND_VERIFY_RESOURCE(fp);

PHP_FUNCTION(sample_fopen){    sample_descriptor_data_t    *sddp;    FILE                        *fp;    char                        *filename, *mode;    int                         filename_len, mode_len;    zend_bool                   persist = 1;    char                        *hash_key;    int                         hash_key_len;    int                         rsrc_l;    zend_rsrc_list_entry        *le_p;    if ( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|b",             &filename, &filename_len,             &mode, &mode_len, &persist) == FAILURE ) {         RETURN_NULL();    }       if ( !filename_len || !mode_len ) {         php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid filename or mode length");        RETURN_FALSE;    }       hash_key_len    = spprintf(&hash_key, 0, "sample_descriptor:%s:%s", filename, mode);    if ( zend_hash_find(&EG(persistent_list), hash_key, hash_key_len + 1, (void **)&le_p) == SUCCESS ) {         rsrc_l  = ZEND_REGISTER_RESOURCE(return_value, le_p->ptr, le_sample_descriptor_persist);    } else {        fp  = fopen(filename, mode);        if ( !fp ) {             efree(hash_key);            php_error_docref(NULL TSRMLS_CC, E_WARNING, "Unable to open %s using mode %s",                     filename, mode);            RETURN_FALSE;        }           sddp        = pemalloc(sizeof(sample_descriptor_data_t), persist);        sddp->fname = pestrdup(filename, persist);        sddp->fp    = fp;         rsrc_l      = ZEND_REGISTER_RESOURCE(return_value, sddp, persist ? le_sample_descriptor_persist : le_sample_descriptor);        if ( persist ) {             zend_rsrc_list_entry    le;             le.type = le_sample_descriptor_persist;            le.ptr  = sddp;            zend_hash_update(&EG(persistent_list), hash_key, hash_key_len + 1, (void *)&le, sizeof(zend_rsrc_list_entry), NULL);        }       }       efree(hash_key);    RETURN_RESOURCE(rsrc_l);}PHP_FUNCTION(sample_fwrite){    sample_descriptor_data_t    *sddp;    zval                        *file_resource;    char                        *data;    int                         data_len;    if ( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "rs",             &file_resource, &data, &data_len) == FAILURE ) {         RETURN_FALSE;    }       ZEND_FETCH_RESOURCE2(sddp, sample_descriptor_data_t *, &file_resource, -1,         SAMPLE_DESCRIPTOR_RES_NAME, le_sample_descriptor, le_sample_descriptor_persist);#if ZEND_DEBUGphp_printf("FILE * pointer: %p\n", sddp->fp);#endif    RETURN_LONG(fwrite(data, 1, data_len, sddp->fp));}PHP_FUNCTION(sample_fclose){    sample_descriptor_data_t    *sddp;    zval                        *file_resource;    if ( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &file_resource) == FAILURE ) {         RETURN_FALSE;    }       ZEND_FETCH_RESOURCE2(sddp, sample_descriptor_data_t *, &file_resource, -1, SAMPLE_DESCRIPTOR_RES_NAME, le_sample_descriptor, le_sample_descriptor_persist);    zend_hash_index_del(&EG(regular_list), Z_RESVAL_P(file_resource));    RETURN_TRUE;}PHP_FUNCTION(sample_fname){    sample_descriptor_data_t    *sddp;    zval    *file_resource;    if ( zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &file_resource) == FAILURE ) {         RETURN_FALSE;    }       ZEND_FETCH_RESOURCE2(sddp, sample_descriptor_data_t *, &file_resource, -1, SAMPLE_DESCRIPTOR_RES_NAME, le_sample_descriptor, le_sample_descriptor_persist);    RETURN_STRING(sddp->fname, 1); }

$a = sample_fopen('notes.txt', 'r');/* var->refcount = 1, rsrc->refcount = 1 */

$b = $a;/* var->refcount = 2, rsrc->refcount = 1 */

unset($b);/* var->refcount = 1, rsrc->refcount = 1 */

$b = $a;$c = &$a;/* bvar->refcount = 1, bvar->is_ref = 0   acvar->refcount = 2, acvar->is_ref = 1   rsrc->refcount = 2 */