4 * Backend test program for CUPS.
6 * Copyright 2007-2012 by Apple Inc.
7 * Copyright 1997-2005 by Easy Software Products, all rights reserved.
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/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * main() - Run the named backend.
20 * sigterm_handler() - Flag when we get SIGTERM.
21 * usage() - Show usage information.
22 * walk_cb() - Show results of cupsSideChannelSNMPWalk...
26 * Include necessary headers.
29 #include <cups/string-private.h>
30 #include <cups/cups.h>
31 #include <cups/sidechannel.h>
42 static int job_canceled
= 0;
49 static void sigterm_handler(int sig
);
50 static void usage(void) __attribute__((noreturn
));
51 static void walk_cb(const char *oid
, const char *data
, int datalen
,
56 * 'main()' - Run the named backend.
60 * testbackend [-s] [-t] device-uri job-id user title copies options [file]
63 int /* O - Exit status */
64 main(int argc
, /* I - Number of command-line args */
65 char *argv
[]) /* I - Command-line arguments */
67 int first_arg
, /* First argument for backend */
68 do_cancel
= 0, /* Simulate a cancel-job via SIGTERM */
69 do_ps
= 0, /* Do PostScript query+test? */
70 do_pcl
= 0, /* Do PCL query+test? */
71 do_side_tests
= 0, /* Test side-channel ops? */
72 do_trickle
= 0, /* Trickle data to backend */
73 do_walk
= 0, /* Do OID lookup (0) or walking (1) */
74 show_log
= 0; /* Show log messages from backends? */
75 const char *oid
= ".1.3.6.1.2.1.43.10.2.1.4.1.1";
76 /* OID to lookup or walk */
77 char scheme
[255], /* Scheme in URI == backend */
78 backend
[1024], /* Backend path */
79 libpath
[1024], /* Path for libcups */
80 *ptr
; /* Pointer into path */
81 const char *serverbin
; /* CUPS_SERVERBIN environment variable */
82 int fd
, /* Temporary file descriptor */
83 back_fds
[2], /* Back-channel pipe */
84 side_fds
[2], /* Side-channel socket */
85 data_fds
[2], /* Data pipe */
86 back_pid
= -1, /* Backend process ID */
87 data_pid
= -1, /* Trickle process ID */
89 status
; /* Exit status */
93 * Get the current directory and point the run-time linker at the "cups"
97 if (getcwd(libpath
, sizeof(libpath
)) &&
98 (ptr
= strrchr(libpath
, '/')) != NULL
&& !strcmp(ptr
, "/backend"))
100 strlcpy(ptr
, "/cups", sizeof(libpath
) - (ptr
- libpath
));
101 if (!access(libpath
, 0))
104 fprintf(stderr
, "Setting DYLD_LIBRARY_PATH to \"%s\".\n", libpath
);
105 setenv("DYLD_LIBRARY_PATH", libpath
, 1);
107 fprintf(stderr
, "Setting LD_LIBRARY_PATH to \"%s\".\n", libpath
);
108 setenv("LD_LIBRARY_PATH", libpath
, 1);
109 #endif /* __APPLE__ */
116 * See if we have side-channel tests to do...
120 argv
[first_arg
] && argv
[first_arg
][0] == '-';
122 if (!strcmp(argv
[first_arg
], "-d"))
124 else if (!strcmp(argv
[first_arg
], "-cancel"))
126 else if (!strcmp(argv
[first_arg
], "-pcl"))
128 else if (!strcmp(argv
[first_arg
], "-ps"))
130 else if (!strcmp(argv
[first_arg
], "-s"))
132 else if (!strcmp(argv
[first_arg
], "-t"))
134 else if (!strcmp(argv
[first_arg
], "-get") && (first_arg
+ 1) < argc
)
139 oid
= argv
[first_arg
];
141 else if (!strcmp(argv
[first_arg
], "-walk") && (first_arg
+ 1) < argc
)
147 oid
= argv
[first_arg
];
153 if (argc
< 6 || argc
> 7 || (argc
== 7 && do_trickle
))
157 * Extract the scheme from the device-uri - that's the program we want to
161 if (sscanf(argv
[first_arg
], "%254[^:]", scheme
) != 1)
163 fputs("testbackend: Bad device-uri - no colon!\n", stderr
);
167 if (!access(scheme
, X_OK
))
168 strlcpy(backend
, scheme
, sizeof(backend
));
171 if ((serverbin
= getenv("CUPS_SERVERBIN")) == NULL
)
172 serverbin
= CUPS_SERVERBIN
;
174 snprintf(backend
, sizeof(backend
), "%s/backend/%s", serverbin
, scheme
);
175 if (access(backend
, X_OK
))
177 fprintf(stderr
, "testbackend: Unknown device scheme \"%s\"!\n", scheme
);
183 * Create the back-channel pipe and side-channel socket...
186 open("/dev/null", O_WRONLY
); /* Make sure fd 3 and 4 are used */
187 open("/dev/null", O_WRONLY
);
190 fcntl(back_fds
[0], F_SETFL
, fcntl(back_fds
[0], F_GETFL
) | O_NONBLOCK
);
191 fcntl(back_fds
[1], F_SETFL
, fcntl(back_fds
[1], F_GETFL
) | O_NONBLOCK
);
193 socketpair(AF_LOCAL
, SOCK_STREAM
, 0, side_fds
);
194 fcntl(side_fds
[0], F_SETFL
, fcntl(side_fds
[0], F_GETFL
) | O_NONBLOCK
);
195 fcntl(side_fds
[1], F_SETFL
, fcntl(side_fds
[1], F_GETFL
) | O_NONBLOCK
);
198 * Execute the trickle process as needed...
201 if (do_trickle
|| do_pcl
|| do_ps
|| do_cancel
)
205 signal(SIGTERM
, sigterm_handler
);
207 if ((data_pid
= fork()) == 0)
210 * Trickle/query child comes here. Rearrange file descriptors so that
211 * FD 1, 3, and 4 point to the backend...
214 if ((fd
= open("/dev/null", O_RDONLY
)) != 0)
220 if (data_fds
[1] != 1)
222 dup2(data_fds
[1], 1);
227 if (back_fds
[0] != 3)
229 dup2(back_fds
[0], 3);
234 if (side_fds
[0] != 4)
236 dup2(side_fds
[0], 4);
244 * Write 10 spaces, 1 per second...
247 int i
; /* Looping var */
249 for (i
= 0; i
< 10; i
++)
258 * Write PS or PCL lines until we see SIGTERM...
261 int line
= 0, page
= 0; /* Current line and page */
262 ssize_t bytes
; /* Number of bytes of response data */
263 char buffer
[1024]; /* Output buffer */
267 write(1, "\033E", 2);
269 write(1, "%!\n/Courier findfont 12 scalefont setfont 0 setgray\n", 52);
271 while (!job_canceled
)
278 snprintf(buffer
, sizeof(buffer
), "PCL Page %d\r\n\r\n", page
);
280 snprintf(buffer
, sizeof(buffer
),
281 "18 732 moveto (PS Page %d) show\n", page
);
283 write(1, buffer
, strlen(buffer
));
289 snprintf(buffer
, sizeof(buffer
), "Line %d\r\n", line
);
291 snprintf(buffer
, sizeof(buffer
), "18 %d moveto (Line %d) show\n",
292 720 - line
* 12, line
);
294 write(1, buffer
, strlen(buffer
));
299 * Eject after 55 lines...
306 write(1, "showpage\n", 9);
310 * Check for back-channel data...
313 if ((bytes
= cupsBackChannelRead(buffer
, sizeof(buffer
), 0)) > 0)
314 write(2, buffer
, bytes
);
317 * Throttle output to ~100hz...
324 * Eject current page with info...
328 snprintf(buffer
, sizeof(buffer
),
329 "Canceled on line %d of page %d\r\n\014\033E", line
, page
);
331 snprintf(buffer
, sizeof(buffer
),
332 "\n18 %d moveto (Canceled on line %d of page %d)\nshowpage\n",
333 720 - line
* 12, line
, page
);
335 write(1, buffer
, strlen(buffer
));
338 * See if we get any back-channel data...
341 while ((bytes
= cupsBackChannelRead(buffer
, sizeof(buffer
), 5.0)) > 0)
342 write(2, buffer
, bytes
);
349 * Do PS or PCL query + test pages.
352 char buffer
[1024]; /* Buffer for response data */
353 ssize_t bytes
; /* Number of bytes of response data */
354 double timeout
; /* Timeout */
355 const char *data
; /* Data to send */
356 static const char *pcl_data
= /* PCL data */
357 "\033%-12345X@PJL\r\n"
358 "@PJL JOB NAME = \"Hello, World!\"\r\n"
359 "@PJL INFO USTATUS\r\n"
360 "@PJL ENTER LANGUAGE = PCL\r\n"
364 "\033%-12345X@PJL\r\n"
365 "@PJL EOJ NAME=\"Hello, World!\"\r\n"
367 static const char *ps_data
= /* PostScript data */
371 "currentpagedevice /PageSize get aload pop\n"
372 "2 copy gt {exch} if\n"
375 "dup [612 792] (Letter) put\n"
376 "dup [612 1008] (Legal) put\n"
377 "dup [612 935] (w612h935) put\n"
378 "dup [522 756] (Executive) put\n"
379 "dup [595 842] (A4) put\n"
380 "dup [420 595] (A5) put\n"
381 "dup [499 709] (ISOB5) put\n"
382 "dup [516 728] (B5) put\n"
383 "dup [612 936] (w612h936) put\n"
384 "dup [284 419] (Postcard) put\n"
385 "dup [419.5 567] (DoublePostcard) put\n"
386 "dup [558 774] (w558h774) put\n"
387 "dup [553 765] (w553h765) put\n"
388 "dup [522 737] (w522h737) put\n"
389 "dup [499 709] (EnvISOB5) put\n"
390 "dup [297 684] (Env10) put\n"
391 "dup [459 649] (EnvC5) put\n"
392 "dup [312 624] (EnvDL) put\n"
393 "dup [279 540] (EnvMonarch) put\n"
394 "{ exch aload pop 4 index sub abs 5 le exch\n"
395 " 5 index sub abs 5 le and\n"
396 " {exch pop exit} {pop} ifelse\n"
399 "/Courier findfont 12 scalefont setfont\n"
400 "0 setgray 36 720 moveto (Hello, ) show product show (!) show\n"
411 write(1, data
, strlen(data
));
412 write(2, "DEBUG: START\n", 13);
414 while ((bytes
= cupsBackChannelRead(buffer
, sizeof(buffer
),
417 write(2, buffer
, bytes
);
420 write(2, "\nDEBUG: END\n", 12);
425 else if (data_pid
< 0)
427 perror("testbackend: Unable to fork");
432 data_fds
[0] = data_fds
[1] = -1;
435 * Execute the backend...
438 if ((back_pid
= fork()) == 0)
441 * Child comes here...
444 if (do_trickle
|| do_ps
|| do_pcl
|| do_cancel
)
446 if (data_fds
[0] != 0)
448 dup2(data_fds
[0], 0);
456 if ((fd
= open("/dev/null", O_WRONLY
)) != 2)
463 if (back_fds
[1] != 3)
465 dup2(back_fds
[1], 3);
470 if (side_fds
[1] != 4)
472 dup2(side_fds
[1], 4);
477 execv(backend
, argv
+ first_arg
);
478 fprintf(stderr
, "testbackend: Unable to execute \"%s\": %s\n", backend
,
482 else if (back_pid
< 0)
484 perror("testbackend: Unable to fork");
489 * Parent comes here, setup back and side channel file descriptors...
492 if (do_trickle
|| do_ps
|| do_pcl
|| do_cancel
)
498 if (back_fds
[0] != 3)
500 dup2(back_fds
[0], 3);
505 if (side_fds
[0] != 4)
507 dup2(side_fds
[0], 4);
513 * Do side-channel tests as needed, then wait for the backend...
518 int length
; /* Length of buffer */
519 char buffer
[2049]; /* Buffer for reponse */
520 cups_sc_status_t scstatus
; /* Status of side-channel command */
521 static const char * const statuses
[] =
523 "CUPS_SC_STATUS_NONE", /* No status */
524 "CUPS_SC_STATUS_OK", /* Operation succeeded */
525 "CUPS_SC_STATUS_IO_ERROR", /* An I/O error occurred */
526 "CUPS_SC_STATUS_TIMEOUT", /* The backend did not respond */
527 "CUPS_SC_STATUS_NO_RESPONSE", /* The device did not respond */
528 "CUPS_SC_STATUS_BAD_MESSAGE", /* The command/response message was invalid */
529 "CUPS_SC_STATUS_TOO_BIG", /* Response too big */
530 "CUPS_SC_STATUS_NOT_IMPLEMENTED" /* Command not implemented */
537 scstatus
= cupsSideChannelDoRequest(CUPS_SC_CMD_DRAIN_OUTPUT
, buffer
,
539 printf("CUPS_SC_CMD_DRAIN_OUTPUT returned %s\n", statuses
[scstatus
]);
542 scstatus
= cupsSideChannelDoRequest(CUPS_SC_CMD_GET_BIDI
, buffer
,
544 printf("CUPS_SC_CMD_GET_BIDI returned %s, %d\n", statuses
[scstatus
], buffer
[0]);
546 length
= sizeof(buffer
) - 1;
547 scstatus
= cupsSideChannelDoRequest(CUPS_SC_CMD_GET_DEVICE_ID
, buffer
,
549 buffer
[length
] = '\0';
550 printf("CUPS_SC_CMD_GET_DEVICE_ID returned %s, \"%s\"\n",
551 statuses
[scstatus
], buffer
);
554 scstatus
= cupsSideChannelDoRequest(CUPS_SC_CMD_GET_STATE
, buffer
,
556 printf("CUPS_SC_CMD_GET_STATE returned %s, %02X\n", statuses
[scstatus
],
562 * Walk the OID tree...
565 scstatus
= cupsSideChannelSNMPWalk(oid
, 5.0, walk_cb
, NULL
);
566 printf("CUPS_SC_CMD_SNMP_WALK returned %s\n", statuses
[scstatus
]);
571 * Lookup the same OID twice...
574 length
= sizeof(buffer
);
575 scstatus
= cupsSideChannelSNMPGet(oid
, buffer
, &length
, 5.0);
576 printf("CUPS_SC_CMD_SNMP_GET %s returned %s, %d bytes (%s)\n", oid
,
577 statuses
[scstatus
], (int)length
, buffer
);
579 length
= sizeof(buffer
);
580 scstatus
= cupsSideChannelSNMPGet(oid
, buffer
, &length
, 5.0);
581 printf("CUPS_SC_CMD_SNMP_GET %s returned %s, %d bytes (%s)\n", oid
,
582 statuses
[scstatus
], (int)length
, buffer
);
586 scstatus
= cupsSideChannelDoRequest(CUPS_SC_CMD_SOFT_RESET
, buffer
,
588 printf("CUPS_SC_CMD_SOFT_RESET returned %s\n", statuses
[scstatus
]);
594 kill(data_pid
, SIGTERM
);
595 kill(back_pid
, SIGTERM
);
598 while ((pid
= wait(&status
)) > 0)
602 if (WIFEXITED(status
))
603 printf("%s exited with status %d!\n",
604 pid
== back_pid
? backend
: "test",
605 WEXITSTATUS(status
));
607 printf("%s crashed with signal %d!\n",
608 pid
== back_pid
? backend
: "test",
614 * Exit accordingly...
617 return (status
!= 0);
622 * 'sigterm_handler()' - Flag when we get SIGTERM.
626 sigterm_handler(int sig
) /* I - Signal */
635 * 'usage()' - Show usage information.
641 puts("Usage: testbackend [-cancel] [-d] [-ps | -pcl] [-s [-get OID] "
642 "[-walk OID]] [-t] device-uri job-id user title copies options [file]");
645 puts(" -cancel Simulate a canceled print job after 2 seconds.");
646 puts(" -d Show log messages from backend.");
647 puts(" -get OID Lookup the specified SNMP OID.");
648 puts(" (.1.3.6.1.2.1.43.10.2.1.4.1.1 is a good one for printers)");
649 puts(" -pcl Send PCL+PJL query and test page to backend.");
650 puts(" -ps Send PostScript query and test page to backend.");
651 puts(" -s Do side-channel + SNMP tests.");
652 puts(" -t Send spaces slowly to backend ('trickle').");
653 puts(" -walk OID Walk the specified SNMP OID.");
654 puts(" (.1.3.6.1.2.1.43 is a good one for printers)");
661 * 'walk_cb()' - Show results of cupsSideChannelSNMPWalk...
665 walk_cb(const char *oid
, /* I - OID */
666 const char *data
, /* I - Data */
667 int datalen
, /* I - Length of data */
668 void *context
) /* I - Context (unused) */
671 if (datalen
> (sizeof(temp
) - 1))
673 memcpy(temp
, data
, sizeof(temp
) - 1);
674 temp
[sizeof(temp
) - 1] = '\0';
678 memcpy(temp
, data
, datalen
);
679 temp
[datalen
] = '\0';
682 printf("CUPS_SC_CMD_SNMP_WALK %s, %d bytes (%s)\n", oid
, datalen
, temp
);