bsd/netinet/tcp_log.h

   1 /*
   2  * Copyright (c) 2018-2019 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 extern int tcp_log_privacy;
  57
  58 #define TCP_ENABLE_FLAG_LIST \
  59         X(TLEF_CONNECTION,      0x1, connection)        \
  60         X(TLEF_RTT,             0x2, rtt)               \
  61         X(TLEF_KEEP_ALIVE,      0x4, ka)                \
  62         X(TLEF_DST_LOOPBACK,    0x10, loop)             \
  63         X(TLEF_DST_LOCAL,       0x20, local)            \
  64         X(TLEF_DST_GW,          0x40, gw)               \
  65         X(TLEF_THF_SYN,         0x100, syn)             \
  66         X(TLEF_THF_FIN,         0x200, fin)             \
  67         X(TLEF_THF_RST,         0x400, rst)             \
  68         X(TLEF_DROP_NECP,       0x1000, dropnecp)       \
  69         X(TLEF_DROP_PCB,        0x2000, droppcb)       \
  70         X(TLEF_DROP_PKT,        0x4000, droppkt)       \
  71         X(TLEF_FSW_FLOW,        0x8000, fswflow)
  72
  73 /*
  74  * Flag values for tcp_log_enabled
  75  */
  76 enum {
  77 #define X(name, value, ...) name = value,
  78         TCP_ENABLE_FLAG_LIST
  79 #undef X
  80 };
  81
  82 #define TLEF_MASK_DST (TLEF_DST_LOOPBACK | TLEF_DST_LOCAL | TLEF_DST_GW)
  83
  84 #define TLEF_MASK_THF (TLEF_THF_SYN | TLEF_THF_FIN | TLEF_THF_RST)
  85
  86 extern void tcp_log_connection_summary(struct tcpcb *tp);
  87 extern void tcp_log_th_flags(void *hdr, struct tcphdr *th, struct tcpcb *tp, bool outgoing, struct ifnet *ifp);
  88 extern void tcp_log_connection(struct tcpcb *tp, const char *event, int error);
  89 extern void tcp_log_listen(struct tcpcb *tp, int error);
  90 extern void tcp_log_drop_pcb(void *hdr, struct tcphdr *th, struct tcpcb *tp, bool outgoing, const char *reason);
  91 extern void tcp_log_drop_pkt(void *hdr, struct tcphdr *th, struct ifnet *ifp, const char *reason);
  92 extern void tcp_log_rtt_info(const char *func_name, int line_no, struct tcpcb *tp);
  93 extern void tcp_log_rt_rtt(const char *func_name, int line_no, struct tcpcb *tp, struct rtentry *rt);
  94 extern void tcp_log_rtt_change(const char *func_name, int line_no, struct tcpcb *tp, int old_srtt, int old_rttvar);
  95 extern void tcp_log_keepalive(const char *func_name, int line_no, struct tcpcb *tp, int32_t idle_time);
  96 extern void tcp_log_message(const char *func_name, int line_no, struct tcpcb *tp, const char *format, ...);
  97 extern void tcp_log_fsw_flow(const char *func_name, int line_no, struct tcpcb *tp, const char *format, ...);
  98
  99 static inline bool
 100 tcp_is_log_enabled(struct tcpcb *tp, uint32_t req_flags)
 101 {
 102         if (tp == NULL || tp->t_inpcb == NULL) {
 103                 return false;
 104         }
 105         if (tcp_log_port > 0 && tcp_log_port <= IPPORT_HILASTAUTO) {
 106                 if (ntohs(tp->t_inpcb->inp_lport) != tcp_log_port &&
 107                     ntohs(tp->t_inpcb->inp_fport) != tcp_log_port) {
 108                         return false;
 109                 }
 110         }
 111         /*
 112          * First find out the kind of destination
 113          */
 114         if (tp->t_log_flags == 0) {
 115                 if (tp->t_inpcb->inp_vflag & INP_IPV6) {
 116                         if (IN6_IS_ADDR_LOOPBACK(&tp->t_inpcb->in6p_laddr) ||
 117                             IN6_IS_ADDR_LOOPBACK(&tp->t_inpcb->in6p_faddr)) {
 118                                 tp->t_log_flags |= TLEF_DST_LOOPBACK;
 119                         }
 120                 } else {
 121                         if (ntohl(tp->t_inpcb->inp_laddr.s_addr) == INADDR_LOOPBACK ||
 122                             ntohl(tp->t_inpcb->inp_faddr.s_addr) == INADDR_LOOPBACK) {
 123                                 tp->t_log_flags |= TLEF_DST_LOOPBACK;
 124                         }
 125                 }
 126                 if (tp->t_log_flags == 0) {
 127                         if (tp->t_flags & TF_LOCAL) {
 128                                 tp->t_log_flags |= TLEF_DST_LOCAL;
 129                         } else {
 130                                 tp->t_log_flags |= TLEF_DST_GW;
 131                         }
 132                 }
 133         }
 134         /*
 135          * Check separately the destination flags that are per TCP connection
 136          * and the other functional flags that are global
 137          */
 138         return (tp->t_log_flags & tcp_log_enable_flags & TLEF_MASK_DST) &&
 139                (tcp_log_enable_flags & (req_flags & ~TLEF_MASK_DST));
 140 }
 141
 142 #define TCP_LOG_RTT_INFO(tp) if (tcp_is_log_enabled(tp, TLEF_RTT)) \
 143     tcp_log_rtt_info(__func__, __LINE__, (tp))
 144
 145 #define TCP_LOG_RTM_RTT(tp, rt) if (tcp_is_log_enabled(tp, TLEF_RTT)) \
 146     tcp_log_rt_rtt(__func__, __LINE__, (tp), (rt))
 147
 148 #define TCP_LOG_RTT_CHANGE(tp, old_srtt, old_rttvar) if (tcp_is_log_enabled(tp, TLEF_RTT)) \
 149     tcp_log_rtt_change(__func__, __LINE__, (tp), (old_srtt), (old_rttvar))
 150
 151 #define TCP_LOG_KEEP_ALIVE(tp, idle_time) if (tcp_is_log_enabled(tp, TLEF_KEEP_ALIVE)) \
 152     tcp_log_keepalive(__func__, __LINE__, (tp), (idle_time))
 153
 154 #define TCP_LOG_CONNECT(tp, outgoing, error) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \
 155     tcp_log_connection((tp), (outgoing) ? "connect outgoing" : "connect incoming", (error))
 156
 157 #define TCP_LOG_LISTEN(tp, error) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \
 158     tcp_log_listen((tp), (error))
 159
 160 #define TCP_LOG_ACCEPT(tp, error) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \
 161     tcp_log_connection((tp), "accept", (error))
 162
 163 #define TCP_LOG_CONNECTION_SUMMARY(tp) if (tcp_is_log_enabled(tp, TLEF_CONNECTION)) \
 164     tcp_log_connection_summary((tp))
 165
 166 #define TCP_LOG_DROP_NECP(hdr, th, tp, outgoing) if (tcp_is_log_enabled(tp, TLEF_DROP_NECP)) \
 167     tcp_log_drop_pcb((hdr), (th), (tp), (outgoing), "NECP")
 168
 169 #define TCP_LOG_DROP_PCB(hdr, th, tp, outgoing, reason) if (tcp_is_log_enabled(tp, TLEF_DROP_PCB)) \
 170     tcp_log_drop_pcb((hdr), (th), (tp), (outgoing), reason)
 171
 172 #define TCP_LOG_TH_FLAGS(hdr, th, tp, outgoing, ifp) \
 173     if ((th) != NULL && ((th)->th_flags & (TH_SYN|TH_FIN|TH_RST))) \
 174             tcp_log_th_flags((hdr), (th), (tp), (outgoing), (ifp))
 175
 176 #define TCP_LOG_DROP_PKT(hdr, th, ifp, reason) \
 177     if ((th) != NULL && ((th->th_flags) & (TH_SYN|TH_FIN|TH_RST)) && \
 178         (tcp_log_enable_flags & TLEF_DROP_PKT)) \
 179                 tcp_log_drop_pkt((hdr), (th), (ifp), (reason))
 180
 181 #define TCP_LOG_FSW_FLOW(tp, format, ...) if (tcp_is_log_enabled(tp, TLEF_FSW_FLOW)) \
 182     tcp_log_fsw_flow(__func__, __LINE__, (tp), format, ##__VA_ARGS__)
 183
 184 #define TCP_LOG(tp, format, ...) \
 185     tcp_log_message(__func__, __LINE__, tp, format, ## __VA_ARGS__)
 186
 187
 188
 189 #endif /* BSD_KERNEL_RPIVATE */
 190
 191 #endif /* _NETINET_TCP_LOG_H_ */