wrapper: move odb_* to environment.c
[git] / wrapper.c
1 /*
2  * Various trivial helper wrappers around standard functions
3  */
4 #include "cache.h"
5
6 static void try_to_free_builtin(size_t size)
7 {
8         release_pack_memory(size, -1);
9 }
10
11 static void (*try_to_free_routine)(size_t size) = try_to_free_builtin;
12
13 try_to_free_t set_try_to_free_routine(try_to_free_t routine)
14 {
15         try_to_free_t old = try_to_free_routine;
16         try_to_free_routine = routine;
17         return old;
18 }
19
20 char *xstrdup(const char *str)
21 {
22         char *ret = strdup(str);
23         if (!ret) {
24                 try_to_free_routine(strlen(str) + 1);
25                 ret = strdup(str);
26                 if (!ret)
27                         die("Out of memory, strdup failed");
28         }
29         return ret;
30 }
31
32 void *xmalloc(size_t size)
33 {
34         void *ret = malloc(size);
35         if (!ret && !size)
36                 ret = malloc(1);
37         if (!ret) {
38                 try_to_free_routine(size);
39                 ret = malloc(size);
40                 if (!ret && !size)
41                         ret = malloc(1);
42                 if (!ret)
43                         die("Out of memory, malloc failed (tried to allocate %lu bytes)",
44                             (unsigned long)size);
45         }
46 #ifdef XMALLOC_POISON
47         memset(ret, 0xA5, size);
48 #endif
49         return ret;
50 }
51
52 void *xmallocz(size_t size)
53 {
54         void *ret;
55         if (size + 1 < size)
56                 die("Data too large to fit into virtual memory space.");
57         ret = xmalloc(size + 1);
58         ((char*)ret)[size] = 0;
59         return ret;
60 }
61
62 /*
63  * xmemdupz() allocates (len + 1) bytes of memory, duplicates "len" bytes of
64  * "data" to the allocated memory, zero terminates the allocated memory,
65  * and returns a pointer to the allocated memory. If the allocation fails,
66  * the program dies.
67  */
68 void *xmemdupz(const void *data, size_t len)
69 {
70         return memcpy(xmallocz(len), data, len);
71 }
72
73 char *xstrndup(const char *str, size_t len)
74 {
75         char *p = memchr(str, '\0', len);
76         return xmemdupz(str, p ? p - str : len);
77 }
78
79 void *xrealloc(void *ptr, size_t size)
80 {
81         void *ret = realloc(ptr, size);
82         if (!ret && !size)
83                 ret = realloc(ptr, 1);
84         if (!ret) {
85                 try_to_free_routine(size);
86                 ret = realloc(ptr, size);
87                 if (!ret && !size)
88                         ret = realloc(ptr, 1);
89                 if (!ret)
90                         die("Out of memory, realloc failed");
91         }
92         return ret;
93 }
94
95 void *xcalloc(size_t nmemb, size_t size)
96 {
97         void *ret = calloc(nmemb, size);
98         if (!ret && (!nmemb || !size))
99                 ret = calloc(1, 1);
100         if (!ret) {
101                 try_to_free_routine(nmemb * size);
102                 ret = calloc(nmemb, size);
103                 if (!ret && (!nmemb || !size))
104                         ret = calloc(1, 1);
105                 if (!ret)
106                         die("Out of memory, calloc failed");
107         }
108         return ret;
109 }
110
111 /*
112  * xread() is the same a read(), but it automatically restarts read()
113  * operations with a recoverable error (EAGAIN and EINTR). xread()
114  * DOES NOT GUARANTEE that "len" bytes is read even if the data is available.
115  */
116 ssize_t xread(int fd, void *buf, size_t len)
117 {
118         ssize_t nr;
119         while (1) {
120                 nr = read(fd, buf, len);
121                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
122                         continue;
123                 return nr;
124         }
125 }
126
127 /*
128  * xwrite() is the same a write(), but it automatically restarts write()
129  * operations with a recoverable error (EAGAIN and EINTR). xwrite() DOES NOT
130  * GUARANTEE that "len" bytes is written even if the operation is successful.
131  */
132 ssize_t xwrite(int fd, const void *buf, size_t len)
133 {
134         ssize_t nr;
135         while (1) {
136                 nr = write(fd, buf, len);
137                 if ((nr < 0) && (errno == EAGAIN || errno == EINTR))
138                         continue;
139                 return nr;
140         }
141 }
142
143 ssize_t read_in_full(int fd, void *buf, size_t count)
144 {
145         char *p = buf;
146         ssize_t total = 0;
147
148         while (count > 0) {
149                 ssize_t loaded = xread(fd, p, count);
150                 if (loaded <= 0)
151                         return total ? total : loaded;
152                 count -= loaded;
153                 p += loaded;
154                 total += loaded;
155         }
156
157         return total;
158 }
159
160 ssize_t write_in_full(int fd, const void *buf, size_t count)
161 {
162         const char *p = buf;
163         ssize_t total = 0;
164
165         while (count > 0) {
166                 ssize_t written = xwrite(fd, p, count);
167                 if (written < 0)
168                         return -1;
169                 if (!written) {
170                         errno = ENOSPC;
171                         return -1;
172                 }
173                 count -= written;
174                 p += written;
175                 total += written;
176         }
177
178         return total;
179 }
180
181 int xdup(int fd)
182 {
183         int ret = dup(fd);
184         if (ret < 0)
185                 die_errno("dup failed");
186         return ret;
187 }
188
189 FILE *xfdopen(int fd, const char *mode)
190 {
191         FILE *stream = fdopen(fd, mode);
192         if (stream == NULL)
193                 die_errno("Out of memory? fdopen failed");
194         return stream;
195 }
196
197 int xmkstemp(char *template)
198 {
199         int fd;
200
201         fd = mkstemp(template);
202         if (fd < 0)
203                 die_errno("Unable to create temporary file");
204         return fd;
205 }
206
207 int xmkstemp_mode(char *template, int mode)
208 {
209         int fd;
210
211         fd = git_mkstemp_mode(template, mode);
212         if (fd < 0)
213                 die_errno("Unable to create temporary file");
214         return fd;
215 }
216
217 /*
218  * zlib wrappers to make sure we don't silently miss errors
219  * at init time.
220  */
221 void git_inflate_init(z_streamp strm)
222 {
223         const char *err;
224
225         switch (inflateInit(strm)) {
226         case Z_OK:
227                 return;
228
229         case Z_MEM_ERROR:
230                 err = "out of memory";
231                 break;
232         case Z_VERSION_ERROR:
233                 err = "wrong version";
234                 break;
235         default:
236                 err = "error";
237         }
238         die("inflateInit: %s (%s)", err, strm->msg ? strm->msg : "no message");
239 }
240
241 void git_inflate_end(z_streamp strm)
242 {
243         if (inflateEnd(strm) != Z_OK)
244                 error("inflateEnd: %s", strm->msg ? strm->msg : "failed");
245 }
246
247 int git_inflate(z_streamp strm, int flush)
248 {
249         int ret = inflate(strm, flush);
250         const char *err;
251
252         switch (ret) {
253         /* Out of memory is fatal. */
254         case Z_MEM_ERROR:
255                 die("inflate: out of memory");
256
257         /* Data corruption errors: we may want to recover from them (fsck) */
258         case Z_NEED_DICT:
259                 err = "needs dictionary"; break;
260         case Z_DATA_ERROR:
261                 err = "data stream error"; break;
262         case Z_STREAM_ERROR:
263                 err = "stream consistency error"; break;
264         default:
265                 err = "unknown error"; break;
266
267         /* Z_BUF_ERROR: normal, needs more space in the output buffer */
268         case Z_BUF_ERROR:
269         case Z_OK:
270         case Z_STREAM_END:
271                 return ret;
272         }
273         error("inflate: %s (%s)", err, strm->msg ? strm->msg : "no message");
274         return ret;
275 }
276
277 static int warn_if_unremovable(const char *op, const char *file, int rc)
278 {
279         if (rc < 0) {
280                 int err = errno;
281                 if (ENOENT != err) {
282                         warning("unable to %s %s: %s",
283                                 op, file, strerror(errno));
284                         errno = err;
285                 }
286         }
287         return rc;
288 }
289
290 int unlink_or_warn(const char *file)
291 {
292         return warn_if_unremovable("unlink", file, unlink(file));
293 }
294
295 int rmdir_or_warn(const char *file)
296 {
297         return warn_if_unremovable("rmdir", file, rmdir(file));
298 }
299
300 int remove_or_warn(unsigned int mode, const char *file)
301 {
302         return S_ISGITLINK(mode) ? rmdir_or_warn(file) : unlink_or_warn(file);
303 }