xref: /curl/lib/dynbuf.h (revision fa0ccd9f)
1 #ifndef HEADER_CURL_DYNBUF_H
2 #define HEADER_CURL_DYNBUF_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 
27 #include <curl/curl.h>
28 
29 #ifndef BUILDING_LIBCURL
30 /* this renames the functions so that the tool code can use the same code
31    without getting symbol collisions */
32 #define Curl_dyn_init(a,b) curlx_dyn_init(a,b)
33 #define Curl_dyn_add(a,b) curlx_dyn_add(a,b)
34 #define Curl_dyn_addn(a,b,c) curlx_dyn_addn(a,b,c)
35 #define Curl_dyn_addf curlx_dyn_addf
36 #define Curl_dyn_vaddf curlx_dyn_vaddf
37 #define Curl_dyn_free(a) curlx_dyn_free(a)
38 #define Curl_dyn_ptr(a) curlx_dyn_ptr(a)
39 #define Curl_dyn_uptr(a) curlx_dyn_uptr(a)
40 #define Curl_dyn_len(a) curlx_dyn_len(a)
41 #define Curl_dyn_reset(a) curlx_dyn_reset(a)
42 #define Curl_dyn_take(a,b) curlx_dyn_take(a,b)
43 #define Curl_dyn_tail(a,b) curlx_dyn_tail(a,b)
44 #define Curl_dyn_setlen(a,b) curlx_dyn_setlen(a,b)
45 #define curlx_dynbuf dynbuf /* for the struct name */
46 #endif
47 
48 struct dynbuf {
49   char *bufr;    /* point to a null-terminated allocated buffer */
50   size_t leng;   /* number of bytes *EXCLUDING* the null-terminator */
51   size_t allc;   /* size of the current allocation */
52   size_t toobig; /* size limit for the buffer */
53 #ifdef DEBUGBUILD
54   int init;     /* detect API usage mistakes */
55 #endif
56 };
57 
58 void Curl_dyn_init(struct dynbuf *s, size_t toobig);
59 void Curl_dyn_free(struct dynbuf *s);
60 CURLcode Curl_dyn_addn(struct dynbuf *s, const void *mem, size_t len)
61   WARN_UNUSED_RESULT;
62 CURLcode Curl_dyn_add(struct dynbuf *s, const char *str)
63   WARN_UNUSED_RESULT;
64 CURLcode Curl_dyn_addf(struct dynbuf *s, const char *fmt, ...)
65   WARN_UNUSED_RESULT CURL_PRINTF(2, 3);
66 CURLcode Curl_dyn_vaddf(struct dynbuf *s, const char *fmt, va_list ap)
67   WARN_UNUSED_RESULT CURL_PRINTF(2, 0);
68 void Curl_dyn_reset(struct dynbuf *s);
69 CURLcode Curl_dyn_tail(struct dynbuf *s, size_t trail);
70 CURLcode Curl_dyn_setlen(struct dynbuf *s, size_t set);
71 char *Curl_dyn_ptr(const struct dynbuf *s);
72 unsigned char *Curl_dyn_uptr(const struct dynbuf *s);
73 size_t Curl_dyn_len(const struct dynbuf *s);
74 
75 /* returns 0 on success, -1 on error */
76 /* The implementation of this function exists in mprintf.c */
77 int Curl_dyn_vprintf(struct dynbuf *dyn, const char *format, va_list ap_save);
78 
79 /* Take the buffer out of the dynbuf. Caller has ownership and
80  * dynbuf resets to initial state. */
81 char *Curl_dyn_take(struct dynbuf *s, size_t *plen);
82 
83 /* Dynamic buffer max sizes */
84 #define DYN_DOH_RESPONSE    3000
85 #define DYN_DOH_CNAME       256
86 #define DYN_PAUSE_BUFFER    (64 * 1024 * 1024)
87 #define DYN_HAXPROXY        2048
88 #define DYN_HTTP_REQUEST    (1024*1024)
89 #define DYN_APRINTF         8000000
90 #define DYN_RTSP_REQ_HEADER (64*1024)
91 #define DYN_TRAILERS        (64*1024)
92 #define DYN_PROXY_CONNECT_HEADERS 16384
93 #define DYN_QLOG_NAME       1024
94 #define DYN_H1_TRAILER      4096
95 #define DYN_PINGPPONG_CMD   (64*1024)
96 #define DYN_IMAP_CMD        (64*1024)
97 #define DYN_MQTT_RECV       (64*1024)
98 #endif
99