file_write.c

   1 /*
   2  * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file file_write.c simple output plugin for testing purposes */
   8
   9 #include <regex.h>
  10 #include <sys/types.h>
  11 #include <dirent.h>
  12 #include <sys/time.h>
  13 #include <stdbool.h>
  14
  15 #include "para.h"
  16 #include "list.h"
  17 #include "sched.h"
  18 #include "ggo.h"
  19 #include "buffer_tree.h"
  20 #include "write.h"
  21 #include "write_common.h"
  22 #include "string.h"
  23 #include "fd.h"
  24 #include "file_write.cmdline.h"
  25 #include "error.h"
  26
  27 /** Data specific to the file writer. */
  28 struct private_file_write_data {
  29         /** The file descriptor of the output file. */
  30         int fd;
  31 };
  32
  33 /*
  34  * Get a random filename.
  35  *
  36  * This is by no means a secure way to create temporary files in a hostile
  37  * directory like \p /tmp. However, we use it only for creating temp files in
  38  * ~/.paraslash, for which it is OK. Result must be freed by the caller.
  39  */
  40 __must_check __malloc static char *random_filename(void)
  41 {
  42         char *result, *home = para_homedir();
  43         struct timeval tv;
  44
  45         gettimeofday(&tv, NULL);
  46         srandom(tv.tv_usec);
  47         result = make_message("%s/.paraslash/%08lu", home,
  48                 para_random(99999999));
  49         free(home);
  50         return result;
  51 }
  52
  53 static void file_write_open(struct writer_node *wn)
  54 {
  55         struct private_file_write_data *pfwd = para_calloc(sizeof(*pfwd));
  56
  57         wn->private_data = pfwd;
  58         pfwd->fd = -1;
  59 }
  60
  61 static int prepare_output_file(struct writer_node *wn)
  62 {
  63         struct file_write_args_info *conf = wn->conf;
  64         struct private_file_write_data *pfwd = wn->private_data;
  65         char *filename;
  66         int ret;
  67
  68         if (conf->filename_given)
  69                 filename = conf->filename_arg;
  70         else
  71                 filename = random_filename();
  72         ret = para_open(filename, O_WRONLY | O_CREAT, S_IRUSR | S_IWUSR);
  73         if (!conf->filename_given)
  74                 free(filename);
  75         if (ret < 0)
  76                 goto out;
  77         pfwd->fd = ret;
  78         ret = mark_fd_blocking(pfwd->fd);
  79         if (ret >= 0)
  80                 return 1;
  81         close(pfwd->fd);
  82 out:
  83         free(pfwd);
  84         return ret;
  85 }
  86
  87 static void file_write_pre_select(struct sched *s, struct task *t)
  88 {
  89         struct writer_node *wn = container_of(t, struct writer_node, task);
  90         struct private_file_write_data *pfwd = wn->private_data;
  91         int ret;
  92
  93         t->error = 0;
  94         ret = btr_node_status(wn->btrn, wn->min_iqs, BTR_NT_LEAF);
  95         if (ret > 0 && pfwd->fd >= 0)
  96                 para_fd_set(pfwd->fd, &s->wfds, &s->max_fileno);
  97         else if (ret != 0) /* error or bos and fd not yet open */
  98                 sched_min_delay(s);
  99 }
 100
 101 static void file_write_close(struct writer_node *wn)
 102 {
 103         struct private_file_write_data *pfwd = wn->private_data;
 104
 105         if (pfwd->fd >= 0)
 106                 close(pfwd->fd);
 107         free(pfwd);
 108 }
 109
 110 static void file_write_post_select(__a_unused struct sched *s,
 111                 struct task *t)
 112 {
 113         struct writer_node *wn = container_of(t, struct writer_node, task);
 114         struct private_file_write_data *pfwd = wn->private_data;
 115         struct btr_node *btrn = wn->btrn;
 116         int ret;
 117         char *buf;
 118         size_t bytes;
 119
 120         t->error = 0;
 121         ret = btr_node_status(btrn, wn->min_iqs, BTR_NT_LEAF);
 122         if (ret <= 0)
 123                 goto out;
 124         if (pfwd->fd < 0) {
 125                 ret = prepare_output_file(wn);
 126                 if (ret < 0)
 127                         goto out;
 128         }
 129         if (!FD_ISSET(pfwd->fd, &s->wfds))
 130                 return;
 131         bytes = btr_next_buffer(btrn, &buf);
 132         assert(bytes > 0);
 133         //PARA_INFO_LOG("writing %zu\n", bytes);
 134         ret = write(pfwd->fd, buf, bytes);
 135         if (ret < 0)
 136                 goto out;
 137         btr_consume(btrn, ret);
 138 out:
 139         if (ret < 0)
 140                 btr_remove_node(btrn);
 141         t->error = ret;
 142 }
 143
 144 __malloc static void *file_write_parse_config_or_die(const char *options)
 145 {
 146         struct file_write_args_info *conf = para_calloc(sizeof(*conf));
 147
 148         /* exits on errors */
 149         file_cmdline_parser_string(options, conf, "file_write");
 150         return conf;
 151 }
 152
 153 static void file_write_free_config(void *conf)
 154 {
 155         file_cmdline_parser_free(conf);
 156 }
 157
 158 /** the init function of the file writer */
 159 void file_write_init(struct writer *w)
 160 {
 161         struct file_write_args_info dummy;
 162
 163         file_cmdline_parser_init(&dummy);
 164         w->open = file_write_open;
 165         w->pre_select = file_write_pre_select;
 166         w->post_select = file_write_post_select;
 167         w->parse_config_or_die = file_write_parse_config_or_die;
 168         w->free_config = file_write_free_config;
 169         w->close = file_write_close;
 170         w->shutdown = NULL; /* nothing to do */
 171         w->help = (struct ggo_help) {
 172                 .short_help = file_write_args_info_help,
 173                 .detailed_help = file_write_args_info_detailed_help
 174         };
 175         file_cmdline_parser_free(&dummy);
 176 }