| /* |
| * sfe_ipv4.h |
| * Shortcut forwarding engine header file for IPv4. |
| * |
| * Copyright (c) 2013-2016, 2019-2020, The Linux Foundation. All rights reserved. |
| * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved. |
| * |
| * Permission to use, copy, modify, and/or distribute this software for any |
| * purpose with or without fee is hereby granted, provided that the above |
| * copyright notice and this permission notice appear in all copies. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
| * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
| * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
| * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| */ |
| |
| #ifndef __SFE_IPV4_H |
| #define __SFE_IPV4_H |
| |
| #define SFE_IPV4_DSCP_MASK 0x3 |
| #define SFE_IPV4_DSCP_SHIFT 2 |
| |
| /* |
| * Specifies the lower bound on ACK numbers carried in the TCP header |
| */ |
| #define SFE_IPV4_TCP_MAX_ACK_WINDOW 65520 |
| |
| /* |
| * IPv4 TCP connection match additional data. |
| */ |
| struct sfe_ipv4_tcp_connection_match { |
| u8 win_scale; /* Window scale */ |
| u32 max_win; /* Maximum window size seen */ |
| u32 end; /* Sequence number of the next byte to send (seq + segment length) */ |
| u32 max_end; /* Sequence number of the last byte to ack */ |
| }; |
| |
| /* |
| * Bit flags for IPv4 connection matching entry. |
| */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_XLATE_SRC (1<<0) |
| /* Perform source translation */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_XLATE_DEST (1<<1) |
| /* Perform destination translation */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_NO_SEQ_CHECK (1<<2) |
| /* Ignore TCP sequence numbers */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_WRITE_FAST_ETH_HDR (1<<3) |
| /* Fast Ethernet header write */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_WRITE_L2_HDR (1<<4) |
| /* Fast Ethernet header write */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_PRIORITY_REMARK (1<<5) |
| /* remark priority of SKB */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_DSCP_REMARK (1<<6) |
| /* remark DSCP of packet */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_CSUM_OFFLOAD (1<<7) |
| /* checksum offload.*/ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_PPPOE_DECAP (1<<8) |
| /* Indicates that PPPoE should be decapsulated */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_PPPOE_ENCAP (1<<9) |
| /* Indicates that PPPoE should be encapsulated */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_BRIDGE_FLOW (1<<10) |
| /* Bridge flow */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_MARK (1<<11) |
| /* skb mark of the packet */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_INSERT_EGRESS_VLAN_TAG (1<<12) |
| /* Insert VLAN tag */ |
| #define SFE_IPV4_CONNECTION_MATCH_FLAG_SRC_INTERFACE_CHECK (1<<13) |
| /* Source interface check.*/ |
| |
| /* |
| * IPv4 connection matching structure. |
| */ |
| struct sfe_ipv4_connection_match { |
| /* |
| * References to other objects. |
| */ |
| struct hlist_node hnode; |
| |
| struct sfe_ipv4_connection *connection; |
| struct sfe_ipv4_connection_match *counter_match; |
| /* Matches the flow in the opposite direction as the one in *connection */ |
| /* |
| * Characteristics that identify flows that match this rule. |
| */ |
| struct net_device *match_dev; /* Network device */ |
| u8 match_protocol; /* Protocol */ |
| __be32 match_src_ip; /* Source IP address */ |
| __be32 match_dest_ip; /* Destination IP address */ |
| __be16 match_src_port; /* Source port/connection ident */ |
| __be16 match_dest_port; /* Destination port/connection ident */ |
| |
| struct udp_sock *up; /* Stores UDP sock information; valid only in decap path */ |
| |
| /* |
| * Control the operations of the match. |
| */ |
| u32 flags; /* Bit flags */ |
| #ifdef CONFIG_NF_FLOW_COOKIE |
| u32 flow_cookie; /* used flow cookie, for debug */ |
| #endif |
| #ifdef CONFIG_XFRM |
| u32 flow_accel; /* The flow accelerated or not */ |
| #endif |
| |
| /* |
| * Connection state that we track once we match. |
| */ |
| union { /* Protocol-specific state */ |
| struct sfe_ipv4_tcp_connection_match tcp; |
| } protocol_state; |
| |
| /* |
| * VLAN headers |
| */ |
| struct sfe_vlan_hdr ingress_vlan_hdr[SFE_MAX_VLAN_DEPTH]; |
| struct sfe_vlan_hdr egress_vlan_hdr[SFE_MAX_VLAN_DEPTH]; |
| |
| /* |
| * Stats recorded in a sync period. These stats will be added to |
| * rx_packet_count64/rx_byte_count64 after a sync period. |
| */ |
| atomic_t rx_packet_count; |
| atomic_t rx_byte_count; |
| |
| /* |
| * Packet translation information. |
| */ |
| __be32 xlate_src_ip; /* Address after source translation */ |
| __be16 xlate_src_port; /* Port/connection ident after source translation */ |
| u16 xlate_src_csum_adjustment; |
| /* Transport layer checksum adjustment after source translation */ |
| u16 xlate_src_partial_csum_adjustment; |
| /* Transport layer pseudo header checksum adjustment after source translation */ |
| |
| __be32 xlate_dest_ip; /* Address after destination translation */ |
| __be16 xlate_dest_port; /* Port/connection ident after destination translation */ |
| u16 xlate_dest_csum_adjustment; |
| /* Transport layer checksum adjustment after destination translation */ |
| u16 xlate_dest_partial_csum_adjustment; |
| /* Transport layer pseudo header checksum adjustment after destination translation */ |
| |
| /* |
| * QoS information |
| */ |
| u32 priority; |
| u32 dscp; |
| u32 mark; /* mark for outgoing packet */ |
| |
| /* |
| * Packet transmit information. |
| */ |
| struct net_device *xmit_dev; /* Network device on which to transmit */ |
| unsigned short int xmit_dev_mtu; |
| /* Interface MTU */ |
| u16 xmit_dest_mac[ETH_ALEN / 2]; |
| /* Destination MAC address to use when forwarding */ |
| u16 xmit_src_mac[ETH_ALEN / 2]; |
| /* Source MAC address to use when forwarding */ |
| |
| u8 ingress_vlan_hdr_cnt; /* Ingress active vlan headers count */ |
| u8 egress_vlan_hdr_cnt; /* Egress active vlan headers count */ |
| |
| /* |
| * Summary stats. |
| */ |
| u64 rx_packet_count64; |
| u64 rx_byte_count64; |
| |
| /* |
| * PPPoE information |
| */ |
| u16 pppoe_session_id; |
| u8 pppoe_remote_mac[ETH_ALEN]; |
| |
| /* |
| * Size of all needed L2 headers |
| */ |
| u16 l2_hdr_size; |
| }; |
| |
| /* |
| * Per-connection data structure. |
| */ |
| struct sfe_ipv4_connection { |
| struct sfe_ipv4_connection *next; |
| /* Pointer to the next entry in a hash chain */ |
| struct sfe_ipv4_connection *prev; |
| /* Pointer to the previous entry in a hash chain */ |
| int protocol; /* IP protocol number */ |
| __be32 src_ip; /* Src IP addr pre-translation */ |
| __be32 src_ip_xlate; /* Src IP addr post-translation */ |
| __be32 dest_ip; /* Dest IP addr pre-translation */ |
| __be32 dest_ip_xlate; /* Dest IP addr post-translation */ |
| __be16 src_port; /* Src port pre-translation */ |
| __be16 src_port_xlate; /* Src port post-translation */ |
| __be16 dest_port; /* Dest port pre-translation */ |
| __be16 dest_port_xlate; /* Dest port post-translation */ |
| struct sfe_ipv4_connection_match *original_match; |
| /* Original direction matching structure */ |
| struct net_device *original_dev; |
| /* Original direction source device */ |
| struct sfe_ipv4_connection_match *reply_match; |
| /* Reply direction matching structure */ |
| struct net_device *reply_dev; /* Reply direction source device */ |
| u64 last_sync_jiffies; /* Jiffies count for the last sync */ |
| struct sfe_ipv4_connection *all_connections_next; |
| /* Pointer to the next entry in the list of all connections */ |
| struct sfe_ipv4_connection *all_connections_prev; |
| /* Pointer to the previous entry in the list of all connections */ |
| u32 mark; /* mark for outgoing packet */ |
| u32 debug_read_seq; /* sequence number for debug dump */ |
| bool removed; /* Indicates the connection is removed */ |
| struct rcu_head rcu; /* delay rcu free */ |
| }; |
| |
| /* |
| * IPv4 connections and hash table size information. |
| */ |
| #define SFE_IPV4_CONNECTION_HASH_SHIFT 12 |
| #define SFE_IPV4_CONNECTION_HASH_SIZE (1 << SFE_IPV4_CONNECTION_HASH_SHIFT) |
| #define SFE_IPV4_CONNECTION_HASH_MASK (SFE_IPV4_CONNECTION_HASH_SIZE - 1) |
| |
| enum sfe_ipv4_exception_events { |
| SFE_IPV4_EXCEPTION_EVENT_UDP_HEADER_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_UDP_NO_CONNECTION, |
| SFE_IPV4_EXCEPTION_EVENT_UDP_IP_OPTIONS_OR_INITIAL_FRAGMENT, |
| SFE_IPV4_EXCEPTION_EVENT_UDP_SMALL_TTL, |
| SFE_IPV4_EXCEPTION_EVENT_UDP_NEEDS_FRAGMENTATION, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_HEADER_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_NO_CONNECTION_SLOW_FLAGS, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_NO_CONNECTION_FAST_FLAGS, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_IP_OPTIONS_OR_INITIAL_FRAGMENT, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_SMALL_TTL, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_NEEDS_FRAGMENTATION, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_FLAGS, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_SEQ_EXCEEDS_RIGHT_EDGE, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_SMALL_DATA_OFFS, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_BAD_SACK, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_BIG_DATA_OFFS, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_SEQ_BEFORE_LEFT_EDGE, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_ACK_EXCEEDS_RIGHT_EDGE, |
| SFE_IPV4_EXCEPTION_EVENT_TCP_ACK_BEFORE_LEFT_EDGE, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_HEADER_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_UNHANDLED_TYPE, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_IPV4_HEADER_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_IPV4_NON_V4, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_IPV4_IP_OPTIONS_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_IPV4_UDP_HEADER_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_IPV4_TCP_HEADER_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_IPV4_UNHANDLED_PROTOCOL, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_NO_CONNECTION, |
| SFE_IPV4_EXCEPTION_EVENT_ICMP_FLUSHED_CONNECTION, |
| SFE_IPV4_EXCEPTION_EVENT_HEADER_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_HEADER_CSUM_BAD, |
| SFE_IPV4_EXCEPTION_EVENT_BAD_TOTAL_LENGTH, |
| SFE_IPV4_EXCEPTION_EVENT_NON_V4, |
| SFE_IPV4_EXCEPTION_EVENT_NON_INITIAL_FRAGMENT, |
| SFE_IPV4_EXCEPTION_EVENT_DATAGRAM_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_IP_OPTIONS_INCOMPLETE, |
| SFE_IPV4_EXCEPTION_EVENT_UNHANDLED_PROTOCOL, |
| SFE_IPV4_EXCEPTION_EVENT_NO_HEADROOM, |
| SFE_IPV4_EXCEPTION_EVENT_INVALID_PPPOE_SESSION, |
| SFE_IPV4_EXCEPTION_EVENT_INCORRECT_PPPOE_PARSING, |
| SFE_IPV4_EXCEPTION_EVENT_PPPOE_NOT_SET_IN_CME, |
| SFE_IPV4_EXCEPTION_EVENT_INGRESS_VLAN_TAG_MISMATCH, |
| SFE_IPV4_EXCEPTION_EVENT_INVALID_SRC_IFACE, |
| SFE_IPV4_EXCEPTION_EVENT_LAST |
| }; |
| |
| /* |
| * per CPU stats |
| */ |
| struct sfe_ipv4_stats { |
| /* |
| * Stats recorded in a sync period. These stats will be added to |
| * connection_xxx64 after a sync period. |
| */ |
| u64 connection_create_requests64; |
| /* Number of IPv4 connection create requests */ |
| u64 connection_create_collisions64; |
| /* Number of IPv4 connection create requests that collided with existing hash table entries */ |
| u64 connection_create_failures64; |
| /* Number of IPv4 connection create requests that failed */ |
| u64 connection_destroy_requests64; |
| /* Number of IPv4 connection destroy requests */ |
| u64 connection_destroy_misses64; |
| /* Number of IPv4 connection destroy requests that missed our hash table */ |
| u64 connection_match_hash_hits64; |
| /* Number of IPv4 connection match hash hits */ |
| u64 connection_match_hash_reorders64; |
| /* Number of IPv4 connection match hash reorders */ |
| u64 connection_flushes64; /* Number of IPv4 connection flushes */ |
| u64 packets_dropped64; /* Number of IPv4 packets dropped */ |
| u64 packets_forwarded64; /* Number of IPv4 packets forwarded */ |
| u64 packets_not_forwarded64; /* Number of IPv4 packets not forwarded */ |
| u64 exception_events64[SFE_IPV4_EXCEPTION_EVENT_LAST]; |
| u64 pppoe_encap_packets_forwarded64; /* Number of IPv4 PPPoE encap packets forwarded */ |
| u64 pppoe_decap_packets_forwarded64; /* Number of IPv4 PPPoE decap packets forwarded */ |
| u64 pppoe_bridge_packets_forwarded64; /* Number of IPv4 PPPoE bridge packets forwarded */ |
| }; |
| |
| /* |
| * Per-module structure. |
| */ |
| struct sfe_ipv4 { |
| spinlock_t lock; /* Lock for SMP correctness */ |
| struct sfe_ipv4_connection *all_connections_head; |
| /* Head of the list of all connections */ |
| struct sfe_ipv4_connection *all_connections_tail; |
| /* Tail of the list of all connections */ |
| unsigned int num_connections; /* Number of connections */ |
| struct delayed_work sync_dwork; /* Work to sync the statistics */ |
| unsigned int work_cpu; /* The core to run stats sync on */ |
| |
| sfe_sync_rule_callback_t __rcu sync_rule_callback; |
| /* Callback function registered by a connection manager for stats syncing */ |
| struct sfe_ipv4_connection *conn_hash[SFE_IPV4_CONNECTION_HASH_SIZE]; |
| /* Connection hash table */ |
| |
| struct hlist_head hlist_conn_match_hash_head[SFE_IPV4_CONNECTION_HASH_SIZE]; |
| /* Connection match hash table */ |
| |
| #ifdef CONFIG_NF_FLOW_COOKIE |
| struct sfe_flow_cookie_entry sfe_flow_cookie_table[SFE_FLOW_COOKIE_SIZE]; |
| /* flow cookie table*/ |
| flow_cookie_set_func_t flow_cookie_set_func; |
| /* function used to configure flow cookie in hardware*/ |
| int flow_cookie_enable; |
| /* Enable/disable flow cookie at runtime */ |
| #endif |
| |
| struct sfe_ipv4_stats __percpu *stats_pcpu; |
| /* Per CPU statistics. */ |
| |
| struct sfe_ipv4_connection *wc_next; /* Connection list walk pointer for stats sync */ |
| |
| /* |
| * Control state. |
| */ |
| struct kobject *sys_ipv4; /* sysfs linkage */ |
| int debug_dev; /* Major number of the debug char device */ |
| u32 debug_read_seq; /* sequence number for debug dump */ |
| }; |
| |
| /* |
| * Enumeration of the XML output. |
| */ |
| enum sfe_ipv4_debug_xml_states { |
| SFE_IPV4_DEBUG_XML_STATE_START, |
| SFE_IPV4_DEBUG_XML_STATE_CONNECTIONS_START, |
| SFE_IPV4_DEBUG_XML_STATE_CONNECTIONS_CONNECTION, |
| SFE_IPV4_DEBUG_XML_STATE_CONNECTIONS_END, |
| SFE_IPV4_DEBUG_XML_STATE_EXCEPTIONS_START, |
| SFE_IPV4_DEBUG_XML_STATE_EXCEPTIONS_EXCEPTION, |
| SFE_IPV4_DEBUG_XML_STATE_EXCEPTIONS_END, |
| SFE_IPV4_DEBUG_XML_STATE_STATS, |
| SFE_IPV4_DEBUG_XML_STATE_END, |
| SFE_IPV4_DEBUG_XML_STATE_DONE |
| }; |
| |
| /* |
| * XML write state. |
| */ |
| struct sfe_ipv4_debug_xml_write_state { |
| enum sfe_ipv4_debug_xml_states state; |
| /* XML output file state machine state */ |
| int iter_exception; /* Next exception iterator */ |
| }; |
| |
| typedef bool (*sfe_ipv4_debug_xml_write_method_t)(struct sfe_ipv4 *si, char *buffer, char *msg, size_t *length, |
| int *total_read, struct sfe_ipv4_debug_xml_write_state *ws); |
| |
| u16 sfe_ipv4_gen_ip_csum(struct iphdr *iph); |
| void sfe_ipv4_exception_stats_inc(struct sfe_ipv4 *si, enum sfe_ipv4_exception_events reason); |
| bool sfe_ipv4_remove_connection(struct sfe_ipv4 *si, struct sfe_ipv4_connection *c); |
| void sfe_ipv4_flush_connection(struct sfe_ipv4 *si, struct sfe_ipv4_connection *c, sfe_sync_reason_t reason); |
| void sfe_ipv4_sync_status(struct sfe_ipv4 *si, struct sfe_ipv4_connection *c, sfe_sync_reason_t reason); |
| |
| struct sfe_ipv4_connection_match * |
| sfe_ipv4_find_connection_match_rcu(struct sfe_ipv4 *si, struct net_device *dev, u8 protocol, |
| __be32 src_ip, __be16 src_port, |
| __be32 dest_ip, __be16 dest_port); |
| |
| void sfe_ipv4_exit(void); |
| int sfe_ipv4_init(void); |
| |
| #endif /* __SFE_IPV4_H */ |