backend/runloop.c

   1 /*
   2  * "$Id: runloop.c 7895 2008-09-02 19:19:43Z mike $"
   3  *
   4  *   Common run loop APIs for the Common UNIX Printing System (CUPS).
   5  *
   6  *   Copyright 2007-2009 by Apple Inc.
   7  *   Copyright 2006-2007 by Easy Software Products, all rights reserved.
   8  *
   9  *   These coded instructions, statements, and computer programs are the
  10  *   property of Apple Inc. and are protected by Federal copyright
  11  *   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12  *   "LICENSE" which should have been included with this file.  If this
  13  *   file is missing or damaged, see the license at "http://www.cups.org/".
  14  *
  15  *   This file is subject to the Apple OS-Developed Software exception.
  16  *
  17  * Contents:
  18  *
  19  *   backendDrainOutput() - Drain pending print data to the device.
  20  *   backendRunLoop()     - Read and write print and back-channel data.
  21  */
  22
  23 /*
  24  * Include necessary headers.
  25  */
  26
  27 #include "backend-private.h"
  28 #include <limits.h>
  29 #ifdef __hpux
  30 #  include <sys/time.h>
  31 #else
  32 #  include <sys/select.h>
  33 #endif /* __hpux */
  34
  35
  36 /*
  37  * 'backendDrainOutput()' - Drain pending print data to the device.
  38  */
  39
  40 int                                     /* O - 0 on success, -1 on error */
  41 backendDrainOutput(int print_fd,        /* I - Print file descriptor */
  42                    int device_fd)       /* I - Device file descriptor */
  43 {
  44   int           nfds;                   /* Maximum file descriptor value + 1 */
  45   fd_set        input;                  /* Input set for reading */
  46   ssize_t       print_bytes,            /* Print bytes read */
  47                 bytes;                  /* Bytes written */
  48   char          print_buffer[8192],     /* Print data buffer */
  49                 *print_ptr;             /* Pointer into print data buffer */
  50   struct timeval timeout;               /* Timeout for read... */
  51
  52
  53   fprintf(stderr, "DEBUG: backendDrainOutput(print_fd=%d, device_fd=%d)\n",
  54           print_fd, device_fd);
  55
  56  /*
  57   * Figure out the maximum file descriptor value to use with select()...
  58   */
  59
  60   nfds = (print_fd > device_fd ? print_fd : device_fd) + 1;
  61
  62  /*
  63   * Now loop until we are out of data from print_fd...
  64   */
  65
  66   for (;;)
  67   {
  68    /*
  69     * Use select() to determine whether we have data to copy around...
  70     */
  71
  72     FD_ZERO(&input);
  73     FD_SET(print_fd, &input);
  74
  75     timeout.tv_sec  = 0;
  76     timeout.tv_usec = 0;
  77
  78     if (select(nfds, &input, NULL, NULL, &timeout) < 0)
  79       return (-1);
  80
  81     if (!FD_ISSET(print_fd, &input))
  82       return (0);
  83
  84     if ((print_bytes = read(print_fd, print_buffer,
  85                             sizeof(print_buffer))) < 0)
  86     {
  87      /*
  88       * Read error - bail if we don't see EAGAIN or EINTR...
  89       */
  90
  91       if (errno != EAGAIN || errno != EINTR)
  92       {
  93         perror("ERROR: Unable to read print data");
  94         return (-1);
  95       }
  96
  97       print_bytes = 0;
  98     }
  99     else if (print_bytes == 0)
 100     {
 101      /*
 102       * End of file, return...
 103       */
 104
 105       return (0);
 106     }
 107
 108     fprintf(stderr, "DEBUG: Read %d bytes of print data...\n",
 109             (int)print_bytes);
 110
 111     for (print_ptr = print_buffer; print_bytes > 0;)
 112     {
 113       if ((bytes = write(device_fd, print_ptr, print_bytes)) < 0)
 114       {
 115        /*
 116         * Write error - bail if we don't see an error we can retry...
 117         */
 118
 119         if (errno != ENOSPC && errno != ENXIO && errno != EAGAIN &&
 120             errno != EINTR && errno != ENOTTY)
 121         {
 122           _cupsLangPrintf(stderr, _("ERROR: Unable to write print data: %s\n"),
 123                           strerror(errno));
 124           return (-1);
 125         }
 126       }
 127       else
 128       {
 129         fprintf(stderr, "DEBUG: Wrote %d bytes of print data...\n", (int)bytes);
 130
 131         print_bytes -= bytes;
 132         print_ptr   += bytes;
 133       }
 134     }
 135   }
 136 }
 137
 138
 139 /*
 140  * 'backendRunLoop()' - Read and write print and back-channel data.
 141  */
 142
 143 ssize_t                                 /* O - Total bytes on success, -1 on error */
 144 backendRunLoop(
 145     int         print_fd,               /* I - Print file descriptor */
 146     int         device_fd,              /* I - Device file descriptor */
 147     int         snmp_fd,                /* I - SNMP socket or -1 if none */
 148     http_addr_t *addr,                  /* I - Address of device */
 149     int         use_bc,                 /* I - Use back-channel? */
 150     int         update_state,           /* I - Update printer-state-reasons? */
 151     int         (*side_cb)(int, int, int, http_addr_t *, int))
 152                                         /* I - Side-channel callback */
 153 {
 154   int           nfds;                   /* Maximum file descriptor value + 1 */
 155   fd_set        input,                  /* Input set for reading */
 156                 output;                 /* Output set for writing */
 157   ssize_t       print_bytes,            /* Print bytes read */
 158                 bc_bytes,               /* Backchannel bytes read */
 159                 total_bytes,            /* Total bytes written */
 160                 bytes;                  /* Bytes written */
 161   int           paperout;               /* "Paper out" status */
 162   int           offline;                /* "Off-line" status */
 163   char          print_buffer[8192],     /* Print data buffer */
 164                 *print_ptr,             /* Pointer into print data buffer */
 165                 bc_buffer[1024];        /* Back-channel data buffer */
 166   struct timeval timeout;               /* Timeout for select() */
 167   time_t        curtime,                /* Current time */
 168                 snmp_update = 0;
 169 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
 170   struct sigaction action;              /* Actions for POSIX signals */
 171 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
 172
 173
 174   fprintf(stderr,
 175           "DEBUG: backendRunLoop(print_fd=%d, device_fd=%d, snmp_fd=%d, "
 176           "addr=%p, use_bc=%d, side_cb=%p)\n",
 177           print_fd, device_fd, snmp_fd, addr, use_bc, side_cb);
 178
 179  /*
 180   * If we are printing data from a print driver on stdin, ignore SIGTERM
 181   * so that the driver can finish out any page data, e.g. to eject the
 182   * current page.  We only do this for stdin printing as otherwise there
 183   * is no way to cancel a raw print job...
 184   */
 185
 186   if (!print_fd)
 187   {
 188 #ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
 189     sigset(SIGTERM, SIG_IGN);
 190 #elif defined(HAVE_SIGACTION)
 191     memset(&action, 0, sizeof(action));
 192
 193     sigemptyset(&action.sa_mask);
 194     action.sa_handler = SIG_IGN;
 195     sigaction(SIGTERM, &action, NULL);
 196 #else
 197     signal(SIGTERM, SIG_IGN);
 198 #endif /* HAVE_SIGSET */
 199   }
 200   else if (print_fd < 0)
 201   {
 202    /*
 203     * Copy print data from stdin, but don't mess with the signal handlers...
 204     */
 205
 206     print_fd = 0;
 207   }
 208
 209  /*
 210   * Figure out the maximum file descriptor value to use with select()...
 211   */
 212
 213   nfds = (print_fd > device_fd ? print_fd : device_fd) + 1;
 214
 215  /*
 216   * Now loop until we are out of data from print_fd...
 217   */
 218
 219   for (print_bytes = 0, print_ptr = print_buffer, offline = -1,
 220            paperout = -1, total_bytes = 0;;)
 221   {
 222    /*
 223     * Use select() to determine whether we have data to copy around...
 224     */
 225
 226     FD_ZERO(&input);
 227     if (!print_bytes)
 228       FD_SET(print_fd, &input);
 229     if (use_bc)
 230       FD_SET(device_fd, &input);
 231     if (!print_bytes && side_cb)
 232       FD_SET(CUPS_SC_FD, &input);
 233
 234     FD_ZERO(&output);
 235     if (print_bytes || (!use_bc && !side_cb))
 236       FD_SET(device_fd, &output);
 237
 238     if (use_bc || side_cb)
 239     {
 240       timeout.tv_sec  = 5;
 241       timeout.tv_usec = 0;
 242
 243       if (select(nfds, &input, &output, NULL, &timeout) < 0)
 244       {
 245        /*
 246         * Pause printing to clear any pending errors...
 247         */
 248
 249         if (errno == ENXIO && offline != 1 && update_state)
 250         {
 251           fputs("STATE: +offline-report\n", stderr);
 252           _cupsLangPuts(stderr, _("INFO: Printer is currently offline.\n"));
 253           offline = 1;
 254         }
 255         else if (errno == EINTR && total_bytes == 0)
 256         {
 257           fputs("DEBUG: Received an interrupt before any bytes were "
 258                 "written, aborting\n", stderr);
 259           return (0);
 260         }
 261
 262         sleep(1);
 263         continue;
 264       }
 265     }
 266
 267    /*
 268     * Check if we have a side-channel request ready...
 269     */
 270
 271     if (side_cb && FD_ISSET(CUPS_SC_FD, &input))
 272     {
 273      /*
 274       * Do the side-channel request, then start back over in the select
 275       * loop since it may have read from print_fd...
 276       */
 277
 278       if ((*side_cb)(print_fd, device_fd, snmp_fd, addr, use_bc))
 279         side_cb = NULL;
 280       continue;
 281     }
 282
 283    /*
 284     * Check if we have back-channel data ready...
 285     */
 286
 287     if (FD_ISSET(device_fd, &input))
 288     {
 289       if ((bc_bytes = read(device_fd, bc_buffer, sizeof(bc_buffer))) > 0)
 290       {
 291         fprintf(stderr,
 292                 "DEBUG: Received " CUPS_LLFMT " bytes of back-channel data\n",
 293                 CUPS_LLCAST bc_bytes);
 294         cupsBackChannelWrite(bc_buffer, bc_bytes, 1.0);
 295       }
 296       else if (bc_bytes < 0 && errno != EAGAIN && errno != EINTR)
 297       {
 298         fprintf(stderr, "DEBUG: Error reading back-channel data: %s\n",
 299                 strerror(errno));
 300         use_bc = 0;
 301       }
 302     }
 303
 304    /*
 305     * Check if we have print data ready...
 306     */
 307
 308     if (FD_ISSET(print_fd, &input))
 309     {
 310       if ((print_bytes = read(print_fd, print_buffer,
 311                               sizeof(print_buffer))) < 0)
 312       {
 313        /*
 314         * Read error - bail if we don't see EAGAIN or EINTR...
 315         */
 316
 317         if (errno != EAGAIN || errno != EINTR)
 318         {
 319           perror("ERROR: Unable to read print data");
 320           return (-1);
 321         }
 322
 323         print_bytes = 0;
 324       }
 325       else if (print_bytes == 0)
 326       {
 327        /*
 328         * End of file, break out of the loop...
 329         */
 330
 331         break;
 332       }
 333
 334       print_ptr = print_buffer;
 335
 336       fprintf(stderr, "DEBUG: Read %d bytes of print data...\n",
 337               (int)print_bytes);
 338     }
 339
 340    /*
 341     * Check if the device is ready to receive data and we have data to
 342     * send...
 343     */
 344
 345     if (print_bytes && FD_ISSET(device_fd, &output))
 346     {
 347       if ((bytes = write(device_fd, print_ptr, print_bytes)) < 0)
 348       {
 349        /*
 350         * Write error - bail if we don't see an error we can retry...
 351         */
 352
 353         if (errno == ENOSPC)
 354         {
 355           if (paperout != 1 && update_state)
 356           {
 357             fputs("STATE: +media-empty-warning\n", stderr);
 358             _cupsLangPuts(stderr, _("ERROR: Out of paper\n"));
 359             paperout = 1;
 360           }
 361         }
 362         else if (errno == ENXIO)
 363         {
 364           if (offline != 1 && update_state)
 365           {
 366             fputs("STATE: +offline-report\n", stderr);
 367             _cupsLangPuts(stderr, _("INFO: Printer is currently off-line.\n"));
 368             offline = 1;
 369           }
 370         }
 371         else if (errno != EAGAIN && errno != EINTR && errno != ENOTTY)
 372         {
 373           fprintf(stderr, _("ERROR: Unable to write print data: %s\n"),
 374                   strerror(errno));
 375           return (-1);
 376         }
 377       }
 378       else
 379       {
 380         if (paperout && update_state)
 381         {
 382           fputs("STATE: -media-empty-warning\n", stderr);
 383           paperout = 0;
 384         }
 385
 386         if (offline && update_state)
 387         {
 388           fputs("STATE: -offline-report\n", stderr);
 389           _cupsLangPuts(stderr, _("INFO: Printer is now online.\n"));
 390           offline = 0;
 391         }
 392
 393         fprintf(stderr, "DEBUG: Wrote %d bytes of print data...\n", (int)bytes);
 394
 395         print_bytes -= bytes;
 396         print_ptr   += bytes;
 397         total_bytes += bytes;
 398       }
 399     }
 400
 401    /*
 402     * Do SNMP updates periodically...
 403     */
 404
 405     if (snmp_fd >= 0 && time(&curtime) >= snmp_update)
 406     {
 407       if (backendSNMPSupplies(snmp_fd, addr, NULL, NULL))
 408         snmp_update = INT_MAX;
 409       else
 410         snmp_update = curtime + 5;
 411     }
 412   }
 413
 414  /*
 415   * Return with success...
 416   */
 417
 418   return (total_bytes);
 419 }
 420
 421
 422 /*
 423  * End of "$Id: runloop.c 7895 2008-09-02 19:19:43Z mike $".
 424  */