/src/php-src/Zend/zend_smart_str.c

Source
/*
   +----------------------------------------------------------------------+
   | Copyright © The PHP Group and Contributors.                          |
   +----------------------------------------------------------------------+
   | This source file is subject to the Modified BSD License that is      |
   | bundled with this package in the file LICENSE, and is available      |
   | through the World Wide Web at <https://www.php.net/license/>.        |
   |                                                                      |
   | SPDX-License-Identifier: BSD-3-Clause                                |
   +----------------------------------------------------------------------+
   | Author: Dmitry Stogov <dmitry@php.net>                               |
   +----------------------------------------------------------------------+
 */

#include <zend.h>
#include "zend_smart_str.h"
#include "zend_smart_string.h"
#include "zend_enum.h"

#define SMART_STR_OVERHEAD   (ZEND_MM_OVERHEAD + _ZSTR_HEADER_SIZE + 1)
#define SMART_STR_START_SIZE 256
#define SMART_STR_START_LEN  (SMART_STR_START_SIZE - SMART_STR_OVERHEAD)
#define SMART_STR_PAGE       4096

#define SMART_STR_NEW_LEN(len) \
  (ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STR_OVERHEAD, SMART_STR_PAGE) - SMART_STR_OVERHEAD)

ZEND_API void ZEND_FASTCALL smart_str_erealloc(smart_str *str, size_t len)
{
  if (UNEXPECTED(!str->s)) {
    str->a = len <= SMART_STR_START_LEN
        ? SMART_STR_START_LEN
        : SMART_STR_NEW_LEN(len);
    str->s = zend_string_alloc(str->a, 0);
    ZSTR_LEN(str->s) = 0;
  } else {
    str->a = SMART_STR_NEW_LEN(len);
    str->s = (zend_string *) erealloc2(str->s, str->a + _ZSTR_HEADER_SIZE + 1, _ZSTR_HEADER_SIZE + ZSTR_LEN(str->s));
  }
}

ZEND_API void ZEND_FASTCALL smart_str_realloc(smart_str *str, size_t len)
{
  if (UNEXPECTED(!str->s)) {
    str->a = len <= SMART_STR_START_LEN
        ? SMART_STR_START_LEN
        : SMART_STR_NEW_LEN(len);
    str->s = zend_string_alloc(str->a, 1);
    ZSTR_LEN(str->s) = 0;
  } else {
    str->a = SMART_STR_NEW_LEN(len);
    str->s = (zend_string *) perealloc(str->s, str->a + _ZSTR_HEADER_SIZE + 1, 1);
  }
}

/* Windows uses VK_ESCAPE instead of \e */
#ifndef VK_ESCAPE
#define VK_ESCAPE '\e'
#endif

static size_t zend_compute_escaped_string_len(const char *s, size_t l) {
  size_t i, len = l;
  for (i = 0; i < l; ++i) {
    char c = s[i];
    if (c == '\n' || c == '\r' || c == '\t' ||
      c == '\f' || c == '\v' || c == '\\' || c == VK_ESCAPE) {
      len += 1;
    } else if (c < 32 || c > 126) {
      len += 3;
    }
  }
  return len;
}

ZEND_API void ZEND_FASTCALL smart_str_append_escaped(smart_str *str, const char *s, size_t l) {
  char *res;
  size_t i, len = zend_compute_escaped_string_len(s, l);

  smart_str_alloc(str, len, 0);
  res = &ZSTR_VAL(str->s)[ZSTR_LEN(str->s)];
  ZSTR_LEN(str->s) += len;

  for (i = 0; i < l; ++i) {
    unsigned char c = s[i];
    if (c < 32 || c == '\\' || c > 126) {
      *res++ = '\\';
      switch (c) {
        case '\n': *res++ = 'n'; break;
        case '\r': *res++ = 'r'; break;
        case '\t': *res++ = 't'; break;
        case '\f': *res++ = 'f'; break;
        case '\v': *res++ = 'v'; break;
        case '\\': *res++ = '\\'; break;
        case VK_ESCAPE: *res++ = 'e'; break;
        default:
          *res++ = 'x';
          if ((c >> 4) < 10) {
            *res++ = (c >> 4) + '0';
          } else {
            *res++ = (c >> 4) + 'A' - 10;
          }
          if ((c & 0xf) < 10) {
            *res++ = (c & 0xf) + '0';
          } else {
            *res++ = (c & 0xf) + 'A' - 10;
          }
      }
    } else {
      *res++ = c;
    }
  }
}

ZEND_API void ZEND_FASTCALL smart_str_append_double(
    smart_str *str, double num, int precision, bool zero_fraction) {
  char buf[ZEND_DOUBLE_MAX_LENGTH];
  /* Model snprintf precision behavior. */
  zend_gcvt(num, precision ? precision : 1, '.', 'E', buf);
  smart_str_appends(str, buf);
  if (zero_fraction && zend_finite(num) && !strchr(buf, '.')) {
    smart_str_appendl(str, ".0", 2);
  }
}

ZEND_API void smart_str_append_printf(smart_str *dest, const char *format, ...) {
  va_list arg;
  va_start(arg, format);
  zend_printf_to_smart_str(dest, format, arg);
  va_end(arg);
}

ZEND_API void smart_string_append_printf(smart_string *dest, const char *format, ...) {
  va_list arg;
  va_start(arg, format);
  zend_printf_to_smart_string(dest, format, arg);
  va_end(arg);
}

#define SMART_STRING_OVERHEAD   (ZEND_MM_OVERHEAD + 1)
#define SMART_STRING_START_SIZE 256
#define SMART_STRING_START_LEN  (SMART_STRING_START_SIZE - SMART_STRING_OVERHEAD)
#define SMART_STRING_PAGE       4096

ZEND_API void ZEND_FASTCALL _smart_string_alloc_persistent(smart_string *str, size_t len)
{
  if (!str->c) {
    str->len = 0;
    if (len <= SMART_STRING_START_LEN) {
      str->a = SMART_STRING_START_LEN;
    } else {
      str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
    }
    str->c = pemalloc(str->a + 1, 1);
  } else {
    if (UNEXPECTED((size_t) len > SIZE_MAX - str->len)) {
      zend_error_noreturn(E_ERROR, "String size overflow");
    }
    len += str->len;
    str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
    str->c = perealloc(str->c, str->a + 1, 1);
  }
}

ZEND_API void ZEND_FASTCALL _smart_string_alloc(smart_string *str, size_t len)
{
  if (!str->c) {
    str->len = 0;
    if (len <= SMART_STRING_START_LEN) {
      str->a = SMART_STRING_START_LEN;
      str->c = emalloc(SMART_STRING_START_LEN + 1);
    } else {
      str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
      if (EXPECTED(str->a < (ZEND_MM_CHUNK_SIZE - SMART_STRING_OVERHEAD))) {
        str->c = emalloc_large(str->a + 1);
      } else {
        /* allocate a huge chunk */
        str->c = emalloc(str->a + 1);
      }
    }
  } else {
    if (UNEXPECTED((size_t) len > SIZE_MAX - str->len)) {
      zend_error_noreturn(E_ERROR, "String size overflow");
    }
    len += str->len;
    str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
    str->c = erealloc2(str->c, str->a + 1, str->len);
  }
}

ZEND_API void ZEND_FASTCALL smart_str_append_escaped_truncated(smart_str *str, const zend_string *value, size_t length)
{
  smart_str_append_escaped(str, ZSTR_VAL(value), MIN(length, ZSTR_LEN(value)));

  if (ZSTR_LEN(value) > length) {
    smart_str_appendl(str, "...", sizeof("...")-1);
  }
}

ZEND_API void ZEND_FASTCALL smart_str_append_scalar(smart_str *dest, const zval *value, size_t truncate) {
  ZEND_ASSERT(Z_TYPE_P(value) <= IS_STRING);

  switch (Z_TYPE_P(value)) {
    case IS_UNDEF:
    case IS_NULL:
      smart_str_appendl(dest, "NULL", sizeof("NULL")-1);
    break;

    case IS_TRUE:
      smart_str_appendl(dest, "true", sizeof("true")-1);
    break;

    case IS_FALSE:
      smart_str_appendl(dest, "false", sizeof("false")-1);
    break;

    case IS_DOUBLE:
      smart_str_append_double(dest, Z_DVAL_P(value), (int) EG(precision), true);
    break;

    case IS_LONG:
      smart_str_append_long(dest, Z_LVAL_P(value));
    break;

    case IS_STRING:
      smart_str_appendc(dest, '\'');
      smart_str_append_escaped_truncated(dest, Z_STR_P(value), truncate);
      smart_str_appendc(dest, '\'');
    break;

    default: ZEND_UNREACHABLE();
  }
}

ZEND_API zend_result ZEND_FASTCALL smart_str_append_zval(smart_str *dest, const zval *value, size_t truncate)
{
  if (Z_TYPE_P(value) <= IS_STRING) {
    smart_str_append_scalar(dest, value, truncate);
  } else if (Z_TYPE_P(value) == IS_OBJECT && (Z_OBJCE_P(value)->ce_flags & ZEND_ACC_ENUM)) {
    smart_str_append(dest, Z_OBJCE_P(value)->name);
    smart_str_appends(dest, "::");
    smart_str_append(dest, Z_STR_P(zend_enum_fetch_case_name(Z_OBJ_P(value))));
  } else {
    return FAILURE;
  }
  return SUCCESS;
}

Coverage Report

Created: 2026-06-02 06:40

Line	Count	Source
1		/*
2		+----------------------------------------------------------------------+
3		\| Copyright © The PHP Group and Contributors. \|
4		+----------------------------------------------------------------------+
5		\| This source file is subject to the Modified BSD License that is \|
6		\| bundled with this package in the file LICENSE, and is available \|
7		\| through the World Wide Web at <https://www.php.net/license/>. \|
8		\| \|
9		\| SPDX-License-Identifier: BSD-3-Clause \|
10		+----------------------------------------------------------------------+
11		\| Author: Dmitry Stogov <dmitry@php.net> \|
12		+----------------------------------------------------------------------+
13		*/
14
15		#include <zend.h>
16		#include "zend_smart_str.h"
17		#include "zend_smart_string.h"
18		#include "zend_enum.h"
19
20	10.8M	#define SMART_STR_OVERHEAD (ZEND_MM_OVERHEAD + _ZSTR_HEADER_SIZE + 1)
21	10.3M	#define SMART_STR_START_SIZE 256
22	10.3M	#define SMART_STR_START_LEN (SMART_STR_START_SIZE - SMART_STR_OVERHEAD)
23		#define SMART_STR_PAGE 4096
24
25		#define SMART_STR_NEW_LEN(len) \
26	5.69M	(ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STR_OVERHEAD, SMART_STR_PAGE) - SMART_STR_OVERHEAD)
27
28		ZEND_API void ZEND_FASTCALL smart_str_erealloc(smart_str *str, size_t len)
29	5.69M	{
30	5.69M	if (UNEXPECTED(!str->s)) {
31	5.15M	str->a = len <= SMART_STR_START_LEN
32	5.15M	? SMART_STR_START_LEN
33	5.15M	: SMART_STR_NEW_LEN(len);
34	5.15M	str->s = zend_string_alloc(str->a, 0);
35	5.15M	ZSTR_LEN(str->s) = 0;
36	5.15M	} else {
37	540k	str->a = SMART_STR_NEW_LEN(len);
38	540k	str->s = (zend_string *) erealloc2(str->s, str->a + _ZSTR_HEADER_SIZE + 1, _ZSTR_HEADER_SIZE + ZSTR_LEN(str->s));
39	540k	}
40	5.69M	}
41
42		ZEND_API void ZEND_FASTCALL smart_str_realloc(smart_str *str, size_t len)
43	0	{
44	0	if (UNEXPECTED(!str->s)) {
45	0	str->a = len <= SMART_STR_START_LEN
46	0	? SMART_STR_START_LEN
47	0	: SMART_STR_NEW_LEN(len);
48	0	str->s = zend_string_alloc(str->a, 1);
49	0	ZSTR_LEN(str->s) = 0;
50	0	} else {
51	0	str->a = SMART_STR_NEW_LEN(len);
52	0	str->s = (zend_string *) perealloc(str->s, str->a + _ZSTR_HEADER_SIZE + 1, 1);
53	0	}
54	0	}
55
56		/* Windows uses VK_ESCAPE instead of \e */
57		#ifndef VK_ESCAPE
58	394k	#define VK_ESCAPE '\e'
59		#endif
60
61	20.3k	static size_t zend_compute_escaped_string_len(const char *s, size_t l) {
62	20.3k	size_t i, len = l;
63	418k	for (i = 0; i < l; ++i) {
64	398k	char c = s[i];
65	398k	if (c == '\n' \|\| c == '\r' \|\| c == '\t' \|\|
66	395k	c == '\f' \|\| c == '\v' \|\| c == '\\' \|\| c == VK_ESCAPE) {
67	4.58k	len += 1;
68	393k	} else if (c < 32 \|\| c > 126) {
69	80.3k	len += 3;
70	80.3k	}
71	398k	}
72	20.3k	return len;
73	20.3k	}
74
75	20.3k	ZEND_API void ZEND_FASTCALL smart_str_append_escaped(smart_str str, const char s, size_t l) {
76	20.3k	char *res;
77	20.3k	size_t i, len = zend_compute_escaped_string_len(s, l);
78
79	20.3k	smart_str_alloc(str, len, 0);
80	20.3k	res = &ZSTR_VAL(str->s)[ZSTR_LEN(str->s)];
81	20.3k	ZSTR_LEN(str->s) += len;
82
83	418k	for (i = 0; i < l; ++i) {
84	398k	unsigned char c = s[i];
85	398k	if (c < 32 \|\| c == '\\' \|\| c > 126) {
86	84.8k	*res++ = '\\';
87	84.8k	switch (c) {
88	944	case '\n': *res++ = 'n'; break;
89	595	case '\r': *res++ = 'r'; break;
90	985	case '\t': *res++ = 't'; break;
91	302	case '\f': *res++ = 'f'; break;
92	563	case '\v': *res++ = 'v'; break;
93	531	case '\\': *res++ = '\\'; break;
94	661	case VK_ESCAPE: *res++ = 'e'; break;
95	80.3k	default:
96	80.3k	*res++ = 'x';
97	80.3k	if ((c >> 4) < 10) {
98	55.9k	*res++ = (c >> 4) + '0';
99	55.9k	} else {
100	24.3k	*res++ = (c >> 4) + 'A' - 10;
101	24.3k	}
102	80.3k	if ((c & 0xf) < 10) {
103	52.5k	*res++ = (c & 0xf) + '0';
104	52.5k	} else {
105	27.7k	*res++ = (c & 0xf) + 'A' - 10;
106	27.7k	}
107	84.8k	}
108	313k	} else {
109	313k	*res++ = c;
110	313k	}
111	398k	}
112	20.3k	}
113
114		ZEND_API void ZEND_FASTCALL smart_str_append_double(
115	189k	smart_str *str, double num, int precision, bool zero_fraction) {
116	189k	char buf[ZEND_DOUBLE_MAX_LENGTH];
117		/* Model snprintf precision behavior. */
118	189k	zend_gcvt(num, precision ? precision : 1, '.', 'E', buf);
119	189k	smart_str_appends(str, buf);
120	189k	if (zero_fraction && zend_finite(num) && !strchr(buf, '.')) {
121	141k	smart_str_appendl(str, ".0", 2);
122	141k	}
123	189k	}
124
125	16.3k	ZEND_API void smart_str_append_printf(smart_str dest, const char format, ...) {
126	16.3k	va_list arg;
127	16.3k	va_start(arg, format);
128	16.3k	zend_printf_to_smart_str(dest, format, arg);
129	16.3k	va_end(arg);
130	16.3k	}
131
132	0	ZEND_API void smart_string_append_printf(smart_string dest, const char format, ...) {
133	0	va_list arg;
134	0	va_start(arg, format);
135	0	zend_printf_to_smart_string(dest, format, arg);
136	0	va_end(arg);
137	0	}
138
139	33.6M	#define SMART_STRING_OVERHEAD (ZEND_MM_OVERHEAD + 1)
140	33.6M	#define SMART_STRING_START_SIZE 256
141	33.6M	#define SMART_STRING_START_LEN (SMART_STRING_START_SIZE - SMART_STRING_OVERHEAD)
142		#define SMART_STRING_PAGE 4096
143
144		ZEND_API void ZEND_FASTCALL _smart_string_alloc_persistent(smart_string *str, size_t len)
145	0	{
146	0	if (!str->c) {
147	0	str->len = 0;
148	0	if (len <= SMART_STRING_START_LEN) {
149	0	str->a = SMART_STRING_START_LEN;
150	0	} else {
151	0	str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
152	0	}
153	0	str->c = pemalloc(str->a + 1, 1);
154	0	} else {
155	0	if (UNEXPECTED((size_t) len > SIZE_MAX - str->len)) {
156	0	zend_error_noreturn(E_ERROR, "String size overflow");
157	0	}
158	0	len += str->len;
159	0	str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
160	0	str->c = perealloc(str->c, str->a + 1, 1);
161	0	}
162	0	}
163
164		ZEND_API void ZEND_FASTCALL _smart_string_alloc(smart_string *str, size_t len)
165	16.8M	{
166	16.8M	if (!str->c) {
167	16.8M	str->len = 0;
168	16.8M	if (len <= SMART_STRING_START_LEN) {
169	16.8M	str->a = SMART_STRING_START_LEN;
170	16.8M	str->c = emalloc(SMART_STRING_START_LEN + 1);
171	16.8M	} else {
172	569	str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
173	569	if (EXPECTED(str->a < (ZEND_MM_CHUNK_SIZE - SMART_STRING_OVERHEAD))) {
174	569	str->c = emalloc_large(str->a + 1);
175	569	} else {
176		/* allocate a huge chunk */
177	0	str->c = emalloc(str->a + 1);
178	0	}
179	569	}
180	16.8M	} else {
181	9.40k	if (UNEXPECTED((size_t) len > SIZE_MAX - str->len)) {
182	0	zend_error_noreturn(E_ERROR, "String size overflow");
183	0	}
184	9.40k	len += str->len;
185	9.40k	str->a = ZEND_MM_ALIGNED_SIZE_EX(len + SMART_STRING_OVERHEAD, SMART_STRING_PAGE) - SMART_STRING_OVERHEAD;
186	9.40k	str->c = erealloc2(str->c, str->a + 1, str->len);
187	9.40k	}
188	16.8M	}
189
190		ZEND_API void ZEND_FASTCALL smart_str_append_escaped_truncated(smart_str str, const zend_string value, size_t length)
191	19.8k	{
192	19.8k	smart_str_append_escaped(str, ZSTR_VAL(value), MIN(length, ZSTR_LEN(value)));
193
194	19.8k	if (ZSTR_LEN(value) > length) {
195	2.75k	smart_str_appendl(str, "...", sizeof("...")-1);
196	2.75k	}
197	19.8k	}
198
199	22.2k	ZEND_API void ZEND_FASTCALL smart_str_append_scalar(smart_str dest, const zval value, size_t truncate) {
200	22.2k	ZEND_ASSERT(Z_TYPE_P(value) <= IS_STRING);
201
202	22.2k	switch (Z_TYPE_P(value)) {
203	13	case IS_UNDEF:
204	1.98k	case IS_NULL:
205	1.98k	smart_str_appendl(dest, "NULL", sizeof("NULL")-1);
206	1.98k	break;
207
208	34	case IS_TRUE:
209	34	smart_str_appendl(dest, "true", sizeof("true")-1);
210	34	break;
211
212	25	case IS_FALSE:
213	25	smart_str_appendl(dest, "false", sizeof("false")-1);
214	25	break;
215
216	15	case IS_DOUBLE:
217	15	smart_str_append_double(dest, Z_DVAL_P(value), (int) EG(precision), true);
218	15	break;
219
220	326	case IS_LONG:
221	326	smart_str_append_long(dest, Z_LVAL_P(value));
222	326	break;
223
224	19.8k	case IS_STRING:
225	19.8k	smart_str_appendc(dest, '\'');
226	19.8k	smart_str_append_escaped_truncated(dest, Z_STR_P(value), truncate);
227	19.8k	smart_str_appendc(dest, '\'');
228	19.8k	break;
229
230	0	default: ZEND_UNREACHABLE();
231	22.2k	}
232	22.2k	}
233
234		ZEND_API zend_result ZEND_FASTCALL smart_str_append_zval(smart_str dest, const zval value, size_t truncate)
235	24.1k	{
236	24.1k	if (Z_TYPE_P(value) <= IS_STRING) {
237	22.2k	smart_str_append_scalar(dest, value, truncate);
238	22.2k	} else if (Z_TYPE_P(value) == IS_OBJECT && (Z_OBJCE_P(value)->ce_flags & ZEND_ACC_ENUM)) {
239	9	smart_str_append(dest, Z_OBJCE_P(value)->name);
240	9	smart_str_appends(dest, "::");
241	9	smart_str_append(dest, Z_STR_P(zend_enum_fetch_case_name(Z_OBJ_P(value))));
242	1.92k	} else {
243	1.92k	return FAILURE;
244	1.92k	}
245	22.2k	return SUCCESS;
246	24.1k	}