Coverage Report

Created: 2026-09-14 07:06

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/curl/lib/curlx/dynbuf.c
Line
Count
Source
1
/***************************************************************************
2
 *                                  _   _ ____  _
3
 *  Project                     ___| | | |  _ \| |
4
 *                             / __| | | | |_) | |
5
 *                            | (__| |_| |  _ <| |___
6
 *                             \___|\___/|_| \_\_____|
7
 *
8
 * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
9
 *
10
 * This software is licensed as described in the file COPYING, which
11
 * you should have received as part of this distribution. The terms
12
 * are also available at https://curl.se/docs/copyright.html.
13
 *
14
 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15
 * copies of the Software, and permit persons to whom the Software is
16
 * furnished to do so, under the terms of the COPYING file.
17
 *
18
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
 * KIND, either express or implied.
20
 *
21
 * SPDX-License-Identifier: curl
22
 *
23
 ***************************************************************************/
24
#include "curl_setup.h"
25
26
#include "curlx/dynbuf.h"
27
#include "curl_printf.h"
28
29
5.74k
#define MIN_FIRST_ALLOC 32
30
31
#ifdef DEBUGBUILD
32
3.75k
#define DYNINIT 0xbee51da /* random pattern */
33
#endif
34
35
/*
36
 * Init a dynbuf struct.
37
 */
38
void curlx_dyn_init(struct dynbuf *s, size_t toobig)
39
3.75k
{
40
3.75k
  DEBUGASSERT(s);
41
3.75k
  DEBUGASSERT(toobig);
42
3.75k
  DEBUGASSERT(toobig <= MAX_DYNBUF_SIZE); /* catch crazy mistakes */
43
3.75k
  s->bufr = NULL;
44
3.75k
  s->leng = 0;
45
3.75k
  s->allc = 0;
46
3.75k
  s->toobig = toobig;
47
3.75k
#ifdef DEBUGBUILD
48
3.75k
  s->init = DYNINIT;
49
3.75k
#endif
50
3.75k
}
51
52
/*
53
 * free the buffer and re-init the necessary fields. It does not touch the
54
 * 'init' field and thus this buffer can be reused to add data to again.
55
 */
56
void curlx_dyn_free(struct dynbuf *s)
57
3.79k
{
58
3.79k
  DEBUGASSERT(s);
59
3.79k
  DEBUGASSERT(s->init == DYNINIT);
60
3.79k
  curlx_safefree(s->bufr);
61
3.79k
  s->leng = s->allc = 0;
62
3.79k
}
63
64
/*
65
 * Store/append an chunk of memory to the dynbuf.
66
 */
67
static CURLcode dyn_nappend(struct dynbuf *s,
68
                            const unsigned char *mem, size_t len)
69
301k
{
70
301k
  size_t idx = s->leng;
71
301k
  size_t a = s->allc;
72
301k
  size_t fit = len + idx + 1; /* new string + old string + zero byte */
73
74
  /* try to detect if there is rubbish in the struct */
75
301k
  DEBUGASSERT(s->init == DYNINIT);
76
301k
  DEBUGASSERT(s->toobig);
77
301k
  DEBUGASSERT(idx < s->toobig);
78
301k
  DEBUGASSERT(!s->leng || s->bufr);
79
301k
  DEBUGASSERT(a <= s->toobig);
80
301k
  DEBUGASSERT(!len || mem);
81
82
301k
  if(fit > s->toobig) {
83
26
    curlx_dyn_free(s);
84
26
    return CURLE_TOO_LARGE;
85
26
  }
86
301k
  else if(!a) {
87
1.94k
    DEBUGASSERT(!idx);
88
    /* first invoke */
89
1.94k
    if(MIN_FIRST_ALLOC > s->toobig)
90
0
      a = s->toobig;
91
1.94k
    else if(fit < MIN_FIRST_ALLOC)
92
1.85k
      a = MIN_FIRST_ALLOC;
93
84
    else
94
84
      a = fit;
95
1.94k
  }
96
299k
  else {
97
303k
    while(a < fit)
98
3.64k
      a *= 2;
99
299k
    if(a > s->toobig)
100
      /* no point in allocating a larger buffer than this is allowed to use */
101
17
      a = s->toobig;
102
299k
  }
103
104
301k
  if(a != s->allc) {
105
4.23k
    void *p = curlx_realloc(s->bufr, a);
106
4.23k
    if(!p) {
107
0
      curlx_dyn_free(s);
108
0
      return CURLE_OUT_OF_MEMORY;
109
0
    }
110
4.23k
    s->bufr = p;
111
4.23k
    s->allc = a;
112
4.23k
  }
113
114
301k
  if(len)
115
292k
    memcpy(&s->bufr[idx], mem, len);
116
301k
  s->leng = idx + len;
117
301k
  s->bufr[s->leng] = 0;
118
301k
  return CURLE_OK;
119
301k
}
120
121
/*
122
 * Clears the string, keeps the allocation. This can also be called on a
123
 * buffer that already was freed.
124
 */
125
void curlx_dyn_reset(struct dynbuf *s)
126
153k
{
127
153k
  DEBUGASSERT(s);
128
153k
  DEBUGASSERT(s->init == DYNINIT);
129
153k
  DEBUGASSERT(!s->leng || s->bufr);
130
153k
  if(s->leng)
131
93.6k
    s->bufr[0] = 0;
132
153k
  s->leng = 0;
133
153k
}
134
135
/*
136
 * Specify the size of the tail to keep (number of bytes from the end of the
137
 * buffer). The rest is dropped.
138
 */
139
CURLcode curlx_dyn_tail(struct dynbuf *s, size_t trail)
140
0
{
141
0
  DEBUGASSERT(s);
142
0
  DEBUGASSERT(s->init == DYNINIT);
143
0
  DEBUGASSERT(!s->leng || s->bufr);
144
0
  if(trail > s->leng)
145
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
146
0
  else if(trail == s->leng)
147
0
    return CURLE_OK;
148
0
  else if(!trail) {
149
0
    curlx_dyn_reset(s);
150
0
  }
151
0
  else {
152
0
    memmove(&s->bufr[0], &s->bufr[s->leng - trail], trail);
153
0
    s->leng = trail;
154
0
    s->bufr[s->leng] = 0;
155
0
  }
156
0
  return CURLE_OK;
157
0
}
158
159
/*
160
 * Appends a buffer with length.
161
 */
162
CURLcode curlx_dyn_addn(struct dynbuf *s, const void *mem, size_t len)
163
222k
{
164
222k
  DEBUGASSERT(s);
165
222k
  DEBUGASSERT(s->init == DYNINIT);
166
222k
  DEBUGASSERT(!s->leng || s->bufr);
167
222k
  return dyn_nappend(s, mem, len);
168
222k
}
169
170
/*
171
 * Append a null-terminated string at the end.
172
 */
173
CURLcode curlx_dyn_add(struct dynbuf *s, const char *str)
174
79.6k
{
175
79.6k
  size_t n;
176
79.6k
  DEBUGASSERT(str);
177
79.6k
  DEBUGASSERT(s);
178
79.6k
  DEBUGASSERT(s->init == DYNINIT);
179
79.6k
  DEBUGASSERT(!s->leng || s->bufr);
180
79.6k
  n = strlen(str);
181
79.6k
  return dyn_nappend(s, (const unsigned char *)str, n);
182
79.6k
}
183
184
/*
185
 * Append a string vprintf()-style
186
 */
187
CURLcode curlx_dyn_vaddf(struct dynbuf *s, const char *fmt, va_list ap)
188
0
{
189
0
#ifdef BUILDING_LIBCURL
190
0
  int rc;
191
0
  DEBUGASSERT(s);
192
0
  DEBUGASSERT(s->init == DYNINIT);
193
0
  DEBUGASSERT(!s->leng || s->bufr);
194
0
  DEBUGASSERT(fmt);
195
0
  rc = curlx_dyn_vprintf(s, fmt, ap);
196
197
0
  if(!rc)
198
0
    return CURLE_OK;
199
0
  else if(rc == MERR_TOO_LARGE)
200
0
    return CURLE_TOO_LARGE;
201
0
  return CURLE_OUT_OF_MEMORY;
202
#else
203
  char *str;
204
  str = curl_mvaprintf(fmt, ap); /* this allocs a new string to append */
205
206
  if(str) {
207
    CURLcode result = dyn_nappend(s, (const unsigned char *)str, strlen(str));
208
    curl_free(str);
209
    return result;
210
  }
211
  /* If we failed, we cleanup the whole buffer and return error */
212
  curlx_dyn_free(s);
213
  return CURLE_OUT_OF_MEMORY;
214
#endif
215
0
}
216
217
/*
218
 * Append a string printf()-style
219
 */
220
CURLcode curlx_dyn_addf(struct dynbuf *s, const char *fmt, ...)
221
0
{
222
0
  CURLcode result;
223
0
  va_list ap;
224
0
  DEBUGASSERT(s);
225
0
  DEBUGASSERT(s->init == DYNINIT);
226
0
  DEBUGASSERT(!s->leng || s->bufr);
227
0
  DEBUGASSERT(strcmp(fmt, "%s")); /* use curlx_dyn_add instead */
228
0
  va_start(ap, fmt);
229
0
  result = curlx_dyn_vaddf(s, fmt, ap);
230
0
  va_end(ap);
231
0
  return result;
232
0
}
233
234
/*
235
 * Returns a pointer to the buffer.
236
 */
237
char *curlx_dyn_ptr(const struct dynbuf *s)
238
192k
{
239
192k
  DEBUGASSERT(s);
240
192k
  DEBUGASSERT(s->init == DYNINIT);
241
192k
  DEBUGASSERT(!s->leng || s->bufr);
242
192k
  return s->bufr;
243
192k
}
244
245
char *curlx_dyn_take(struct dynbuf *s, size_t *plen)
246
0
{
247
0
  char *ptr = s->bufr;
248
0
  DEBUGASSERT(s);
249
0
  DEBUGASSERT(s->init == DYNINIT);
250
0
  *plen = s->leng;
251
0
  s->bufr = NULL;
252
0
  s->leng = 0;
253
0
  s->allc = 0;
254
0
  return ptr;
255
0
}
256
257
/*
258
 * Returns an unsigned pointer to the buffer.
259
 */
260
unsigned char *curlx_dyn_uptr(const struct dynbuf *s)
261
0
{
262
0
  DEBUGASSERT(s);
263
0
  DEBUGASSERT(s->init == DYNINIT);
264
0
  DEBUGASSERT(!s->leng || s->bufr);
265
0
  return (unsigned char *)s->bufr;
266
0
}
267
268
/*
269
 * Returns the length of the buffer.
270
 */
271
size_t curlx_dyn_len(const struct dynbuf *s)
272
96.3k
{
273
96.3k
  DEBUGASSERT(s);
274
96.3k
  DEBUGASSERT(s->init == DYNINIT);
275
96.3k
  DEBUGASSERT(!s->leng || s->bufr);
276
96.3k
  return s->leng;
277
96.3k
}
278
279
/*
280
 * Set a new (smaller) length.
281
 */
282
CURLcode curlx_dyn_setlen(struct dynbuf *s, size_t set)
283
0
{
284
0
  DEBUGASSERT(s);
285
0
  DEBUGASSERT(s->init == DYNINIT);
286
0
  DEBUGASSERT(!s->leng || s->bufr);
287
0
  if(set > s->leng)
288
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
289
0
  s->leng = set;
290
0
  s->bufr[s->leng] = 0;
291
0
  return CURLE_OK;
292
0
}