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

Source
/*
   +----------------------------------------------------------------------+
   | Copyright (c) The PHP Group                                          |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | https://www.php.net/license/3_01.txt                                 |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | 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;

    EMPTY_SWITCH_DEFAULT_CASE();
  }
}

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: 2025-12-14 06:09

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