/* SPDX-License-Identifier: GPL-2.0 */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include struct nl_sock; struct osmo_stream_srv_link; /*********************************************************************** * Utility ***********************************************************************/ /* ensure we are called from main thread context */ #define ASSERT_MAIN_THREAD(d) OSMO_ASSERT(pthread_self() == (d)->main_thread) #define MAX_UDP_PACKET 65535 struct addrinfo *addrinfo_helper(uint16_t family, uint16_t type, uint8_t proto, const char *host, uint16_t port, bool passive); enum { DTUN, DEP, DGT, DUECUPS, DICMP6, }; /*********************************************************************** * GTP Endpoint (UDP socket) ***********************************************************************/ struct gtp_daemon; struct gtp_tunnel; /* local UDP socket for GTP communication */ struct gtp_endpoint { /* entry in global list */ struct llist_head list; /* back-pointer to daemon */ struct gtp_daemon *d; unsigned long use_count; /* file descriptor */ int fd; /* local IP:port */ struct osmo_sockaddr bind_addr; char *name; /* the thread handling Rx from the fd/socket */ pthread_t thread; }; struct gtp_endpoint * gtp_endpoint_find_or_create(struct gtp_daemon *d, const struct osmo_sockaddr *bind_addr); struct gtp_endpoint * _gtp_endpoint_find(struct gtp_daemon *d, const struct osmo_sockaddr *bind_addr); void _gtp_endpoint_deref_destroy(struct gtp_endpoint *ep); bool _gtp_endpoint_release(struct gtp_endpoint *ep); bool gtp_endpoint_release(struct gtp_endpoint *ep); /*********************************************************************** * TUN Device ***********************************************************************/ /* Message sent tun thread -> main thread through osmo_itq */ struct gtp_daemon_itq_msg { struct llist_head list; struct { struct tun_device *tun; } tun_released; /* tun became stopped and can be freed */ }; struct tun_device { /* entry in global list */ struct llist_head list; /* back-pointer to daemon */ struct gtp_daemon *d; unsigned long use_count; /* which device we refer to */ const char *devname; int ifindex; /* file descriptor */ int fd; /* network namespace */ const char *netns_name; int netns_fd; struct osmo_netdev *netdev; /* list of local addresses? or simply only have the kernel know thses? */ /* the thread handling Rx from the tun fd */ pthread_t thread; /* Used to store messages to be sent to main thread, since tun thread doesn't allocate through talloc */ struct gtp_daemon_itq_msg itq_msg; }; struct tun_device * tun_device_find_or_create(struct gtp_daemon *d, const char *devname, const char *netns_name); struct tun_device * tun_device_find_netns(struct gtp_daemon *d, const char *netns_name); struct tun_device * _tun_device_find(struct gtp_daemon *d, const char *devname); void _tun_device_destroy(struct tun_device *tun); bool _tun_device_release(struct tun_device *tun); void _tun_device_deref_release(struct tun_device *tun); bool tun_device_release(struct tun_device *tun); /*********************************************************************** * Client (Control/User Plane Separation) Socket ***********************************************************************/ struct cups_client { /* member in daemon->cups_clients */ struct llist_head list; /* back-pointer to daemon */ struct gtp_daemon *d; /* client socket */ struct osmo_stream_srv *srv; char sockname[OSMO_SOCK_NAME_MAXLEN]; bool reset_all_state_res_pending; }; struct osmo_stream_srv_link *cups_srv_link_create(struct gtp_daemon *d); void child_terminated(struct gtp_daemon *d, int pid, int status); void cc_ipv6_slaac_ind(const struct gtp_tunnel *t); json_t *gen_uecups_result(const char *name, const char *res); int cups_client_tx_json(struct cups_client *cc, json_t *jtx); /*********************************************************************** * GTP Tunnel ***********************************************************************/ /* Every tunnel is identified uniquely by the following tuples: * * a) local endpoint + TEID * this is what happens on incoming GTP messages * * b) tun device + end-user-address (+ filter, if any) * this is what happens when IP arrives on the tun device */ enum gtp1u_eua_type { GTP1U_EUA_TYPE_IPv4, GTP1U_EUA_TYPE_IPv6, GTP1U_EUA_TYPE_IPv4v6, }; struct gtp1u_exthdr_pdu_sess_container { bool enabled; uint8_t pdu_type; /* GTP1_EXTHDR_PDU_TYPE_* */ uint8_t qos_flow_identifier; }; struct gtp1u_exthdrs { bool seq_num_enabled; bool n_pdu_num_enabled; struct gtp1u_exthdr_pdu_sess_container pdu_sess_container; }; struct gtp_tunnel { /* entry in global list / hash table */ struct llist_head list; /* back-pointer to daemon */ struct gtp_daemon *d; const char *name; /* the TUN device associated with this tunnel */ struct tun_device *tun_dev; /* the GTP endpoint (UDP socket) associated with this tunnel */ struct gtp_endpoint *gtp_ep; /* TEID on transmit (host byte order) */ uint32_t tx_teid; /* TEID one receive (host byte order) */ uint32_t rx_teid; /* End user Address (inner IP) */ enum gtp1u_eua_type user_addr_type; struct osmo_sockaddr user_addr_ipv4; struct osmo_sockaddr user_addr_ipv6_ll; struct osmo_sockaddr user_addr_ipv6_prefix; struct osmo_sockaddr user_addr_ipv6_global; /* Remote UDP IP/Port*/ struct osmo_sockaddr remote_udp; /* GTP Extension Header */ struct gtp1u_exthdrs exthdr; /* TODO: Filter */ }; struct gtp_tunnel * _gtp_tunnel_find_r(struct gtp_daemon *d, uint32_t rx_teid, struct gtp_endpoint *ep); struct gtp_tunnel * _gtp_tunnel_find_eua(struct tun_device *tun, const struct osmo_sockaddr *osa, uint8_t proto); struct gtp_tunnel_params { /* TEID in receive and transmit direction */ uint32_t rx_teid; uint32_t tx_teid; /* GTPv1U Extension Headers: */ struct gtp1u_exthdrs exthdr; /* end user address */ enum gtp1u_eua_type user_addr_type; struct osmo_sockaddr user_addr_ipv4; struct osmo_sockaddr user_addr_ipv6; /* remote GTP/UDP IP+Port */ struct osmo_sockaddr remote_udp; /* local GTP/UDP IP+Port (used to lookup/create local EP) */ struct osmo_sockaddr local_udp; /* local TUN device name (used to lookup/create local tun) */ const char *tun_name; const char *tun_netns_name; }; struct gtp_tunnel *gtp_tunnel_alloc(struct gtp_daemon *d, const struct gtp_tunnel_params *cpars); void _gtp_tunnel_destroy(struct gtp_tunnel *t); bool gtp_tunnel_destroy(struct gtp_daemon *d, const struct osmo_sockaddr *bind_addr, uint32_t rx_teid); int gtp_tunnel_tx_icmpv6_rs(struct gtp_daemon *d, const struct osmo_sockaddr *bind_addr, uint32_t rx_teid); int tx_gtp1u_pkt(struct gtp_tunnel *t, uint8_t *base_buffer, const uint8_t *payload, unsigned int payload_len); #define LOGT(t, lvl, fmt, args ...) \ LOGP(DGT, lvl, "%s: " fmt, (t)->name, ## args) /*********************************************************************** * GTP Daemon ***********************************************************************/ #define UECUPS_SCTP_PORT 4268 struct osmo_signalfd; struct gtp_daemon { /* global lists of various objects */ struct llist_head gtp_endpoints; struct llist_head tun_devices; struct llist_head gtp_tunnels; struct llist_head subprocesses; /* lock protecting all of the above lists */ pthread_rwlock_t rwlock; /* main thread ID */ pthread_t main_thread; /* client CUPS interface */ struct llist_head cups_clients; struct osmo_stream_srv_link *cups_link; struct osmo_signalfd *signalfd; /* inter-thread queue between main thread and workers, pass struct gtp_daemon_itq_msg: */ struct osmo_it_q *itq; /* Number of tunnels in progrress of being released: */ unsigned int reset_all_state_tun_remaining; struct { char *cups_local_ip; uint16_t cups_local_port; } cfg; }; extern struct gtp_daemon *g_daemon; struct gtp_daemon *gtp_daemon_alloc(void *ctx); int gtpud_vty_init(void);