2 * "$Id: sysman.c 5833 2006-08-16 20:05:58Z mike $"
4 * System management definitions for the Common UNIX Printing System (CUPS).
6 * Copyright 2006 by Easy Software Products.
8 * These coded instructions, statements, and computer programs are the
9 * property of Easy Software Products and are protected by Federal
10 * copyright law. Distribution and use rights are outlined in the file
11 * "LICENSE.txt" which should have been included with this file. If this
12 * file is missing or damaged please contact Easy Software Products
15 * Attn: CUPS Licensing Information
16 * Easy Software Products
17 * 44141 Airport View Drive, Suite 204
18 * Hollywood, Maryland 20636 USA
20 * Voice: (301) 373-9600
21 * EMail: cups-info@cups.org
22 * WWW: http://www.cups.org
26 * cupsdStartSystemMonitor() - Start monitoring for system change.
27 * cupsdStopSystemMonitor() - Stop monitoring for system change.
28 * cupsdUpdateSystemMonitor() - Update the current system state.
29 * sysEventThreadEntry() - A thread to receive power and computer
30 * name change notifications.
31 * sysEventPowerNotifier() - Handle power notification events.
32 * sysEventConfigurationNotifier() - Computer name changed notification
34 * sysEventTimerNotifier() - Handle delayed event notifications.
39 * Include necessary headers...
46 * Power management is a new addition to CUPS. Right now it is only
47 * implemented on MacOS X, but essentially we use these three functions
48 * to let the OS know when it is OK to put the system to sleep, typically
49 * when we are not in the middle of printing a job.
51 * Once put to sleep, we invalidate all remote printers since it is
52 * common to wake up in a new location.
57 * This is the Apple-specific system event code. It works by creating
58 * a worker thread that waits for events from the OS and relays them
59 * to the main thread via a traditional pipe.
63 * Include MacOS-specific headers...
66 # include <IOKit/IOKitLib.h>
67 # include <IOKit/IOMessage.h>
68 # include <IOKit/pwr_mgt/IOPMLib.h>
69 # include <SystemConfiguration/SystemConfiguration.h>
77 # define SYSEVENT_CANSLEEP 0x1 /* Decide whether to allow sleep or not */
78 # define SYSEVENT_WILLSLEEP 0x2 /* Computer will go to sleep */
79 # define SYSEVENT_WOKE 0x4 /* Computer woke from sleep */
80 # define SYSEVENT_NETCHANGED 0x8 /* Network changed */
81 # define SYSEVENT_NAMECHANGED 0x10 /* Computer name changed */
88 typedef struct cupsd_sysevent_s
/*** System event data ****/
90 unsigned char event
; /* Event bit field */
91 io_connect_t powerKernelPort
; /* Power context data */
92 long powerNotificationID
; /* Power event data */
96 typedef struct cupsd_thread_data_s
/*** Thread context data ****/
98 cupsd_sysevent_t sysevent
; /* System event */
99 CFRunLoopTimerRef timerRef
; /* Timer to delay some change *
101 } cupsd_thread_data_t
;
108 static pthread_t SysEventThread
= NULL
;
109 /* Thread to host a runloop */
110 static pthread_mutex_t SysEventThreadMutex
= { 0 };
111 /* Coordinates access to shared gloabals */
112 static pthread_cond_t SysEventThreadCond
= { 0 };
113 /* Thread initialization complete condition */
114 static CFRunLoopRef SysEventRunloop
= NULL
;
115 /* The runloop. Access must be protected! */
116 static CFStringRef ComputerNameKey
= NULL
,
117 /* Computer name key */
118 NetworkGlobalKey
= NULL
,
119 /* Network global key */
122 NetworkInterfaceKey
= NULL
;
123 /* Netowrk interface key */
130 static void *sysEventThreadEntry(void);
131 static void sysEventPowerNotifier(void *context
, io_service_t service
,
132 natural_t messageType
,
133 void *messageArgument
);
134 static void sysEventConfigurationNotifier(SCDynamicStoreRef store
,
135 CFArrayRef changedKeys
,
137 static void sysEventTimerNotifier(CFRunLoopTimerRef timer
, void *context
);
141 * 'cupsdStartSystemMonitor()' - Start monitoring for system change.
145 cupsdStartSystemMonitor(void)
147 int flags
; /* fcntl flags on pipe */
150 if (cupsdOpenPipe(SysEventPipes
))
152 cupsdLogMessage(CUPSD_LOG_ERROR
, "System event monitor pipe() failed - %s!",
157 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
158 "cupsdStartSystemMonitor: Adding fd %d to InputSet...",
160 FD_SET(SysEventPipes
[0], InputSet
);
163 * Set non-blocking mode on the descriptor we will be receiving notification
167 flags
= fcntl(SysEventPipes
[0], F_GETFL
, 0);
168 fcntl(SysEventPipes
[0], F_SETFL
, flags
| O_NONBLOCK
);
171 * Start the thread that runs the runloop...
174 pthread_mutex_init(&SysEventThreadMutex
, NULL
);
175 pthread_cond_init(&SysEventThreadCond
, NULL
);
176 pthread_create(&SysEventThread
, NULL
, (void *(*)())sysEventThreadEntry
, NULL
);
181 * 'cupsdStopSystemMonitor()' - Stop monitoring for system change.
185 cupsdStopSystemMonitor(void)
187 CFRunLoopRef rl
; /* The event handler runloop */
193 * Make sure the thread has completed it's initialization and
194 * stored it's runloop reference in the shared global.
197 pthread_mutex_lock(&SysEventThreadMutex
);
199 if (!SysEventRunloop
)
200 pthread_cond_wait(&SysEventThreadCond
, &SysEventThreadMutex
);
202 rl
= SysEventRunloop
;
203 SysEventRunloop
= NULL
;
205 pthread_mutex_unlock(&SysEventThreadMutex
);
210 pthread_join(SysEventThread
, NULL
);
211 pthread_mutex_destroy(&SysEventThreadMutex
);
212 pthread_cond_destroy(&SysEventThreadCond
);
215 if (SysEventPipes
[0] >= 0)
217 cupsdLogMessage(CUPSD_LOG_DEBUG2
,
218 "cupsdStopSystemMonitor: Removing fd %d from InputSet...",
221 FD_CLR(SysEventPipes
[0], InputSet
);
223 cupsdClosePipe(SysEventPipes
);
229 * 'cupsdUpdateSystemMonitor()' - Update the current system state.
233 cupsdUpdateSystemMonitor(void)
235 int i
; /* Looping var */
236 cupsd_sysevent_t sysevent
; /* The system event */
237 cupsd_printer_t
*p
; /* Printer information */
241 * Drain the event pipe...
244 while (read((int)SysEventPipes
[0], &sysevent
, sizeof(sysevent
))
247 if (sysevent
.event
& SYSEVENT_CANSLEEP
)
250 * If there are active printers that don't have the connecting-to-device
251 * printer-state-reason then cancel the sleep request (i.e. this reason
252 * indicates a job that is not yet connected to the printer)...
255 for (p
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
257 p
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
261 for (i
= 0; i
< p
->num_reasons
; i
++)
262 if (!strcmp(p
->reasons
[i
], "connecting-to-device"))
265 if (!p
->num_reasons
|| i
>= p
->num_reasons
)
272 cupsdLogMessage(CUPSD_LOG_INFO
,
273 "System sleep canceled because printer %s is active",
275 IOCancelPowerChange(sysevent
.powerKernelPort
,
276 sysevent
.powerNotificationID
);
280 cupsdLogMessage(CUPSD_LOG_DEBUG
, "System wants to sleep");
281 IOAllowPowerChange(sysevent
.powerKernelPort
,
282 sysevent
.powerNotificationID
);
286 if (sysevent
.event
& SYSEVENT_WILLSLEEP
)
288 cupsdLogMessage(CUPSD_LOG_DEBUG
, "System going to sleep");
295 for (p
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
297 p
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
299 if (p
->type
& CUPS_PRINTER_REMOTE
)
301 cupsdLogMessage(CUPSD_LOG_DEBUG
,
302 "Deleting remote destination \"%s\"", p
->name
);
303 cupsArraySave(Printers
);
304 cupsdDeletePrinter(p
, 0);
305 cupsArrayRestore(Printers
);
309 /* TODO: Possibly update when MDNS support is added? */
310 cupsdLogMessage(CUPSD_LOG_DEBUG
,
311 "Deregistering local printer \"%s\"", p
->name
);
312 cupsdSendBrowseDelete(p
);
316 IOAllowPowerChange(sysevent
.powerKernelPort
,
317 sysevent
.powerNotificationID
);
320 if (sysevent
.event
& SYSEVENT_WOKE
)
322 cupsdLogMessage(CUPSD_LOG_DEBUG
, "System woke from sleep");
323 IOAllowPowerChange(sysevent
.powerKernelPort
,
324 sysevent
.powerNotificationID
);
329 if (sysevent
.event
& SYSEVENT_NETCHANGED
)
333 cupsdLogMessage(CUPSD_LOG_DEBUG
,
334 "System network configuration changed");
337 * Force an update of the list of network interfaces in 2 seconds.
340 NetIFTime
= time(NULL
) - 58;
343 * Resetting browse_time before calling cupsdSendBrowseList causes
344 * browse packets to be sent for local shared printers.
347 for (p
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
349 p
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
352 cupsdSendBrowseList();
353 cupsdRestartPolling();
356 cupsdLogMessage(CUPSD_LOG_DEBUG
,
357 "System network configuration changed; "
358 "ignored while sleeping");
361 if (sysevent
.event
& SYSEVENT_NAMECHANGED
)
365 cupsdLogMessage(CUPSD_LOG_DEBUG
, "Computer name changed");
368 * De-register the individual printers...
371 for (p
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
373 p
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
374 cupsdSendBrowseDelete(p
);
377 * Now re-register them...
379 * TODO: This might need updating for MDNS.
382 for (p
= (cupsd_printer_t
*)cupsArrayFirst(Printers
);
384 p
= (cupsd_printer_t
*)cupsArrayNext(Printers
))
388 cupsdLogMessage(CUPSD_LOG_DEBUG
,
389 "Computer name changed; ignored while sleeping");
396 * 'sysEventThreadEntry()' - A thread to receive power and computer name
397 * change notifications.
400 static void * /* O - Return status/value */
401 sysEventThreadEntry(void)
403 io_object_t powerNotifierObj
;
404 /* Power notifier object */
405 IONotificationPortRef powerNotifierPort
;
406 /* Power notifier port */
407 SCDynamicStoreRef store
= NULL
;/* System Config dynamic store */
408 CFRunLoopSourceRef powerRLS
= NULL
,/* Power runloop source */
409 storeRLS
= NULL
;/* System Config runloop source */
410 CFStringRef key
[3], /* System Config keys */
411 pattern
[1]; /* System Config patterns */
412 CFArrayRef keys
= NULL
, /* System Config key array*/
413 patterns
= NULL
;/* System Config pattern array */
414 SCDynamicStoreContext storeContext
; /* Dynamic store context */
415 CFRunLoopTimerContext timerContext
; /* Timer context */
416 cupsd_thread_data_t threadData
; /* Thread context data for the *
417 * runloop notifiers */
421 * Register for power state change notifications
424 bzero(&threadData
, sizeof(threadData
));
426 threadData
.sysevent
.powerKernelPort
=
427 IORegisterForSystemPower(&threadData
, &powerNotifierPort
,
428 sysEventPowerNotifier
, &powerNotifierObj
);
430 if (threadData
.sysevent
.powerKernelPort
)
432 powerRLS
= IONotificationPortGetRunLoopSource(powerNotifierPort
);
433 CFRunLoopAddSource(CFRunLoopGetCurrent(), powerRLS
, kCFRunLoopDefaultMode
);
436 DEBUG_puts("sysEventThreadEntry: error registering for system power "
440 * Register for system configuration change notifications
443 bzero(&storeContext
, sizeof(storeContext
));
444 storeContext
.info
= &threadData
;
446 store
= SCDynamicStoreCreate(NULL
, CFSTR("cupsd"),
447 sysEventConfigurationNotifier
, &storeContext
);
449 if (!ComputerNameKey
)
450 ComputerNameKey
= SCDynamicStoreKeyCreateComputerName(NULL
);
452 if (!NetworkGlobalKey
)
454 SCDynamicStoreKeyCreateNetworkGlobalEntity(NULL
,
455 kSCDynamicStoreDomainState
,
459 HostNamesKey
= SCDynamicStoreKeyCreateHostNames(NULL
);
461 if (!NetworkInterfaceKey
)
462 NetworkInterfaceKey
=
463 SCDynamicStoreKeyCreateNetworkInterfaceEntity(NULL
,
464 kSCDynamicStoreDomainState
,
468 if (store
&& ComputerNameKey
&& NetworkGlobalKey
&& HostNamesKey
&&
471 key
[0] = ComputerNameKey
;
472 key
[1] = NetworkGlobalKey
;
473 key
[2] = HostNamesKey
;
474 pattern
[0] = NetworkInterfaceKey
;
476 keys
= CFArrayCreate(NULL
, (const void **)key
,
477 sizeof(key
) / sizeof(key
[0]),
478 &kCFTypeArrayCallBacks
);
479 patterns
= CFArrayCreate(NULL
, (const void **)pattern
,
480 sizeof(pattern
) / sizeof(pattern
[0]),
481 &kCFTypeArrayCallBacks
);
483 if (keys
&& patterns
&&
484 SCDynamicStoreSetNotificationKeys(store
, keys
, patterns
))
486 if ((storeRLS
= SCDynamicStoreCreateRunLoopSource(NULL
, store
, 0))
489 CFRunLoopAddSource(CFRunLoopGetCurrent(), storeRLS
,
490 kCFRunLoopDefaultMode
);
493 DEBUG_printf(("sysEventThreadEntry: SCDynamicStoreCreateRunLoopSource "
494 "failed: %s\n", SCErrorString(SCError())));
497 DEBUG_printf(("sysEventThreadEntry: SCDynamicStoreSetNotificationKeys "
498 "failed: %s\n", SCErrorString(SCError())));
501 DEBUG_printf(("sysEventThreadEntry: SCDynamicStoreCreate failed: %s\n",
502 SCErrorString(SCError())));
511 * Set up a timer to delay the wake change notifications.
513 * The initial time is set a decade or so into the future, we'll adjust
517 bzero(&timerContext
, sizeof(timerContext
));
518 timerContext
.info
= &threadData
;
520 threadData
.timerRef
=
521 CFRunLoopTimerCreate(NULL
,
522 CFAbsoluteTimeGetCurrent() + (86400L * 365L * 10L),
523 86400L * 365L * 10L, 0, 0, sysEventTimerNotifier
,
525 CFRunLoopAddTimer(CFRunLoopGetCurrent(), threadData
.timerRef
,
526 kCFRunLoopDefaultMode
);
529 * Store our runloop in a global so the main thread can use it to stop us.
532 pthread_mutex_lock(&SysEventThreadMutex
);
534 SysEventRunloop
= CFRunLoopGetCurrent();
536 pthread_cond_signal(&SysEventThreadCond
);
537 pthread_mutex_unlock(&SysEventThreadMutex
);
540 * Disappear into the runloop until it's stopped by the main thread.
546 * Clean up before exiting.
549 if (threadData
.timerRef
)
551 CFRunLoopRemoveTimer(CFRunLoopGetCurrent(), threadData
.timerRef
,
552 kCFRunLoopDefaultMode
);
553 CFRelease(threadData
.timerRef
);
556 if (threadData
.sysevent
.powerKernelPort
)
558 CFRunLoopRemoveSource(CFRunLoopGetCurrent(), powerRLS
,
559 kCFRunLoopDefaultMode
);
560 IODeregisterForSystemPower(&powerNotifierObj
);
561 IOServiceClose(threadData
.sysevent
.powerKernelPort
);
562 IONotificationPortDestroy(powerNotifierPort
);
567 CFRunLoopRemoveSource(CFRunLoopGetCurrent(), storeRLS
,
568 kCFRunLoopDefaultMode
);
569 CFRunLoopSourceInvalidate(storeRLS
);
581 * 'sysEventPowerNotifier()' - Handle power notification events.
585 sysEventPowerNotifier(
586 void *context
, /* I - Thread context data */
587 io_service_t service
, /* I - Unused service info */
588 natural_t messageType
, /* I - Type of message */
589 void *messageArgument
) /* I - Message data */
591 int sendit
= 1; /* Send event to main thread? *
592 * (0 = no, 1 = yes, 2 = delayed */
593 cupsd_thread_data_t
*threadData
; /* Thread context data */
596 threadData
= (cupsd_thread_data_t
*)context
;
598 (void)service
; /* anti-compiler-warning-code */
602 case kIOMessageCanSystemPowerOff
:
603 case kIOMessageCanSystemSleep
:
604 threadData
->sysevent
.event
|= SYSEVENT_CANSLEEP
;
607 case kIOMessageSystemWillRestart
:
608 case kIOMessageSystemWillPowerOff
:
609 case kIOMessageSystemWillSleep
:
610 threadData
->sysevent
.event
|= SYSEVENT_WILLSLEEP
;
613 case kIOMessageSystemHasPoweredOn
:
615 * Because powered on is followed by a net-changed event, delay
620 threadData
->sysevent
.event
|= SYSEVENT_WOKE
;
623 case kIOMessageSystemWillNotPowerOff
:
624 case kIOMessageSystemWillNotSleep
:
625 #ifdef kIOMessageSystemWillPowerOn
626 case kIOMessageSystemWillPowerOn
:
627 #endif /* kIOMessageSystemWillPowerOn */
634 IOAllowPowerChange(threadData
->sysevent
.powerKernelPort
,
635 (long)messageArgument
);
638 threadData
->sysevent
.powerNotificationID
= (long)messageArgument
;
643 * Send the event to the main thread now.
646 write(SysEventPipes
[1], &threadData
->sysevent
,
647 sizeof(threadData
->sysevent
));
648 threadData
->sysevent
.event
= 0;
653 * Send the event to the main thread after 1 to 2 seconds.
656 CFRunLoopTimerSetNextFireDate(threadData
->timerRef
,
657 CFAbsoluteTimeGetCurrent() + 2);
664 * 'sysEventConfigurationNotifier()' - Computer name changed notification
669 sysEventConfigurationNotifier(
670 SCDynamicStoreRef store
, /* I - System data (unused) */
671 CFArrayRef changedKeys
, /* I - Changed data */
672 void *context
) /* I - Thread context data */
674 cupsd_thread_data_t
*threadData
; /* Thread context data */
677 threadData
= (cupsd_thread_data_t
*)context
;
679 (void)store
; /* anti-compiler-warning-code */
681 CFRange range
= CFRangeMake(0, CFArrayGetCount(changedKeys
));
683 if (CFArrayContainsValue(changedKeys
, range
, ComputerNameKey
))
684 threadData
->sysevent
.event
|= SYSEVENT_NAMECHANGED
;
686 if (CFArrayContainsValue(changedKeys
, range
, NetworkGlobalKey
) ||
687 CFArrayContainsValue(changedKeys
, range
, HostNamesKey
) ||
688 CFArrayContainsValue(changedKeys
, range
, NetworkInterfaceKey
))
689 threadData
->sysevent
.event
|= SYSEVENT_NETCHANGED
;
692 * Because we registered for several different kinds of change notifications
693 * this callback usually gets called several times in a row. We use a timer to
694 * de-bounce these so we only end up generating one event for the main thread.
697 CFRunLoopTimerSetNextFireDate(threadData
->timerRef
,
698 CFAbsoluteTimeGetCurrent() + 2);
703 * 'sysEventTimerNotifier()' - Handle delayed event notifications.
707 sysEventTimerNotifier(
708 CFRunLoopTimerRef timer
, /* I - Timer information */
709 void *context
) /* I - Thread context data */
711 cupsd_thread_data_t
*threadData
; /* Thread context data */
714 threadData
= (cupsd_thread_data_t
*)context
;
717 * If an event is still pending send it to the main thread.
720 if (threadData
->sysevent
.event
)
722 write(SysEventPipes
[1], &threadData
->sysevent
,
723 sizeof(threadData
->sysevent
));
724 threadData
->sysevent
.event
= 0;
727 #endif /* __APPLE__ */
731 * End of "$Id: sysman.c 5833 2006-08-16 20:05:58Z mike $".