backend/runloop.c

   1 /*
   2  * "$Id: runloop.c 10369 2012-03-21 04:31:19Z mike $"
   3  *
   4  *   Common run loop APIs for CUPS backends.
   5  *
   6  *   Copyright 2007-2012 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  *   backendWaitLoop()    - Wait for input from stdin while handling
  22  *                          side-channel queries.
  23  */
  24
  25 /*
  26  * Include necessary headers.
  27  */
  28
  29 #include "backend-private.h"
  30 #include <limits.h>
  31 #ifdef __hpux
  32 #  include <sys/time.h>
  33 #else
  34 #  include <sys/select.h>
  35 #endif /* __hpux */
  36
  37
  38 /*
  39  * 'backendDrainOutput()' - Drain pending print data to the device.
  40  */
  41
  42 int                                     /* O - 0 on success, -1 on error */
  43 backendDrainOutput(int print_fd,        /* I - Print file descriptor */
  44                    int device_fd)       /* I - Device file descriptor */
  45 {
  46   int           nfds;                   /* Maximum file descriptor value + 1 */
  47   fd_set        input;                  /* Input set for reading */
  48   ssize_t       print_bytes,            /* Print bytes read */
  49                 bytes;                  /* Bytes written */
  50   char          print_buffer[8192],     /* Print data buffer */
  51                 *print_ptr;             /* Pointer into print data buffer */
  52   struct timeval timeout;               /* Timeout for read... */
  53
  54
  55   fprintf(stderr, "DEBUG: backendDrainOutput(print_fd=%d, device_fd=%d)\n",
  56           print_fd, device_fd);
  57
  58  /*
  59   * Figure out the maximum file descriptor value to use with select()...
  60   */
  61
  62   nfds = (print_fd > device_fd ? print_fd : device_fd) + 1;
  63
  64  /*
  65   * Now loop until we are out of data from print_fd...
  66   */
  67
  68   for (;;)
  69   {
  70    /*
  71     * Use select() to determine whether we have data to copy around...
  72     */
  73
  74     FD_ZERO(&input);
  75     FD_SET(print_fd, &input);
  76
  77     timeout.tv_sec  = 0;
  78     timeout.tv_usec = 0;
  79
  80     if (select(nfds, &input, NULL, NULL, &timeout) < 0)
  81       return (-1);
  82
  83     if (!FD_ISSET(print_fd, &input))
  84       return (0);
  85
  86     if ((print_bytes = read(print_fd, print_buffer,
  87                             sizeof(print_buffer))) < 0)
  88     {
  89      /*
  90       * Read error - bail if we don't see EAGAIN or EINTR...
  91       */
  92
  93       if (errno != EAGAIN || errno != EINTR)
  94       {
  95         _cupsLangPrintError("ERROR", _("Unable to read print data"));
  96         return (-1);
  97       }
  98
  99       print_bytes = 0;
 100     }
 101     else if (print_bytes == 0)
 102     {
 103      /*
 104       * End of file, return...
 105       */
 106
 107       return (0);
 108     }
 109
 110     fprintf(stderr, "DEBUG: Read %d bytes of print data...\n",
 111             (int)print_bytes);
 112
 113     for (print_ptr = print_buffer; print_bytes > 0;)
 114     {
 115       if ((bytes = write(device_fd, print_ptr, print_bytes)) < 0)
 116       {
 117        /*
 118         * Write error - bail if we don't see an error we can retry...
 119         */
 120
 121         if (errno != ENOSPC && errno != ENXIO && errno != EAGAIN &&
 122             errno != EINTR && errno != ENOTTY)
 123         {
 124           _cupsLangPrintError("ERROR", _("Unable to write print data"));
 125           return (-1);
 126         }
 127       }
 128       else
 129       {
 130         fprintf(stderr, "DEBUG: Wrote %d bytes of print data...\n", (int)bytes);
 131
 132         print_bytes -= bytes;
 133         print_ptr   += bytes;
 134       }
 135     }
 136   }
 137 }
 138
 139
 140 /*
 141  * 'backendRunLoop()' - Read and write print and back-channel data.
 142  */
 143
 144 ssize_t                                 /* O - Total bytes on success, -1 on error */
 145 backendRunLoop(
 146     int          print_fd,              /* I - Print file descriptor */
 147     int          device_fd,             /* I - Device file descriptor */
 148     int          snmp_fd,               /* I - SNMP socket or -1 if none */
 149     http_addr_t  *addr,                 /* I - Address of device */
 150     int          use_bc,                /* I - Use back-channel? */
 151     int          update_state,          /* I - Update printer-state-reasons? */
 152     _cups_sccb_t side_cb)               /* 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           _cupsLangPrintFilter(stderr, "INFO",
 253                                _("Printer is not currently connected."));
 254           offline = 1;
 255         }
 256         else if (errno == EINTR && total_bytes == 0)
 257         {
 258           fputs("DEBUG: Received an interrupt before any bytes were "
 259                 "written, aborting.\n", stderr);
 260           return (0);
 261         }
 262
 263         sleep(1);
 264         continue;
 265       }
 266     }
 267
 268    /*
 269     * Check if we have a side-channel request ready...
 270     */
 271
 272     if (side_cb && FD_ISSET(CUPS_SC_FD, &input))
 273     {
 274      /*
 275       * Do the side-channel request, then start back over in the select
 276       * loop since it may have read from print_fd...
 277       */
 278
 279       if ((*side_cb)(print_fd, device_fd, snmp_fd, addr, use_bc))
 280         side_cb = NULL;
 281       continue;
 282     }
 283
 284    /*
 285     * Check if we have back-channel data ready...
 286     */
 287
 288     if (FD_ISSET(device_fd, &input))
 289     {
 290       if ((bc_bytes = read(device_fd, bc_buffer, sizeof(bc_buffer))) > 0)
 291       {
 292         fprintf(stderr,
 293                 "DEBUG: Received " CUPS_LLFMT " bytes of back-channel data\n",
 294                 CUPS_LLCAST bc_bytes);
 295         cupsBackChannelWrite(bc_buffer, bc_bytes, 1.0);
 296       }
 297       else if (bc_bytes < 0 && errno != EAGAIN && errno != EINTR)
 298       {
 299         fprintf(stderr, "DEBUG: Error reading back-channel data: %s\n",
 300                 strerror(errno));
 301         use_bc = 0;
 302       }
 303       else if (bc_bytes == 0)
 304         use_bc = 0;
 305     }
 306
 307    /*
 308     * Check if we have print data ready...
 309     */
 310
 311     if (FD_ISSET(print_fd, &input))
 312     {
 313       if ((print_bytes = read(print_fd, print_buffer,
 314                               sizeof(print_buffer))) < 0)
 315       {
 316        /*
 317         * Read error - bail if we don't see EAGAIN or EINTR...
 318         */
 319
 320         if (errno != EAGAIN || errno != EINTR)
 321         {
 322           _cupsLangPrintError("ERROR", _("Unable to read print data"));
 323           return (-1);
 324         }
 325
 326         print_bytes = 0;
 327       }
 328       else if (print_bytes == 0)
 329       {
 330        /*
 331         * End of file, break out of the loop...
 332         */
 333
 334         break;
 335       }
 336
 337       print_ptr = print_buffer;
 338
 339       fprintf(stderr, "DEBUG: Read %d bytes of print data...\n",
 340               (int)print_bytes);
 341     }
 342
 343    /*
 344     * Check if the device is ready to receive data and we have data to
 345     * send...
 346     */
 347
 348     if (print_bytes && FD_ISSET(device_fd, &output))
 349     {
 350       if ((bytes = write(device_fd, print_ptr, print_bytes)) < 0)
 351       {
 352        /*
 353         * Write error - bail if we don't see an error we can retry...
 354         */
 355
 356         if (errno == ENOSPC)
 357         {
 358           if (paperout != 1 && update_state)
 359           {
 360             fputs("STATE: +media-empty-warning\n", stderr);
 361             fputs("DEBUG: Out of paper\n", stderr);
 362             paperout = 1;
 363           }
 364         }
 365         else if (errno == ENXIO)
 366         {
 367           if (offline != 1 && update_state)
 368           {
 369             fputs("STATE: +offline-report\n", stderr);
 370             _cupsLangPrintFilter(stderr, "INFO",
 371                                  _("Printer is not currently connected."));
 372             offline = 1;
 373           }
 374         }
 375         else if (errno != EAGAIN && errno != EINTR && errno != ENOTTY)
 376         {
 377           _cupsLangPrintError("ERROR", _("Unable to write print data"));
 378           return (-1);
 379         }
 380       }
 381       else
 382       {
 383         if (paperout && update_state)
 384         {
 385           fputs("STATE: -media-empty-warning\n", stderr);
 386           paperout = 0;
 387         }
 388
 389         if (offline && update_state)
 390         {
 391           fputs("STATE: -offline-report\n", stderr);
 392           _cupsLangPrintFilter(stderr, "INFO", _("Printer is now connected."));
 393           offline = 0;
 394         }
 395
 396         fprintf(stderr, "DEBUG: Wrote %d bytes of print data...\n", (int)bytes);
 397
 398         print_bytes -= bytes;
 399         print_ptr   += bytes;
 400         total_bytes += bytes;
 401       }
 402     }
 403
 404    /*
 405     * Do SNMP updates periodically...
 406     */
 407
 408     if (snmp_fd >= 0 && time(&curtime) >= snmp_update)
 409     {
 410       if (backendSNMPSupplies(snmp_fd, addr, NULL, NULL))
 411         snmp_update = INT_MAX;
 412       else
 413         snmp_update = curtime + 5;
 414     }
 415   }
 416
 417  /*
 418   * Return with success...
 419   */
 420
 421   return (total_bytes);
 422 }
 423
 424
 425 /*
 426  * 'backendWaitLoop()' - Wait for input from stdin while handling side-channel
 427  *                       queries.
 428  */
 429
 430 int                                     /* O - 1 if data is ready, 0 if not */
 431 backendWaitLoop(
 432     int          snmp_fd,               /* I - SNMP socket or -1 if none */
 433     http_addr_t  *addr,                 /* I - Address of device */
 434     int          use_bc,                /* I - Use back-channel? */
 435     _cups_sccb_t side_cb)               /* I - Side-channel callback */
 436 {
 437   int                   nfds;           /* Number of file descriptors */
 438   fd_set                input;          /* Input set for reading */
 439   time_t                curtime,        /* Current time */
 440                         snmp_update = 0;/* Last SNMP status update */
 441   struct timeval        timeout;        /* Timeout for select() */
 442
 443
 444   fprintf(stderr, "DEBUG: backendWaitLoop(snmp_fd=%d, addr=%p, side_cb=%p)\n",
 445           snmp_fd, addr, side_cb);
 446
 447  /*
 448   * Now loop until we receive data from stdin...
 449   */
 450
 451   if (snmp_fd >= 0)
 452     snmp_update = time(NULL) + 5;
 453
 454   for (;;)
 455   {
 456    /*
 457     * Use select() to determine whether we have data to copy around...
 458     */
 459
 460     FD_ZERO(&input);
 461     FD_SET(0, &input);
 462     if (side_cb)
 463       FD_SET(CUPS_SC_FD, &input);
 464
 465     if (snmp_fd >= 0)
 466     {
 467       curtime         = time(NULL);
 468       timeout.tv_sec  = curtime >= snmp_update ? 0 : snmp_update - curtime;
 469       timeout.tv_usec = 0;
 470
 471       nfds = select(CUPS_SC_FD + 1, &input, NULL, NULL, &timeout);
 472     }
 473     else
 474       nfds = select(CUPS_SC_FD + 1, &input, NULL, NULL, NULL);
 475
 476     if (nfds < 0)
 477     {
 478      /*
 479       * Pause printing to clear any pending errors...
 480       */
 481
 482       if (errno == EINTR)
 483       {
 484         fputs("DEBUG: Received an interrupt before any bytes were "
 485               "written, aborting.\n", stderr);
 486         return (0);
 487       }
 488
 489       sleep(1);
 490       continue;
 491     }
 492
 493    /*
 494     * Check for input on stdin...
 495     */
 496
 497     if (FD_ISSET(0, &input))
 498       break;
 499
 500    /*
 501     * Check if we have a side-channel request ready...
 502     */
 503
 504     if (side_cb && FD_ISSET(CUPS_SC_FD, &input))
 505     {
 506      /*
 507       * Do the side-channel request, then start back over in the select
 508       * loop since it may have read from print_fd...
 509       */
 510
 511       if ((*side_cb)(0, -1, snmp_fd, addr, use_bc))
 512         side_cb = NULL;
 513       continue;
 514     }
 515
 516    /*
 517     * Do SNMP updates periodically...
 518     */
 519
 520     if (snmp_fd >= 0 && curtime >= snmp_update)
 521     {
 522       if (backendSNMPSupplies(snmp_fd, addr, NULL, NULL))
 523         snmp_fd = -1;
 524       else
 525         snmp_update = curtime + 5;
 526     }
 527   }
 528
 529  /*
 530   * Return with success...
 531   */
 532
 533   return (1);
 534 }
 535
 536
 537 /*
 538  * End of "$Id: runloop.c 10369 2012-03-21 04:31:19Z mike $".
 539  */