Change license for some files in common to LGPLv3+/GPLv2+.
[gnupg.git] / common / membuf.c
1 /* membuf.c - A simple implementation of a dynamic buffer.
2  * Copyright (C) 2001, 2003, 2009, 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * This file is free software; you can redistribute it and/or modify
7  * it under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * This file is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, see <http://www.gnu.org/licenses/>.
28  */
29
30 #include <config.h>
31 #include <stdlib.h>
32 #include <errno.h>
33
34 #include "membuf.h"
35
36 #include "util.h"
37
38
39 /* A simple implementation of a dynamic buffer.  Use init_membuf() to
40    create a buffer, put_membuf to append bytes and get_membuf to
41    release and return the buffer.  Allocation errors are detected but
42    only returned at the final get_membuf(), this helps not to clutter
43    the code with out of core checks.  */
44
45 void
46 init_membuf (membuf_t *mb, int initiallen)
47 {
48   mb->len = 0;
49   mb->size = initiallen;
50   mb->out_of_core = 0;
51   mb->buf = xtrymalloc (initiallen);
52   if (!mb->buf)
53     mb->out_of_core = errno;
54 }
55
56 /* Same as init_membuf but allocates the buffer in secure memory.  */
57 void
58 init_membuf_secure (membuf_t *mb, int initiallen)
59 {
60   mb->len = 0;
61   mb->size = initiallen;
62   mb->out_of_core = 0;
63   mb->buf = xtrymalloc_secure (initiallen);
64   if (!mb->buf)
65     mb->out_of_core = errno;
66 }
67
68
69 /* Shift the the content of the membuf MB by AMOUNT bytes.  The next
70    operation will then behave as if AMOUNT bytes had not been put into
71    the buffer.  If AMOUNT is greater than the actual accumulated
72    bytes, the membuf is basically reset to its initial state.  */
73 void
74 clear_membuf (membuf_t *mb, size_t amount)
75 {
76   /* No need to clear if we are already out of core.  */
77   if (mb->out_of_core)
78     return;
79   if (amount >= mb->len)
80     mb->len = 0;
81   else
82     {
83       mb->len -= amount;
84       memmove (mb->buf, mb->buf+amount, mb->len);
85     }
86 }
87
88
89 void
90 put_membuf (membuf_t *mb, const void *buf, size_t len)
91 {
92   if (mb->out_of_core || !len)
93     return;
94
95   if (mb->len + len >= mb->size)
96     {
97       char *p;
98
99       mb->size += len + 1024;
100       p = xtryrealloc (mb->buf, mb->size);
101       if (!p)
102         {
103           mb->out_of_core = errno ? errno : ENOMEM;
104           /* Wipe out what we already accumulated.  This is required
105              in case we are storing sensitive data here.  The membuf
106              API does not provide another way to cleanup after an
107              error. */
108           wipememory (mb->buf, mb->len);
109           return;
110         }
111       mb->buf = p;
112     }
113   memcpy (mb->buf + mb->len, buf, len);
114   mb->len += len;
115 }
116
117
118 void
119 put_membuf_str (membuf_t *mb, const char *string)
120 {
121   put_membuf (mb, string, strlen (string));
122 }
123
124
125 void *
126 get_membuf (membuf_t *mb, size_t *len)
127 {
128   char *p;
129
130   if (mb->out_of_core)
131     {
132       if (mb->buf)
133         {
134           wipememory (mb->buf, mb->len);
135           xfree (mb->buf);
136           mb->buf = NULL;
137         }
138       gpg_err_set_errno (mb->out_of_core);
139       return NULL;
140     }
141
142   p = mb->buf;
143   if (len)
144     *len = mb->len;
145   mb->buf = NULL;
146   mb->out_of_core = ENOMEM; /* hack to make sure it won't get reused. */
147   return p;
148 }
149
150
151 /* Peek at the membuf MB.  On success a pointer to the buffer is
152    returned which is valid until the next operation on MB.  If LEN is
153    not NULL the current LEN of the buffer is stored there.  On error
154    NULL is returned and ERRNO is set.  */
155 const void *
156 peek_membuf (membuf_t *mb, size_t *len)
157 {
158   const char *p;
159
160   if (mb->out_of_core)
161     {
162       gpg_err_set_errno (mb->out_of_core);
163       return NULL;
164     }
165
166   p = mb->buf;
167   if (len)
168     *len = mb->len;
169   return p;
170 }