2 * Copyright (c) 2000-2015 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
21 * @APPLE_LICENSE_HEADER_END@
25 * Modification History
27 * December 3, 2002 Dieter Siegmund <dieter@apple.com>
28 * - handle the new KEV_INET_ARPCOLLISION event
29 * - format the event into a DynamicStore key
30 * State:/Network/Interface/ifname/IPv4Collision/ip_addr/hw_addr
31 * and send a notification on the key
33 * August 8, 2002 Allan Nathanson <ajn@apple.com>
34 * - added support for KEV_INET6_xxx events
36 * January 6, 2002 Jessica Vazquez <vazquez@apple.com>
37 * - added handling for KEV_ATALK_xxx events
39 * July 2, 2001 Dieter Siegmund <dieter@apple.com>
40 * - added handling for KEV_DL_PROTO_{ATTACHED, DETACHED}
41 * - mark an interface up if the number of protocols remaining is not 0,
42 * mark an interface down if the number is zero
43 * - allocate socket on demand instead of keeping it open all the time
45 * June 23, 2001 Allan Nathanson <ajn@apple.com>
46 * - update to public SystemConfiguration.framework APIs
48 * May 17, 2001 Allan Nathanson <ajn@apple.com>
49 * - add/maintain per-interface address/netmask/destaddr information
50 * in the dynamic store.
52 * June 30, 2000 Allan Nathanson <ajn@apple.com>
64 #define KEV_LOG_SUBCLASS 10
66 static dispatch_queue_t S_kev_queue
;
67 static dispatch_source_t S_kev_source
;
68 __private_extern__ Boolean network_changed
= FALSE
;
69 __private_extern__ SCDynamicStoreRef store
= NULL
;
70 __private_extern__ Boolean _verbose
= FALSE
;
73 #define MESSAGES_MAX 100
74 static CFMutableArrayRef S_messages
;
75 static Boolean S_messages_modified
;
80 S_messages
= CFArrayCreateMutable(NULL
,
82 &kCFTypeArrayCallBacks
);
89 if (S_messages
!= NULL
) {
90 CFRelease(S_messages
);
97 messages_should_add_message(void)
99 if (S_messages
== NULL
100 || CFArrayGetCount(S_messages
) >= MESSAGES_MAX
) {
107 messages_add_message(CFStringRef message
)
109 if (messages_should_add_message()) {
110 CFArrayAppendValue(S_messages
, message
);
111 S_messages_modified
= TRUE
;
116 __private_extern__
void
117 messages_add_msg_with_arg(const char * msg
, const char * arg
)
119 if (messages_should_add_message()) {
122 str
= CFStringCreateWithFormat(NULL
, NULL
,
123 CFSTR("%12.8f: %s %s"),
124 CFAbsoluteTimeGetCurrent(),
126 messages_add_message(str
);
135 if (S_messages
!= NULL
&& S_messages_modified
) {
136 SCDynamicStoreSetValue(NULL
,
137 CFSTR("Plugin:KernelEventMonitor"),
139 S_messages_modified
= FALSE
;
146 dgram_socket(int domain
)
150 s
= socket(domain
, SOCK_DGRAM
, 0);
152 SC_log(LOG_ERR
, "socket() failed: %s", strerror(errno
));
159 ifflags_set(int s
, char * name
, short flags
)
164 bzero(&ifr
, sizeof(ifr
));
165 strlcpy(ifr
.ifr_name
, name
, sizeof(ifr
.ifr_name
));
166 ret
= ioctl(s
, SIOCGIFFLAGS
, (caddr_t
)&ifr
);
170 ifr
.ifr_flags
|= flags
;
171 return (ioctl(s
, SIOCSIFFLAGS
, &ifr
));
175 ifflags_clear(int s
, char * name
, short flags
)
180 bzero(&ifr
, sizeof(ifr
));
181 strlcpy(ifr
.ifr_name
, name
, sizeof(ifr
.ifr_name
));
182 ret
= ioctl(s
, SIOCGIFFLAGS
, (caddr_t
)&ifr
);
186 ifr
.ifr_flags
&= ~flags
;
187 return (ioctl(s
, SIOCSIFFLAGS
, &ifr
));
191 mark_if_up(char * name
)
193 int s
= dgram_socket(AF_INET
);
196 ifflags_set(s
, name
, IFF_UP
);
201 mark_if_down(char * name
)
203 int s
= dgram_socket(AF_INET
);
206 ifflags_clear(s
, name
, IFF_UP
);
211 post_network_changed(void)
213 if (network_changed
) {
216 status
= notify_post(_SC_NOTIFY_NETWORK_CHANGE
);
217 if (status
!= NOTIFY_STATUS_OK
) {
218 SC_log(LOG_NOTICE
, "notify_post() failed: error=%u", status
);
221 network_changed
= FALSE
;
228 logEvent(CFStringRef evStr
, struct kern_event_msg
*ev_msg
)
237 SC_log(LOG_DEBUG
, "%@ event:", evStr
);
238 SC_log(LOG_DEBUG
, " Event size=%d, id=%d, vendor=%d, class=%d, subclass=%d, code=%d",
243 ev_msg
->kev_subclass
,
245 for (i
= 0, j
= KEV_MSG_HEADER_SIZE
; j
< ev_msg
->total_size
; i
++, j
+=4) {
246 SC_log(LOG_DEBUG
, " Event data[%2d] = %08x", i
, ev_msg
->event_data
[i
]);
251 copy_if_name(const struct net_event_data
* ev
, char * ifr_name
, int ifr_len
)
253 snprintf(ifr_name
, ifr_len
, "%s%d", ev
->if_name
, ev
->if_unit
);
257 static uint8_t info_zero
[DLIL_MODARGLEN
];
260 processEvent_Apple_Network(struct kern_event_msg
*ev_msg
)
262 int dataLen
= (ev_msg
->total_size
- KEV_MSG_HEADER_SIZE
);
263 void * event_data
= &ev_msg
->event_data
[0];
264 Boolean handled
= TRUE
;
265 char ifr_name
[IFNAMSIZ
];
267 switch (ev_msg
->kev_subclass
) {
268 case KEV_INET_SUBCLASS
: {
269 switch (ev_msg
->event_code
) {
270 case KEV_INET_NEW_ADDR
:
271 case KEV_INET_CHANGED_ADDR
:
272 case KEV_INET_ADDR_DELETED
:
273 case KEV_INET_SIFDSTADDR
:
274 case KEV_INET_SIFBRDADDR
:
275 case KEV_INET_SIFNETMASK
: {
276 struct kev_in_data
* ev
;
278 ev
= (struct kev_in_data
*)event_data
;
279 if (dataLen
< sizeof(*ev
)) {
283 copy_if_name(&ev
->link_data
, ifr_name
, sizeof(ifr_name
));
284 SC_log(LOG_INFO
, "Process IPv4 address change: %s: %d", (char *)ifr_name
, ev_msg
->event_code
);
285 ipv4_interface_update(NULL
, ifr_name
);
288 case KEV_INET_ARPCOLLISION
: {
289 struct kev_in_collision
* ev
;
291 ev
= (struct kev_in_collision
*)event_data
;
292 if ((dataLen
< sizeof(*ev
))
293 || (dataLen
< (sizeof(*ev
) + ev
->hw_len
))) {
297 copy_if_name(&ev
->link_data
, ifr_name
, sizeof(ifr_name
));
298 SC_log(LOG_INFO
, "Process ARP collision: %s", (char *)ifr_name
);
299 ipv4_arp_collision(ifr_name
,
305 #if !TARGET_OS_IPHONE
306 case KEV_INET_PORTINUSE
: {
307 struct kev_in_portinuse
* ev
;
308 ev
= (struct kev_in_portinuse
*)event_data
;
309 if (dataLen
< sizeof(*ev
)) {
313 SC_log(LOG_INFO
, "Process port-in-use: %hu, %u", ev
->port
, ev
->req_pid
);
314 ipv4_port_in_use(ev
->port
, ev
->req_pid
);
317 #endif /* !TARGET_OS_IPHONE */
318 case KEV_INET_ARPRTRFAILURE
: {
319 const struct kev_in_arpfailure
* ev
;
321 ev
= (const struct kev_in_arpfailure
*)event_data
;
322 if (dataLen
< sizeof(*ev
)) {
326 copy_if_name(&ev
->link_data
, ifr_name
, sizeof(ifr_name
));
327 SC_log(LOG_INFO
, "Process router ARP failure: %s", (char *)ifr_name
);
328 ipv4_router_arp_failure(ifr_name
);
331 case KEV_INET_ARPRTRALIVE
: {
332 const struct kev_in_arpalive
* ev
;
334 ev
= (const struct kev_in_arpalive
*)event_data
;
335 if (dataLen
< sizeof(*ev
)) {
339 copy_if_name(&ev
->link_data
, ifr_name
, sizeof(ifr_name
));
340 SC_log(LOG_INFO
, "Process router ARP alive: %s", (char *)ifr_name
);
341 ipv4_router_arp_alive(ifr_name
);
350 case KEV_INET6_SUBCLASS
: {
351 struct kev_in6_data
* ev
;
353 ev
= (struct kev_in6_data
*)event_data
;
354 switch (ev_msg
->event_code
) {
355 case KEV_INET6_NEW_USER_ADDR
:
356 case KEV_INET6_CHANGED_ADDR
:
357 case KEV_INET6_ADDR_DELETED
:
358 case KEV_INET6_NEW_LL_ADDR
:
359 case KEV_INET6_NEW_RTADV_ADDR
:
360 case KEV_INET6_DEFROUTER
:
361 if (dataLen
< sizeof(*ev
)) {
365 copy_if_name(&ev
->link_data
, ifr_name
, sizeof(ifr_name
));
366 SC_log(LOG_INFO
, "Process IPv6 address change: %s: %d", (char *)ifr_name
, ev_msg
->event_code
);
367 interface_update_ipv6(NULL
, ifr_name
);
368 if (ev_msg
->event_code
== KEV_INET6_NEW_USER_ADDR
369 && (ev
->ia6_flags
& IN6_IFF_DUPLICATED
) != 0) {
370 ipv6_duplicated_address(ifr_name
,
371 &ev
->ia_addr
.sin6_addr
,
383 case KEV_DL_SUBCLASS
: {
384 struct net_event_data
* ev
;
386 ev
= (struct net_event_data
*)event_data
;
387 switch (ev_msg
->event_code
) {
388 case KEV_DL_IF_ATTACHED
:
390 * new interface added
392 if (dataLen
< sizeof(*ev
)) {
396 copy_if_name(ev
, ifr_name
, sizeof(ifr_name
));
397 SC_log(LOG_INFO
, "Process interface attach: %s", (char *)ifr_name
);
401 case KEV_DL_IF_DETACHED
:
405 if (dataLen
< sizeof(*ev
)) {
409 copy_if_name(ev
, ifr_name
, sizeof(ifr_name
));
410 SC_log(LOG_INFO
, "Process interface detach: %s", (char *)ifr_name
);
411 link_remove(ifr_name
);
414 case KEV_DL_IF_DETACHING
:
416 * interface detaching
418 if (dataLen
< sizeof(*ev
)) {
422 copy_if_name(ev
, ifr_name
, sizeof(ifr_name
));
423 SC_log(LOG_INFO
, "Process interface detaching: %s", (char *)ifr_name
);
424 interface_detaching(ifr_name
);
427 case KEV_DL_PROTO_ATTACHED
:
428 case KEV_DL_PROTO_DETACHED
: {
429 struct kev_dl_proto_data
* protoEvent
;
431 protoEvent
= (struct kev_dl_proto_data
*)event_data
;
432 if (dataLen
< sizeof(*protoEvent
)) {
436 copy_if_name(&protoEvent
->link_data
,
437 ifr_name
, sizeof(ifr_name
));
438 SC_log(LOG_INFO
, "Process protocol %s: %s (n=%d)",
439 (ev_msg
->event_code
== KEV_DL_PROTO_ATTACHED
) ? "attach" : "detach",
441 protoEvent
->proto_remaining_count
);
442 if (protoEvent
->proto_remaining_count
== 0) {
443 mark_if_down(ifr_name
);
445 mark_if_up(ifr_name
);
450 #ifdef KEV_DL_IF_IDLE_ROUTE_REFCNT
451 case KEV_DL_IF_IDLE_ROUTE_REFCNT
: {
453 * interface route refcnt idle
455 if (dataLen
< sizeof(*ev
)) {
459 copy_if_name(ev
, ifr_name
, sizeof(ifr_name
));
460 SC_log(LOG_INFO
, "Process interface idle: %s", (char *)ifr_name
);
461 interface_update_idle_state(ifr_name
);
464 #endif // KEV_DL_IF_IDLE_ROUTE_REFCNT
466 case KEV_DL_LINK_OFF
:
467 case KEV_DL_LINK_ON
:
469 * update the link status in the store
471 if (dataLen
< sizeof(*ev
)) {
475 copy_if_name(ev
, ifr_name
, sizeof(ifr_name
));
476 SC_log(LOG_INFO
, "Process interface link %s: %s",
477 (ev_msg
->event_code
== KEV_DL_LINK_ON
) ? "up" : "down",
479 link_update_status(ifr_name
, FALSE
);
482 #ifdef KEV_DL_LINK_QUALITY_METRIC_CHANGED
483 case KEV_DL_LINK_QUALITY_METRIC_CHANGED
: {
484 struct kev_dl_link_quality_metric_data
* lqm_data
;
485 lqm_data
= (struct kev_dl_link_quality_metric_data
*) event_data
;
487 if (dataLen
< sizeof(*ev
)) {
491 copy_if_name(ev
, ifr_name
, sizeof(ifr_name
));
492 SC_log(LOG_INFO
, "Process interface quality: %s (q=%d)",
494 lqm_data
->link_quality_metric
);
495 interface_update_quality_metric(ifr_name
,
496 lqm_data
->link_quality_metric
);
499 #endif // KEV_DL_LINK_QUALITY_METRIC_CHANGED
502 case KEV_DL_ISSUES
: {
503 struct kev_dl_issues
*issues
;
505 issues
= (struct kev_dl_issues
*)event_data
;
506 if (dataLen
< sizeof(*ev
)) {
510 copy_if_name(ev
, ifr_name
, sizeof(ifr_name
));
511 SC_log(LOG_INFO
, "Process interface link issues: %s",
513 interface_update_link_issues(ifr_name
,
518 (bcmp(issues
->info
, info_zero
, DLIL_MODIDLEN
) != 0)
523 #endif // KEV_DL_ISSUES
525 case KEV_DL_SIFFLAGS
:
526 case KEV_DL_SIFMETRICS
:
528 case KEV_DL_SIFPHYS
:
529 case KEV_DL_SIFMEDIA
:
530 case KEV_DL_SIFGENERIC
:
531 case KEV_DL_ADDMULTI
:
532 case KEV_DL_DELMULTI
:
533 case KEV_DL_LINK_ADDRESS_CHANGED
:
534 case KEV_DL_WAKEFLAGS_CHANGED
:
535 #ifdef KEV_DL_IFCAP_CHANGED
536 case KEV_DL_IFCAP_CHANGED
:
537 #endif // KEV_DL_IFCAP_CHANGED
546 #ifdef KEV_ND6_SUBCLASS
547 case KEV_ND6_SUBCLASS
: {
548 switch (ev_msg
->event_code
) {
549 case KEV_KEV_ND6_RA
:
558 #endif // KEV_ND6_SUBCLASS
559 case KEV_LOG_SUBCLASS
: {
568 logEvent(CFSTR("New Apple network subclass"), ev_msg
);
574 eventCallback(int so
)
579 struct kern_event_msg ev_msg1
; // first kernel event
581 struct kern_event_msg
*ev_msg
= &buf
.ev_msg1
;
584 status
= recv(so
, &buf
, sizeof(buf
), 0);
586 SC_log(LOG_NOTICE
, "recv() failed: %s", strerror(errno
));
592 while (offset
< status
) {
593 if ((offset
+ ev_msg
->total_size
) > status
) {
594 SC_log(LOG_NOTICE
, "missed SYSPROTO_EVENT event, buffer not big enough");
598 switch (ev_msg
->vendor_code
) {
599 case KEV_VENDOR_APPLE
:
600 switch (ev_msg
->kev_class
) {
601 case KEV_NETWORK_CLASS
:
602 processEvent_Apple_Network(ev_msg
);
604 case KEV_IOKIT_CLASS
:
605 case KEV_SYSTEM_CLASS
:
606 case KEV_APPLESHARE_CLASS
:
607 case KEV_FIREWALL_CLASS
:
608 case KEV_IEEE80211_CLASS
:
611 /* unrecognized (Apple) event class */
612 logEvent(CFSTR("New (Apple) class"), ev_msg
);
617 /* unrecognized vendor code */
618 logEvent(CFSTR("New vendor"), ev_msg
);
621 offset
+= ev_msg
->total_size
;
622 ev_msg
= (struct kern_event_msg
*)(void *)&buf
.bytes
[offset
];
627 post_network_changed();
635 update_interfaces(const char * msg
, Boolean ipv4_ipv6_too
)
637 Boolean added
= FALSE
;
638 struct ifaddrs
* ifap
= NULL
;
639 CFMutableArrayRef ifList
= NULL
;
640 struct ifaddrs
* scan
;
642 if (getifaddrs(&ifap
) == -1) {
643 messages_add_msg_with_arg("getifaddrs", strerror(errno
));
644 SC_log(LOG_NOTICE
, "getifaddrs() failed: %s", strerror(errno
));
648 /* update list of interfaces & link status */
649 ifList
= interfaceListCopy();
650 for (scan
= ifap
; scan
!= NULL
; scan
= scan
->ifa_next
) {
651 if (scan
->ifa_addr
== NULL
652 || scan
->ifa_addr
->sa_family
!= AF_LINK
) {
655 /* get the per-interface link/media information */
656 if (interfaceListAddInterface(ifList
, scan
->ifa_name
)) {
657 messages_add_msg_with_arg(msg
, scan
->ifa_name
);
662 /* update the global list if an interface was added */
664 interfaceListUpdate(ifList
);
668 /* update IPv4/IPv6 addresses that are already assigned */
670 ipv4_interface_update(ifap
, NULL
);
671 interface_update_ipv6(ifap
, NULL
);
680 #define TIMER_INTERVAL (6LL * NSEC_PER_SEC)
681 #define MAX_TIMER_COUNT 20
684 check_for_new_interfaces(void * context
);
689 dispatch_after_f(dispatch_time(DISPATCH_TIME_NOW
, TIMER_INTERVAL
),
692 check_for_new_interfaces
);
697 check_for_new_interfaces(void * context
)
703 snprintf(msg
, sizeof(msg
), "timeout %d (of %d)", count
, MAX_TIMER_COUNT
);
705 update_interfaces(msg
, FALSE
);
710 /* schedule the next timer, if needed */
711 if (count
< MAX_TIMER_COUNT
) {
724 SC_log(LOG_DEBUG
, "prime() called");
728 update_interfaces("prime", TRUE
);
732 network_changed
= TRUE
;
733 post_network_changed();
736 /* start handling kernel events */
737 dispatch_resume(S_kev_source
);
739 /* schedule polling timer */
748 prime_KernelEventMonitor()
750 dispatch_async(S_kev_queue
, ^{ prime(); });
755 initialize_store(void)
757 store
= SCDynamicStoreCreate(NULL
,
758 CFSTR("Kernel Event Monitor plug-in"),
762 SC_log(LOG_ERR
, "SCDynamicStoreCreate() failed: %s", SCErrorString(SCError()));
771 load_KernelEventMonitor(CFBundleRef bundle
, Boolean bundleVerbose
)
773 struct kev_request kev_req
;
781 SC_log(LOG_DEBUG
, "load() called");
782 SC_log(LOG_DEBUG
, " bundle ID = %@", CFBundleGetIdentifier(bundle
));
784 if (!initialize_store()) {
785 SC_log(LOG_ERR
, "kernel event monitor disabled");
789 /* Open an event socket */
790 so
= socket(PF_SYSTEM
, SOCK_RAW
, SYSPROTO_EVENT
);
792 /* establish filter to return events of interest */
793 kev_req
.vendor_code
= KEV_VENDOR_APPLE
;
794 kev_req
.kev_class
= KEV_NETWORK_CLASS
;
795 kev_req
.kev_subclass
= KEV_ANY_SUBCLASS
;
796 status
= ioctl(so
, SIOCSKEVFILT
, &kev_req
);
798 SC_log(LOG_ERR
, "could not establish event filter, ioctl() failed: %s", strerror(errno
));
803 SC_log(LOG_ERR
, "could not open event socket, socket() failed: %s", strerror(errno
));
809 status
= ioctl(so
, FIONBIO
, &yes
);
811 SC_log(LOG_ERR
, "could not set non-blocking io, ioctl() failed: %s", strerror(errno
));
818 SC_log(LOG_ERR
, "kernel event monitor disabled");
823 S_kev_queue
= dispatch_queue_create("com.apple.SystemConfiguration.KernelEventMonitor", NULL
);
825 = dispatch_source_create(DISPATCH_SOURCE_TYPE_READ
, so
, 0, S_kev_queue
);
826 dispatch_source_set_cancel_handler(S_kev_source
, ^{
829 dispatch_source_set_event_handler(S_kev_source
, ^{
830 os_activity_t activity_id
;
833 activity_id
= os_activity_start("processing network kernel events",
834 OS_ACTIVITY_FLAG_DEFAULT
);
836 ok
= eventCallback(so
);
838 SC_log(LOG_ERR
, "kernel event monitor disabled");
839 dispatch_source_cancel(S_kev_source
);
842 os_activity_end(activity_id
);
844 // NOTE: dispatch_resume() will be called in prime()
853 #define appendAddress appendAddress_v4
854 #define getIF getIF_v4
855 #define updateStore updateStore_v4
861 #define appendAddress appendAddress_v6
862 #define getIF getIF_v6
863 #define updateStore updateStore_v6
870 main(int argc
, char **argv
)
873 _sc_verbose
= (argc
> 1) ? TRUE
: FALSE
;
875 load_KernelEventMonitor(CFBundleGetMainBundle(), (argc
> 1) ? TRUE
: FALSE
);
876 prime_KernelEventMonitor();