docs/examples/evhiperfifo.c

   1 /***************************************************************************
   2  *                                  _   _ ____  _
   3  *  Project                     ___| | | |  _ \| |
   4  *                             / __| | | | |_) | |
   5  *                            | (__| |_| |  _ <| |___
   6  *                             \___|\___/|_| \_\_____|
   7  *
   8  * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
   9  *
  10  * This software is licensed as described in the file COPYING, which
  11  * you should have received as part of this distribution. The terms
  12  * are also available at http://curl.haxx.se/docs/copyright.html.
  13  *
  14  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15  * copies of the Software, and permit persons to whom the Software is
  16  * furnished to do so, under the terms of the COPYING file.
  17  *
  18  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19  * KIND, either express or implied.
  20  *
  21  ***************************************************************************/
  22 /* <DESC>
  23  * multi socket interface together with libev
  24  * </DESC>
  25  */
  26 /* Example application source code using the multi socket interface to
  27  * download many files at once.
  28  *
  29  * This example features the same basic functionality as hiperfifo.c does,
  30  * but this uses libev instead of libevent.
  31  *
  32  * Written by Jeff Pohlmeyer, converted to use libev by Markus Koetter
  33
  34 Requires libev and a (POSIX?) system that has mkfifo().
  35
  36 This is an adaptation of libcurl's "hipev.c" and libevent's "event-test.c"
  37 sample programs.
  38
  39 When running, the program creates the named pipe "hiper.fifo"
  40
  41 Whenever there is input into the fifo, the program reads the input as a list
  42 of URL's and creates some new easy handles to fetch each URL via the
  43 curl_multi "hiper" API.
  44
  45
  46 Thus, you can try a single URL:
  47   % echo http://www.yahoo.com > hiper.fifo
  48
  49 Or a whole bunch of them:
  50   % cat my-url-list > hiper.fifo
  51
  52 The fifo buffer is handled almost instantly, so you can even add more URL's
  53 while the previous requests are still being downloaded.
  54
  55 Note:
  56   For the sake of simplicity, URL length is limited to 1023 char's !
  57
  58 This is purely a demo app, all retrieved data is simply discarded by the write
  59 callback.
  60
  61 */
  62
  63 #include <stdio.h>
  64 #include <string.h>
  65 #include <stdlib.h>
  66 #include <sys/time.h>
  67 #include <time.h>
  68 #include <unistd.h>
  69 #include <sys/poll.h>
  70 #include <curl/curl.h>
  71 #include <ev.h>
  72 #include <fcntl.h>
  73 #include <sys/stat.h>
  74 #include <errno.h>
  75
  76 #define DPRINT(x...) printf(x)
  77
  78 #define MSG_OUT stdout /* Send info to stdout, change to stderr if you want */
  79
  80
  81 /* Global information, common to all connections */
  82 typedef struct _GlobalInfo
  83 {
  84   struct ev_loop *loop;
  85   struct ev_io fifo_event;
  86   struct ev_timer timer_event;
  87   CURLM *multi;
  88   int still_running;
  89   FILE* input;
  90 } GlobalInfo;
  91
  92
  93 /* Information associated with a specific easy handle */
  94 typedef struct _ConnInfo
  95 {
  96   CURL *easy;
  97   char *url;
  98   GlobalInfo *global;
  99   char error[CURL_ERROR_SIZE];
 100 } ConnInfo;
 101
 102
 103 /* Information associated with a specific socket */
 104 typedef struct _SockInfo
 105 {
 106   curl_socket_t sockfd;
 107   CURL *easy;
 108   int action;
 109   long timeout;
 110   struct ev_io ev;
 111   int evset;
 112   GlobalInfo *global;
 113 } SockInfo;
 114
 115 static void timer_cb(EV_P_ struct ev_timer *w, int revents);
 116
 117 /* Update the event timer after curl_multi library calls */
 118 static int multi_timer_cb(CURLM *multi, long timeout_ms, GlobalInfo *g)
 119 {
 120   DPRINT("%s %li\n", __PRETTY_FUNCTION__,  timeout_ms);
 121   ev_timer_stop(g->loop, &g->timer_event);
 122   if (timeout_ms > 0)
 123   {
 124     double  t = timeout_ms / 1000;
 125     ev_timer_init(&g->timer_event, timer_cb, t, 0.);
 126     ev_timer_start(g->loop, &g->timer_event);
 127   }else
 128     timer_cb(g->loop, &g->timer_event, 0);
 129   return 0;
 130 }
 131
 132 /* Die if we get a bad CURLMcode somewhere */
 133 static void mcode_or_die(const char *where, CURLMcode code)
 134 {
 135   if ( CURLM_OK != code )
 136   {
 137     const char *s;
 138     switch ( code )
 139     {
 140     case CURLM_BAD_HANDLE:         s="CURLM_BAD_HANDLE";         break;
 141     case CURLM_BAD_EASY_HANDLE:    s="CURLM_BAD_EASY_HANDLE";    break;
 142     case CURLM_OUT_OF_MEMORY:      s="CURLM_OUT_OF_MEMORY";      break;
 143     case CURLM_INTERNAL_ERROR:     s="CURLM_INTERNAL_ERROR";     break;
 144     case CURLM_UNKNOWN_OPTION:     s="CURLM_UNKNOWN_OPTION";     break;
 145     case CURLM_LAST:               s="CURLM_LAST";               break;
 146     default: s="CURLM_unknown";
 147       break;
 148     case     CURLM_BAD_SOCKET:         s="CURLM_BAD_SOCKET";
 149       fprintf(MSG_OUT, "ERROR: %s returns %s\n", where, s);
 150       /* ignore this error */
 151       return;
 152     }
 153     fprintf(MSG_OUT, "ERROR: %s returns %s\n", where, s);
 154     exit(code);
 155   }
 156 }
 157
 158
 159
 160 /* Check for completed transfers, and remove their easy handles */
 161 static void check_multi_info(GlobalInfo *g)
 162 {
 163   char *eff_url;
 164   CURLMsg *msg;
 165   int msgs_left;
 166   ConnInfo *conn;
 167   CURL *easy;
 168   CURLcode res;
 169
 170   fprintf(MSG_OUT, "REMAINING: %d\n", g->still_running);
 171   while ((msg = curl_multi_info_read(g->multi, &msgs_left))) {
 172     if (msg->msg == CURLMSG_DONE) {
 173       easy = msg->easy_handle;
 174       res = msg->data.result;
 175       curl_easy_getinfo(easy, CURLINFO_PRIVATE, &conn);
 176       curl_easy_getinfo(easy, CURLINFO_EFFECTIVE_URL, &eff_url);
 177       fprintf(MSG_OUT, "DONE: %s => (%d) %s\n", eff_url, res, conn->error);
 178       curl_multi_remove_handle(g->multi, easy);
 179       free(conn->url);
 180       curl_easy_cleanup(easy);
 181       free(conn);
 182     }
 183   }
 184 }
 185
 186
 187
 188 /* Called by libevent when we get action on a multi socket */
 189 static void event_cb(EV_P_ struct ev_io *w, int revents)
 190 {
 191   DPRINT("%s  w %p revents %i\n", __PRETTY_FUNCTION__, w, revents);
 192   GlobalInfo *g = (GlobalInfo*) w->data;
 193   CURLMcode rc;
 194
 195   int action = (revents&EV_READ?CURL_POLL_IN:0)|
 196     (revents&EV_WRITE?CURL_POLL_OUT:0);
 197   rc = curl_multi_socket_action(g->multi, w->fd, action, &g->still_running);
 198   mcode_or_die("event_cb: curl_multi_socket_action", rc);
 199   check_multi_info(g);
 200   if ( g->still_running <= 0 )
 201   {
 202     fprintf(MSG_OUT, "last transfer done, kill timeout\n");
 203     ev_timer_stop(g->loop, &g->timer_event);
 204   }
 205 }
 206
 207 /* Called by libevent when our timeout expires */
 208 static void timer_cb(EV_P_ struct ev_timer *w, int revents)
 209 {
 210   DPRINT("%s  w %p revents %i\n", __PRETTY_FUNCTION__, w, revents);
 211
 212   GlobalInfo *g = (GlobalInfo *)w->data;
 213   CURLMcode rc;
 214
 215   rc = curl_multi_socket_action(g->multi, CURL_SOCKET_TIMEOUT, 0, &g->still_running);
 216   mcode_or_die("timer_cb: curl_multi_socket_action", rc);
 217   check_multi_info(g);
 218 }
 219
 220 /* Clean up the SockInfo structure */
 221 static void remsock(SockInfo *f, GlobalInfo *g)
 222 {
 223   printf("%s  \n", __PRETTY_FUNCTION__);
 224   if ( f )
 225   {
 226     if ( f->evset )
 227       ev_io_stop(g->loop, &f->ev);
 228     free(f);
 229   }
 230 }
 231
 232
 233
 234 /* Assign information to a SockInfo structure */
 235 static void setsock(SockInfo*f, curl_socket_t s, CURL*e, int act, GlobalInfo*g)
 236 {
 237   printf("%s  \n", __PRETTY_FUNCTION__);
 238
 239   int kind = (act&CURL_POLL_IN?EV_READ:0)|(act&CURL_POLL_OUT?EV_WRITE:0);
 240
 241   f->sockfd = s;
 242   f->action = act;
 243   f->easy = e;
 244   if ( f->evset )
 245     ev_io_stop(g->loop, &f->ev);
 246   ev_io_init(&f->ev, event_cb, f->sockfd, kind);
 247   f->ev.data = g;
 248   f->evset=1;
 249   ev_io_start(g->loop, &f->ev);
 250 }
 251
 252
 253
 254 /* Initialize a new SockInfo structure */
 255 static void addsock(curl_socket_t s, CURL *easy, int action, GlobalInfo *g)
 256 {
 257   SockInfo *fdp = calloc(sizeof(SockInfo), 1);
 258
 259   fdp->global = g;
 260   setsock(fdp, s, easy, action, g);
 261   curl_multi_assign(g->multi, s, fdp);
 262 }
 263
 264 /* CURLMOPT_SOCKETFUNCTION */
 265 static int sock_cb(CURL *e, curl_socket_t s, int what, void *cbp, void *sockp)
 266 {
 267   DPRINT("%s e %p s %i what %i cbp %p sockp %p\n",
 268          __PRETTY_FUNCTION__, e, s, what, cbp, sockp);
 269
 270   GlobalInfo *g = (GlobalInfo*) cbp;
 271   SockInfo *fdp = (SockInfo*) sockp;
 272   const char *whatstr[]={ "none", "IN", "OUT", "INOUT", "REMOVE"};
 273
 274   fprintf(MSG_OUT,
 275           "socket callback: s=%d e=%p what=%s ", s, e, whatstr[what]);
 276   if ( what == CURL_POLL_REMOVE )
 277   {
 278     fprintf(MSG_OUT, "\n");
 279     remsock(fdp, g);
 280   } else
 281   {
 282     if ( !fdp )
 283     {
 284       fprintf(MSG_OUT, "Adding data: %s\n", whatstr[what]);
 285       addsock(s, e, what, g);
 286     } else
 287     {
 288       fprintf(MSG_OUT,
 289               "Changing action from %s to %s\n",
 290               whatstr[fdp->action], whatstr[what]);
 291       setsock(fdp, s, e, what, g);
 292     }
 293   }
 294   return 0;
 295 }
 296
 297
 298 /* CURLOPT_WRITEFUNCTION */
 299 static size_t write_cb(void *ptr, size_t size, size_t nmemb, void *data)
 300 {
 301   size_t realsize = size * nmemb;
 302   ConnInfo *conn = (ConnInfo*) data;
 303   (void)ptr;
 304   (void)conn;
 305   return realsize;
 306 }
 307
 308
 309 /* CURLOPT_PROGRESSFUNCTION */
 310 static int prog_cb (void *p, double dltotal, double dlnow, double ult,
 311                     double uln)
 312 {
 313   ConnInfo *conn = (ConnInfo *)p;
 314   (void)ult;
 315   (void)uln;
 316
 317   fprintf(MSG_OUT, "Progress: %s (%g/%g)\n", conn->url, dlnow, dltotal);
 318   return 0;
 319 }
 320
 321
 322 /* Create a new easy handle, and add it to the global curl_multi */
 323 static void new_conn(char *url, GlobalInfo *g )
 324 {
 325   ConnInfo *conn;
 326   CURLMcode rc;
 327
 328   conn = calloc(1, sizeof(ConnInfo));
 329   memset(conn, 0, sizeof(ConnInfo));
 330   conn->error[0]='\0';
 331
 332   conn->easy = curl_easy_init();
 333   if ( !conn->easy )
 334   {
 335     fprintf(MSG_OUT, "curl_easy_init() failed, exiting!\n");
 336     exit(2);
 337   }
 338   conn->global = g;
 339   conn->url = strdup(url);
 340   curl_easy_setopt(conn->easy, CURLOPT_URL, conn->url);
 341   curl_easy_setopt(conn->easy, CURLOPT_WRITEFUNCTION, write_cb);
 342   curl_easy_setopt(conn->easy, CURLOPT_WRITEDATA, conn);
 343   curl_easy_setopt(conn->easy, CURLOPT_VERBOSE, 1L);
 344   curl_easy_setopt(conn->easy, CURLOPT_ERRORBUFFER, conn->error);
 345   curl_easy_setopt(conn->easy, CURLOPT_PRIVATE, conn);
 346   curl_easy_setopt(conn->easy, CURLOPT_NOPROGRESS, 0L);
 347   curl_easy_setopt(conn->easy, CURLOPT_PROGRESSFUNCTION, prog_cb);
 348   curl_easy_setopt(conn->easy, CURLOPT_PROGRESSDATA, conn);
 349   curl_easy_setopt(conn->easy, CURLOPT_LOW_SPEED_TIME, 3L);
 350   curl_easy_setopt(conn->easy, CURLOPT_LOW_SPEED_LIMIT, 10L);
 351
 352   fprintf(MSG_OUT,
 353           "Adding easy %p to multi %p (%s)\n", conn->easy, g->multi, url);
 354   rc = curl_multi_add_handle(g->multi, conn->easy);
 355   mcode_or_die("new_conn: curl_multi_add_handle", rc);
 356
 357   /* note that the add_handle() will set a time-out to trigger very soon so
 358      that the necessary socket_action() call will be called by this app */
 359 }
 360
 361 /* This gets called whenever data is received from the fifo */
 362 static void fifo_cb(EV_P_ struct ev_io *w, int revents)
 363 {
 364   char s[1024];
 365   long int rv=0;
 366   int n=0;
 367   GlobalInfo *g = (GlobalInfo *)w->data;
 368
 369   do
 370   {
 371     s[0]='\0';
 372     rv=fscanf(g->input, "%1023s%n", s, &n);
 373     s[n]='\0';
 374     if ( n && s[0] )
 375     {
 376       new_conn(s,g);  /* if we read a URL, go get it! */
 377     } else break;
 378   } while ( rv != EOF );
 379 }
 380
 381 /* Create a named pipe and tell libevent to monitor it */
 382 static int init_fifo (GlobalInfo *g)
 383 {
 384   struct stat st;
 385   static const char *fifo = "hiper.fifo";
 386   curl_socket_t sockfd;
 387
 388   fprintf(MSG_OUT, "Creating named pipe \"%s\"\n", fifo);
 389   if ( lstat (fifo, &st) == 0 )
 390   {
 391     if ( (st.st_mode & S_IFMT) == S_IFREG )
 392     {
 393       errno = EEXIST;
 394       perror("lstat");
 395       exit (1);
 396     }
 397   }
 398   unlink(fifo);
 399   if ( mkfifo (fifo, 0600) == -1 )
 400   {
 401     perror("mkfifo");
 402     exit (1);
 403   }
 404   sockfd = open(fifo, O_RDWR | O_NONBLOCK, 0);
 405   if ( sockfd == -1 )
 406   {
 407     perror("open");
 408     exit (1);
 409   }
 410   g->input = fdopen(sockfd, "r");
 411
 412   fprintf(MSG_OUT, "Now, pipe some URL's into > %s\n", fifo);
 413   ev_io_init(&g->fifo_event, fifo_cb, sockfd, EV_READ);
 414   ev_io_start(g->loop, &g->fifo_event);
 415   return(0);
 416 }
 417
 418 int main(int argc, char **argv)
 419 {
 420   GlobalInfo g;
 421   CURLMcode rc;
 422   (void)argc;
 423   (void)argv;
 424
 425   memset(&g, 0, sizeof(GlobalInfo));
 426   g.loop = ev_default_loop(0);
 427
 428   init_fifo(&g);
 429   g.multi = curl_multi_init();
 430
 431   ev_timer_init(&g.timer_event, timer_cb, 0., 0.);
 432   g.timer_event.data = &g;
 433   g.fifo_event.data = &g;
 434   curl_multi_setopt(g.multi, CURLMOPT_SOCKETFUNCTION, sock_cb);
 435   curl_multi_setopt(g.multi, CURLMOPT_SOCKETDATA, &g);
 436   curl_multi_setopt(g.multi, CURLMOPT_TIMERFUNCTION, multi_timer_cb);
 437   curl_multi_setopt(g.multi, CURLMOPT_TIMERDATA, &g);
 438
 439   /* we don't call any curl_multi_socket*() function yet as we have no handles
 440      added! */
 441
 442   ev_loop(g.loop, 0);
 443   curl_multi_cleanup(g.multi);
 444   return 0;
 445 }