1 | /* |
2 | * Copyright (c) 2018-2023 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 | |
30 | #ifndef _NETINET_TCP_LOG_H_ |
31 | #define _NETINET_TCP_LOG_H_ |
32 | |
33 | #ifdef BSD_KERNEL_PRIVATE |
34 | |
35 | #include <sys/param.h> |
36 | #include <sys/systm.h> |
37 | |
38 | #include <netinet/in.h> |
39 | #include <netinet/in_systm.h> |
40 | #include <netinet/in_pcb.h> |
41 | #include <netinet6/in6_pcb.h> |
42 | |
43 | #include <netinet/tcp.h> |
44 | #include <netinet/tcp_var.h> |
45 | #include <netinet6/tcp6_var.h> |
46 | |
47 | #include <net/net_log_common.h> |
48 | |
49 | #include <os/log.h> |
50 | |
51 | #include <stdbool.h> |
52 | |
53 | extern os_log_t tcp_mpkl_log_object; |
54 | extern uint32_t tcp_log_enable_flags; |
55 | extern uint32_t tcp_log_port; |
56 | |
57 | #define TCP_ENABLE_FLAG_LIST \ |
58 | X(TLEF_CONNECTION, 0x00000001, connection) \ |
59 | X(TLEF_RTT, 0x00000002, rtt) \ |
60 | X(TLEF_KEEP_ALIVE, 0x00000004, ka) \ |
61 | X(TLEF_LOG, 0x00000008, log) \ |
62 | X(TLEF_DST_LOOPBACK, 0x00000010, loop) \ |
63 | X(TLEF_DST_LOCAL, 0x00000020, local) \ |
64 | X(TLEF_DST_GW, 0x00000040, gw) \ |
65 | X(TLEF_THF_SYN, 0x00000100, syn) \ |
66 | X(TLEF_THF_FIN, 0x00000200, fin) \ |
67 | X(TLEF_THF_RST, 0x00000400, rst) \ |
68 | X(TLEF_DROP_NECP, 0x00001000, dropnecp) \ |
69 | X(TLEF_DROP_PCB, 0x00002000, droppcb) \ |
70 | X(TLEF_DROP_PKT, 0x00004000, droppkt) \ |
71 | X(TLEF_FSW_FLOW, 0x00008000, fswflow) \ |
72 | X(TLEF_STATE, 0x00010000, state) \ |
73 | X(TLEF_SYN_RXMT, 0x00020000, synrxmt) \ |
74 | X(TLEF_OUTPUT, 0x00040000, output) |
75 | |
76 | /* |
77 | * Flag values for tcp_log_enabled |
78 | */ |
79 | enum { |
80 | #define X(name, value, ...) name = value, |
81 | TCP_ENABLE_FLAG_LIST |
82 | #undef X |
83 | }; |
84 | |
85 | #define TLEF_MASK_DST (TLEF_DST_LOOPBACK | TLEF_DST_LOCAL | TLEF_DST_GW) |
86 | |
87 | extern void tcp_log_connection_summary(struct tcpcb *tp); |
88 | extern void tcp_log_th_flags(void *hdr, struct tcphdr *th, struct tcpcb *tp, bool outgoing, struct ifnet *ifp); |
89 | extern void tcp_log_connection(struct tcpcb *tp, const char *event, int error); |
90 | extern void tcp_log_listen(struct tcpcb *tp, int error); |
91 | extern void tcp_log_drop_pcb(void *hdr, struct tcphdr *th, struct tcpcb *tp, bool outgoing, const char *reason); |
92 | extern void tcp_log_drop_pkt(void *hdr, struct tcphdr *th, struct ifnet *ifp, const char *reason); |
93 | extern void tcp_log_rtt_info(const char *func_name, int line_no, struct tcpcb *tp); |
94 | extern void tcp_log_rt_rtt(const char *func_name, int line_no, struct tcpcb *tp, struct rtentry *rt); |
95 | extern void tcp_log_rtt_change(const char *func_name, int line_no, struct tcpcb *tp, int old_srtt, int old_rttvar); |
96 | extern void tcp_log_keepalive(const char *func_name, int line_no, struct tcpcb *tp, int32_t idle_time); |
97 | extern void tcp_log_message(const char *func_name, int line_no, struct tcpcb *tp, const char *format, ...) __printflike(4, 5); |
98 | extern void tcp_log_fsw_flow(const char *func_name, int line_no, struct tcpcb *tp, const char *format, ...) __printflike(4, 5); |
99 | extern void tcp_log_state_change(struct tcpcb *tp, int new_state); |
100 | extern void tcp_log_output(const char *func_name, int line_no, struct tcpcb *tp, const char *format, ...) __printflike(4, 5); |
101 | |
102 | static inline bool |
103 | tcp_is_log_enabled(struct tcpcb *tp, uint32_t req_flags) |
104 | { |
105 | struct inpcb *inp; |
106 | |
107 | if (tp == NULL || tp->t_inpcb == NULL) { |
108 | return false; |
109 | } |
110 | inp = tp->t_inpcb; |
111 | if (tcp_log_port > 0 && tcp_log_port <= IPPORT_HILASTAUTO) { |
112 | if (ntohs(inp->inp_lport) != tcp_log_port && |
113 | ntohs(tp->t_inpcb->inp_fport) != tcp_log_port) { |
114 | return false; |
115 | } |
116 | } |
117 | /* |
118 | * First find out the kind of destination |
119 | */ |
120 | if (inp->inp_log_flags == 0) { |
121 | if (tp->t_inpcb->inp_vflag & INP_IPV6) { |
122 | if (IN6_IS_ADDR_LOOPBACK(&tp->t_inpcb->in6p_laddr) || |
123 | IN6_IS_ADDR_LOOPBACK(&tp->t_inpcb->in6p_faddr)) { |
124 | inp->inp_log_flags |= TLEF_DST_LOOPBACK; |
125 | } |
126 | } else { |
127 | if (ntohl(tp->t_inpcb->inp_laddr.s_addr) == INADDR_LOOPBACK || |
128 | ntohl(tp->t_inpcb->inp_faddr.s_addr) == INADDR_LOOPBACK) { |
129 | inp->inp_log_flags |= TLEF_DST_LOOPBACK; |
130 | } |
131 | } |
132 | if (inp->inp_log_flags == 0) { |
133 | if (tp->t_flags & TF_LOCAL) { |
134 | inp->inp_log_flags |= TLEF_DST_LOCAL; |
135 | } else { |
136 | inp->inp_log_flags |= TLEF_DST_GW; |
137 | } |
138 | } |
139 | } |
140 | /* |
141 | * Check separately the destination flags that are per TCP connection |
142 | * and the other functional flags that are global |
143 | */ |
144 | return (inp->inp_log_flags & tcp_log_enable_flags & TLEF_MASK_DST) && |
145 | (tcp_log_enable_flags & (req_flags & ~TLEF_MASK_DST)); |
146 | } |
147 | |
148 | #define TCP_LOG_RTT_INFO(tp) if (tcp_is_log_enabled(tp, TLEF_RTT)) \ |
149 | tcp_log_rtt_info(__func__, __LINE__, (tp)) |
150 | |
151 | #define TCP_LOG_RTM_RTT(tp, rt) if (tcp_is_log_enabled(tp, TLEF_RTT)) \ |
152 | tcp_log_rt_rtt(__func__, __LINE__, (tp), (rt)) |
153 | |
154 | #define TCP_LOG_RTT_CHANGE(tp, old_srtt, old_rttvar) if (tcp_is_log_enabled(tp, TLEF_RTT)) \ |
155 | tcp_log_rtt_change(__func__, __LINE__, (tp), (old_srtt), (old_rttvar)) |
156 | |
157 | #define TCP_LOG_KEEP_ALIVE(tp, idle_time) if (tcp_is_log_enabled(tp, TLEF_KEEP_ALIVE)) \ |
158 | tcp_log_keepalive(__func__, __LINE__, (tp), (idle_time)) |
159 | |
160 | #define TCP_LOG_CONNECT(tp, outgoing, error) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \ |
161 | tcp_log_connection((tp), (outgoing) ? "connect outgoing" : "connect incoming", (error)) |
162 | |
163 | #define TCP_LOG_CONNECTED(tp, error) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \ |
164 | tcp_log_connection((tp), "connected", (error)) |
165 | |
166 | #define TCP_LOG_LISTEN(tp, error) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \ |
167 | tcp_log_listen((tp), (error)) |
168 | |
169 | #define TCP_LOG_ACCEPT(tp, error) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \ |
170 | tcp_log_connection((tp), "accept", (error)) |
171 | |
172 | #define TCP_LOG_CONNECTION_SUMMARY(tp) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \ |
173 | tcp_log_connection_summary((tp)) |
174 | |
175 | #define TCP_LOG_DROP_NECP(hdr, th, tp, outgoing) if (tcp_is_log_enabled(tp, TLEF_DROP_NECP)) \ |
176 | tcp_log_drop_pcb((hdr), (th), (tp), (outgoing), "NECP") |
177 | |
178 | #define TCP_LOG_DROP_PCB(hdr, th, tp, outgoing, reason) if (tcp_is_log_enabled(tp, TLEF_DROP_PCB)) \ |
179 | tcp_log_drop_pcb((hdr), (th), (tp), (outgoing), reason) |
180 | |
181 | #define TCP_LOG_TH_FLAGS(hdr, th, tp, outgoing, ifp) \ |
182 | if ((th) != NULL && ((th)->th_flags & (TH_SYN|TH_FIN|TH_RST))) \ |
183 | tcp_log_th_flags((hdr), (th), (tp), (outgoing), (ifp)) |
184 | |
185 | #define TCP_LOG_DROP_PKT(hdr, th, ifp, reason) \ |
186 | if ((th) != NULL && ((th->th_flags) & (TH_SYN|TH_FIN|TH_RST)) && \ |
187 | (tcp_log_enable_flags & TLEF_DROP_PKT)) \ |
188 | tcp_log_drop_pkt((hdr), (th), (ifp), (reason)) |
189 | |
190 | #define TCP_LOG_FSW_FLOW(tp, format, ...) if (tcp_is_log_enabled(tp, TLEF_FSW_FLOW)) \ |
191 | tcp_log_fsw_flow(__func__, __LINE__, (tp), format, ##__VA_ARGS__) |
192 | |
193 | #define TCP_LOG(tp, format, ...) if (tcp_is_log_enabled(tp, TLEF_LOG)) \ |
194 | tcp_log_message(__func__, __LINE__, tp, format, ## __VA_ARGS__) |
195 | |
196 | #define TCP_LOG_STATE(tp, new_state) if (tcp_log_enable_flags & TLEF_STATE) \ |
197 | tcp_log_state_change((tp), (new_state)) |
198 | |
199 | #define TCP_LOG_OUTPUT(tp, format, ...) if (tcp_is_log_enabled(tp, TLEF_OUTPUT)) \ |
200 | tcp_log_output(__func__, __LINE__, tp, format, ## __VA_ARGS__) |
201 | |
202 | #endif /* BSD_KERNEL_PRIVATE */ |
203 | |
204 | #endif /* _NETINET_TCP_LOG_H_ */ |
205 | |