[apple/xnu.git] / bsd / net / net_api_stats.h

/*
 * Copyright (c) 2017 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef __NET_API_STATS__
#define __NET_API_STATS__

#ifdef PRIVATE
#include <stdint.h>

/*
 * net_api_stats counts the usage of the networking APIs
 *
 * Note: we are using signed 64 bit values to detect and prevent wrap around
 */
struct net_api_stats {
	/*
	 * Interface Filters
	 */
	int64_t nas_iflt_attach_count;  // Currently attached
	int64_t nas_iflt_attach_total;  // Total number of attachments
	int64_t nas_iflt_attach_os_total;

	/*
	 * IP Filters
	 */
	int64_t nas_ipf_add_count;      // Currently attached
	int64_t nas_ipf_add_total;      // Total number of attachments
	int64_t nas_ipf_add_os_total;

	/*
	 * Socket Filters
	 */
	int64_t nas_sfltr_register_count;       // Currently attached
	int64_t nas_sfltr_register_total;       // Total number of attachments
	int64_t nas_sfltr_register_os_total;

	/*
	 * Sockets
	 */
	int64_t nas_socket_alloc_total;
	int64_t nas_socket_in_kernel_total;
	int64_t nas_socket_in_kernel_os_total;
	int64_t nas_socket_necp_clientuuid_total;

	/*
	 * Sockets per protocol domains
	 */
	int64_t nas_socket_domain_local_total;
	int64_t nas_socket_domain_route_total;
	int64_t nas_socket_domain_inet_total;
	int64_t nas_socket_domain_inet6_total;
	int64_t nas_socket_domain_system_total;
	int64_t nas_socket_domain_multipath_total;
	int64_t nas_socket_domain_key_total;
	int64_t nas_socket_domain_ndrv_total;
	int64_t nas_socket_domain_other_total;

	/*
	 * Sockets per domain and type
	 */
	int64_t nas_socket_inet_stream_total;
	int64_t nas_socket_inet_dgram_total;
	int64_t nas_socket_inet_dgram_connected;
	int64_t nas_socket_inet_dgram_dns;      // port 53
	int64_t nas_socket_inet_dgram_no_data;  // typically for interface ioctl

	int64_t nas_socket_inet6_stream_total;
	int64_t nas_socket_inet6_dgram_total;
	int64_t nas_socket_inet6_dgram_connected;
	int64_t nas_socket_inet6_dgram_dns;     // port 53
	int64_t nas_socket_inet6_dgram_no_data; // typically for interface ioctl

	/*
	 * Multicast join
	 */
	int64_t nas_socket_mcast_join_total;
	int64_t nas_socket_mcast_join_os_total;

	/*
	 * IPv6 Extension Header Socket API
	 */
	int64_t nas_sock_inet6_stream_exthdr_in;
	int64_t nas_sock_inet6_stream_exthdr_out;
	int64_t nas_sock_inet6_dgram_exthdr_in;
	int64_t nas_sock_inet6_dgram_exthdr_out;

	/*
	 * Nexus flows
	 */
	int64_t nas_nx_flow_inet_stream_total;
	int64_t nas_nx_flow_inet_dgram_total;

	int64_t nas_nx_flow_inet6_stream_total;
	int64_t nas_nx_flow_inet6_dgram_total;

	/*
	 * Interfaces
	 */
	int64_t nas_ifnet_alloc_count;
	int64_t nas_ifnet_alloc_total;
	int64_t nas_ifnet_alloc_os_count;
	int64_t nas_ifnet_alloc_os_total;

	/*
	 * PF
	 */
	int64_t nas_pf_addrule_total;
	int64_t nas_pf_addrule_os;

	/*
	 * vmnet API
	 */
	int64_t nas_vmnet_total;
};

#ifdef XNU_KERNEL_PRIVATE
extern struct net_api_stats net_api_stats;

/*
 * Increment up to the max value of int64_t
 */
#define INC_ATOMIC_INT64_LIM(counter) {                                 \
	int64_t val;                                                    \
	do {                                                            \
	        val = counter;                                          \
	        if (val >= INT64_MAX) {                                 \
	                break;                                          \
	        }                                                       \
	} while (!OSCompareAndSwap64(val, val + 1, &(counter)));        \
}
#endif /* XNU_KERNEL_PRIVATE */

#endif /* PRIVATE */

#endif /* __NET_API_STATS__ */
Commit	Line	Data
5ba3f43e A	1	/*
	2	* Copyright (c) 2017 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
	5	*
	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. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28
	29	#ifndef __NET_API_STATS__
0a7de745	30	#define __NET_API_STATS__
5ba3f43e A	31
	32	#ifdef PRIVATE
	33	#include <stdint.h>
	34
	35	/*
	36	* net_api_stats counts the usage of the networking APIs
	37	*
	38	* Note: we are using signed 64 bit values to detect and prevent wrap around
	39	*/
	40	struct net_api_stats {
	41	/*
	42	* Interface Filters
	43	*/
0a7de745 A	44	int64_t nas_iflt_attach_count; // Currently attached
0a7de745 A	45	int64_t nas_iflt_attach_total; // Total number of attachments
5ba3f43e A	46	int64_t nas_iflt_attach_os_total;
	47
	48	/*
	49	* IP Filters
	50	*/
0a7de745 A	51	int64_t nas_ipf_add_count; // Currently attached
0a7de745 A	52	int64_t nas_ipf_add_total; // Total number of attachments
5ba3f43e A	53	int64_t nas_ipf_add_os_total;
	54
	55	/*
	56	* Socket Filters
	57	*/
0a7de745 A	58	int64_t nas_sfltr_register_count; // Currently attached
0a7de745 A	59	int64_t nas_sfltr_register_total; // Total number of attachments
5ba3f43e A	60	int64_t nas_sfltr_register_os_total;
	61
	62	/*
	63	* Sockets
	64	*/
0a7de745 A	65	int64_t nas_socket_alloc_total;
0a7de745 A	66	int64_t nas_socket_in_kernel_total;
5ba3f43e	67	int64_t nas_socket_in_kernel_os_total;
0a7de745	68	int64_t nas_socket_necp_clientuuid_total;
5ba3f43e A	69
	70	/*
	71	* Sockets per protocol domains
	72	*/
	73	int64_t nas_socket_domain_local_total;
	74	int64_t nas_socket_domain_route_total;
	75	int64_t nas_socket_domain_inet_total;
	76	int64_t nas_socket_domain_inet6_total;
	77	int64_t nas_socket_domain_system_total;
	78	int64_t nas_socket_domain_multipath_total;
	79	int64_t nas_socket_domain_key_total;
	80	int64_t nas_socket_domain_ndrv_total;
	81	int64_t nas_socket_domain_other_total;
	82
	83	/*
	84	* Sockets per domain and type
	85	*/
	86	int64_t nas_socket_inet_stream_total;
	87	int64_t nas_socket_inet_dgram_total;
	88	int64_t nas_socket_inet_dgram_connected;
0a7de745 A	89	int64_t nas_socket_inet_dgram_dns; // port 53
0a7de745 A	90	int64_t nas_socket_inet_dgram_no_data; // typically for interface ioctl
5ba3f43e A	91
	92	int64_t nas_socket_inet6_stream_total;
	93	int64_t nas_socket_inet6_dgram_total;
	94	int64_t nas_socket_inet6_dgram_connected;
0a7de745 A	95	int64_t nas_socket_inet6_dgram_dns; // port 53
0a7de745 A	96	int64_t nas_socket_inet6_dgram_no_data; // typically for interface ioctl
5ba3f43e A	97
	98	/*
	99	* Multicast join
	100	*/
	101	int64_t nas_socket_mcast_join_total;
	102	int64_t nas_socket_mcast_join_os_total;
	103
	104	/*
	105	* IPv6 Extension Header Socket API
	106	*/
0a7de745 A	107	int64_t nas_sock_inet6_stream_exthdr_in;
	108	int64_t nas_sock_inet6_stream_exthdr_out;
	109	int64_t nas_sock_inet6_dgram_exthdr_in;
	110	int64_t nas_sock_inet6_dgram_exthdr_out;
5ba3f43e A	111
	112	/*
	113	* Nexus flows
	114	*/
0a7de745 A	115	int64_t nas_nx_flow_inet_stream_total;
0a7de745 A	116	int64_t nas_nx_flow_inet_dgram_total;
5ba3f43e	117
0a7de745 A	118	int64_t nas_nx_flow_inet6_stream_total;
0a7de745 A	119	int64_t nas_nx_flow_inet6_dgram_total;
5ba3f43e A	120
	121	/*
	122	* Interfaces
	123	*/
0a7de745 A	124	int64_t nas_ifnet_alloc_count;
	125	int64_t nas_ifnet_alloc_total;
	126	int64_t nas_ifnet_alloc_os_count;
	127	int64_t nas_ifnet_alloc_os_total;
5ba3f43e A	128
	129	/*
	130	* PF
	131	*/
0a7de745 A	132	int64_t nas_pf_addrule_total;
0a7de745 A	133	int64_t nas_pf_addrule_os;
5ba3f43e A	134
	135	/*
	136	* vmnet API
	137	*/
	138	int64_t nas_vmnet_total;
	139	};
	140
	141	#ifdef XNU_KERNEL_PRIVATE
	142	extern struct net_api_stats net_api_stats;
	143
	144	/*
	145	* Increment up to the max value of int64_t
	146	*/
0a7de745 A	147	#define INC_ATOMIC_INT64_LIM(counter) { \
	148	int64_t val; \
	149	do { \
	150	val = counter; \
	151	if (val >= INT64_MAX) { \
	152	break; \
	153	} \
	154	} while (!OSCompareAndSwap64(val, val + 1, &(counter))); \
5ba3f43e A	155	}
	156	#endif /* XNU_KERNEL_PRIVATE */
	157
	158	#endif /* PRIVATE */
	159
	160	#endif /* __NET_API_STATS__ */