Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * stringinfo.c
4 : : *
5 : : * StringInfo provides an extensible string data type (currently limited to a
6 : : * length of 1GB). It can be used to buffer either ordinary C strings
7 : : * (null-terminated text) or arbitrary binary data. All storage is allocated
8 : : * with palloc() (falling back to malloc in frontend code).
9 : : *
10 : : * Portions Copyright (c) 1996-2026, PostgreSQL Global Development Group
11 : : * Portions Copyright (c) 1994, Regents of the University of California
12 : : *
13 : : * src/common/stringinfo.c
14 : : *
15 : : *-------------------------------------------------------------------------
16 : : */
17 : :
18 : : #ifndef FRONTEND
19 : :
20 : : #include "postgres.h"
21 : : #include "utils/memutils.h"
22 : :
23 : : #else
24 : :
25 : : #include "postgres_fe.h"
26 : :
27 : : #endif
28 : :
29 : : #include "lib/stringinfo.h"
30 : :
31 : :
32 : : /*
33 : : * initStringInfoInternal
34 : : *
35 : : * Initialize a StringInfoData struct (with previously undefined contents)
36 : : * to describe an empty string.
37 : : * The initial memory allocation size is specified by 'initsize'.
38 : : * The valid range for 'initsize' is 1 to MaxAllocSize.
39 : : */
40 : : static inline void
41 : 674784 : initStringInfoInternal(StringInfo str, int initsize)
42 : : {
43 [ + - ]: 674784 : Assert(initsize >= 1 && initsize <= MaxAllocSize);
[ - + + - ]
44 : :
45 : 674784 : str->data = (char *) palloc(initsize);
46 : 674784 : str->maxlen = initsize;
47 : 674784 : resetStringInfo(str);
48 : 674784 : }
49 : :
50 : : /*
51 : : * makeStringInfoInternal(int initsize)
52 : : *
53 : : * Create an empty 'StringInfoData' & return a pointer to it.
54 : : * The initial memory allocation size is specified by 'initsize'.
55 : : * The valid range for 'initsize' is 1 to MaxAllocSize.
56 : : */
57 : : static inline StringInfo
58 : 11913 : makeStringInfoInternal(int initsize)
59 : : {
60 : 11913 : StringInfo res = palloc_object(StringInfoData);
61 : :
62 : 11913 : initStringInfoInternal(res, initsize);
63 : 23826 : return res;
64 : 11913 : }
65 : :
66 : : /*
67 : : * makeStringInfo
68 : : *
69 : : * Create an empty 'StringInfoData' & return a pointer to it.
70 : : */
71 : : StringInfo
72 : 11913 : makeStringInfo(void)
73 : : {
74 : 11913 : return makeStringInfoInternal(STRINGINFO_DEFAULT_SIZE);
75 : : }
76 : :
77 : : /*
78 : : * makeStringInfoExt(int initsize)
79 : : *
80 : : * Create an empty 'StringInfoData' & return a pointer to it.
81 : : * The initial memory allocation size is specified by 'initsize'.
82 : : * The valid range for 'initsize' is 1 to MaxAllocSize.
83 : : */
84 : : StringInfo
85 : 0 : makeStringInfoExt(int initsize)
86 : : {
87 : 0 : return makeStringInfoInternal(initsize);
88 : : }
89 : :
90 : : /*
91 : : * initStringInfo
92 : : *
93 : : * Initialize a StringInfoData struct (with previously undefined contents)
94 : : * to describe an empty string.
95 : : */
96 : : void
97 : 662871 : initStringInfo(StringInfo str)
98 : : {
99 : 662871 : initStringInfoInternal(str, STRINGINFO_DEFAULT_SIZE);
100 : 662871 : }
101 : :
102 : : /*
103 : : * initStringInfoExt
104 : : *
105 : : * Initialize a StringInfoData struct (with previously undefined contents)
106 : : * to describe an empty string.
107 : : * The initial memory allocation size is specified by 'initsize'.
108 : : * The valid range for 'initsize' is 1 to MaxAllocSize.
109 : : */
110 : : void
111 : 0 : initStringInfoExt(StringInfo str, int initsize)
112 : : {
113 : 0 : initStringInfoInternal(str, initsize);
114 : 0 : }
115 : :
116 : : /*
117 : : * resetStringInfo
118 : : *
119 : : * Reset the StringInfo: the data buffer remains valid, but its
120 : : * previous content, if any, is cleared.
121 : : *
122 : : * Read-only StringInfos as initialized by initReadOnlyStringInfo cannot be
123 : : * reset.
124 : : */
125 : : void
126 : 1225008 : resetStringInfo(StringInfo str)
127 : : {
128 : : /* don't allow resets of read-only StringInfos */
129 [ + - ]: 1225008 : Assert(str->maxlen != 0);
130 : :
131 : 1225008 : str->data[0] = '\0';
132 : 1225008 : str->len = 0;
133 : 1225008 : str->cursor = 0;
134 : 1225008 : }
135 : :
136 : : /*
137 : : * appendStringInfo
138 : : *
139 : : * Format text data under the control of fmt (an sprintf-style format string)
140 : : * and append it to whatever is already in str. More space is allocated
141 : : * to str if necessary. This is sort of like a combination of sprintf and
142 : : * strcat.
143 : : */
144 : : void
145 : 973624 : appendStringInfo(StringInfo str, const char *fmt,...)
146 : : {
147 : 973624 : int save_errno = errno;
148 : :
149 : 975342 : for (;;)
150 : : {
151 : 975342 : va_list args;
152 : 975342 : int needed;
153 : :
154 : : /* Try to format the data. */
155 : 975342 : errno = save_errno;
156 : 975342 : va_start(args, fmt);
157 : 975342 : needed = appendStringInfoVA(str, fmt, args);
158 : 975342 : va_end(args);
159 : :
160 [ + + ]: 975342 : if (needed == 0)
161 : 973624 : break; /* success */
162 : :
163 : : /* Increase the buffer size and try again. */
164 : 1718 : enlargeStringInfo(str, needed);
165 [ - + + ]: 975342 : }
166 : 973624 : }
167 : :
168 : : /*
169 : : * appendStringInfoVA
170 : : *
171 : : * Attempt to format text data under the control of fmt (an sprintf-style
172 : : * format string) and append it to whatever is already in str. If successful
173 : : * return zero; if not (because there's not enough space), return an estimate
174 : : * of the space needed, without modifying str. Typically the caller should
175 : : * pass the return value to enlargeStringInfo() before trying again; see
176 : : * appendStringInfo for standard usage pattern.
177 : : *
178 : : * Caution: callers must be sure to preserve their entry-time errno
179 : : * when looping, in case the fmt contains "%m".
180 : : *
181 : : * XXX This API is ugly, but there seems no alternative given the C spec's
182 : : * restrictions on what can portably be done with va_list arguments: you have
183 : : * to redo va_start before you can rescan the argument list, and we can't do
184 : : * that from here.
185 : : */
186 : : int
187 : 1056019 : appendStringInfoVA(StringInfo str, const char *fmt, va_list args)
188 : : {
189 : 1056019 : int avail;
190 : 1056019 : size_t nprinted;
191 : :
192 [ + - ]: 1056019 : Assert(str != NULL);
193 : :
194 : : /*
195 : : * If there's hardly any space, don't bother trying, just fail to make the
196 : : * caller enlarge the buffer first. We have to guess at how much to
197 : : * enlarge, since we're skipping the formatting work.
198 : : */
199 : 1056019 : avail = str->maxlen - str->len;
200 [ + + ]: 1056019 : if (avail < 16)
201 : 1577 : return 32;
202 : :
203 : 1054442 : nprinted = pvsnprintf(str->data + str->len, (size_t) avail, fmt, args);
204 : :
205 [ + + ]: 1054442 : if (nprinted < (size_t) avail)
206 : : {
207 : : /* Success. Note nprinted does not include trailing null. */
208 : 1054202 : str->len += (int) nprinted;
209 : 1054202 : return 0;
210 : : }
211 : :
212 : : /* Restore the trailing null so that str is unmodified. */
213 : 240 : str->data[str->len] = '\0';
214 : :
215 : : /*
216 : : * Return pvsnprintf's estimate of the space needed. (Although this is
217 : : * given as a size_t, we know it will fit in int because it's not more
218 : : * than MaxAllocSize.)
219 : : */
220 : 240 : return (int) nprinted;
221 : 1056019 : }
222 : :
223 : : /*
224 : : * appendStringInfoString
225 : : *
226 : : * Append a null-terminated string to str.
227 : : * Like appendStringInfo(str, "%s", s) but faster.
228 : : */
229 : : void
230 : 867982 : appendStringInfoString(StringInfo str, const char *s)
231 : : {
232 : 867982 : appendBinaryStringInfo(str, s, strlen(s));
233 : 867982 : }
234 : :
235 : : /*
236 : : * appendStringInfoChar
237 : : *
238 : : * Append a single byte to str.
239 : : * Like appendStringInfo(str, "%c", ch) but much faster.
240 : : */
241 : : void
242 : 1854671 : appendStringInfoChar(StringInfo str, char ch)
243 : : {
244 : : /* Make more room if needed */
245 [ + + ]: 1854671 : if (str->len + 1 >= str->maxlen)
246 : 1393 : enlargeStringInfo(str, 1);
247 : :
248 : : /* OK, append the character */
249 : 1854671 : str->data[str->len] = ch;
250 : 1854671 : str->len++;
251 : 1854671 : str->data[str->len] = '\0';
252 : 1854671 : }
253 : :
254 : : /*
255 : : * appendStringInfoSpaces
256 : : *
257 : : * Append the specified number of spaces to a buffer.
258 : : */
259 : : void
260 : 33072 : appendStringInfoSpaces(StringInfo str, int count)
261 : : {
262 [ + + ]: 33072 : if (count > 0)
263 : : {
264 : : /* Make more room if needed */
265 : 31867 : enlargeStringInfo(str, count);
266 : :
267 : : /* OK, append the spaces */
268 : 31867 : memset(&str->data[str->len], ' ', count);
269 : 31867 : str->len += count;
270 : 31867 : str->data[str->len] = '\0';
271 : 31867 : }
272 : 33072 : }
273 : :
274 : : /*
275 : : * appendBinaryStringInfo
276 : : *
277 : : * Append arbitrary binary data to a StringInfo, allocating more space
278 : : * if necessary. Ensures that a trailing null byte is present.
279 : : */
280 : : void
281 : 1140369 : appendBinaryStringInfo(StringInfo str, const void *data, int datalen)
282 : : {
283 [ + - ]: 1140369 : Assert(str != NULL);
284 : :
285 : : /* Make more room if needed */
286 : 1140369 : enlargeStringInfo(str, datalen);
287 : :
288 : : /* OK, append the data */
289 : 1140369 : memcpy(str->data + str->len, data, datalen);
290 : 1140369 : str->len += datalen;
291 : :
292 : : /*
293 : : * Keep a trailing null in place, even though it's probably useless for
294 : : * binary data. (Some callers are dealing with text but call this because
295 : : * their input isn't null-terminated.)
296 : : */
297 : 1140369 : str->data[str->len] = '\0';
298 : 1140369 : }
299 : :
300 : : /*
301 : : * appendBinaryStringInfoNT
302 : : *
303 : : * Append arbitrary binary data to a StringInfo, allocating more space
304 : : * if necessary. Does not ensure a trailing null-byte exists.
305 : : */
306 : : void
307 : 279064 : appendBinaryStringInfoNT(StringInfo str, const void *data, int datalen)
308 : : {
309 [ + - ]: 279064 : Assert(str != NULL);
310 : :
311 : : /* Make more room if needed */
312 : 279064 : enlargeStringInfo(str, datalen);
313 : :
314 : : /* OK, append the data */
315 : 279064 : memcpy(str->data + str->len, data, datalen);
316 : 279064 : str->len += datalen;
317 : 279064 : }
318 : :
319 : : /*
320 : : * enlargeStringInfo
321 : : *
322 : : * Make sure there is enough space for 'needed' more bytes
323 : : * ('needed' does not include the terminating null).
324 : : *
325 : : * External callers usually need not concern themselves with this, since
326 : : * all stringinfo.c routines do it automatically. However, if a caller
327 : : * knows that a StringInfo will eventually become X bytes large, it
328 : : * can save some palloc overhead by enlarging the buffer before starting
329 : : * to store data in it.
330 : : *
331 : : * NB: In the backend, because we use repalloc() to enlarge the buffer, the
332 : : * string buffer will remain allocated in the same memory context that was
333 : : * current when initStringInfo was called, even if another context is now
334 : : * current. This is the desired and indeed critical behavior!
335 : : */
336 : : void
337 : 2228484 : enlargeStringInfo(StringInfo str, int needed)
338 : : {
339 : 2228484 : int newlen;
340 : :
341 : : /* validate this is not a read-only StringInfo */
342 [ + - ]: 2228484 : Assert(str->maxlen != 0);
343 : :
344 : : /*
345 : : * Guard against out-of-range "needed" values. Without this, we can get
346 : : * an overflow or infinite loop in the following.
347 : : */
348 [ + - ]: 2228484 : if (needed < 0) /* should not happen */
349 : : {
350 : : #ifndef FRONTEND
351 [ # # # # ]: 0 : elog(ERROR, "invalid string enlargement request size: %d", needed);
352 : : #else
353 : 0 : fprintf(stderr, "invalid string enlargement request size: %d\n", needed);
354 : 0 : exit(EXIT_FAILURE);
355 : : #endif
356 : 0 : }
357 [ + - ]: 2228484 : if (((Size) needed) >= (MaxAllocSize - (Size) str->len))
358 : : {
359 : : #ifndef FRONTEND
360 [ # # # # ]: 0 : ereport(ERROR,
361 : : (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
362 : : errmsg("string buffer exceeds maximum allowed length (%zu bytes)", MaxAllocSize),
363 : : errdetail("Cannot enlarge string buffer containing %d bytes by %d more bytes.",
364 : : str->len, needed)));
365 : : #else
366 : 0 : fprintf(stderr,
367 : 0 : _("string buffer exceeds maximum allowed length (%zu bytes)\n\nCannot enlarge string buffer containing %d bytes by %d more bytes.\n"),
368 : 0 : MaxAllocSize, str->len, needed);
369 : 0 : exit(EXIT_FAILURE);
370 : : #endif
371 : 0 : }
372 : :
373 : 2228484 : needed += str->len + 1; /* total space required now */
374 : :
375 : : /* Because of the above test, we now have needed <= MaxAllocSize */
376 : :
377 [ + + ]: 2228484 : if (needed <= str->maxlen)
378 : 2210088 : return; /* got enough space already */
379 : :
380 : : /*
381 : : * We don't want to allocate just a little more space with each append;
382 : : * for efficiency, double the buffer size each time it overflows.
383 : : * Actually, we might need to more than double it if 'needed' is big...
384 : : */
385 : 18396 : newlen = 2 * str->maxlen;
386 [ + + ]: 69400 : while (needed > newlen)
387 : 51004 : newlen = 2 * newlen;
388 : :
389 : : /*
390 : : * Clamp to MaxAllocSize in case we went past it. Note we are assuming
391 : : * here that MaxAllocSize <= INT_MAX/2, else the above loop could
392 : : * overflow. We will still have newlen >= needed.
393 : : */
394 [ + - ]: 18396 : if (newlen > (int) MaxAllocSize)
395 : 0 : newlen = (int) MaxAllocSize;
396 : :
397 : 18396 : str->data = (char *) repalloc(str->data, newlen);
398 : :
399 : 18396 : str->maxlen = newlen;
400 [ - + ]: 2228484 : }
401 : :
402 : : /*
403 : : * destroyStringInfo
404 : : *
405 : : * Frees a StringInfo and its buffer (opposite of makeStringInfo()).
406 : : * This must only be called on palloc'd StringInfos.
407 : : */
408 : : void
409 : 1070 : destroyStringInfo(StringInfo str)
410 : : {
411 : : /* don't allow destroys of read-only StringInfos */
412 [ + - ]: 1070 : Assert(str->maxlen != 0);
413 : :
414 : 1070 : pfree(str->data);
415 : 1070 : pfree(str);
416 : 1070 : }
|
