- Check number of free TX descs before trying to xmit packets
[dragonfly.git] / contrib / libarchive-2 / libarchive / archive_read_support_compression_program.c
1 /*-
2  * Copyright (c) 2007 Joerg Sonnenberger
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "archive_platform.h"
27 __FBSDID("$FreeBSD: src/lib/libarchive/archive_read_support_compression_program.c,v 1.2 2007/07/20 01:28:50 kientzle Exp $");
28
29
30 /* This capability is only available on POSIX systems. */
31 #if !defined(HAVE_PIPE) || !defined(HAVE_VFORK) || !defined(HAVE_FCNTL)
32
33 /*
34  * On non-Posix systems, allow the program to build, but choke if
35  * this function is actually invoked.
36  */
37 int
38 archive_read_support_compression_program(struct archive *_a, const char *cmd)
39 {
40         archive_set_error(_a, -1,
41             "External compression programs not supported on this platform");
42         return (ARCHIVE_FATAL);
43 }
44
45 #else
46
47 #ifdef HAVE_SYS_WAIT_H
48 #  include <sys/wait.h>
49 #endif
50 #ifdef HAVE_ERRNO_H
51 #  include <errno.h>
52 #endif
53 #ifdef HAVE_FCNTL_H
54 #  include <fcntl.h>
55 #endif
56 #ifdef HAVE_LIMITS_H
57 #  include <limits.h>
58 #endif
59 #ifdef HAVE_STDLIB_H
60 #  include <stdlib.h>
61 #endif
62 #ifdef HAVE_STRING_H
63 #  include <string.h>
64 #endif
65 #ifdef HAVE_UNISTD_H
66 #  include <unistd.h>
67 #endif
68
69 #include "archive.h"
70 #include "archive_private.h"
71 #include "archive_read_private.h"
72
73 #include "filter_fork.h"
74
75 struct archive_decompress_program {
76         char            *description;
77         pid_t            child;
78         int              child_stdin, child_stdout;
79
80         char            *child_out_buf;
81         char            *child_out_buf_next;
82         size_t           child_out_buf_len, child_out_buf_avail;
83
84         const char      *child_in_buf;
85         size_t           child_in_buf_avail;
86 };
87
88 static int      archive_decompressor_program_bid(const void *, size_t);
89 static int      archive_decompressor_program_finish(struct archive_read *);
90 static int      archive_decompressor_program_init(struct archive_read *,
91                     const void *, size_t);
92 static ssize_t  archive_decompressor_program_read_ahead(struct archive_read *,
93                     const void **, size_t);
94 static ssize_t  archive_decompressor_program_read_consume(struct archive_read *,
95                     size_t);
96
97 int
98 archive_read_support_compression_program(struct archive *_a, const char *cmd)
99 {
100         struct archive_read *a = (struct archive_read *)_a;
101         struct decompressor_t *decompressor;
102
103         if (cmd == NULL || *cmd == '\0')
104                 return (ARCHIVE_WARN);
105
106         decompressor = __archive_read_register_compression(a,
107                     archive_decompressor_program_bid,
108                     archive_decompressor_program_init);
109         if (decompressor == NULL)
110                 return (ARCHIVE_WARN);
111
112         decompressor->config = strdup(cmd);
113         return (ARCHIVE_OK);
114 }
115
116 /*
117  * If the user used us to register, they must really want us to
118  * handle it, so this module always bids INT_MAX.
119  */
120 static int
121 archive_decompressor_program_bid(const void *buff, size_t len)
122 {
123         (void)buff; /* UNUSED */
124         (void)len; /* UNUSED */
125
126         return (INT_MAX); /* Default: We'll take it. */
127 }
128
129 static ssize_t
130 child_read(struct archive_read *a, char *buf, size_t buf_len)
131 {
132         struct archive_decompress_program *state = a->decompressor->data;
133         ssize_t ret, requested;
134         const void *child_buf;
135
136         if (state->child_stdout == -1)
137                 return (-1);
138
139         if (buf_len == 0)
140                 return (-1);
141
142 restart_read:
143         requested = buf_len > SSIZE_MAX ? SSIZE_MAX : buf_len;
144
145         do {
146                 ret = read(state->child_stdout, buf, requested);
147         } while (ret == -1 && errno == EINTR);
148
149         if (ret > 0)
150                 return (ret);
151         if (ret == 0 || (ret == -1 && errno == EPIPE)) {
152                 close(state->child_stdout);
153                 state->child_stdout = -1;
154                 return (0);
155         }
156         if (ret == -1 && errno != EAGAIN)
157                 return (-1);
158
159         if (state->child_in_buf_avail == 0) {
160                 child_buf = state->child_in_buf;
161                 ret = (a->client_reader)(&a->archive,
162                     a->client_data,&child_buf);
163                 state->child_in_buf = (const char *)child_buf;
164
165                 if (ret < 0) {
166                         close(state->child_stdin);
167                         state->child_stdin = -1;
168                         fcntl(state->child_stdout, F_SETFL, 0);
169                         return (-1);
170                 }
171                 if (ret == 0) {
172                         close(state->child_stdin);
173                         state->child_stdin = -1;
174                         fcntl(state->child_stdout, F_SETFL, 0);
175                         goto restart_read;
176                 }
177                 state->child_in_buf_avail = ret;
178         }
179
180         do {
181                 ret = write(state->child_stdin, state->child_in_buf,
182                     state->child_in_buf_avail);
183         } while (ret == -1 && errno == EINTR);
184
185         if (ret > 0) {
186                 state->child_in_buf += ret;
187                 state->child_in_buf_avail -= ret;
188                 goto restart_read;
189         } else if (ret == -1 && errno == EAGAIN) {
190                 __archive_check_child(state->child_stdin, state->child_stdout);
191                 goto restart_read;
192         } else if (ret == 0 || (ret == -1 && errno == EPIPE)) {
193                 close(state->child_stdin);
194                 state->child_stdout = -1;
195                 fcntl(state->child_stdout, F_SETFL, 0);
196                 goto restart_read;
197         } else {
198                 close(state->child_stdin);
199                 state->child_stdin = -1;
200                 fcntl(state->child_stdout, F_SETFL, 0);
201                 return (-1);
202         }
203 }
204
205 static int
206 archive_decompressor_program_init(struct archive_read *a, const void *buff, size_t n)
207 {
208         struct archive_decompress_program       *state;
209         const char *cmd = a->decompressor->config;
210         const char *prefix = "Program: ";
211
212
213         state = (struct archive_decompress_program *)malloc(sizeof(*state));
214         if (!state) {
215                 archive_set_error(&a->archive, ENOMEM,
216                     "Can't allocate input data");
217                 return (ARCHIVE_FATAL);
218         }
219
220         a->archive.compression_code = ARCHIVE_COMPRESSION_PROGRAM;
221         state->description = (char *)malloc(strlen(prefix) + strlen(cmd) + 1);
222         strcpy(state->description, prefix);
223         strcat(state->description, cmd);
224         a->archive.compression_name = state->description;
225
226         state->child_out_buf_next = state->child_out_buf = malloc(65536);
227         if (!state->child_out_buf) {
228                 free(state);
229                 archive_set_error(&a->archive, ENOMEM,
230                     "Can't allocate filter buffer");
231                 return (ARCHIVE_FATAL);
232         }
233         state->child_out_buf_len = 65536;
234         state->child_out_buf_avail = 0;
235
236         state->child_in_buf = buff;
237         state->child_in_buf_avail = n;
238
239         if ((state->child = __archive_create_child(cmd,
240                  &state->child_stdin, &state->child_stdout)) == -1) {
241                 free(state->child_out_buf);
242                 free(state);
243                 archive_set_error(&a->archive, EINVAL,
244                     "Can't initialise filter");
245                 return (ARCHIVE_FATAL);
246         }
247
248         a->decompressor->data = state;
249         a->decompressor->read_ahead = archive_decompressor_program_read_ahead;
250         a->decompressor->consume = archive_decompressor_program_read_consume;
251         a->decompressor->skip = NULL;
252         a->decompressor->finish = archive_decompressor_program_finish;
253
254         /* XXX Check that we can read at least one byte? */
255         return (ARCHIVE_OK);
256 }
257
258 static ssize_t
259 archive_decompressor_program_read_ahead(struct archive_read *a, const void **buff,
260     size_t min)
261 {
262         struct archive_decompress_program *state;
263         ssize_t bytes_read;
264
265         state = (struct archive_decompress_program *)a->decompressor->data;
266
267         if (min > state->child_out_buf_len)
268                 min = state->child_out_buf_len;
269
270         while (state->child_stdout != -1 && min > state->child_out_buf_avail) {
271                 if (state->child_out_buf != state->child_out_buf_next) {
272                         memmove(state->child_out_buf, state->child_out_buf_next,
273                             state->child_out_buf_avail);
274                         state->child_out_buf_next = state->child_out_buf;
275                 }
276
277                 bytes_read = child_read(a,
278                     state->child_out_buf + state->child_out_buf_avail,
279                     state->child_out_buf_len - state->child_out_buf_avail);
280                 if (bytes_read == -1)
281                         return (-1);
282                 if (bytes_read == 0)
283                         break;
284                 state->child_out_buf_avail += bytes_read;
285                 a->archive.raw_position += bytes_read;
286         }
287
288         *buff = state->child_out_buf_next;
289         return (state->child_out_buf_avail);
290 }
291
292 static ssize_t
293 archive_decompressor_program_read_consume(struct archive_read *a, size_t request)
294 {
295         struct archive_decompress_program *state;
296
297         state = (struct archive_decompress_program *)a->decompressor->data;
298
299         state->child_out_buf_next += request;
300         state->child_out_buf_avail -= request;
301
302         a->archive.file_position += request;
303         return (request);
304 }
305
306 static int
307 archive_decompressor_program_finish(struct archive_read *a)
308 {
309         struct archive_decompress_program       *state;
310         int status;
311
312         state = (struct archive_decompress_program *)a->decompressor->data;
313
314         /* Release our configuration data. */
315         free(a->decompressor->config);
316         a->decompressor->config = NULL;
317
318         /* Shut down the child. */
319         if (state->child_stdin != -1)
320                 close(state->child_stdin);
321         if (state->child_stdout != -1)
322                 close(state->child_stdout);
323         while (waitpid(state->child, &status, 0) == -1 && errno == EINTR)
324                 continue;
325
326         /* Release our private data. */
327         free(state->child_out_buf);
328         free(state->description);
329         free(state);
330         a->decompressor->data = NULL;
331
332         return (ARCHIVE_OK);
333 }
334
335 #endif /* !defined(HAVE_PIPE) || !defined(HAVE_VFORK) || !defined(HAVE_FCNTL) */