git.sesse.net Git - vlc/blob - modules/stream_filter/decomp.c

   1 /*****************************************************************************
   2  * decomp.c : Decompression module for vlc
   3  *****************************************************************************
   4  * Copyright © 2008-2009 Rémi Denis-Courmont
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU Lesser General Public License as published by
   8  * the Free Software Foundation; either version 2.1 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  19  *****************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include "config.h"
  23 #endif
  24
  25 #include <vlc_common.h>
  26 #include <vlc_plugin.h>
  27 #include <vlc_stream.h>
  28 #include <vlc_network.h>
  29 #include <assert.h>
  30 #include <unistd.h>
  31 #include <errno.h>
  32 #ifndef _POSIX_SPAWN
  33 # define _POSIX_SPAWN (-1)
  34 #endif
  35 #include <fcntl.h>
  36 #if (_POSIX_SPAWN >= 0)
  37 # include <spawn.h>
  38 #endif
  39 #include <sys/wait.h>
  40 #include <sys/ioctl.h>
  41 #if defined (__linux__) && defined (HAVE_VMSPLICE)
  42 # include <sys/uio.h>
  43 # include <sys/mman.h>
  44 #else
  45 # undef HAVE_VMSPLICE
  46 #endif
  47
  48 static int  OpenGzip (vlc_object_t *);
  49 static int  OpenBzip2 (vlc_object_t *);
  50 static int  OpenXZ (vlc_object_t *);
  51 static void Close (vlc_object_t *);
  52
  53 vlc_module_begin ()
  54     set_description (N_("Decompression"))
  55     set_category (CAT_INPUT)
  56     set_subcategory (SUBCAT_INPUT_STREAM_FILTER)
  57     set_capability ("stream_filter", 20)
  58     set_callbacks (OpenXZ, Close)
  59
  60     add_submodule ()
  61     set_callbacks (OpenBzip2, Close)
  62     /* TODO: access shortnames for stream_UrlNew() */
  63
  64     add_submodule ()
  65     set_callbacks (OpenGzip, Close)
  66 vlc_module_end ()
  67
  68 struct stream_sys_t
  69 {
  70     block_t      *peeked;
  71     uint64_t     offset;
  72     vlc_thread_t thread;
  73     pid_t        pid;
  74     int          write_fd, read_fd;
  75 };
  76
  77 static void cloexec (int fd)
  78 {
  79     int flags = fcntl (fd, F_GETFD);
  80     fcntl (fd, F_SETFD, FD_CLOEXEC | ((flags != -1) ? flags : 0));
  81 }
  82
  83 extern char **environ;
  84
  85 static const size_t bufsize = 65536;
  86 #ifdef HAVE_VMSPLICE
  87 static void cleanup_mmap (void *addr)
  88 {
  89     munmap (addr, bufsize);
  90 }
  91 #endif
  92
  93 static void *Thread (void *data)
  94 {
  95     stream_t *stream = data;
  96     stream_sys_t *p_sys = stream->p_sys;
  97 #ifdef HAVE_VMSPLICE
  98     const ssize_t page_mask = sysconf (_SC_PAGE_SIZE) - 1;
  99 #endif
 100     int fd = p_sys->write_fd;
 101     bool error = false;
 102
 103     do
 104     {
 105         ssize_t len;
 106         int canc = vlc_savecancel ();
 107 #ifdef HAVE_VMSPLICE
 108         unsigned char *buf = mmap (NULL, bufsize, PROT_READ|PROT_WRITE,
 109                                    MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
 110         if (unlikely(buf == MAP_FAILED))
 111             break;
 112         vlc_cleanup_push (cleanup_mmap, buf);
 113 #else
 114         unsigned char buf[bufsize];
 115 #endif
 116
 117         len = stream_Read (stream->p_source, buf, bufsize);
 118         vlc_restorecancel (canc);
 119         error = len <= 0;
 120
 121         for (ssize_t i = 0, j; i < len; i += j)
 122         {
 123 #ifdef HAVE_VMSPLICE
 124             if ((len - i) <= page_mask) /* incomplete last page */
 125                 j = write (fd, buf + i, len - i);
 126             else
 127             {
 128                 struct iovec iov = { buf + i, (len - i) & ~page_mask, };
 129                 j = vmsplice (fd, &iov, 1, SPLICE_F_GIFT);
 130             }
 131             if (j == -1 && errno == ENOSYS) /* vmsplice() not supported */
 132 #endif
 133             j = write (fd, buf + i, len - i);
 134             if (j <= 0)
 135             {
 136                 if (j == 0)
 137                     errno = EPIPE;
 138                 msg_Err (stream, "cannot write data (%m)");
 139                 error = true;
 140                 break;
 141             }
 142         }
 143 #ifdef HAVE_VMSPLICE
 144         vlc_cleanup_run (); /* munmap (buf, bufsize) */
 145 #endif
 146     }
 147     while (!error);
 148
 149     msg_Dbg (stream, "compressed stream at EOF");
 150     return NULL;
 151 }
 152
 153
 154 static int Peek (stream_t *, const uint8_t **, unsigned int);
 155
 156 #define MIN_BLOCK (1 << 10)
 157 #define MAX_BLOCK (1 << 20)
 158 /**
 159  * Reads decompressed from the decompression program
 160  * @return -1 for EAGAIN, 0 for EOF, byte count otherwise.
 161  */
 162 static int Read (stream_t *stream, void *buf, unsigned int buflen)
 163 {
 164     stream_sys_t *p_sys = stream->p_sys;
 165     block_t *peeked;
 166     ssize_t length;
 167
 168     if (buf == NULL) /* caller skips data, get big enough peek buffer */
 169         buflen = Peek (stream, &(const uint8_t *){ NULL }, buflen);
 170
 171     if ((peeked = p_sys->peeked) != NULL)
 172     {   /* dequeue peeked data */
 173         length = (buflen > peeked->i_buffer) ? peeked->i_buffer : buflen;
 174         if (buf != NULL)
 175         {
 176             memcpy (buf, peeked->p_buffer, length);
 177             buf = ((char *)buf) + length;
 178         }
 179         buflen -= length;
 180         peeked->p_buffer += length;
 181         peeked->i_buffer -= length;
 182         if (peeked->i_buffer == 0)
 183         {
 184             block_Release (peeked);
 185             p_sys->peeked = NULL;
 186         }
 187         p_sys->offset += length;
 188
 189         if (buflen > 0)
 190             length += Read (stream, ((char *)buf) + length, buflen - length);
 191         return length;
 192     }
 193     assert ((buf != NULL) || (buflen == 0));
 194
 195     length = net_Read (stream, p_sys->read_fd, NULL, buf, buflen, false);
 196     if (length < 0)
 197         return 0;
 198     p_sys->offset += length;
 199     return length;
 200 }
 201
 202 /**
 203  *
 204  */
 205 static int Peek (stream_t *stream, const uint8_t **pbuf, unsigned int len)
 206 {
 207     stream_sys_t *p_sys = stream->p_sys;
 208     block_t *peeked = p_sys->peeked;
 209     size_t curlen = 0;
 210     int fd = p_sys->read_fd;
 211
 212     if (peeked == NULL)
 213         peeked = block_Alloc (len);
 214     else if ((curlen = peeked->i_buffer) < len)
 215         peeked = block_Realloc (peeked, 0, len);
 216
 217     if ((p_sys->peeked = peeked) == NULL)
 218         return 0;
 219
 220     if (curlen < len)
 221     {
 222         ssize_t val = net_Read (stream, fd, NULL, peeked->p_buffer + curlen,
 223                                 len - curlen, true);
 224         if (val >= 0)
 225         {
 226             curlen += val;
 227             peeked->i_buffer = curlen;
 228         }
 229     }
 230     *pbuf = peeked->p_buffer;
 231     return curlen;
 232 }
 233
 234 /**
 235  *
 236  */
 237 static int Control (stream_t *stream, int query, va_list args)
 238 {
 239     stream_sys_t *p_sys = stream->p_sys;
 240
 241     switch (query)
 242     {
 243         case STREAM_CAN_SEEK:
 244         case STREAM_CAN_FASTSEEK:
 245             *(va_arg (args, bool *)) = false;
 246             break;
 247         case STREAM_GET_POSITION:
 248             *(va_arg (args, uint64_t *)) = p_sys->offset;
 249             break;
 250         case STREAM_GET_SIZE:
 251             *(va_arg (args, uint64_t *)) = 0;
 252             break;
 253         default:
 254             return VLC_EGENERIC;
 255     }
 256     return VLC_SUCCESS;
 257 }
 258
 259 /**
 260  * Pipe data through an external executable.
 261  * @param stream the stream filter object.
 262  * @param path path to the executable.
 263  */
 264 static int Open (stream_t *stream, const char *path)
 265 {
 266     stream_sys_t *p_sys = stream->p_sys = malloc (sizeof (*p_sys));
 267     if (p_sys == NULL)
 268         return VLC_ENOMEM;
 269
 270     stream->pf_read = Read;
 271     stream->pf_peek = Peek;
 272     stream->pf_control = Control;
 273     p_sys->peeked = NULL;
 274     p_sys->offset = 0;
 275     p_sys->pid = -1;
 276
 277     /* I am not a big fan of the pyramid style, but I cannot think of anything
 278      * better here. There are too many failure cases. */
 279     int ret = VLC_EGENERIC;
 280     int comp[2];
 281
 282     /* We use two pipes rather than one stream socket pair, so that we can
 283      * use vmsplice() on Linux. */
 284     if (pipe (comp) == 0)
 285     {
 286         cloexec (comp[1]);
 287         p_sys->write_fd = comp[1];
 288
 289         int uncomp[2];
 290         if (pipe (uncomp) == 0)
 291         {
 292             cloexec (uncomp[0]);
 293             p_sys->read_fd = uncomp[0];
 294
 295 #if (_POSIX_SPAWN >= 0)
 296             posix_spawn_file_actions_t actions;
 297             if (posix_spawn_file_actions_init (&actions) == 0)
 298             {
 299                 char *const argv[] = { (char *)path, NULL };
 300
 301                 if (!posix_spawn_file_actions_adddup2 (&actions, comp[0], 0)
 302                  && !posix_spawn_file_actions_addclose (&actions, comp[0])
 303                  && !posix_spawn_file_actions_adddup2 (&actions, uncomp[1], 1)
 304                  && !posix_spawn_file_actions_addclose (&actions, uncomp[1])
 305                  && !posix_spawnp (&p_sys->pid, path, &actions, NULL, argv,
 306                                    environ))
 307                 {
 308                     if (vlc_clone (&p_sys->thread, Thread, stream,
 309                                    VLC_THREAD_PRIORITY_INPUT) == 0)
 310                         ret = VLC_SUCCESS;
 311                 }
 312                 else
 313                 {
 314                     msg_Err (stream, "Cannot execute %s", path);
 315                     p_sys->pid = -1;
 316                 }
 317                 posix_spawn_file_actions_destroy (&actions);
 318             }
 319 #else /* _POSIX_SPAWN */
 320             switch (p_sys->pid = fork ())
 321             {
 322                 case -1:
 323                     msg_Err (stream, "Cannot fork (%m)");
 324                     break;
 325                 case 0:
 326                     dup2 (comp[0], 0);
 327                     close (comp[0]);
 328                     dup2 (uncomp[1], 1);
 329                     close (uncomp[1]);
 330                     execlp (path, path, (char *)NULL);
 331                     exit (1); /* if we get, execlp() failed! */
 332                 default:
 333                     if (vlc_clone (&p_sys->thread, Thread, stream,
 334                                    VLC_THREAD_PRIORITY_INPUT) == 0)
 335                         ret = VLC_SUCCESS;
 336             }
 337 #endif /* _POSIX_SPAWN < 0 */
 338             close (uncomp[1]);
 339             if (ret != VLC_SUCCESS)
 340                 close (uncomp[0]);
 341         }
 342         close (comp[0]);
 343         if (ret != VLC_SUCCESS)
 344         {
 345             close (comp[1]);
 346             if (p_sys->pid != -1)
 347                 while (waitpid (p_sys->pid, &(int){ 0 }, 0) == -1);
 348         }
 349     }
 350     return ret;
 351 }
 352
 353
 354 /**
 355  * Releases allocate resources.
 356  */
 357 static void Close (vlc_object_t *obj)
 358 {
 359     stream_t *stream = (stream_t *)obj;
 360     stream_sys_t *p_sys = stream->p_sys;
 361     int status;
 362
 363     vlc_cancel (p_sys->thread);
 364     close (p_sys->read_fd);
 365     vlc_join (p_sys->thread, NULL);
 366     close (p_sys->write_fd);
 367
 368     msg_Dbg (obj, "waiting for PID %u", (unsigned)p_sys->pid);
 369     while (waitpid (p_sys->pid, &status, 0) == -1);
 370     msg_Dbg (obj, "exit status %d", status);
 371
 372     if (p_sys->peeked)
 373         block_Release (p_sys->peeked);
 374     free (p_sys);
 375 }
 376
 377
 378 /**
 379  * Detects gzip file format
 380  */
 381 static int OpenGzip (vlc_object_t *obj)
 382 {
 383     stream_t      *stream = (stream_t *)obj;
 384     const uint8_t *peek;
 385
 386     if (stream_Peek (stream->p_source, &peek, 3) < 3)
 387         return VLC_EGENERIC;
 388
 389     if (memcmp (peek, "\x1f\x8b\x08", 3))
 390         return VLC_EGENERIC;
 391
 392     msg_Dbg (obj, "detected gzip compressed stream");
 393     return Open (stream, "zcat");
 394 }
 395
 396
 397 /**
 398  * Detects bzip2 file format
 399  */
 400 static int OpenBzip2 (vlc_object_t *obj)
 401 {
 402     stream_t      *stream = (stream_t *)obj;
 403     const uint8_t *peek;
 404
 405     /* (Try to) parse the bzip2 header */
 406     if (stream_Peek (stream->p_source, &peek, 10) < 10)
 407         return VLC_EGENERIC;
 408
 409     if (memcmp (peek, "BZh", 3) || (peek[3] < '1') || (peek[3] > '9')
 410      || memcmp (peek + 4, "\x31\x41\x59\x26\x53\x59", 6))
 411         return VLC_EGENERIC;
 412
 413     msg_Dbg (obj, "detected bzip2 compressed stream");
 414     return Open (stream, "bzcat");
 415 }
 416
 417 /**
 418  * Detects xz file format
 419  */
 420 static int OpenXZ (vlc_object_t *obj)
 421 {
 422     stream_t      *stream = (stream_t *)obj;
 423     const uint8_t *peek;
 424
 425     /* (Try to) parse the xz stream header */
 426     if (stream_Peek (stream->p_source, &peek, 8) < 8)
 427         return VLC_EGENERIC;
 428
 429     if (memcmp (peek, "\xfd\x37\x7a\x58\x5a", 6))
 430         return VLC_EGENERIC;
 431
 432     msg_Dbg (obj, "detected xz compressed stream");
 433     return Open (stream, "xzcat");
 434 }