SCDNotifierInformViaCallback.c [plain text]
#include <Availability.h>
#include <TargetConditionals.h>
#include <sys/cdefs.h>
#include <dispatch/dispatch.h>
#include <mach/mach.h>
#include <mach/mach_error.h>
#include <SystemConfiguration/SystemConfiguration.h>
#include <SystemConfiguration/SCPrivate.h>
#include "SCDynamicStoreInternal.h"
#include "config.h"
static CFStringRef
notifyMPCopyDescription(const void *info)
{
SCDynamicStoreRef store = (SCDynamicStoreRef)info;
return CFStringCreateWithFormat(NULL,
NULL,
CFSTR("<SCDynamicStore notification MP> {store = %p}"),
store);
}
static void
rlsCallback(CFMachPortRef port, void *msg, CFIndex size, void *info)
{
mach_no_senders_notification_t *buf = msg;
mach_msg_id_t msgid = buf->not_header.msgh_id;
SCDynamicStoreRef store = (SCDynamicStoreRef)info;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
if (msgid == MACH_NOTIFY_NO_SENDERS) {
#ifdef DEBUG
SCLog(_sc_verbose, LOG_INFO, CFSTR(" rlsCallback(), notifier port closed"));
#endif
#ifdef DEBUG
if (port != storePrivate->rlsNotifyPort) {
SCLog(_sc_verbose, LOG_DEBUG, CFSTR("rlsCallback(), why is port != rlsNotifyPort?"));
}
#endif
(void)__SCDynamicStoreReconnectNotifications(store);
}
if (storePrivate->rls != NULL) {
CFRunLoopSourceSignal(storePrivate->rls);
}
return;
}
static void
rlsSchedule(void *info, CFRunLoopRef rl, CFStringRef mode)
{
SCDynamicStoreRef store = (SCDynamicStoreRef)info;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
#ifdef DEBUG
SCLog(_sc_verbose, LOG_DEBUG,
CFSTR("schedule notifications for mode %@"),
(rl != NULL) ? mode : CFSTR("libdispatch"));
#endif
if (storePrivate->rlList == NULL) {
CFMachPortContext context = { 0
, (void *)store
, CFRetain
, CFRelease
, notifyMPCopyDescription
};
mach_port_t oldNotify;
mach_port_t port;
int sc_status;
kern_return_t status;
#ifdef DEBUG
SCLog(_sc_verbose, LOG_DEBUG, CFSTR(" activate callback runloop source"));
#endif
status = mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &port);
if (status != KERN_SUCCESS) {
SCLog(TRUE, LOG_ERR, CFSTR("rlsSchedule mach_port_allocate(): %s"), mach_error_string(status));
return;
}
status = mach_port_insert_right(mach_task_self(),
port,
port,
MACH_MSG_TYPE_MAKE_SEND);
if (status != KERN_SUCCESS) {
SCLog(TRUE, LOG_ERR, CFSTR("rlsSchedule mach_port_insert_right(): %s"), mach_error_string(status));
return;
}
status = mach_port_request_notification(mach_task_self(),
port,
MACH_NOTIFY_NO_SENDERS,
1,
port,
MACH_MSG_TYPE_MAKE_SEND_ONCE,
&oldNotify);
if (status != KERN_SUCCESS) {
SCLog(TRUE, LOG_ERR, CFSTR("rlsSchedule mach_port_request_notification(): %s"), mach_error_string(status));
return;
}
if (oldNotify != MACH_PORT_NULL) {
SCLog(TRUE, LOG_ERR, CFSTR("rlsSchedule(): oldNotify != MACH_PORT_NULL"));
}
retry :
__MACH_PORT_DEBUG(TRUE, "*** rlsSchedule", port);
status = notifyviaport(storePrivate->server, port, 0, (int *)&sc_status);
if (__SCDynamicStoreCheckRetryAndHandleError(store,
status,
&sc_status,
"rlsSchedule notifyviaport()")) {
goto retry;
}
if (status != KERN_SUCCESS) {
if ((status == MACH_SEND_INVALID_DEST) || (status == MIG_SERVER_DIED)) {
(void) mach_port_deallocate(mach_task_self(), port);
}
(void) mach_port_mod_refs(mach_task_self(), port, MACH_PORT_RIGHT_RECEIVE, -1);
return;
}
if (sc_status != kSCStatusOK) {
(void) mach_port_mod_refs(mach_task_self(), port, MACH_PORT_RIGHT_RECEIVE, -1);
return;
}
__MACH_PORT_DEBUG(TRUE, "*** rlsSchedule (after notifyviaport)", port);
storePrivate->rlsNotifyPort = _SC_CFMachPortCreateWithPort("SCDynamicStore",
port,
rlsCallback,
&context);
storePrivate->rlsNotifyRLS = CFMachPortCreateRunLoopSource(NULL, storePrivate->rlsNotifyPort, 0);
storePrivate->rlList = CFArrayCreateMutable(NULL, 0, &kCFTypeArrayCallBacks);
}
if ((rl != NULL) && (storePrivate->rlsNotifyRLS != NULL)) {
if (!_SC_isScheduled(store, rl, mode, storePrivate->rlList)) {
CFRunLoopAddSource(rl, storePrivate->rlsNotifyRLS, mode);
__MACH_PORT_DEBUG(TRUE, "*** rlsSchedule (after CFRunLoopAddSource)", CFMachPortGetPort(storePrivate->rlsNotifyPort));
}
_SC_schedule(store, rl, mode, storePrivate->rlList);
}
return;
}
static void
rlsCancel(void *info, CFRunLoopRef rl, CFStringRef mode)
{
CFIndex n = 0;
SCDynamicStoreRef store = (SCDynamicStoreRef)info;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
#ifdef DEBUG
SCLog(_sc_verbose, LOG_DEBUG,
CFSTR("cancel notifications for mode %@"),
(rl != NULL) ? mode : CFSTR("libdispatch"));
#endif
if ((rl != NULL) && (storePrivate->rlsNotifyRLS != NULL)) {
if (_SC_unschedule(store, rl, mode, storePrivate->rlList, FALSE)) {
n = CFArrayGetCount(storePrivate->rlList);
if (n == 0 || !_SC_isScheduled(store, rl, mode, storePrivate->rlList)) {
CFRunLoopRemoveSource(rl, storePrivate->rlsNotifyRLS, mode);
}
}
}
if (n == 0) {
int sc_status;
kern_return_t status;
#ifdef DEBUG
SCLog(_sc_verbose, LOG_DEBUG, CFSTR(" cancel callback runloop source"));
#endif
__MACH_PORT_DEBUG((storePrivate->rlsNotifyPort != NULL),
"*** rlsCancel",
CFMachPortGetPort(storePrivate->rlsNotifyPort));
if (storePrivate->rlList != NULL) {
CFRelease(storePrivate->rlList);
storePrivate->rlList = NULL;
}
if (storePrivate->rlsNotifyRLS != NULL) {
CFRunLoopSourceInvalidate(storePrivate->rlsNotifyRLS);
CFRelease(storePrivate->rlsNotifyRLS);
storePrivate->rlsNotifyRLS = NULL;
}
if (storePrivate->rlsNotifyPort != NULL) {
mach_port_t mp;
mp = CFMachPortGetPort(storePrivate->rlsNotifyPort);
__MACH_PORT_DEBUG((storePrivate->rlsNotifyPort != NULL),
"*** rlsCancel (before invalidating/releasing CFMachPort)",
mp);
CFMachPortInvalidate(storePrivate->rlsNotifyPort);
CFRelease(storePrivate->rlsNotifyPort);
storePrivate->rlsNotifyPort = NULL;
(void)mach_port_mod_refs(mach_task_self(), mp, MACH_PORT_RIGHT_RECEIVE, -1);
}
if (storePrivate->server != MACH_PORT_NULL) {
status = notifycancel(storePrivate->server, (int *)&sc_status);
(void) __SCDynamicStoreCheckRetryAndHandleError(store,
status,
&sc_status,
"rlsCancel notifycancel()");
if (status != KERN_SUCCESS) {
return;
}
}
}
return;
}
static void
rlsPerform(void *info)
{
CFArrayRef changedKeys;
void *context_info;
void (*context_release)(const void *);
SCDynamicStoreCallBack rlsFunction;
SCDynamicStoreRef store = (SCDynamicStoreRef)info;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
#ifdef DEBUG
SCLog(_sc_verbose, LOG_DEBUG, CFSTR(" executing notification function"));
#endif
changedKeys = SCDynamicStoreCopyNotifiedKeys(store);
if (storePrivate->disconnectForceCallBack) {
storePrivate->disconnectForceCallBack = FALSE;
if (changedKeys == NULL) {
changedKeys = CFArrayCreate(NULL, NULL, 0, &kCFTypeArrayCallBacks);
}
} else {
if (changedKeys == NULL) {
return;
} else if (CFArrayGetCount(changedKeys) == 0) {
goto done;
}
}
rlsFunction = storePrivate->rlsFunction;
if (storePrivate->rlsContext.retain != NULL) {
context_info = (void *)storePrivate->rlsContext.retain(storePrivate->rlsContext.info);
context_release = storePrivate->rlsContext.release;
} else {
context_info = storePrivate->rlsContext.info;
context_release = NULL;
}
if (rlsFunction != NULL) {
(*rlsFunction)(store, changedKeys, context_info);
}
if (context_release != NULL) {
context_release(context_info);
}
done :
CFRelease(changedKeys);
return;
}
static CFTypeRef
rlsRetain(CFTypeRef cf)
{
SCDynamicStoreRef store = (SCDynamicStoreRef)cf;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
switch (storePrivate->notifyStatus) {
case NotifierNotRegistered :
storePrivate->notifyStatus = Using_NotifierInformViaRunLoop;
CFRetain(store);
break;
case Using_NotifierInformViaRunLoop :
break;
default :
SCLog(TRUE, LOG_ERR, CFSTR("rlsRetain() error: notifyStatus=%d"), storePrivate->notifyStatus);
break;
}
return cf;
}
static void
rlsRelease(CFTypeRef cf)
{
SCDynamicStoreRef store = (SCDynamicStoreRef)cf;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
switch (storePrivate->notifyStatus) {
case NotifierNotRegistered :
break;
case Using_NotifierInformViaRunLoop :
storePrivate->notifyStatus = NotifierNotRegistered;
storePrivate->rls = NULL;
CFRelease(store);
break;
default :
SCLog(TRUE, LOG_ERR, CFSTR("rlsRelease() error: notifyStatus=%d"), storePrivate->notifyStatus);
break;
}
return;
}
static CFStringRef
rlsCopyDescription(const void *info)
{
CFMutableStringRef result;
SCDynamicStoreRef store = (SCDynamicStoreRef)info;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
result = CFStringCreateMutable(NULL, 0);
CFStringAppendFormat(result, NULL, CFSTR("<SCDynamicStore RLS> {"));
CFStringAppendFormat(result, NULL, CFSTR("store = %p"), store);
if (storePrivate->notifyStatus == Using_NotifierInformViaRunLoop) {
CFStringRef description = NULL;
CFStringAppendFormat(result, NULL, CFSTR(", callout = %p"), storePrivate->rlsFunction);
if ((storePrivate->rlsContext.info != NULL) && (storePrivate->rlsContext.copyDescription != NULL)) {
description = (*storePrivate->rlsContext.copyDescription)(storePrivate->rlsContext.info);
}
if (description == NULL) {
description = CFStringCreateWithFormat(NULL, NULL, CFSTR("<SCDynamicStore context %p>"), storePrivate->rlsContext.info);
}
if (description == NULL) {
description = CFRetain(CFSTR("<no description>"));
}
CFStringAppendFormat(result, NULL, CFSTR(", context = %@"), description);
CFRelease(description);
}
CFStringAppendFormat(result, NULL, CFSTR("}"));
return result;
}
CFRunLoopSourceRef
SCDynamicStoreCreateRunLoopSource(CFAllocatorRef allocator,
SCDynamicStoreRef store,
CFIndex order)
{
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
if (store == NULL) {
_SCErrorSet(kSCStatusNoStoreSession);
return NULL;
}
if (storePrivate->server == MACH_PORT_NULL) {
_SCErrorSet(kSCStatusNoStoreServer);
return NULL;
}
switch (storePrivate->notifyStatus) {
case NotifierNotRegistered :
case Using_NotifierInformViaRunLoop :
break;
default :
_SCErrorSet(kSCStatusNotifierActive);
return NULL;
}
if (storePrivate->rls != NULL) {
CFRetain(storePrivate->rls);
} else {
CFRunLoopSourceContext context = { 0 , (void *)store , rlsRetain , rlsRelease , rlsCopyDescription , CFEqual , CFHash , rlsSchedule , rlsCancel , rlsPerform };
storePrivate->rls = CFRunLoopSourceCreate(allocator, order, &context);
if (storePrivate->rls == NULL) {
_SCErrorSet(kSCStatusFailed);
}
}
return storePrivate->rls;
}
Boolean
SCDynamicStoreSetDispatchQueue(SCDynamicStoreRef store, dispatch_queue_t queue)
{
dispatch_group_t drainGroup = NULL;
dispatch_queue_t drainQueue = NULL;
dispatch_group_t group = NULL;
mach_port_t mp;
Boolean ok = FALSE;
dispatch_source_t source;
SCDynamicStorePrivateRef storePrivate = (SCDynamicStorePrivateRef)store;
if (store == NULL) {
_SCErrorSet(kSCStatusNoStoreSession);
return FALSE;
}
if (queue == NULL) {
if (storePrivate->dispatchQueue == NULL) {
_SCErrorSet(kSCStatusInvalidArgument);
return FALSE;
}
ok = TRUE;
goto cleanup;
}
if (storePrivate->server == MACH_PORT_NULL) {
_SCErrorSet(kSCStatusNoStoreServer);
return FALSE;
}
if ((storePrivate->dispatchQueue != NULL) || (storePrivate->rls != NULL)) {
_SCErrorSet(kSCStatusInvalidArgument);
return FALSE;
}
if (storePrivate->notifyStatus != NotifierNotRegistered) {
_SCErrorSet(kSCStatusNotifierActive);
return FALSE;
}
storePrivate->notifyStatus = Using_NotifierInformViaDispatch;
rlsSchedule((void*)store, NULL, NULL);
if (storePrivate->rlsNotifyPort == NULL) {
_SCErrorSet(kSCStatusFailed);
goto cleanup;
}
storePrivate->dispatchQueue = queue;
dispatch_retain(storePrivate->dispatchQueue);
group = dispatch_group_create();
storePrivate->dispatchGroup = group;
CFRetain(store);
dispatch_set_context(storePrivate->dispatchGroup, (void *)store);
dispatch_set_finalizer_f(storePrivate->dispatchGroup, (dispatch_function_t)CFRelease);
mp = CFMachPortGetPort(storePrivate->rlsNotifyPort);
source = dispatch_source_create(DISPATCH_SOURCE_TYPE_MACH_RECV, mp, 0, queue);
if (source == NULL) {
SCLog(TRUE, LOG_ERR, CFSTR("SCDynamicStore dispatch_source_create() failed"));
_SCErrorSet(kSCStatusFailed);
goto cleanup;
}
dispatch_source_set_event_handler(source, ^{
kern_return_t kr;
mach_msg_id_t msgid;
union {
u_int8_t buf[sizeof(mach_msg_empty_t) + MAX_TRAILER_SIZE];
mach_msg_empty_rcv_t msg;
mach_no_senders_notification_t no_senders;
} notify_msg;
kr = mach_msg(¬ify_msg.msg.header, MACH_RCV_MSG, 0, sizeof(notify_msg), mp, MACH_MSG_TIMEOUT_NONE, MACH_PORT_NULL); if (kr != KERN_SUCCESS) {
SCLog(TRUE, LOG_ERR,
CFSTR("SCDynamicStore notification handler, kr=0x%x"),
kr);
return;
}
msgid = notify_msg.msg.header.msgh_id;
CFRetain(store);
dispatch_group_async(group, queue, ^{
if (msgid == MACH_NOTIFY_NO_SENDERS) {
(void)__SCDynamicStoreReconnectNotifications(store);
}
rlsPerform(storePrivate);
CFRelease(store);
});
});
dispatch_source_set_cancel_handler(source, ^{
dispatch_release(source);
});
storePrivate->dispatchSource = source;
dispatch_resume(source);
return TRUE;
cleanup :
CFRetain(store);
if (storePrivate->dispatchSource != NULL) {
dispatch_source_cancel(storePrivate->dispatchSource);
storePrivate->dispatchSource = NULL;
}
drainGroup = storePrivate->dispatchGroup;
storePrivate->dispatchGroup = NULL;
drainQueue = storePrivate->dispatchQueue;
storePrivate->dispatchQueue = NULL;
rlsCancel((void*)store, NULL, NULL);
if (drainGroup != NULL) {
dispatch_group_notify(drainGroup, drainQueue, ^{
dispatch_release(drainQueue);
dispatch_release(drainGroup); });
}
storePrivate->notifyStatus = NotifierNotRegistered;
CFRelease(store);
return ok;
}