Coverage Report

Created: 2026-05-30 06:25

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
19.8M
#define MIN_FIRST_ALLOC 32
30
31
#ifdef DEBUGBUILD
32
5.32M
#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
5.32M
{
40
5.32M
  DEBUGASSERT(s);
41
5.32M
  DEBUGASSERT(toobig);
42
5.32M
  DEBUGASSERT(toobig <= MAX_DYNBUF_SIZE); /* catch crazy mistakes */
43
5.32M
  s->bufr = NULL;
44
5.32M
  s->leng = 0;
45
5.32M
  s->allc = 0;
46
5.32M
  s->toobig = toobig;
47
5.32M
#ifdef DEBUGBUILD
48
5.32M
  s->init = DYNINIT;
49
5.32M
#endif
50
5.32M
}
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
4.42M
{
58
4.42M
  DEBUGASSERT(s);
59
4.42M
  DEBUGASSERT(s->init == DYNINIT);
60
4.42M
  curlx_safefree(s->bufr);
61
4.42M
  s->leng = s->allc = 0;
62
4.42M
}
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
927M
{
70
927M
  size_t idx = s->leng;
71
927M
  size_t a = s->allc;
72
927M
  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
927M
  DEBUGASSERT(s->init == DYNINIT);
76
927M
  DEBUGASSERT(s->toobig);
77
927M
  DEBUGASSERT(idx < s->toobig);
78
927M
  DEBUGASSERT(!s->leng || s->bufr);
79
927M
  DEBUGASSERT(a <= s->toobig);
80
927M
  DEBUGASSERT(!len || mem);
81
82
927M
  if(fit > s->toobig) {
83
382
    curlx_dyn_free(s);
84
382
    return CURLE_TOO_LARGE;
85
382
  }
86
927M
  else if(!a) {
87
6.74M
    DEBUGASSERT(!idx);
88
    /* first invoke */
89
6.74M
    if(MIN_FIRST_ALLOC > s->toobig)
90
163k
      a = s->toobig;
91
6.58M
    else if(fit < MIN_FIRST_ALLOC)
92
6.47M
      a = MIN_FIRST_ALLOC;
93
113k
    else
94
113k
      a = fit;
95
6.74M
  }
96
920M
  else {
97
922M
    while(a < fit)
98
1.51M
      a *= 2;
99
920M
    if(a > s->toobig)
100
      /* no point in allocating a larger buffer than this is allowed to use */
101
31.7k
      a = s->toobig;
102
920M
  }
103
104
927M
  if(a != s->allc) {
105
8.23M
    void *p = curlx_realloc(s->bufr, a);
106
8.23M
    if(!p) {
107
0
      curlx_dyn_free(s);
108
0
      return CURLE_OUT_OF_MEMORY;
109
0
    }
110
8.23M
    s->bufr = p;
111
8.23M
    s->allc = a;
112
8.23M
  }
113
114
927M
  if(len)
115
926M
    memcpy(&s->bufr[idx], mem, len);
116
927M
  s->leng = idx + len;
117
927M
  s->bufr[s->leng] = 0;
118
927M
  return CURLE_OK;
119
927M
}
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
2.48M
{
127
2.48M
  DEBUGASSERT(s);
128
2.48M
  DEBUGASSERT(s->init == DYNINIT);
129
2.48M
  DEBUGASSERT(!s->leng || s->bufr);
130
2.48M
  if(s->leng)
131
855k
    s->bufr[0] = 0;
132
2.48M
  s->leng = 0;
133
2.48M
}
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
3.50M
{
141
3.50M
  DEBUGASSERT(s);
142
3.50M
  DEBUGASSERT(s->init == DYNINIT);
143
3.50M
  DEBUGASSERT(!s->leng || s->bufr);
144
3.50M
  if(trail > s->leng)
145
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
146
3.50M
  else if(trail == s->leng)
147
3
    return CURLE_OK;
148
3.50M
  else if(!trail) {
149
4.65k
    curlx_dyn_reset(s);
150
4.65k
  }
151
3.50M
  else {
152
3.50M
    memmove(&s->bufr[0], &s->bufr[s->leng - trail], trail);
153
3.50M
    s->leng = trail;
154
3.50M
    s->bufr[s->leng] = 0;
155
3.50M
  }
156
3.50M
  return CURLE_OK;
157
3.50M
}
158
159
/*
160
 * Appends a buffer with length.
161
 */
162
CURLcode curlx_dyn_addn(struct dynbuf *s, const void *mem, size_t len)
163
926M
{
164
926M
  DEBUGASSERT(s);
165
926M
  DEBUGASSERT(s->init == DYNINIT);
166
926M
  DEBUGASSERT(!s->leng || s->bufr);
167
926M
  return dyn_nappend(s, mem, len);
168
926M
}
169
170
/*
171
 * Append a null-terminated string at the end.
172
 */
173
CURLcode curlx_dyn_add(struct dynbuf *s, const char *str)
174
545k
{
175
545k
  size_t n;
176
545k
  DEBUGASSERT(str);
177
545k
  DEBUGASSERT(s);
178
545k
  DEBUGASSERT(s->init == DYNINIT);
179
545k
  DEBUGASSERT(!s->leng || s->bufr);
180
545k
  n = strlen(str);
181
545k
  return dyn_nappend(s, (const unsigned char *)str, n);
182
545k
}
183
184
/*
185
 * Append a string vprintf()-style
186
 */
187
CURLcode curlx_dyn_vaddf(struct dynbuf *s, const char *fmt, va_list ap)
188
4.93M
{
189
4.93M
#ifdef BUILDING_LIBCURL
190
4.93M
  int rc;
191
4.93M
  DEBUGASSERT(s);
192
4.93M
  DEBUGASSERT(s->init == DYNINIT);
193
4.93M
  DEBUGASSERT(!s->leng || s->bufr);
194
4.93M
  DEBUGASSERT(fmt);
195
4.93M
  rc = curlx_dyn_vprintf(s, fmt, ap);
196
197
4.93M
  if(!rc)
198
4.93M
    return CURLE_OK;
199
202
  else if(rc == MERR_TOO_LARGE)
200
202
    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
4.93M
}
216
217
/*
218
 * Append a string printf()-style
219
 */
220
CURLcode curlx_dyn_addf(struct dynbuf *s, const char *fmt, ...)
221
4.91M
{
222
4.91M
  CURLcode result;
223
4.91M
  va_list ap;
224
4.91M
  DEBUGASSERT(s);
225
4.91M
  DEBUGASSERT(s->init == DYNINIT);
226
4.91M
  DEBUGASSERT(!s->leng || s->bufr);
227
4.91M
  DEBUGASSERT(strcmp(fmt, "%s")); /* use curlx_dyn_add instead */
228
4.91M
  va_start(ap, fmt);
229
4.91M
  result = curlx_dyn_vaddf(s, fmt, ap);
230
4.91M
  va_end(ap);
231
4.91M
  return result;
232
4.91M
}
233
234
/*
235
 * Returns a pointer to the buffer.
236
 */
237
char *curlx_dyn_ptr(const struct dynbuf *s)
238
12.4M
{
239
12.4M
  DEBUGASSERT(s);
240
12.4M
  DEBUGASSERT(s->init == DYNINIT);
241
12.4M
  DEBUGASSERT(!s->leng || s->bufr);
242
12.4M
  return s->bufr;
243
12.4M
}
244
245
char *curlx_dyn_take(struct dynbuf *s, size_t *plen)
246
34.2k
{
247
34.2k
  char *ptr = s->bufr;
248
34.2k
  DEBUGASSERT(s);
249
34.2k
  DEBUGASSERT(s->init == DYNINIT);
250
34.2k
  *plen = s->leng;
251
34.2k
  s->bufr = NULL;
252
34.2k
  s->leng = 0;
253
34.2k
  s->allc = 0;
254
34.2k
  return ptr;
255
34.2k
}
256
257
/*
258
 * Returns an unsigned pointer to the buffer.
259
 */
260
unsigned char *curlx_dyn_uptr(const struct dynbuf *s)
261
21.7k
{
262
21.7k
  DEBUGASSERT(s);
263
21.7k
  DEBUGASSERT(s->init == DYNINIT);
264
21.7k
  DEBUGASSERT(!s->leng || s->bufr);
265
21.7k
  return (unsigned char *)s->bufr;
266
21.7k
}
267
268
/*
269
 * Returns the length of the buffer.
270
 */
271
size_t curlx_dyn_len(const struct dynbuf *s)
272
25.4M
{
273
25.4M
  DEBUGASSERT(s);
274
25.4M
  DEBUGASSERT(s->init == DYNINIT);
275
25.4M
  DEBUGASSERT(!s->leng || s->bufr);
276
25.4M
  return s->leng;
277
25.4M
}
278
279
/*
280
 * Set a new (smaller) length.
281
 */
282
CURLcode curlx_dyn_setlen(struct dynbuf *s, size_t set)
283
195k
{
284
195k
  DEBUGASSERT(s);
285
195k
  DEBUGASSERT(s->init == DYNINIT);
286
195k
  DEBUGASSERT(!s->leng || s->bufr);
287
195k
  if(set > s->leng)
288
0
    return CURLE_BAD_FUNCTION_ARGUMENT;
289
195k
  s->leng = set;
290
195k
  s->bufr[s->leng] = 0;
291
195k
  return CURLE_OK;
292
195k
}