Skip to content

New internal API for serialization and unserialization #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

New internal API for serialization and unserialization #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion ext/standard/php_var.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,47 @@ PHPAPI void php_var_export_ex(zval **struc, int level, smart_str *buf TSRMLS_DC)

PHPAPI void php_debug_zval_dump(zval **struc, int level TSRMLS_DC);


#define PHP_SERIALIZE_FAILURE (FAILURE)
#define PHP_SERIALIZE_CUSTOM (SUCCESS)
#define PHP_SERIALIZE_OBJECT (SUCCESS + 1)

typedef HashTable* php_serialize_data_t;

/* serialize variable */
PHPAPI void php_var_serialize(smart_str *buf, zval **struc, php_serialize_data_t *var_hash TSRMLS_DC);

/* add object serialization string prefix */
PHPAPI void php_var_serialize_object_start(smart_str *buf, zval *object, zend_uint nprops TSRMLS_DC);

/* append string that ends the object definition */
PHPAPI void php_var_serialize_object_end(smart_str *buf);

/* append null property */
PHPAPI void php_var_serialize_property_null(smart_str *buf, const char *key);

/* append boolean property */
PHPAPI void php_var_serialize_property_bool(smart_str *buf, const char *key, int value);

/* append long property */
PHPAPI void php_var_serialize_property_long(smart_str *buf, const char *key, long value);

/* append double property */
PHPAPI void php_var_serialize_property_double(smart_str *buf, const char *key, double value TSRMLS_DC);

/* append string property */
PHPAPI void php_var_serialize_property_string(smart_str *buf, const char *key, const char *value);

/* append string property */
PHPAPI void php_var_serialize_property_stringl(smart_str *buf, const char *key, const char *value, int value_len);

/* append string property zval */
PHPAPI void php_var_serialize_property_zval(smart_str *buf, const char *key, zval *value, zend_serialize_data *data TSRMLS_DC);

/* append properties taken from HashTable */
PHPAPI void php_var_serialize_properties(smart_str *buf, HashTable *properties, zend_serialize_data *data TSRMLS_DC);


struct php_unserialize_data {
void *first;
void *last;
Expand All @@ -49,9 +88,16 @@ struct php_unserialize_data {

typedef struct php_unserialize_data* php_unserialize_data_t;

PHPAPI void php_var_serialize(smart_str *buf, zval **struc, php_serialize_data_t *var_hash TSRMLS_DC);
/* unserialize variable */
PHPAPI int php_var_unserialize(zval **rval, const unsigned char **p, const unsigned char *max, php_unserialize_data_t *var_hash TSRMLS_DC);

/* unserialize one property (key and value) of the serialized object */
PHPAPI int php_var_unserialize_property(zval *key, zval *value, const unsigned char **buf, zend_uint *buf_len, zend_unserialize_data *data TSRMLS_DC);

/* unserialize all properties of the serialized object and save them to ht */
PHPAPI int php_var_unserialize_properties(HashTable *ht, const unsigned char **buf, zend_uint *buf_len, zend_uint elements, zend_unserialize_data *data TSRMLS_DC);


#define PHP_VAR_SERIALIZE_INIT(var_hash_ptr) \
do { \
/* fprintf(stderr, "SERIALIZE_INIT == lock: %u, level: %u\n", BG(serialize_lock), BG(serialize).level); */ \
Expand Down
219 changes: 158 additions & 61 deletions ext/standard/var.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -584,6 +584,20 @@ static inline int php_add_var_hash(HashTable *var_hash, zval *var, void *var_old
}
/* }}} */

static inline void php_var_serialize_null(smart_str *buf) /* {{{ */
{
smart_str_appendl(buf, "N;", 2);
}
/* }}} */

static inline void php_var_serialize_bool(smart_str *buf, long val) /* {{{ */
{
smart_str_appendl(buf, "b:", 2);
smart_str_append_long(buf, val);
smart_str_appendc(buf, ';');
}
/* }}} */

static inline void php_var_serialize_long(smart_str *buf, long val) /* {{{ */
{
smart_str_appendl(buf, "i:", 2);
Expand All @@ -592,7 +606,21 @@ static inline void php_var_serialize_long(smart_str *buf, long val) /* {{{ */
}
/* }}} */

static inline void php_var_serialize_string(smart_str *buf, char *str, int len) /* {{{ */
static inline void php_var_serialize_double(smart_str *buf, double val TSRMLS_DC) /* {{{ */
{
char *s;

smart_str_appendl(buf, "d:", 2);
s = (char *) safe_emalloc(PG(serialize_precision), 1, MAX_LENGTH_OF_DOUBLE + 1);
php_gcvt(val, PG(serialize_precision), '.', 'E', s);
smart_str_appends(buf, s);
smart_str_appendc(buf, ';');
efree(s);
return;
}
/* }}} */

static inline void php_var_serialize_string(smart_str *buf, const char *str, int len) /* {{{ */
{
smart_str_appendl(buf, "s:", 2);
smart_str_append_long(buf, len);
Expand All @@ -602,6 +630,55 @@ static inline void php_var_serialize_string(smart_str *buf, char *str, int len)
}
/* }}} */

static inline void php_var_serialize_hash_table(smart_str *buf, HashTable *myht, zval **pstruc, zend_bool incomplete_class, HashTable *var_hash TSRMLS_DC) /* {{{ */
{
int i;
char *key;
zval **data;
ulong index;
uint key_len;
HashPosition pos;

zend_hash_internal_pointer_reset_ex(myht, &pos);
for (;; zend_hash_move_forward_ex(myht, &pos)) {
i = zend_hash_get_current_key_ex(myht, &key, &key_len, &index, 0, &pos);
if (i == HASH_KEY_NON_EXISTENT) {
break;
}
if (incomplete_class && strcmp(key, MAGIC_MEMBER) == 0) {
continue;
}

switch (i) {
case HASH_KEY_IS_LONG:
php_var_serialize_long(buf, index);
break;
case HASH_KEY_IS_STRING:
php_var_serialize_string(buf, key, key_len - 1);
break;
}

/* we should still add element even if it's not OK,
* since we already wrote the length of the array before */
if (zend_hash_get_current_data_ex(myht, (void **) &data, &pos) != SUCCESS
|| !data
|| data == pstruc
|| (Z_TYPE_PP(data) == IS_ARRAY && Z_ARRVAL_PP(data)->nApplyCount > 1)
) {
smart_str_appendl(buf, "N;", 2);
} else {
if (Z_TYPE_PP(data) == IS_ARRAY) {
Z_ARRVAL_PP(data)->nApplyCount++;
}
php_var_serialize_intern(buf, *data, var_hash TSRMLS_CC);
if (Z_TYPE_PP(data) == IS_ARRAY) {
Z_ARRVAL_PP(data)->nApplyCount--;
}
}
}
}
/* }}} */

static inline zend_bool php_var_serialize_class_name(smart_str *buf, zval *struc TSRMLS_DC) /* {{{ */
{
PHP_CLASS_ATTRIBUTES;
Expand Down Expand Up @@ -734,30 +811,20 @@ static void php_var_serialize_intern(smart_str *buf, zval *struc, HashTable *var

switch (Z_TYPE_P(struc)) {
case IS_BOOL:
smart_str_appendl(buf, "b:", 2);
smart_str_append_long(buf, Z_LVAL_P(struc));
smart_str_appendc(buf, ';');
php_var_serialize_bool(buf, Z_LVAL_P(struc));
return;

case IS_NULL:
smart_str_appendl(buf, "N;", 2);
php_var_serialize_null(buf);
return;

case IS_LONG:
php_var_serialize_long(buf, Z_LVAL_P(struc));
return;

case IS_DOUBLE: {
char *s;

smart_str_appendl(buf, "d:", 2);
s = (char *) safe_emalloc(PG(serialize_precision), 1, MAX_LENGTH_OF_DOUBLE + 1);
php_gcvt(Z_DVAL_P(struc), PG(serialize_precision), '.', 'E', s);
smart_str_appends(buf, s);
smart_str_appendc(buf, ';');
efree(s);
return;
}
case IS_DOUBLE:
php_var_serialize_double(buf, Z_DVAL_P(struc) TSRMLS_CC);
return;

case IS_STRING:
php_var_serialize_string(buf, Z_STRVAL_P(struc), Z_STRLEN_P(struc));
Expand All @@ -766,7 +833,7 @@ static void php_var_serialize_intern(smart_str *buf, zval *struc, HashTable *var
case IS_OBJECT: {
zval *retval_ptr = NULL;
zval fname;
int res;
int res, serialize_rc;
zend_class_entry *ce = NULL;

if (Z_OBJ_HT_P(struc)->get_class_entry) {
Expand All @@ -778,7 +845,8 @@ static void php_var_serialize_intern(smart_str *buf, zval *struc, HashTable *var
unsigned char *serialized_data = NULL;
zend_uint serialized_length;

if (ce->serialize(struc, &serialized_data, &serialized_length, (zend_serialize_data *)var_hash TSRMLS_CC) == SUCCESS) {
serialize_rc = ce->serialize(struc, &serialized_data, &serialized_length, (zend_serialize_data *)var_hash TSRMLS_CC);
if (serialize_rc == PHP_SERIALIZE_CUSTOM) {
smart_str_appendl(buf, "C:", 2);
smart_str_append_long(buf, (int)Z_OBJCE_P(struc)->name_length);
smart_str_appendl(buf, ":\"", 2);
Expand All @@ -789,6 +857,8 @@ static void php_var_serialize_intern(smart_str *buf, zval *struc, HashTable *var
smart_str_appendl(buf, ":{", 2);
smart_str_appendl(buf, serialized_data, serialized_length);
smart_str_appendc(buf, '}');
} else if (serialize_rc == PHP_SERIALIZE_OBJECT) {
smart_str_appendl(buf, serialized_data, serialized_length);
} else {
smart_str_appendl(buf, "N;", 2);
}
Expand Down Expand Up @@ -851,49 +921,7 @@ static void php_var_serialize_intern(smart_str *buf, zval *struc, HashTable *var
smart_str_append_long(buf, i);
smart_str_appendl(buf, ":{", 2);
if (i > 0) {
char *key;
zval **data;
ulong index;
uint key_len;
HashPosition pos;

zend_hash_internal_pointer_reset_ex(myht, &pos);
for (;; zend_hash_move_forward_ex(myht, &pos)) {
i = zend_hash_get_current_key_ex(myht, &key, &key_len, &index, 0, &pos);
if (i == HASH_KEY_NON_EXISTENT) {
break;
}
if (incomplete_class && strcmp(key, MAGIC_MEMBER) == 0) {
continue;
}

switch (i) {
case HASH_KEY_IS_LONG:
php_var_serialize_long(buf, index);
break;
case HASH_KEY_IS_STRING:
php_var_serialize_string(buf, key, key_len - 1);
break;
}

/* we should still add element even if it's not OK,
* since we already wrote the length of the array before */
if (zend_hash_get_current_data_ex(myht, (void **) &data, &pos) != SUCCESS
|| !data
|| data == &struc
|| (Z_TYPE_PP(data) == IS_ARRAY && Z_ARRVAL_PP(data)->nApplyCount > 1)
) {
smart_str_appendl(buf, "N;", 2);
} else {
if (Z_TYPE_PP(data) == IS_ARRAY) {
Z_ARRVAL_PP(data)->nApplyCount++;
}
php_var_serialize_intern(buf, *data, var_hash TSRMLS_CC);
if (Z_TYPE_PP(data) == IS_ARRAY) {
Z_ARRVAL_PP(data)->nApplyCount--;
}
}
}
php_var_serialize_hash_table(buf, myht, &struc, incomplete_class, var_hash TSRMLS_CC);
}
smart_str_appendc(buf, '}');
return;
Expand All @@ -912,6 +940,75 @@ PHPAPI void php_var_serialize(smart_str *buf, zval **struc, php_serialize_data_t
}
/* }}} */

PHPAPI void php_var_serialize_object_start(smart_str *buf, zval *object, zend_uint nprops TSRMLS_DC) /* {{{ */
{
php_var_serialize_class_name(buf, object TSRMLS_CC);
smart_str_append_long(buf, nprops);
smart_str_appendl(buf, ":{", 2);
}
/* }}} */

PHPAPI void php_var_serialize_object_end(smart_str *buf) /* {{{ */
{
smart_str_appendc(buf, '}');
}
/* }}} */

PHPAPI void php_var_serialize_property_null(smart_str *buf, const char *key) /* {{{ */
{
php_var_serialize_string(buf, key, strlen(key));
}
/* }}} */

PHPAPI void php_var_serialize_property_bool(smart_str *buf, const char *key, int value) /* {{{ */
{
php_var_serialize_string(buf, key, strlen(key));
php_var_serialize_bool(buf, (long) value);
}
/* }}} */

PHPAPI void php_var_serialize_property_long(smart_str *buf, const char *key, long value) /* {{{ */
{
php_var_serialize_string(buf, key, strlen(key));
php_var_serialize_long(buf, value);
}
/* }}} */

PHPAPI void php_var_serialize_property_double(smart_str *buf, const char *key, double value TSRMLS_DC) /* {{{ */
{
php_var_serialize_string(buf, key, strlen(key));
php_var_serialize_double(buf, value TSRMLS_CC);
}
/* }}} */

PHPAPI void php_var_serialize_property_string(smart_str *buf, const char *key, const char *value) /* {{{ */
{
php_var_serialize_string(buf, key, strlen(key));
php_var_serialize_string(buf, value, strlen(value));
}
/* }}} */

PHPAPI void php_var_serialize_property_stringl(smart_str *buf, const char *key, const char *value, int value_len) /* {{{ */
{
php_var_serialize_string(buf, key, strlen(key));
php_var_serialize_string(buf, value, value_len);
}
/* }}} */

PHPAPI void php_var_serialize_property_zval(smart_str *buf, const char *key, zval *value, zend_serialize_data *data TSRMLS_DC) /* {{{ */
{
php_var_serialize_string(buf, key, strlen(key));
php_var_serialize_intern(buf, value, (HashTable *) data TSRMLS_CC);
}
/* }}} */

PHPAPI void php_var_serialize_properties(smart_str *buf, HashTable *properties, zend_serialize_data *data TSRMLS_DC) /* {{{ */
{
php_var_serialize_hash_table(buf, properties, NULL, 0, (HashTable *) data TSRMLS_CC);
}
/* }}} */


/* {{{ proto string serialize(mixed variable)
Returns a string representation of variable (which can later be unserialized) */
PHP_FUNCTION(serialize)
Expand Down
Loading