recv.h: Cosmetics.
[paraslash.git] / filter_chain.c
index 42db378..1a29024 100644 (file)
@@ -1,25 +1,18 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file filter_chain.c common helper functions for filter input/output */
+/** \file filter_chain.c Common helper functions for filter input/output. */
+
+#include <sys/types.h>
+#include <dirent.h>
 
 #include "para.h"
 #include "list.h"
+#include "sched.h"
+#include "fd.h"
 #include "filter.h"
 #include "error.h"
 #include "string.h"
 DEFINE_FILTER_ARRAY(filters);
 
 /**
- * call the init function of each supported filter
+ * Call the init function of each supported filter.
+ *
+ * \param all_filters the array of all supported filters.
  *
- * \param all_filters the array of all supported filters
  * \sa filter::init
  */
 void filter_init(struct filter *all_filters)
@@ -41,9 +35,9 @@ void filter_init(struct filter *all_filters)
 }
 
 /**
- * close and destroy a filter callback
+ * Close and destroy a filter callback.
  *
- * \param fcb the filter callback to close
+ * \param fcb The filter callback to close.
  *
  * This removes \a fcb from the list of filter callbacks and calls
  * the close callback associated with \a fcb.
@@ -56,9 +50,9 @@ static void close_filter_callback(struct filter_callback *fcb)
 }
 
 /**
- * close all callbacks of a filter node
+ * Close all callbacks of a filter node.
  *
- * \param fn the filter node which contains the filter callbacks to be closed
+ * \param fn The filter node which contains the filter callbacks to be closed.
  *
  * Call close_filter_callback() for each entry in the filter callback list
  * of \a fn.
@@ -67,8 +61,11 @@ static void close_callbacks(struct filter_node *fn)
 {
        struct filter_callback *fcb, *tmp;
 
-       list_for_each_entry_safe(fcb, tmp, &fn->callbacks, node)
+       list_for_each_entry_safe(fcb, tmp, &fn->callbacks, node) {
+               PARA_INFO_LOG("closing %s filter callback\n",
+                       filters[fn->filter_num].name);
                close_filter_callback(fcb);
+       }
 }
 
 static void call_callbacks(struct filter_node *fn, char *inbuf, size_t inlen,
@@ -93,89 +90,105 @@ static void call_callbacks(struct filter_node *fn, char *inbuf, size_t inlen,
 }
 
 /**
- * call the convert function of each filter
+ * Call the convert function of each filter.
  *
- * \param fci the filter chain containing the list of filter nodes.
+ * \param s Unused.
+ * \param t The task identifying the filter chain.
  *
  * This is the core function of the filter subsystem. It loops over the list of
- * filter nodes determined by \a fci and calls the filter's convert function if
+ * filter nodes determined by \a t and calls the filter's convert function if
  * there is input available for the filter node in question. If the convert
  * function consumed some or all of its input data, all registered input
  * callbacks are called.  Similarly, if a convert function produced output, all
  * registerd output callbacks get called.
  *
- * \return The sum of output bytes produced by the convert functions on success,
- * negative return value on errors.
+ * On errors a (negative) error code is stored in t->error.
  *
- * \sa filter_node, filter#convert, filter_callback
+ * \sa filter_node, filter#convert, filter_callback.
  */
-int filter_io(struct filter_chain_info *fci)
+void filter_pre_select(__a_unused struct sched *s, struct task *t)
 {
+       struct filter_chain *fc = container_of(t, struct filter_chain, task);
        struct filter_node *fn;
        char *ib;
        size_t *loaded;
-       int conv, conv_total = 0;
+       int i, conv, conv_total = 0;
+
+       if (fc->output_error && *fc->output_error < 0) {
+               t->error =  *fc->output_error;
+               return;
+       }
 again:
-       ib = fci->inbuf;
-       loaded = fci->in_loaded;
+       ib = fc->inbuf;
+       loaded = fc->in_loaded;
        conv = 0;
-       list_for_each_entry(fn, &fci->filters, node) {
-               int ret;
+       FOR_EACH_FILTER_NODE(fn, fc, i) {
+               struct filter *f = filters + fn->filter_num;
                if (*loaded && fn->loaded < fn->bufsize) {
-                       size_t old_fn_loaded = fn->loaded;
-                       PARA_DEBUG_LOG("fc %p loaded: %zd, calling %s convert\n", fci, *loaded, fn->filter->name);
-                       ret = fn->filter->convert(ib, *loaded, fn);
-                       if (ret < 0) {
-                               if (!fci->error)
-                                       fci->error = -ret;
-                               return ret;
-                       }
-                       call_callbacks(fn, ib, ret, fn->buf + old_fn_loaded, fn->loaded - old_fn_loaded);
-                       *loaded -= ret;
-                       conv += ret;
-                       if (*loaded && ret) {
-                               PARA_DEBUG_LOG("moving %zd bytes in input buffer for %s filter\n",
-                                       *loaded,  fn->filter->name);
-                               memmove(ib, ib + ret, *loaded);
+                       size_t size, old_fn_loaded = fn->loaded;
+//                     PARA_DEBUG_LOG("fc %p loaded: %zd, calling %s convert\n",
+//                             fc, *loaded, fn->filter->name);
+                       t->error = f->convert(ib, *loaded, fn);
+                       if (t->error < 0)
+                               return;
+                       size = t->error;
+                       call_callbacks(fn, ib, size, fn->buf + old_fn_loaded,
+                               fn->loaded - old_fn_loaded);
+                       *loaded -= size;
+                       conv += size;
+                       if (*loaded && size) {
+//                             PARA_DEBUG_LOG("moving %zd bytes in input "
+//                                     "buffer for %s filter\n",
+//                                     *loaded,  fn->filter->name);
+                               memmove(ib, ib + size, *loaded);
                        }
                }
                ib = fn->buf;
                loaded = &fn->loaded;
        }
-//     PARA_DEBUG_LOG("loaded: %d\n", *loaded);
        conv_total += conv;
+//     PARA_DEBUG_LOG("eof (in/out/fc): %d/%d/%d out_loaded: %zd, "
+//             "conv: %d, conv_total: %d\n", *fc->input_eof,
+//             fc->output_eof? *fc->output_eof : -42,
+//             fc->eof, *fc->out_loaded, conv, conv_total);
        if (conv)
                goto again;
-       return conv_total;
+       if (!*fc->input_error)
+               return;
+       if (*fc->out_loaded)
+               return;
+       if (*fc->in_loaded && conv_total)
+               return;
+       t->error = -E_FC_EOF;
 }
 
 /**
- * close all filter nodes and its callbacks
+ * Close all filter nodes and their callbacks.
  *
- * \param fci the filter chain to close
+ * \param fc The filter chain to close.
  *
- * For each filter node determined by \a fci, call the close function of each
+ * For each filter node determined by \a fc, call the close function of each
  * registered filter callback as well as the close function of the
  * corresponding filter.  Free all resources and destroy all callback lists and
  * the filter node list.
  *
  * \sa filter::close, filter_callback::close
  */
-void close_filters(struct filter_chain_info *fci)
+void close_filters(struct filter_chain *fc)
 {
-       struct filter_node *fn, *tmp;
+       struct filter_node *fn;
+       int i;
 
-       if (!fci)
+       if (!fc)
                return;
-       PARA_DEBUG_LOG("closing filter chain %p\n", fci);
-       list_for_each_entry_safe(fn, tmp, &fci->filters, node) {
-               PARA_NOTICE_LOG("closing %s filter callbacks (fci %p, fn %p)\n", fn->filter->name, fci, fn);
+       PARA_NOTICE_LOG("closing filter chain %p\n", fc);
+       FOR_EACH_FILTER_NODE(fn, fc, i) {
+               struct filter *f = filters + fn->filter_num;
                close_callbacks(fn);
-               PARA_NOTICE_LOG("closing %s filter (fci %p, fn %p)\n", fn->filter->name, fci, fn);
-               fn->filter->close(fn);
-               list_del(&fn->node);
-               free(fn);
+               PARA_INFO_LOG("closing %s filter\n", f->name);
+               f->close(fn);
        }
+       free(fc->filter_nodes);
 }
 
 /*
@@ -186,33 +199,30 @@ static int parse_filter_args(int filter_num, char *options, void **conf)
 {
        struct filter *f = &filters[filter_num];
        int i, argc = 2;
-       char *dummy_args[] = {"", "", NULL};
        char **argv;
 
 //     PARA_DEBUG_LOG("%s, options: %s, parser: %p\n", f->name,
 //             options? options : "(none)", f->parse_config);
        if (!f->parse_config)
-               return options? -E_BAD_FILTER_OPTIONS : filter_num;
-       if (options) {
-//             PARA_DEBUG_LOG("options: %s\n", options);
-               argc = split_args(options, &argv, ' ');
+               return strlen(options)? -E_BAD_FILTER_OPTIONS : filter_num;
+//     PARA_DEBUG_LOG("options: %s\n", options);
+       argc = split_args(options, &argv, " \t");
 //             PARA_DEBUG_LOG("argc = %d, argv[0]: %s\n", argc, argv[0]);
-               for (i = argc; i >= 0; i--)
-                       argv[i + 1] = argv[i];
-               argc += 2;
-               *conf = f->parse_config(argc, argv);
-       } else {
-               /* is it OK to have no options? */
-               *conf = f->parse_config(2, dummy_args);
-       }
+       for (i = argc - 1; i >= 0; i--)
+               argv[i + 1] = argv[i];
+       argv[0] = para_strdup(f->name);
+       argc += 1;
+       *conf = f->parse_config(argc, argv);
+       free(argv[0]);
+       free(argv);
        return *conf? filter_num : -E_BAD_FILTER_OPTIONS;
 }
 
 /**
- * check the filter command line options
+ * Check the filter command line options.
  *
- * \param fa the command line options
- * \param conf points to the filter configuration upon successful return
+ * \param fa The command line options.
+ * \param conf Points to the filter configuration upon successful return.
  *
  * Check if \a fa starts with a the name of a supported filter, followed by
  * a colon. If yes, call the command line parser of that filter.
@@ -245,7 +255,8 @@ int check_filter_arg(char *fa, void **conf)
                        continue;
                if (c && !filters[j].parse_config)
                        return -E_BAD_FILTER_OPTIONS;
-               return parse_filter_args(j, c? fa + len + 1 : NULL, conf);
+               return parse_filter_args(j, c? fa + len + 1 :
+                       fa + strlen(fa), conf);
        }
        return -E_UNSUPPORTED_FILTER;
 }