gerrit-log February 2022

gerrit-log@lists.osmocom.org

3 participants
1508 discussions

Change in osmo-upf[master]: contrib: add PFCP cause and IEI string maps

by neels

neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27220 ) Change subject: contrib: add PFCP cause and IEI string maps ...................................................................... contrib: add PFCP cause and IEI string maps These help to build enums and value_strings using regexes. They are a verbatim copy from 3GPP TS 29.244 version 16.6.0 Release 16, paired with C-compatible and possibly abbreviated name strings. Related: SYS#5599 Change-Id: I7f37efd3cfc4c7b0ae49740ac15e461c52fae6e8 --- A contrib/pfcp_cause.txt A contrib/pfcp_iei.txt 2 files changed, 290 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/20/27220/1 diff --git a/contrib/pfcp_cause.txt b/contrib/pfcp_cause.txt new file mode 100644 index 0000000..c85a8d7 --- /dev/null +++ b/contrib/pfcp_cause.txt @@ -0,0 +1,19 @@ +0 RESERVED Reserved +1 REQUEST_ACCEPTED Request accepted (success) +2 MORE_USAGE_REPORT_TO_SEND More Usage Report to send +64 REQUEST_REJECTED Request rejected (reason not specified) +65 SESSION_CTX_NOT_FOUND Session context not found +66 MANDATORY_IE_MISSING Mandatory IE missing +67 CONDITIONAL_IE_MISSING Conditional IE missing +68 INVALID_LENGTH Invalid length +69 MANDATORY_IE_INCORRECT Mandatory IE incorrect +70 INVALID_FORW_POLICY Invalid Forwarding Policy +71 INVALID_F_TEID_ALLOC_OPTION Invalid F-TEID allocation option +72 NO_ESTABLISHED_PFCP_ASSOC No established PFCP Association +73 RULE_CREATION_MOD_FAILURE Rule creation/modification Failure +74 PFCP_ENTITY_IN_CONGESTION PFCP entity in congestion +75 NO_RESOURCES_AVAILABLE No resources available +76 SERVICE_NOT_SUPPORTED Service not supported +77 SYSTEM_FAILURE System failure +78 REDIRECTION_REQUESTED Redirection Requested +79 ALL_DYNAMIC_ADDRESSES_ARE_OCCUPIED All dynamic addresses are occupied diff --git a/contrib/pfcp_iei.txt b/contrib/pfcp_iei.txt new file mode 100644 index 0000000..25b7d79 --- /dev/null +++ b/contrib/pfcp_iei.txt @@ -0,0 +1,271 @@ +1 CREATE_PDR Create PDR +2 PDI PDI +3 CREATE_FAR Create FAR +4 FORW_PARAMS Forwarding Parameters +5 DUPL_PARAMS Duplicating Parameters +6 CREATE_URR Create URR +7 CREATE_QER Create QER +8 CREATED_PDR Created PDR +9 UPD_PDR Update PDR +10 UPD_FAR Update FAR +11 UPD_FORW_PARAMS Update Forwarding Parameters +12 UPD_BAR_SESS_REP_RESP Update BAR (PFCP Session Report Response) +13 UPD_URR Update URR +14 UPD_QER Update QER +15 REMOVE_PDR Remove PDR +16 REMOVE_FAR Remove FAR +17 REMOVE_URR Remove URR +18 REMOVE_QER Remove QER +19 CAUSE Cause +20 SOURCE_IFACE Source Interface +21 F_TEID F-TEID +22 NETWORK_INST Network Instance +23 SDF_FILTER SDF Filter +24 APPLICATION_ID Application ID +25 GATE_STATUS Gate Status +26 MBR MBR +27 GBR GBR +28 QER_CORRELATION_ID QER Correlation ID +29 PRECEDENCE Precedence +30 TRANSPORT_LEVEL_MARKING Transport Level Marking +31 VOLUME_THRESH Volume Threshold +32 TIME_THRESH Time Threshold +33 MONITORING_TIME Monitoring Time +34 SUBSEQUENT_VOLUME_THRESH Subsequent Volume Threshold +35 SUBSEQUENT_TIME_THRESH Subsequent Time Threshold +36 INACT_DETECTION_TIME Inactivity Detection Time +37 REPORTING_TRIGGERS Reporting Triggers +38 REDIRECT_INFO Redirect Information +39 REP_TYPE Report Type +40 OFFENDING_IE Offending IE +41 FORW_POLICY Forwarding Policy +42 DESTINATION_IFACE Destination Interface +43 UP_FUNCTION_FEATURES UP Function Features +44 APPLY_ACTION Apply Action +45 DL_DATA_SERVICE_INFO Downlink Data Service Information +46 DL_DATA_NOTIFICATION_DELAY Downlink Data Notification Delay +47 DL_BUFF_DURATION DL Buffering Duration +48 DL_BUFF_SUGGESTED_PACKET_COUNT DL Buffering Suggested Packet Count +49 PFCPSMREQ_FLAGS PFCPSMReq-Flags +50 PFCPSRRSP_FLAGS PFCPSRRsp-Flags +51 LOAD_CTRL_INFO Load Control Information +52 SEQUENCE_NUMBER Sequence Number +53 METRIC Metric +54 OVERLOAD_CTRL_INFO Overload Control Information +55 TIMER Timer +56 PDR_ID PDR ID +57 F_SEID F-SEID +58 APPLICATION_IDS_PFDS Application ID's PFDs +59 PFD_CONTEXT PFD context +60 NODE_ID Node ID +61 PFD_CONTENTS PFD contents +62 MEAS_METHOD Measurement Method +63 USAGE_REP_TRIGGER Usage Report Trigger +64 MEAS_PERIOD Measurement Period +65 FQ_CSID FQ-CSID +66 VOLUME_MEAS Volume Measurement +67 DURATION_MEAS Duration Measurement +68 APPLICATION_DETECTION_INFO Application Detection Information +69 TIME_OF_FIRST_PACKET Time of First Packet +70 TIME_OF_LAST_PACKET Time of Last Packet +71 QUOTA_HOLDING_TIME Quota Holding Time +72 DROPPED_DL_TRAFFIC_THRESH Dropped DL Traffic Threshold +73 VOLUME_QUOTA Volume Quota +74 TIME_QUOTA Time Quota +75 START_TIME Start Time +76 END_TIME End Time +77 QUERY_URR Query URR +78 USAGE_REP_SESS_MOD_RESP Usage Report (Session Modification Response) +79 USAGE_REP_SESS_DEL_RESP Usage Report (Session Deletion Response) +80 USAGE_REP_SESS_REP_REQ Usage Report (Session Report Request) +81 URR_ID URR ID +82 LINKED_URR_ID Linked URR ID +83 DL_DATA_REP Downlink Data Report +84 OUTER_HEADER_CREATION Outer Header Creation +85 CREATE_BAR Create BAR +86 UPD_BAR_SESS_MOD_REQ Update BAR (Session Modification Request) +87 REMOVE_BAR Remove BAR +88 BAR_ID BAR ID +89 CP_FUNCTION_FEATURES CP Function Features +90 USAGE_INFO Usage Information +91 APPLICATION_INST_ID Application Instance ID +92 FLOW_INFO Flow Information +93 UE_IP_ADDRESS UE IP Address +94 PACKET_RATE Packet Rate +95 OUTER_HEADER_REMOVAL Outer Header Removal +96 RECOVERY_TIME_STAMP Recovery Time Stamp +97 DL_FLOW_LEVEL_MARKING DL Flow Level Marking +98 HEADER_ENRICHMENT Header Enrichment +99 ERROR_IND_REP Error Indication Report +100 MEAS_INFO Measurement Information +101 NODE_REP_TYPE Node Report Type +102 USER_PLANE_PATH_FAILURE_REP User Plane Path Failure Report +103 REMOTE_GTP_U_PEER Remote GTP-U Peer +104 UR_SEQN UR-SEQN +105 UPD_DUPL_PARAMS Update Duplicating Parameters +106 ACTIVATE_PREDEFINED_RULES Activate Predefined Rules +107 DEACTIVATE_PREDEFINED_RULES Deactivate Predefined Rules +108 FAR_ID FAR ID +109 QER_ID QER ID +110 OCI_FLAGS OCI Flags +111 PFCP_ASSOC_RELEASE_REQ PFCP Association Release Request +112 GRACEFUL_RELEASE_PERIOD Graceful Release Period +113 PDN_TYPE PDN Type +114 FAILED_RULE_ID Failed Rule ID +115 TIME_QUOTA_MECHANISM Time Quota Mechanism +116 RESERVED Reserved +117 USER_PLANE_INACT_TIMER User Plane Inactivity Timer +118 AGGREGATED_URRS Aggregated URRs +119 MULTIPLIER Multiplier +120 AGGREGATED_URR_ID Aggregated URR ID +121 SUBSEQUENT_VOLUME_QUOTA Subsequent Volume Quota +122 SUBSEQUENT_TIME_QUOTA Subsequent Time Quota +123 RQI RQI +124 QFI QFI +125 QUERY_URR_REFERENCE Query URR Reference +126 ADDITIONAL_USAGE_REPS_INFO Additional Usage Reports Information +127 CREATE_TRAFFIC_ENDPOINT Create Traffic Endpoint +128 CREATED_TRAFFIC_ENDPOINT Created Traffic Endpoint +129 UPD_TRAFFIC_ENDPOINT Update Traffic Endpoint +130 REMOVE_TRAFFIC_ENDPOINT Remove Traffic Endpoint +131 TRAFFIC_ENDPOINT_ID Traffic Endpoint ID +132 ETHERNET_PACKET_FILTER Ethernet Packet Filter +133 MAC_ADDRESS MAC address +134 C_TAG C-TAG +135 S_TAG S-TAG +136 ETHERTYPE Ethertype +137 PROXYING Proxying +138 ETHERNET_FILTER_ID Ethernet Filter ID +139 ETHERNET_FILTER_PROPERTIES Ethernet Filter Properties +140 SUGGESTED_BUFF_PACKETS_COUNT Suggested Buffering Packets Count +141 USER_ID User ID +142 ETHERNET_PDU_SESS_INFO Ethernet PDU Session Information +143 ETHERNET_TRAFFIC_INFO Ethernet Traffic Information +144 MAC_ADDRS_DETECTED MAC Addresses Detected +145 MAC_ADDRS_REMOVED MAC Addresses Removed +146 ETHERNET_INACT_TIMER Ethernet Inactivity Timer +147 ADDITIONAL_MONITORING_TIME Additional Monitoring Time +148 EVENT_QUOTA Event Quota +149 EVENT_THRESH Event Threshold +150 SUBSEQUENT_EVENT_QUOTA Subsequent Event Quota +151 SUBSEQUENT_EVENT_THRESH Subsequent Event Threshold +152 TRACE_INFO Trace Information +153 FRAMED_ROUTE Framed-Route +154 FRAMED_ROUTING Framed-Routing +155 FRAMED_IPV6_ROUTE Framed-IPv6-Route +156 TIME_STAMP Time Stamp +157 AVERAGING_WINDOW Averaging Window +158 PAGING_POLICY_INDICATOR Paging Policy Indicator +159 APN_DNN APN/DNN +160 3GPP_IFACE_TYPE 3GPP Interface Type +161 PFCPSRREQ_FLAGS PFCPSRReq-Flags +162 PFCPAUREQ_FLAGS PFCPAUReq-Flags +163 ACTIVATION_TIME Activation Time +164 DEACTIVATION_TIME Deactivation Time +165 CREATE_MAR Create MAR +166 3GPP_ACCESS_FORW_ACTION_INFO 3GPP Access Forwarding Action Information +167 NON_3GPP_ACCESS_FORW_ACTION_INFO Non-3GPP Access Forwarding Action Information +168 REMOVE_MAR Remove MAR +169 UPD_MAR Update MAR +170 MAR_ID MAR ID +171 STEERING_FUNCTIONALITY Steering Functionality +172 STEERING_MODE Steering Mode +173 WEIGHT Weight +174 PRIORITY Priority +175 UPD_3GPP_ACCESS_FORW_ACTION_INFO Update 3GPP Access Forwarding Action Information +176 UPD_NON_3GPP_ACCESS_FORW_ACTION_INFO Update Non 3GPP Access Forwarding Action Information +177 UE_IP_ADDRESS_POOL_IDENTITY UE IP address Pool Identity +178 ALTERNATIVE_SMF_IP_ADDRESS Alternative SMF IP Address +179 PACKET_REPLICATION_AND_DETECTION_CARRY_ON_INFO Packet Replication and Detection Carry-On Information +180 SMF_SET_ID SMF Set ID +181 QUOTA_VALIDITY_TIME Quota Validity Time +182 NUMBER_OF_REPS Number of Reports +183 PFCP_SESS_RETENTION_INFO_IN_ASSOC_SETUP_REQ PFCP Session Retention Information (within PFCP Association Setup Request) +184 PFCPASRSP_FLAGS PFCPASRsp-Flags +185 CP_ENTITY_IP_ADDRESS CP PFCP Entity IP Address +186 PFCPSEREQ_FLAGS PFCPSEReq-Flags +187 USER_PLANE_PATH_RECOVERY_REP User Plane Path Recovery Report +188 IP_MULTICAST_ADDR_INFO_IN_SESS_EST_REQ IP Multicast Addressing Info within PFCP Session Establishment Request +189 JOIN_IP_MULTICAST_INFO_IE_IN_USAGE_REP Join IP Multicast Information IE within Usage Report +190 LEAVE_IP_MULTICAST_INFO_IE_IN_USAGE_REP Leave IP Multicast Information IE within Usage Report +191 IP_MULTICAST_ADDRESS IP Multicast Address +192 SOURCE_IP_ADDRESS Source IP Address +193 PACKET_RATE_STATUS Packet Rate Status +194 CREATE_BRIDGE_INFO_FOR_TSC Create Bridge Info for TSC +195 CREATED_BRIDGE_INFO_FOR_TSC Created Bridge Info for TSC +196 DS_TT_PORT_NUMBER DS-TT Port Number +197 NW_TT_PORT_NUMBER NW-TT Port Number +198 TSN_BRIDGE_ID TSN Bridge ID +199 TSC_MGMT_INFO_IE_IN_SESS_MOD_REQ TSC Management Information IE within PFCP Session Modification Request +200 TSC_MGMT_INFO_IE_IN_SESS_MOD_RESP TSC Management Information IE within PFCP Session Modification Response +201 TSC_MGMT_INFO_IE_IN_SESS_REP_REQ TSC Management Information IE within PFCP Session Report Request +202 PORT_MGMT_INFO_CONTAINER Port Management Information Container +203 CLOCK_DRIFT_CTRL_INFO Clock Drift Control Information +204 REQUESTED_CLOCK_DRIFT_INFO Requested Clock Drift Information +205 CLOCK_DRIFT_REP Clock Drift Report +206 TSN_TIME_DOMAIN_NUMBER TSN Time Domain Number +207 TIME_OFFSET_THRESH Time Offset Threshold +208 CUMULATIVE_RATERATIO_THRESH Cumulative rateRatio Threshold +209 TIME_OFFSET_MEAS Time Offset Measurement +210 CUMULATIVE_RATERATIO_MEAS Cumulative rateRatio Measurement +211 REMOVE_SRR Remove SRR +212 CREATE_SRR Create SRR +213 UPD_SRR Update SRR +214 SESS_REP Session Report +215 SRR_ID SRR ID +216 ACCESS_AVAIL_CTRL_INFO Access Availability Control Information +217 REQUESTED_ACCESS_AVAIL_INFO Requested Access Availability Information +218 ACCESS_AVAIL_REP Access Availability Report +219 ACCESS_AVAIL_INFO Access Availability Information +220 PROVIDE_ATSSS_CTRL_INFO Provide ATSSS Control Information +221 ATSSS_CTRL_PARAMS ATSSS Control Parameters +222 MPTCP_CTRL_INFO MPTCP Control Information +223 ATSSS_LL_CTRL_INFO ATSSS-LL Control Information +224 PMF_CTRL_INFO PMF Control Information +225 MPTCP_PARAMS MPTCP Parameters +226 ATSSS_LL_PARAMS ATSSS-LL Parameters +227 PMF_PARAMS PMF Parameters +228 MPTCP_ADDRESS_INFO MPTCP Address Information +229 UE_LINK_SPECIFIC_IP_ADDRESS UE Link-Specific IP Address +230 PMF_ADDRESS_INFO PMF Address Information +231 ATSSS_LL_INFO ATSSS-LL Information +232 DATA_NETWORK_ACCESS_IDENTIFIER Data Network Access Identifier +233 UE_IP_ADDRESS_POOL_INFO UE IP address Pool Information +234 AVERAGE_PACKET_DELAY Average Packet Delay +235 MIN_PACKET_DELAY Minimum Packet Delay +236 MAX_PACKET_DELAY Maximum Packet Delay +237 QOS_REP_TRIGGER QoS Report Trigger +238 GTP_U_PATH_QOS_CTRL_INFO GTP-U Path QoS Control Information +239 GTP_U_PATH_QOS_REP_NODE_REP_REQ GTP-U Path QoS Report (PFCP Node Report Request) +240 QOS_INFO_IN_GTP_U_PATH_QOS_REP QoS Information in GTP-U Path QoS Report +241 GTP_U_PATH_IFACE_TYPE GTP-U Path Interface Type +242 QOS_MONITORING_PER_QOS_FLOW_CTRL_INFO QoS Monitoring per QoS flow Control Information +243 REQUESTED_QOS_MONITORING Requested QoS Monitoring +244 REPORTING_FREQUENCY Reporting Frequency +245 PACKET_DELAY_THRESHOLDS Packet Delay Thresholds +246 MIN_WAIT_TIME Minimum Wait Time +247 QOS_MONITORING_REP QoS Monitoring Report +248 QOS_MONITORING_MEAS QoS Monitoring Measurement +249 MT_EDT_CTRL_INFO MT-EDT Control Information +250 DL_DATA_PACKETS_SIZE DL Data Packets Size +251 QER_CTRL_INDICATIONS QER Control Indications +252 PACKET_RATE_STATUS_REP Packet Rate Status Report +253 NF_INST_ID NF Instance ID +254 ETHERNET_CONTEXT_INFO Ethernet Context Information +255 REDUNDANT_TRANSMISSION_PARAMS Redundant Transmission Parameters +256 UPDATED_PDR Updated PDR +257 S_NSSAI S-NSSAI +258 IP_VERSION IP version +259 PFCPASREQ_FLAGS PFCPASReq-Flags +260 DATA_STATUS Data Status +261 PROVIDE_RDS_CONF_INFO Provide RDS configuration information +262 RDS_CONF_INFO RDS configuration information +263 QUERY_PACKET_RATE_STATUS_IE_IN_SESS_MOD_REQ Query Packet Rate Status IE within PFCP Session Modification Request +264 PACKET_RATE_STATUS_REP_IE_IN_SESS_MOD_RESP Packet Rate Status Report IE within PFCP Session Modification Response +265 MPTCP_APPLICABLE_IND MPTCP Applicable Indication +266 BRIDGE_MGMT_INFO_CONTAINER Bridge Management Information Container +267 UE_IP_ADDRESS_USAGE_INFO UE IP Address Usage Information +268 NUMBER_OF_UE_IP_ADDRS Number of UE IP Addresses +269 VALIDITY_TIMER Validity Timer +270 REDUNDANT_TRANSMISSION_FORW_PARAMS Redundant Transmission Forwarding Parameters +271 TRANSPORT_DELAY_REPORTING Transport Delay Reporting -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27220 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: I7f37efd3cfc4c7b0ae49740ac15e461c52fae6e8 Gerrit-Change-Number: 27220 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in osmo-upf[master]: libosmo-pfcp: add pfcp_proto.h pfcp_strs.h

by neels

neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27221 ) Change subject: libosmo-pfcp: add pfcp_proto.h pfcp_strs.h ...................................................................... libosmo-pfcp: add pfcp_proto.h pfcp_strs.h Related: SYS#5599 Change-Id: I568b821e89007ed52eeefcdbcb6edd8052a8b5be --- M configure.ac M include/osmocom/Makefile.am A include/osmocom/pfcp/Makefile.am A include/osmocom/pfcp/pfcp_proto.h A include/osmocom/pfcp/pfcp_strs.h M src/Makefile.am A src/libosmo-pfcp/Makefile.am A src/libosmo-pfcp/pfcp_strs.c 8 files changed, 1,076 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/21/27221/1 diff --git a/configure.ac b/configure.ac index f9e85ce..f0f29d7 100644 --- a/configure.ac +++ b/configure.ac @@ -198,9 +198,11 @@ include/Makefile include/osmocom/Makefile include/osmocom/tlv/Makefile + include/osmocom/pfcp/Makefile include/osmocom/upf/Makefile src/Makefile src/libosmo-tlv/Makefile + src/libosmo-pfcp/Makefile src/osmo-upf/Makefile tests/Makefile tests/atlocal diff --git a/include/osmocom/Makefile.am b/include/osmocom/Makefile.am index 4d56df0..f82abfb 100644 --- a/include/osmocom/Makefile.am +++ b/include/osmocom/Makefile.am @@ -1,4 +1,5 @@ SUBDIRS = \ tlv \ + pfcp \ upf \ $(NULL) diff --git a/include/osmocom/pfcp/Makefile.am b/include/osmocom/pfcp/Makefile.am new file mode 100644 index 0000000..ff7df5e --- /dev/null +++ b/include/osmocom/pfcp/Makefile.am @@ -0,0 +1,6 @@ +pfcp_HEADERS = \ + pfcp_proto.h \ + pfcp_strs.h \ + $(NULL) + +pfcpdir = $(includedir)/osmocom/pfcp diff --git a/include/osmocom/pfcp/pfcp_proto.h b/include/osmocom/pfcp/pfcp_proto.h new file mode 100644 index 0000000..2df91d2 --- /dev/null +++ b/include/osmocom/pfcp/pfcp_proto.h @@ -0,0 +1,505 @@ +/* 3GPP TS 29.244: Packet Forwarding Control Protocol */ +#pragma once + +#define OSMO_PFCP_PORT 8805 + +/* Section 7.3 / Table 7.3-1 */ +enum osmo_pfcp_message_type { + OSMO_PFCP_MSGT_NONE = 0, + + /* Node related messages */ + OSMO_PFCP_MSGT_HEARTBEAT_REQ = 1, + OSMO_PFCP_MSGT_HEARTBEAT_RESP = 2, + OSMO_PFCP_MSGT_PFD_MGMT_REQ = 3, + OSMO_PFCP_MSGT_PFD_MGMT_RESP = 4, + OSMO_PFCP_MSGT_ASSOC_SETUP_REQ = 5, + OSMO_PFCP_MSGT_ASSOC_SETUP_RESP = 6, + OSMO_PFCP_MSGT_ASSOC_UPDATE_REQ = 7, + OSMO_PFCP_MSGT_ASSOC_UPDATE_RESP = 8, + OSMO_PFCP_MSGT_ASSOC_RELEASE_REQ = 9, + OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP = 10, + OSMO_PFCP_MSGT_VERSION_NOT_SUPP_RESP = 11, + OSMO_PFCP_MSGT_NODE_REPORT_REQ = 12, + OSMO_PFCP_MSGT_NODE_REPORT_RESP = 13, + OSMO_PFCP_MSGT_SESSION_SET_DEL_REQ = 14, + OSMO_PFCP_MSGT_SESSION_SET_DEL_RESP = 15, + + /* Session related messages */ + OSMO_PFCP_MSGT_SESSION_EST_REQ = 50, + OSMO_PFCP_MSGT_SESSION_EST_RESP = 51, + OSMO_PFCP_MSGT_SESSION_MOD_REQ = 52, + OSMO_PFCP_MSGT_SESSION_MOD_RESP = 53, + OSMO_PFCP_MSGT_SESSION_DEL_REQ = 54, + OSMO_PFCP_MSGT_SESSION_DEL_RESP = 55, + OSMO_PFCP_MSGT_SESSION_REP_REQ = 56, + OSMO_PFCP_MSGT_SESSION_REP_RESP = 57, +}; + +/* Section 8.1.2 / Table 8.1.2-1 */ +enum osmo_pfcp_iei { + OSMO_PFCP_INVALID_IEI = 0, + OSMO_PFCP_IEI_CREATE_PDR = 1, + OSMO_PFCP_IEI_PDI = 2, + OSMO_PFCP_IEI_CREATE_FAR = 3, + OSMO_PFCP_IEI_FORW_PARAMS = 4, + OSMO_PFCP_IEI_DUPL_PARAMS = 5, + OSMO_PFCP_IEI_CREATE_URR = 6, + OSMO_PFCP_IEI_CREATE_QER = 7, + OSMO_PFCP_IEI_CREATED_PDR = 8, + OSMO_PFCP_IEI_UPD_PDR = 9, + OSMO_PFCP_IEI_UPD_FAR = 10, + OSMO_PFCP_IEI_UPD_FORW_PARAMS = 11, + OSMO_PFCP_IEI_UPD_BAR_SESS_REP_RESP = 12, + OSMO_PFCP_IEI_UPD_URR = 13, + OSMO_PFCP_IEI_UPD_QER = 14, + OSMO_PFCP_IEI_REMOVE_PDR = 15, + OSMO_PFCP_IEI_REMOVE_FAR = 16, + OSMO_PFCP_IEI_REMOVE_URR = 17, + OSMO_PFCP_IEI_REMOVE_QER = 18, + OSMO_PFCP_IEI_CAUSE = 19, + OSMO_PFCP_IEI_SOURCE_IFACE = 20, + OSMO_PFCP_IEI_F_TEID = 21, + OSMO_PFCP_IEI_NETWORK_INST = 22, + OSMO_PFCP_IEI_SDF_FILTER = 23, + OSMO_PFCP_IEI_APPLICATION_ID = 24, + OSMO_PFCP_IEI_GATE_STATUS = 25, + OSMO_PFCP_IEI_MBR = 26, + OSMO_PFCP_IEI_GBR = 27, + OSMO_PFCP_IEI_QER_CORRELATION_ID = 28, + OSMO_PFCP_IEI_PRECEDENCE = 29, + OSMO_PFCP_IEI_TRANSPORT_LEVEL_MARKING = 30, + OSMO_PFCP_IEI_VOLUME_THRESH = 31, + OSMO_PFCP_IEI_TIME_THRESH = 32, + OSMO_PFCP_IEI_MONITORING_TIME = 33, + OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_THRESH = 34, + OSMO_PFCP_IEI_SUBSEQUENT_TIME_THRESH = 35, + OSMO_PFCP_IEI_INACT_DETECTION_TIME = 36, + OSMO_PFCP_IEI_REPORTING_TRIGGERS = 37, + OSMO_PFCP_IEI_REDIRECT_INFO = 38, + OSMO_PFCP_IEI_REP_TYPE = 39, + OSMO_PFCP_IEI_OFFENDING_IE = 40, + OSMO_PFCP_IEI_FORW_POLICY = 41, + OSMO_PFCP_IEI_DESTINATION_IFACE = 42, + OSMO_PFCP_IEI_UP_FUNCTION_FEATURES = 43, + OSMO_PFCP_IEI_APPLY_ACTION = 44, + OSMO_PFCP_IEI_DL_DATA_SERVICE_INFO = 45, + OSMO_PFCP_IEI_DL_DATA_NOTIFICATION_DELAY = 46, + OSMO_PFCP_IEI_DL_BUFF_DURATION = 47, + OSMO_PFCP_IEI_DL_BUFF_SUGGESTED_PACKET_COUNT = 48, + OSMO_PFCP_IEI_PFCPSMREQ_FLAGS = 49, + OSMO_PFCP_IEI_PFCPSRRSP_FLAGS = 50, + OSMO_PFCP_IEI_LOAD_CTRL_INFO = 51, + OSMO_PFCP_IEI_SEQUENCE_NUMBER = 52, + OSMO_PFCP_IEI_METRIC = 53, + OSMO_PFCP_IEI_OVERLOAD_CTRL_INFO = 54, + OSMO_PFCP_IEI_TIMER = 55, + OSMO_PFCP_IEI_PDR_ID = 56, + OSMO_PFCP_IEI_F_SEID = 57, + OSMO_PFCP_IEI_APPLICATION_IDS_PFDS = 58, + OSMO_PFCP_IEI_PFD_CONTEXT = 59, + OSMO_PFCP_IEI_NODE_ID = 60, + OSMO_PFCP_IEI_PFD_CONTENTS = 61, + OSMO_PFCP_IEI_MEAS_METHOD = 62, + OSMO_PFCP_IEI_USAGE_REP_TRIGGER = 63, + OSMO_PFCP_IEI_MEAS_PERIOD = 64, + OSMO_PFCP_IEI_FQ_CSID = 65, + OSMO_PFCP_IEI_VOLUME_MEAS = 66, + OSMO_PFCP_IEI_DURATION_MEAS = 67, + OSMO_PFCP_IEI_APPLICATION_DETECTION_INFO = 68, + OSMO_PFCP_IEI_TIME_OF_FIRST_PACKET = 69, + OSMO_PFCP_IEI_TIME_OF_LAST_PACKET = 70, + OSMO_PFCP_IEI_QUOTA_HOLDING_TIME = 71, + OSMO_PFCP_IEI_DROPPED_DL_TRAFFIC_THRESH = 72, + OSMO_PFCP_IEI_VOLUME_QUOTA = 73, + OSMO_PFCP_IEI_TIME_QUOTA = 74, + OSMO_PFCP_IEI_START_TIME = 75, + OSMO_PFCP_IEI_END_TIME = 76, + OSMO_PFCP_IEI_QUERY_URR = 77, + OSMO_PFCP_IEI_USAGE_REP_SESS_MOD_RESP = 78, + OSMO_PFCP_IEI_USAGE_REP_SESS_DEL_RESP = 79, + OSMO_PFCP_IEI_USAGE_REP_SESS_REP_REQ = 80, + OSMO_PFCP_IEI_URR_ID = 81, + OSMO_PFCP_IEI_LINKED_URR_ID = 82, + OSMO_PFCP_IEI_DL_DATA_REP = 83, + OSMO_PFCP_IEI_OUTER_HEADER_CREATION = 84, + OSMO_PFCP_IEI_CREATE_BAR = 85, + OSMO_PFCP_IEI_UPD_BAR_SESS_MOD_REQ = 86, + OSMO_PFCP_IEI_REMOVE_BAR = 87, + OSMO_PFCP_IEI_BAR_ID = 88, + OSMO_PFCP_IEI_CP_FUNCTION_FEATURES = 89, + OSMO_PFCP_IEI_USAGE_INFO = 90, + OSMO_PFCP_IEI_APPLICATION_INST_ID = 91, + OSMO_PFCP_IEI_FLOW_INFO = 92, + OSMO_PFCP_IEI_UE_IP_ADDRESS = 93, + OSMO_PFCP_IEI_PACKET_RATE = 94, + OSMO_PFCP_IEI_OUTER_HEADER_REMOVAL = 95, + OSMO_PFCP_IEI_RECOVERY_TIME_STAMP = 96, + OSMO_PFCP_IEI_DL_FLOW_LEVEL_MARKING = 97, + OSMO_PFCP_IEI_HEADER_ENRICHMENT = 98, + OSMO_PFCP_IEI_ERROR_IND_REP = 99, + OSMO_PFCP_IEI_MEAS_INFO = 100, + OSMO_PFCP_IEI_NODE_REP_TYPE = 101, + OSMO_PFCP_IEI_USER_PLANE_PATH_FAILURE_REP = 102, + OSMO_PFCP_IEI_REMOTE_GTP_U_PEER = 103, + OSMO_PFCP_IEI_UR_SEQN = 104, + OSMO_PFCP_IEI_UPD_DUPL_PARAMS = 105, + OSMO_PFCP_IEI_ACTIVATE_PREDEFINED_RULES = 106, + OSMO_PFCP_IEI_DEACTIVATE_PREDEFINED_RULES = 107, + OSMO_PFCP_IEI_FAR_ID = 108, + OSMO_PFCP_IEI_QER_ID = 109, + OSMO_PFCP_IEI_OCI_FLAGS = 110, + OSMO_PFCP_IEI_PFCP_ASSOC_RELEASE_REQ = 111, + OSMO_PFCP_IEI_GRACEFUL_RELEASE_PERIOD = 112, + OSMO_PFCP_IEI_PDN_TYPE = 113, + OSMO_PFCP_IEI_FAILED_RULE_ID = 114, + OSMO_PFCP_IEI_TIME_QUOTA_MECHANISM = 115, + OSMO_PFCP_IEI_RESERVED = 116, + OSMO_PFCP_IEI_USER_PLANE_INACT_TIMER = 117, + OSMO_PFCP_IEI_AGGREGATED_URRS = 118, + OSMO_PFCP_IEI_MULTIPLIER = 119, + OSMO_PFCP_IEI_AGGREGATED_URR_ID = 120, + OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_QUOTA = 121, + OSMO_PFCP_IEI_SUBSEQUENT_TIME_QUOTA = 122, + OSMO_PFCP_IEI_RQI = 123, + OSMO_PFCP_IEI_QFI = 124, + OSMO_PFCP_IEI_QUERY_URR_REFERENCE = 125, + OSMO_PFCP_IEI_ADDITIONAL_USAGE_REPS_INFO = 126, + OSMO_PFCP_IEI_CREATE_TRAFFIC_ENDPOINT = 127, + OSMO_PFCP_IEI_CREATED_TRAFFIC_ENDPOINT = 128, + OSMO_PFCP_IEI_UPD_TRAFFIC_ENDPOINT = 129, + OSMO_PFCP_IEI_REMOVE_TRAFFIC_ENDPOINT = 130, + OSMO_PFCP_IEI_TRAFFIC_ENDPOINT_ID = 131, + OSMO_PFCP_IEI_ETHERNET_PACKET_FILTER = 132, + OSMO_PFCP_IEI_MAC_ADDRESS = 133, + OSMO_PFCP_IEI_C_TAG = 134, + OSMO_PFCP_IEI_S_TAG = 135, + OSMO_PFCP_IEI_ETHERTYPE = 136, + OSMO_PFCP_IEI_PROXYING = 137, + OSMO_PFCP_IEI_ETHERNET_FILTER_ID = 138, + OSMO_PFCP_IEI_ETHERNET_FILTER_PROPERTIES = 139, + OSMO_PFCP_IEI_SUGGESTED_BUFF_PACKETS_COUNT = 140, + OSMO_PFCP_IEI_USER_ID = 141, + OSMO_PFCP_IEI_ETHERNET_PDU_SESS_INFO = 142, + OSMO_PFCP_IEI_ETHERNET_TRAFFIC_INFO = 143, + OSMO_PFCP_IEI_MAC_ADDRS_DETECTED = 144, + OSMO_PFCP_IEI_MAC_ADDRS_REMOVED = 145, + OSMO_PFCP_IEI_ETHERNET_INACT_TIMER = 146, + OSMO_PFCP_IEI_ADDITIONAL_MONITORING_TIME = 147, + OSMO_PFCP_IEI_EVENT_QUOTA = 148, + OSMO_PFCP_IEI_EVENT_THRESH = 149, + OSMO_PFCP_IEI_SUBSEQUENT_EVENT_QUOTA = 150, + OSMO_PFCP_IEI_SUBSEQUENT_EVENT_THRESH = 151, + OSMO_PFCP_IEI_TRACE_INFO = 152, + OSMO_PFCP_IEI_FRAMED_ROUTE = 153, + OSMO_PFCP_IEI_FRAMED_ROUTING = 154, + OSMO_PFCP_IEI_FRAMED_IPV6_ROUTE = 155, + OSMO_PFCP_IEI_TIME_STAMP = 156, + OSMO_PFCP_IEI_AVERAGING_WINDOW = 157, + OSMO_PFCP_IEI_PAGING_POLICY_INDICATOR = 158, + OSMO_PFCP_IEI_APN_DNN = 159, + OSMO_PFCP_IEI_3GPP_IFACE_TYPE = 160, + OSMO_PFCP_IEI_PFCPSRREQ_FLAGS = 161, + OSMO_PFCP_IEI_PFCPAUREQ_FLAGS = 162, + OSMO_PFCP_IEI_ACTIVATION_TIME = 163, + OSMO_PFCP_IEI_DEACTIVATION_TIME = 164, + OSMO_PFCP_IEI_CREATE_MAR = 165, + OSMO_PFCP_IEI_3GPP_ACCESS_FORW_ACTION_INFO = 166, + OSMO_PFCP_IEI_NON_3GPP_ACCESS_FORW_ACTION_INFO = 167, + OSMO_PFCP_IEI_REMOVE_MAR = 168, + OSMO_PFCP_IEI_UPD_MAR = 169, + OSMO_PFCP_IEI_MAR_ID = 170, + OSMO_PFCP_IEI_STEERING_FUNCTIONALITY = 171, + OSMO_PFCP_IEI_STEERING_MODE = 172, + OSMO_PFCP_IEI_WEIGHT = 173, + OSMO_PFCP_IEI_PRIORITY = 174, + OSMO_PFCP_IEI_UPD_3GPP_ACCESS_FORW_ACTION_INFO = 175, + OSMO_PFCP_IEI_UPD_NON_3GPP_ACCESS_FORW_ACTION_INFO = 176, + OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_IDENTITY = 177, + OSMO_PFCP_IEI_ALTERNATIVE_SMF_IP_ADDRESS = 178, + OSMO_PFCP_IEI_PACKET_REPLICATION_AND_DETECTION_CARRY_ON_INFO = 179, + OSMO_PFCP_IEI_SMF_SET_ID = 180, + OSMO_PFCP_IEI_QUOTA_VALIDITY_TIME = 181, + OSMO_PFCP_IEI_NUMBER_OF_REPS = 182, + OSMO_PFCP_IEI_PFCP_SESS_RETENTION_INFO_IN_ASSOC_SETUP_REQ = 183, + OSMO_PFCP_IEI_PFCPASRSP_FLAGS = 184, + OSMO_PFCP_IEI_CP_ENTITY_IP_ADDRESS = 185, + OSMO_PFCP_IEI_PFCPSEREQ_FLAGS = 186, + OSMO_PFCP_IEI_USER_PLANE_PATH_RECOVERY_REP = 187, + OSMO_PFCP_IEI_IP_MULTICAST_ADDR_INFO_IN_SESS_EST_REQ = 188, + OSMO_PFCP_IEI_JOIN_IP_MULTICAST_INFO_IE_IN_USAGE_REP = 189, + OSMO_PFCP_IEI_LEAVE_IP_MULTICAST_INFO_IE_IN_USAGE_REP = 190, + OSMO_PFCP_IEI_IP_MULTICAST_ADDRESS = 191, + OSMO_PFCP_IEI_SOURCE_IP_ADDRESS = 192, + OSMO_PFCP_IEI_PACKET_RATE_STATUS = 193, + OSMO_PFCP_IEI_CREATE_BRIDGE_INFO_FOR_TSC = 194, + OSMO_PFCP_IEI_CREATED_BRIDGE_INFO_FOR_TSC = 195, + OSMO_PFCP_IEI_DS_TT_PORT_NUMBER = 196, + OSMO_PFCP_IEI_NW_TT_PORT_NUMBER = 197, + OSMO_PFCP_IEI_TSN_BRIDGE_ID = 198, + OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_REQ = 199, + OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_RESP = 200, + OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_REP_REQ = 201, + OSMO_PFCP_IEI_PORT_MGMT_INFO_CONTAINER = 202, + OSMO_PFCP_IEI_CLOCK_DRIFT_CTRL_INFO = 203, + OSMO_PFCP_IEI_REQUESTED_CLOCK_DRIFT_INFO = 204, + OSMO_PFCP_IEI_CLOCK_DRIFT_REP = 205, + OSMO_PFCP_IEI_TSN_TIME_DOMAIN_NUMBER = 206, + OSMO_PFCP_IEI_TIME_OFFSET_THRESH = 207, + OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_THRESH = 208, + OSMO_PFCP_IEI_TIME_OFFSET_MEAS = 209, + OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_MEAS = 210, + OSMO_PFCP_IEI_REMOVE_SRR = 211, + OSMO_PFCP_IEI_CREATE_SRR = 212, + OSMO_PFCP_IEI_UPD_SRR = 213, + OSMO_PFCP_IEI_SESS_REP = 214, + OSMO_PFCP_IEI_SRR_ID = 215, + OSMO_PFCP_IEI_ACCESS_AVAIL_CTRL_INFO = 216, + OSMO_PFCP_IEI_REQUESTED_ACCESS_AVAIL_INFO = 217, + OSMO_PFCP_IEI_ACCESS_AVAIL_REP = 218, + OSMO_PFCP_IEI_ACCESS_AVAIL_INFO = 219, + OSMO_PFCP_IEI_PROVIDE_ATSSS_CTRL_INFO = 220, + OSMO_PFCP_IEI_ATSSS_CTRL_PARAMS = 221, + OSMO_PFCP_IEI_MPTCP_CTRL_INFO = 222, + OSMO_PFCP_IEI_ATSSS_LL_CTRL_INFO = 223, + OSMO_PFCP_IEI_PMF_CTRL_INFO = 224, + OSMO_PFCP_IEI_MPTCP_PARAMS = 225, + OSMO_PFCP_IEI_ATSSS_LL_PARAMS = 226, + OSMO_PFCP_IEI_PMF_PARAMS = 227, + OSMO_PFCP_IEI_MPTCP_ADDRESS_INFO = 228, + OSMO_PFCP_IEI_UE_LINK_SPECIFIC_IP_ADDRESS = 229, + OSMO_PFCP_IEI_PMF_ADDRESS_INFO = 230, + OSMO_PFCP_IEI_ATSSS_LL_INFO = 231, + OSMO_PFCP_IEI_DATA_NETWORK_ACCESS_IDENTIFIER = 232, + OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_INFO = 233, + OSMO_PFCP_IEI_AVERAGE_PACKET_DELAY = 234, + OSMO_PFCP_IEI_MIN_PACKET_DELAY = 235, + OSMO_PFCP_IEI_MAX_PACKET_DELAY = 236, + OSMO_PFCP_IEI_QOS_REP_TRIGGER = 237, + OSMO_PFCP_IEI_GTP_U_PATH_QOS_CTRL_INFO = 238, + OSMO_PFCP_IEI_GTP_U_PATH_QOS_REP_NODE_REP_REQ = 239, + OSMO_PFCP_IEI_QOS_INFO_IN_GTP_U_PATH_QOS_REP = 240, + OSMO_PFCP_IEI_GTP_U_PATH_IFACE_TYPE = 241, + OSMO_PFCP_IEI_QOS_MONITORING_PER_QOS_FLOW_CTRL_INFO = 242, + OSMO_PFCP_IEI_REQUESTED_QOS_MONITORING = 243, + OSMO_PFCP_IEI_REPORTING_FREQUENCY = 244, + OSMO_PFCP_IEI_PACKET_DELAY_THRESHOLDS = 245, + OSMO_PFCP_IEI_MIN_WAIT_TIME = 246, + OSMO_PFCP_IEI_QOS_MONITORING_REP = 247, + OSMO_PFCP_IEI_QOS_MONITORING_MEAS = 248, + OSMO_PFCP_IEI_MT_EDT_CTRL_INFO = 249, + OSMO_PFCP_IEI_DL_DATA_PACKETS_SIZE = 250, + OSMO_PFCP_IEI_QER_CTRL_INDICATIONS = 251, + OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP = 252, + OSMO_PFCP_IEI_NF_INST_ID = 253, + OSMO_PFCP_IEI_ETHERNET_CONTEXT_INFO = 254, + OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_PARAMS = 255, + OSMO_PFCP_IEI_UPDATED_PDR = 256, + OSMO_PFCP_IEI_S_NSSAI = 257, + OSMO_PFCP_IEI_IP_VERSION = 258, + OSMO_PFCP_IEI_PFCPASREQ_FLAGS = 259, + OSMO_PFCP_IEI_DATA_STATUS = 260, + OSMO_PFCP_IEI_PROVIDE_RDS_CONF_INFO = 261, + OSMO_PFCP_IEI_RDS_CONF_INFO = 262, + OSMO_PFCP_IEI_QUERY_PACKET_RATE_STATUS_IE_IN_SESS_MOD_REQ = 263, + OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP_IE_IN_SESS_MOD_RESP = 264, + OSMO_PFCP_IEI_MPTCP_APPLICABLE_IND = 265, + OSMO_PFCP_IEI_BRIDGE_MGMT_INFO_CONTAINER = 266, + OSMO_PFCP_IEI_UE_IP_ADDRESS_USAGE_INFO = 267, + OSMO_PFCP_IEI_NUMBER_OF_UE_IP_ADDRS = 268, + OSMO_PFCP_IEI_VALIDITY_TIMER = 269, + OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_FORW_PARAMS = 270, + OSMO_PFCP_IEI_TRANSPORT_DELAY_REPORTING = 271, +}; + +/* Section 8.2.1 / Table 8.2.1-1 */ +enum osmo_pfcp_cause { + OSMO_PFCP_CAUSE_RESERVED = 0, + OSMO_PFCP_CAUSE_REQUEST_ACCEPTED = 1, + OSMO_PFCP_CAUSE_MORE_USAGE_REPORT_TO_SEND = 2, + OSMO_PFCP_CAUSE_REQUEST_REJECTED = 64, + OSMO_PFCP_CAUSE_SESSION_CTX_NOT_FOUND = 65, + OSMO_PFCP_CAUSE_MANDATORY_IE_MISSING = 66, + OSMO_PFCP_CAUSE_CONDITIONAL_IE_MISSING = 67, + OSMO_PFCP_CAUSE_INVALID_LENGTH = 68, + OSMO_PFCP_CAUSE_MANDATORY_IE_INCORRECT = 69, + OSMO_PFCP_CAUSE_INVALID_FORW_POLICY = 70, + OSMO_PFCP_CAUSE_INVALID_F_TEID_ALLOC_OPTION = 71, + OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC = 72, + OSMO_PFCP_CAUSE_RULE_CREATION_MOD_FAILURE = 73, + OSMO_PFCP_CAUSE_PFCP_ENTITY_IN_CONGESTION = 74, + OSMO_PFCP_CAUSE_NO_RESOURCES_AVAILABLE = 75, + OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED = 76, + OSMO_PFCP_CAUSE_SYSTEM_FAILURE = 77, + OSMO_PFCP_CAUSE_REDIRECTION_REQUESTED = 78, + OSMO_PFCP_CAUSE_ALL_DYNAMIC_ADDRESSES_ARE_OCCUPIED = 79, +}; + +/* Section 8.2.38 */ +enum osmo_pfcp_node_id_type { + OSMO_PFCP_NODE_ID_T_IPV4 = 0, + OSMO_PFCP_NODE_ID_T_IPV6 = 1, + OSMO_PFCP_NODE_ID_T_FQDN = 2, +}; + +enum osmo_pfcp_3gpp_iface_type { + OSMO_PFCP_3GPP_IFACE_TYPE_S1_U = 0, + OSMO_PFCP_3GPP_IFACE_TYPE_S5_S8_U = 1, + OSMO_PFCP_3GPP_IFACE_TYPE_S4_U = 2, + OSMO_PFCP_3GPP_IFACE_TYPE_S11_U = 3, + OSMO_PFCP_3GPP_IFACE_TYPE_S12_U = 4, + OSMO_PFCP_3GPP_IFACE_TYPE_GN_GP_U = 5, + OSMO_PFCP_3GPP_IFACE_TYPE_S2A_U = 6, + OSMO_PFCP_3GPP_IFACE_TYPE_S2B_U = 7, + OSMO_PFCP_3GPP_IFACE_TYPE_ENODEB_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING = 8, + OSMO_PFCP_3GPP_IFACE_TYPE_ENODEB_GTP_U_INTERFACE_FOR_UL_DATA_FORWARDING = 9, + OSMO_PFCP_3GPP_IFACE_TYPE_SGW_UPF_GTP_U_INTERFACE_FOR_DL_DATA_FORWARDING = 10, + OSMO_PFCP_3GPP_IFACE_TYPE_N3_3GPP_ACCESS = 11, + OSMO_PFCP_3GPP_IFACE_TYPE_N3_TRUSTED_NON_3GPP_ACCESS = 12, + OSMO_PFCP_3GPP_IFACE_TYPE_N3_UNTRUSTED_NON_3GPP_ACCESS = 13, + OSMO_PFCP_3GPP_IFACE_TYPE_N3_FOR_DATA_FORWARDING = 14, + OSMO_PFCP_3GPP_IFACE_TYPE_N9 = 15, + OSMO_PFCP_3GPP_IFACE_TYPE_SGI = 16, + OSMO_PFCP_3GPP_IFACE_TYPE_N6 = 17, + OSMO_PFCP_3GPP_IFACE_TYPE_N19 = 18, + OSMO_PFCP_3GPP_IFACE_TYPE_S8_U = 19, + OSMO_PFCP_3GPP_IFACE_TYPE_GP_U = 20, +}; + +enum osmo_pfcp_source_iface { + OSMO_PFCP_SOURCE_IFACE_ACCESS = 0, + OSMO_PFCP_SOURCE_IFACE_CORE = 1, + OSMO_PFCP_SOURCE_IFACE_SGI_LAN_N6_LAN = 2, + OSMO_PFCP_SOURCE_IFACE_CP_FUNCTION = 3, + OSMO_PFCP_SOURCE_IFACE_5G_VN_INTERNAL = 4, +}; + +enum osmo_pfcp_dest_iface { + OSMO_PFCP_DEST_IFACE_ACCESS = 0, + OSMO_PFCP_DEST_IFACE_CORE = 1, + OSMO_PFCP_DEST_IFACE_SGI_LAN_N6_LAN = 2, + OSMO_PFCP_DEST_IFACE_CP_FUNCTION = 3, + OSMO_PFCP_DEST_IFACE_LI_FUNCTION = 4, + OSMO_PFCP_DEST_IFACE_5G_VN_INTERNAL = 5, +}; + +/* The enum values correspond to the bit index in the supported features bitmask in the PFCP UP Function Features IE. + * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; + * 7 means first octet last bit, "Octet 5 Bit 8"; + * 8 means second octet first bit, "Octet 6 Bit 1"; + * and so on. + * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). + */ +enum osmo_pfcp_up_feature { + OSMO_PFCP_UP_FEAT_BUCP = 0, + OSMO_PFCP_UP_FEAT_DDND, + OSMO_PFCP_UP_FEAT_DLBD, + OSMO_PFCP_UP_FEAT_TRST, + OSMO_PFCP_UP_FEAT_FTUP, + OSMO_PFCP_UP_FEAT_PFDM, + OSMO_PFCP_UP_FEAT_HEEU, + OSMO_PFCP_UP_FEAT_TREU, + OSMO_PFCP_UP_FEAT_EMPU, + OSMO_PFCP_UP_FEAT_PDIU, + OSMO_PFCP_UP_FEAT_UDBC, + OSMO_PFCP_UP_FEAT_QUOAC, + OSMO_PFCP_UP_FEAT_TRACE, + OSMO_PFCP_UP_FEAT_FRRT, + OSMO_PFCP_UP_FEAT_PFDE, + OSMO_PFCP_UP_FEAT_EPFAR, + OSMO_PFCP_UP_FEAT_DPDRA, + OSMO_PFCP_UP_FEAT_ADPDP, + OSMO_PFCP_UP_FEAT_UEIP, + OSMO_PFCP_UP_FEAT_SSET, + OSMO_PFCP_UP_FEAT_MNOP, + OSMO_PFCP_UP_FEAT_MTE, + OSMO_PFCP_UP_FEAT_BUNDL, + OSMO_PFCP_UP_FEAT_GCOM, + OSMO_PFCP_UP_FEAT_MPAS, + OSMO_PFCP_UP_FEAT_RTTL, + OSMO_PFCP_UP_FEAT_VTIME, + OSMO_PFCP_UP_FEAT_NORP, + OSMO_PFCP_UP_FEAT_IP6PL, + OSMO_PFCP_UP_FEAT_TSCU, + OSMO_PFCP_UP_FEAT_MPTCP, + OSMO_PFCP_UP_FEAT_ATSSSLL, + OSMO_PFCP_UP_FEAT_QFQM, + OSMO_PFCP_UP_FEAT_GPQM, + OSMO_PFCP_UP_FEAT_MTEDT, + OSMO_PFCP_UP_FEAT_CIOT, + OSMO_PFCP_UP_FEAT_ETHAR, + OSMO_PFCP_UP_FEAT_DDDS, + OSMO_PFCP_UP_FEAT_RDS, + OSMO_PFCP_UP_FEAT_RTTWP, +}; + +/* The enum values correspond to the bit index in the supported features bitmask in the PFCP CP Function Features IE. + * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; + * 7 means first octet last bit, "Octet 5 Bit 8"; + * 8 means second octet first bit, "Octet 6 Bit 1"; + * and so on. + * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). + */ +enum osmo_pfcp_cp_feature { + OSMO_PFCP_CP_FEAT_LOAD = 0, + OSMO_PFCP_CP_FEAT_OVRL, + OSMO_PFCP_CP_FEAT_EPFAR, + OSMO_PFCP_CP_FEAT_SSET, + OSMO_PFCP_CP_FEAT_BUNDL, + OSMO_PFCP_CP_FEAT_MPAS, + OSMO_PFCP_CP_FEAT_ARDR, + OSMO_PFCP_CP_FEAT_UIAUR, +}; + +/* The enum values correspond to the bit index in the PFCP Apply Action IE. + * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; + * 7 means first octet last bit, "Octet 5 Bit 8"; + * 8 means second octet first bit, "Octet 6 Bit 1"; + * and so on. + * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). + */ +enum osmo_pfcp_apply_action { + OSMO_PFCP_APPLY_ACTION_DROP = 0, + OSMO_PFCP_APPLY_ACTION_FORW, + OSMO_PFCP_APPLY_ACTION_BUFF, + OSMO_PFCP_APPLY_ACTION_NOCP, + OSMO_PFCP_APPLY_ACTION_DUPL, + OSMO_PFCP_APPLY_ACTION_IPMA, + OSMO_PFCP_APPLY_ACTION_IPMD, + OSMO_PFCP_APPLY_ACTION_DFRT, + OSMO_PFCP_APPLY_ACTION_EDRT, + OSMO_PFCP_APPLY_ACTION_BDPN, + OSMO_PFCP_APPLY_ACTION_DDPN, +}; + +/* The enum values correspond to the bit index in the description bitmask in the PFCP Outer Header Creation IE. + * 0 means first octet and first bit, "Octet 5 Bit 1" as in spec; + * 7 means first octet last bit, "Octet 5 Bit 8"; + * 8 means second octet first bit, "Octet 6 Bit 1"; + * and so on. + * Intended for use with osmo_pfcp_bits_get(), osmo_pfcp_bits_set(), osmo_pfcp_bits_to_str_c(). + */ +enum osmo_pfcp_outer_header_creation { + OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4 = 0, + OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6, + OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4, + OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6, + OSMO_PFCP_OUTER_HEADER_CREATION_IPV4, + OSMO_PFCP_OUTER_HEADER_CREATION_IPV6, + OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG, + OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG, + OSMO_PFCP_OUTER_HEADER_CREATION_N19_INDICATION, + OSMO_PFCP_OUTER_HEADER_CREATION_N6_INDICATION, +}; + +/* 3GPP TS 29.244 8.2.64 */ +enum osmo_pfcp_outer_header_removal_desc { + OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4 = 0, + OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV6 = 1, + OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV4 = 2, + OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV6 = 3, + OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV4 = 4, + OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV6 = 5, + OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IP = 6, + OSMO_PFCP_OUTER_HEADER_REMOVAL_VLAN_S_TAG = 7, + OSMO_PFCP_OUTER_HEADER_REMOVAL_S_TAG_AND_C_TAG = 8, +}; diff --git a/include/osmocom/pfcp/pfcp_strs.h b/include/osmocom/pfcp/pfcp_strs.h new file mode 100644 index 0000000..fd11a8d --- /dev/null +++ b/include/osmocom/pfcp/pfcp_strs.h @@ -0,0 +1,65 @@ +#pragma once + +#include <osmocom/core/utils.h> + +#include <osmocom/pfcp/pfcp_proto.h> + +extern const struct value_string osmo_pfcp_message_type_strs[]; +static inline const char *osmo_pfcp_message_type_str(enum osmo_pfcp_message_type val) +{ + return get_value_string(osmo_pfcp_message_type_strs, val); +} + +extern const struct value_string osmo_pfcp_iei_strs[]; +static inline const char *osmo_pfcp_iei_str(enum osmo_pfcp_iei val) +{ + return get_value_string(osmo_pfcp_iei_strs, val); +} + +extern const struct value_string osmo_pfcp_cause_strs[]; +static inline const char *osmo_pfcp_cause_str(enum osmo_pfcp_cause val) +{ + return get_value_string(osmo_pfcp_cause_strs, val); +} + +extern const struct value_string osmo_pfcp_up_feature_strs[]; +static inline const char *osmo_pfcp_up_feature_str(enum osmo_pfcp_up_feature val) +{ + return get_value_string(osmo_pfcp_up_feature_strs, val); +} + +extern const struct value_string osmo_pfcp_cp_feature_strs[]; +static inline const char *osmo_pfcp_cp_feature_str(enum osmo_pfcp_cp_feature val) +{ + return get_value_string(osmo_pfcp_cp_feature_strs, val); +} + +extern const struct value_string osmo_pfcp_apply_action_strs[]; +static inline const char *osmo_pfcp_apply_action_str(enum osmo_pfcp_apply_action val) +{ + return get_value_string(osmo_pfcp_apply_action_strs, val); +} + +extern const struct value_string osmo_pfcp_outer_header_creation_strs[]; +static inline const char *osmo_pfcp_outer_header_creation_str(enum osmo_pfcp_outer_header_creation val) +{ + return get_value_string(osmo_pfcp_outer_header_creation_strs, val); +} + +extern const struct value_string osmo_pfcp_outer_header_removal_desc_strs[]; +static inline const char *osmo_pfcp_outer_header_removal_desc_str(enum osmo_pfcp_outer_header_removal_desc val) +{ + return get_value_string(osmo_pfcp_outer_header_removal_desc_strs, val); +} + +extern const struct value_string osmo_pfcp_source_iface_strs[]; +static inline const char *osmo_pfcp_source_iface_str(enum osmo_pfcp_source_iface val) +{ + return get_value_string(osmo_pfcp_source_iface_strs, val); +} + +extern const struct value_string osmo_pfcp_dest_iface_strs[]; +static inline const char *osmo_pfcp_dest_iface_str(enum osmo_pfcp_dest_iface val) +{ + return get_value_string(osmo_pfcp_dest_iface_strs, val); +} diff --git a/src/Makefile.am b/src/Makefile.am index 0e44dcc..d3d6972 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,4 +1,5 @@ SUBDIRS = \ libosmo-tlv \ + libosmo-pfcp \ osmo-upf \ $(NULL) diff --git a/src/libosmo-pfcp/Makefile.am b/src/libosmo-pfcp/Makefile.am new file mode 100644 index 0000000..f2dacfe --- /dev/null +++ b/src/libosmo-pfcp/Makefile.am @@ -0,0 +1,28 @@ +AM_CPPFLAGS = \ + $(all_includes) \ + -I$(top_srcdir)/include \ + -I$(top_builddir)/include \ + -I$(top_builddir) \ + -I$(builddir) \ + $(NULL) + +AM_CFLAGS = \ + -Wall \ + $(LIBOSMOCORE_CFLAGS) \ + $(LIBOSMOVTY_CFLAGS) \ + $(COVERAGE_CFLAGS) \ + $(NULL) + +AM_LDFLAGS = \ + $(LIBOSMOCORE_LIBS) \ + $(LIBOSMOVTY_LIBS) \ + $(COVERAGE_LDFLAGS) \ + $(NULL) + +noinst_LIBRARIES = \ + libosmo-pfcp.a \ + $(NULL) + +libosmo_pfcp_a_SOURCES = \ + pfcp_strs.c \ + $(NULL) diff --git a/src/libosmo-pfcp/pfcp_strs.c b/src/libosmo-pfcp/pfcp_strs.c new file mode 100644 index 0000000..85a753d --- /dev/null +++ b/src/libosmo-pfcp/pfcp_strs.c @@ -0,0 +1,468 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <osmocom/pfcp/pfcp_strs.h> + +const struct value_string osmo_pfcp_message_type_strs[] = { + { OSMO_PFCP_MSGT_HEARTBEAT_REQ, "HEARTBEAT_REQ" }, + { OSMO_PFCP_MSGT_HEARTBEAT_RESP, "HEARTBEAT_RESP" }, + { OSMO_PFCP_MSGT_PFD_MGMT_REQ, "PFD_MGMT_REQ" }, + { OSMO_PFCP_MSGT_PFD_MGMT_RESP, "PFD_MGMT_RESP" }, + { OSMO_PFCP_MSGT_ASSOC_SETUP_REQ, "ASSOC_SETUP_REQ" }, + { OSMO_PFCP_MSGT_ASSOC_SETUP_RESP, "ASSOC_SETUP_RESP" }, + { OSMO_PFCP_MSGT_ASSOC_UPDATE_REQ, "ASSOC_UPDATE_REQ" }, + { OSMO_PFCP_MSGT_ASSOC_UPDATE_RESP, "ASSOC_UPDATE_RESP" }, + { OSMO_PFCP_MSGT_ASSOC_RELEASE_REQ, "ASSOC_RELEASE_REQ" }, + { OSMO_PFCP_MSGT_ASSOC_RELEASE_RESP, "ASSOC_RELEASE_RESP" }, + { OSMO_PFCP_MSGT_VERSION_NOT_SUPP_RESP, "VERSION_NOT_SUPP_RESP" }, + { OSMO_PFCP_MSGT_NODE_REPORT_REQ, "NODE_REPORT_REQ" }, + { OSMO_PFCP_MSGT_NODE_REPORT_RESP, "NODE_REPORT_RESP" }, + { OSMO_PFCP_MSGT_SESSION_SET_DEL_REQ, "SESSION_SET_DEL_REQ" }, + { OSMO_PFCP_MSGT_SESSION_SET_DEL_RESP, "SESSION_SET_DEL_RESP" }, + { OSMO_PFCP_MSGT_SESSION_EST_REQ, "SESSION_EST_REQ" }, + { OSMO_PFCP_MSGT_SESSION_EST_RESP, "SESSION_EST_RESP" }, + { OSMO_PFCP_MSGT_SESSION_MOD_REQ, "SESSION_MOD_REQ" }, + { OSMO_PFCP_MSGT_SESSION_MOD_RESP, "SESSION_MOD_RESP" }, + { OSMO_PFCP_MSGT_SESSION_DEL_REQ, "SESSION_DEL_REQ" }, + { OSMO_PFCP_MSGT_SESSION_DEL_RESP, "SESSION_DEL_RESP" }, + { OSMO_PFCP_MSGT_SESSION_REP_REQ, "SESSION_REP_REQ" }, + { OSMO_PFCP_MSGT_SESSION_REP_RESP, "SESSION_REP_RESP" }, + { 0 } +}; + +const struct value_string osmo_pfcp_iei_strs[] = { + { OSMO_PFCP_IEI_CREATE_PDR, "Create PDR" }, + { OSMO_PFCP_IEI_PDI, "PDI" }, + { OSMO_PFCP_IEI_CREATE_FAR, "Create FAR" }, + { OSMO_PFCP_IEI_FORW_PARAMS, "Forwarding Parameters" }, + { OSMO_PFCP_IEI_DUPL_PARAMS, "Duplicating Parameters" }, + { OSMO_PFCP_IEI_CREATE_URR, "Create URR" }, + { OSMO_PFCP_IEI_CREATE_QER, "Create QER" }, + { OSMO_PFCP_IEI_CREATED_PDR, "Created PDR" }, + { OSMO_PFCP_IEI_UPD_PDR, "Update PDR" }, + { OSMO_PFCP_IEI_UPD_FAR, "Update FAR" }, + { OSMO_PFCP_IEI_UPD_FORW_PARAMS, "Update Forwarding Parameters" }, + { OSMO_PFCP_IEI_UPD_BAR_SESS_REP_RESP, "Update BAR (OSMO_PFCP Session Report Response)" }, + { OSMO_PFCP_IEI_UPD_URR, "Update URR" }, + { OSMO_PFCP_IEI_UPD_QER, "Update QER" }, + { OSMO_PFCP_IEI_REMOVE_PDR, "Remove PDR" }, + { OSMO_PFCP_IEI_REMOVE_FAR, "Remove FAR" }, + { OSMO_PFCP_IEI_REMOVE_URR, "Remove URR" }, + { OSMO_PFCP_IEI_REMOVE_QER, "Remove QER" }, + { OSMO_PFCP_IEI_CAUSE, "Cause" }, + { OSMO_PFCP_IEI_SOURCE_IFACE, "Source Interface" }, + { OSMO_PFCP_IEI_F_TEID, "F-TEID" }, + { OSMO_PFCP_IEI_NETWORK_INST, "Network Instance" }, + { OSMO_PFCP_IEI_SDF_FILTER, "SDF Filter" }, + { OSMO_PFCP_IEI_APPLICATION_ID, "Application ID" }, + { OSMO_PFCP_IEI_GATE_STATUS, "Gate Status" }, + { OSMO_PFCP_IEI_MBR, "MBR" }, + { OSMO_PFCP_IEI_GBR, "GBR" }, + { OSMO_PFCP_IEI_QER_CORRELATION_ID, "QER Correlation ID" }, + { OSMO_PFCP_IEI_PRECEDENCE, "Precedence" }, + { OSMO_PFCP_IEI_TRANSPORT_LEVEL_MARKING, "Transport Level Marking" }, + { OSMO_PFCP_IEI_VOLUME_THRESH, "Volume Threshold" }, + { OSMO_PFCP_IEI_TIME_THRESH, "Time Threshold" }, + { OSMO_PFCP_IEI_MONITORING_TIME, "Monitoring Time" }, + { OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_THRESH, "Subsequent Volume Threshold" }, + { OSMO_PFCP_IEI_SUBSEQUENT_TIME_THRESH, "Subsequent Time Threshold" }, + { OSMO_PFCP_IEI_INACT_DETECTION_TIME, "Inactivity Detection Time" }, + { OSMO_PFCP_IEI_REPORTING_TRIGGERS, "Reporting Triggers" }, + { OSMO_PFCP_IEI_REDIRECT_INFO, "Redirect Information" }, + { OSMO_PFCP_IEI_REP_TYPE, "Report Type" }, + { OSMO_PFCP_IEI_OFFENDING_IE, "Offending IE" }, + { OSMO_PFCP_IEI_FORW_POLICY, "Forwarding Policy" }, + { OSMO_PFCP_IEI_DESTINATION_IFACE, "Destination Interface" }, + { OSMO_PFCP_IEI_UP_FUNCTION_FEATURES, "UP Function Features" }, + { OSMO_PFCP_IEI_APPLY_ACTION, "Apply Action" }, + { OSMO_PFCP_IEI_DL_DATA_SERVICE_INFO, "Downlink Data Service Information" }, + { OSMO_PFCP_IEI_DL_DATA_NOTIFICATION_DELAY, "Downlink Data Notification Delay" }, + { OSMO_PFCP_IEI_DL_BUFF_DURATION, "DL Buffering Duration" }, + { OSMO_PFCP_IEI_DL_BUFF_SUGGESTED_PACKET_COUNT, "DL Buffering Suggested Packet Count" }, + { OSMO_PFCP_IEI_PFCPSMREQ_FLAGS, "OSMO_PFCPSMReq-Flags" }, + { OSMO_PFCP_IEI_PFCPSRRSP_FLAGS, "OSMO_PFCPSRRsp-Flags" }, + { OSMO_PFCP_IEI_LOAD_CTRL_INFO, "Load Control Information" }, + { OSMO_PFCP_IEI_SEQUENCE_NUMBER, "Sequence Number" }, + { OSMO_PFCP_IEI_METRIC, "Metric" }, + { OSMO_PFCP_IEI_OVERLOAD_CTRL_INFO, "Overload Control Information" }, + { OSMO_PFCP_IEI_TIMER, "Timer" }, + { OSMO_PFCP_IEI_PDR_ID, "PDR ID" }, + { OSMO_PFCP_IEI_F_SEID, "F-SEID" }, + { OSMO_PFCP_IEI_APPLICATION_IDS_PFDS, "Application ID's PFDs" }, + { OSMO_PFCP_IEI_PFD_CONTEXT, "PFD context" }, + { OSMO_PFCP_IEI_NODE_ID, "Node ID" }, + { OSMO_PFCP_IEI_PFD_CONTENTS, "PFD contents" }, + { OSMO_PFCP_IEI_MEAS_METHOD, "Measurement Method" }, + { OSMO_PFCP_IEI_USAGE_REP_TRIGGER, "Usage Report Trigger" }, + { OSMO_PFCP_IEI_MEAS_PERIOD, "Measurement Period" }, + { OSMO_PFCP_IEI_FQ_CSID, "FQ-CSID" }, + { OSMO_PFCP_IEI_VOLUME_MEAS, "Volume Measurement" }, + { OSMO_PFCP_IEI_DURATION_MEAS, "Duration Measurement" }, + { OSMO_PFCP_IEI_APPLICATION_DETECTION_INFO, "Application Detection Information" }, + { OSMO_PFCP_IEI_TIME_OF_FIRST_PACKET, "Time of First Packet" }, + { OSMO_PFCP_IEI_TIME_OF_LAST_PACKET, "Time of Last Packet" }, + { OSMO_PFCP_IEI_QUOTA_HOLDING_TIME, "Quota Holding Time" }, + { OSMO_PFCP_IEI_DROPPED_DL_TRAFFIC_THRESH, "Dropped DL Traffic Threshold" }, + { OSMO_PFCP_IEI_VOLUME_QUOTA, "Volume Quota" }, + { OSMO_PFCP_IEI_TIME_QUOTA, "Time Quota" }, + { OSMO_PFCP_IEI_START_TIME, "Start Time" }, + { OSMO_PFCP_IEI_END_TIME, "End Time" }, + { OSMO_PFCP_IEI_QUERY_URR, "Query URR" }, + { OSMO_PFCP_IEI_USAGE_REP_SESS_MOD_RESP, "Usage Report (Session Modification Response)" }, + { OSMO_PFCP_IEI_USAGE_REP_SESS_DEL_RESP, "Usage Report (Session Deletion Response)" }, + { OSMO_PFCP_IEI_USAGE_REP_SESS_REP_REQ, "Usage Report (Session Report Request)" }, + { OSMO_PFCP_IEI_URR_ID, "URR ID" }, + { OSMO_PFCP_IEI_LINKED_URR_ID, "Linked URR ID" }, + { OSMO_PFCP_IEI_DL_DATA_REP, "Downlink Data Report" }, + { OSMO_PFCP_IEI_OUTER_HEADER_CREATION, "Outer Header Creation" }, + { OSMO_PFCP_IEI_CREATE_BAR, "Create BAR" }, + { OSMO_PFCP_IEI_UPD_BAR_SESS_MOD_REQ, "Update BAR (Session Modification Request)" }, + { OSMO_PFCP_IEI_REMOVE_BAR, "Remove BAR" }, + { OSMO_PFCP_IEI_BAR_ID, "BAR ID" }, + { OSMO_PFCP_IEI_CP_FUNCTION_FEATURES, "CP Function Features" }, + { OSMO_PFCP_IEI_USAGE_INFO, "Usage Information" }, + { OSMO_PFCP_IEI_APPLICATION_INST_ID, "Application Instance ID" }, + { OSMO_PFCP_IEI_FLOW_INFO, "Flow Information" }, + { OSMO_PFCP_IEI_UE_IP_ADDRESS, "UE IP Address" }, + { OSMO_PFCP_IEI_PACKET_RATE, "Packet Rate" }, + { OSMO_PFCP_IEI_OUTER_HEADER_REMOVAL, "Outer Header Removal" }, + { OSMO_PFCP_IEI_RECOVERY_TIME_STAMP, "Recovery Time Stamp" }, + { OSMO_PFCP_IEI_DL_FLOW_LEVEL_MARKING, "DL Flow Level Marking" }, + { OSMO_PFCP_IEI_HEADER_ENRICHMENT, "Header Enrichment" }, + { OSMO_PFCP_IEI_ERROR_IND_REP, "Error Indication Report" }, + { OSMO_PFCP_IEI_MEAS_INFO, "Measurement Information" }, + { OSMO_PFCP_IEI_NODE_REP_TYPE, "Node Report Type" }, + { OSMO_PFCP_IEI_USER_PLANE_PATH_FAILURE_REP, "User Plane Path Failure Report" }, + { OSMO_PFCP_IEI_REMOTE_GTP_U_PEER, "Remote GTP-U Peer" }, + { OSMO_PFCP_IEI_UR_SEQN, "UR-SEQN" }, + { OSMO_PFCP_IEI_UPD_DUPL_PARAMS, "Update Duplicating Parameters" }, + { OSMO_PFCP_IEI_ACTIVATE_PREDEFINED_RULES, "Activate Predefined Rules" }, + { OSMO_PFCP_IEI_DEACTIVATE_PREDEFINED_RULES, "Deactivate Predefined Rules" }, + { OSMO_PFCP_IEI_FAR_ID, "FAR ID" }, + { OSMO_PFCP_IEI_QER_ID, "QER ID" }, + { OSMO_PFCP_IEI_OCI_FLAGS, "OCI Flags" }, + { OSMO_PFCP_IEI_PFCP_ASSOC_RELEASE_REQ, "OSMO_PFCP Association Release Request" }, + { OSMO_PFCP_IEI_GRACEFUL_RELEASE_PERIOD, "Graceful Release Period" }, + { OSMO_PFCP_IEI_PDN_TYPE, "PDN Type" }, + { OSMO_PFCP_IEI_FAILED_RULE_ID, "Failed Rule ID" }, + { OSMO_PFCP_IEI_TIME_QUOTA_MECHANISM, "Time Quota Mechanism" }, + { OSMO_PFCP_IEI_RESERVED, "Reserved" }, + { OSMO_PFCP_IEI_USER_PLANE_INACT_TIMER, "User Plane Inactivity Timer" }, + { OSMO_PFCP_IEI_AGGREGATED_URRS, "Aggregated URRs" }, + { OSMO_PFCP_IEI_MULTIPLIER, "Multiplier" }, + { OSMO_PFCP_IEI_AGGREGATED_URR_ID, "Aggregated URR ID" }, + { OSMO_PFCP_IEI_SUBSEQUENT_VOLUME_QUOTA, "Subsequent Volume Quota" }, + { OSMO_PFCP_IEI_SUBSEQUENT_TIME_QUOTA, "Subsequent Time Quota" }, + { OSMO_PFCP_IEI_RQI, "RQI" }, + { OSMO_PFCP_IEI_QFI, "QFI" }, + { OSMO_PFCP_IEI_QUERY_URR_REFERENCE, "Query URR Reference" }, + { OSMO_PFCP_IEI_ADDITIONAL_USAGE_REPS_INFO, "Additional Usage Reports Information" }, + { OSMO_PFCP_IEI_CREATE_TRAFFIC_ENDPOINT, "Create Traffic Endpoint" }, + { OSMO_PFCP_IEI_CREATED_TRAFFIC_ENDPOINT, "Created Traffic Endpoint" }, + { OSMO_PFCP_IEI_UPD_TRAFFIC_ENDPOINT, "Update Traffic Endpoint" }, + { OSMO_PFCP_IEI_REMOVE_TRAFFIC_ENDPOINT, "Remove Traffic Endpoint" }, + { OSMO_PFCP_IEI_TRAFFIC_ENDPOINT_ID, "Traffic Endpoint ID" }, + { OSMO_PFCP_IEI_ETHERNET_PACKET_FILTER, "Ethernet Packet Filter" }, + { OSMO_PFCP_IEI_MAC_ADDRESS, "MAC address" }, + { OSMO_PFCP_IEI_C_TAG, "C-TAG" }, + { OSMO_PFCP_IEI_S_TAG, "S-TAG" }, + { OSMO_PFCP_IEI_ETHERTYPE, "Ethertype" }, + { OSMO_PFCP_IEI_PROXYING, "Proxying" }, + { OSMO_PFCP_IEI_ETHERNET_FILTER_ID, "Ethernet Filter ID" }, + { OSMO_PFCP_IEI_ETHERNET_FILTER_PROPERTIES, "Ethernet Filter Properties" }, + { OSMO_PFCP_IEI_SUGGESTED_BUFF_PACKETS_COUNT, "Suggested Buffering Packets Count" }, + { OSMO_PFCP_IEI_USER_ID, "User ID" }, + { OSMO_PFCP_IEI_ETHERNET_PDU_SESS_INFO, "Ethernet PDU Session Information" }, + { OSMO_PFCP_IEI_ETHERNET_TRAFFIC_INFO, "Ethernet Traffic Information" }, + { OSMO_PFCP_IEI_MAC_ADDRS_DETECTED, "MAC Addresses Detected" }, + { OSMO_PFCP_IEI_MAC_ADDRS_REMOVED, "MAC Addresses Removed" }, + { OSMO_PFCP_IEI_ETHERNET_INACT_TIMER, "Ethernet Inactivity Timer" }, + { OSMO_PFCP_IEI_ADDITIONAL_MONITORING_TIME, "Additional Monitoring Time" }, + { OSMO_PFCP_IEI_EVENT_QUOTA, "Event Quota" }, + { OSMO_PFCP_IEI_EVENT_THRESH, "Event Threshold" }, + { OSMO_PFCP_IEI_SUBSEQUENT_EVENT_QUOTA, "Subsequent Event Quota" }, + { OSMO_PFCP_IEI_SUBSEQUENT_EVENT_THRESH, "Subsequent Event Threshold" }, + { OSMO_PFCP_IEI_TRACE_INFO, "Trace Information" }, + { OSMO_PFCP_IEI_FRAMED_ROUTE, "Framed-Route" }, + { OSMO_PFCP_IEI_FRAMED_ROUTING, "Framed-Routing" }, + { OSMO_PFCP_IEI_FRAMED_IPV6_ROUTE, "Framed-IPv6-Route" }, + { OSMO_PFCP_IEI_TIME_STAMP, "Time Stamp" }, + { OSMO_PFCP_IEI_AVERAGING_WINDOW, "Averaging Window" }, + { OSMO_PFCP_IEI_PAGING_POLICY_INDICATOR, "Paging Policy Indicator" }, + { OSMO_PFCP_IEI_APN_DNN, "APN/DNN" }, + { OSMO_PFCP_IEI_3GPP_IFACE_TYPE, "3GPP Interface Type" }, + { OSMO_PFCP_IEI_PFCPSRREQ_FLAGS, "OSMO_PFCPSRReq-Flags" }, + { OSMO_PFCP_IEI_PFCPAUREQ_FLAGS, "OSMO_PFCPAUReq-Flags" }, + { OSMO_PFCP_IEI_ACTIVATION_TIME, "Activation Time" }, + { OSMO_PFCP_IEI_DEACTIVATION_TIME, "Deactivation Time" }, + { OSMO_PFCP_IEI_CREATE_MAR, "Create MAR" }, + { OSMO_PFCP_IEI_3GPP_ACCESS_FORW_ACTION_INFO, "3GPP Access Forwarding Action Information" }, + { OSMO_PFCP_IEI_NON_3GPP_ACCESS_FORW_ACTION_INFO, "Non-3GPP Access Forwarding Action Information" }, + { OSMO_PFCP_IEI_REMOVE_MAR, "Remove MAR" }, + { OSMO_PFCP_IEI_UPD_MAR, "Update MAR" }, + { OSMO_PFCP_IEI_MAR_ID, "MAR ID" }, + { OSMO_PFCP_IEI_STEERING_FUNCTIONALITY, "Steering Functionality" }, + { OSMO_PFCP_IEI_STEERING_MODE, "Steering Mode" }, + { OSMO_PFCP_IEI_WEIGHT, "Weight" }, + { OSMO_PFCP_IEI_PRIORITY, "Priority" }, + { OSMO_PFCP_IEI_UPD_3GPP_ACCESS_FORW_ACTION_INFO, "Update 3GPP Access Forwarding Action Information" }, + { OSMO_PFCP_IEI_UPD_NON_3GPP_ACCESS_FORW_ACTION_INFO, "Update Non 3GPP Access Forwarding Action Information" }, + { OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_IDENTITY, "UE IP address Pool Identity" }, + { OSMO_PFCP_IEI_ALTERNATIVE_SMF_IP_ADDRESS, "Alternative SMF IP Address" }, + { OSMO_PFCP_IEI_PACKET_REPLICATION_AND_DETECTION_CARRY_ON_INFO, "Packet Replication and Detection Carry-On Information" }, + { OSMO_PFCP_IEI_SMF_SET_ID, "SMF Set ID" }, + { OSMO_PFCP_IEI_QUOTA_VALIDITY_TIME, "Quota Validity Time" }, + { OSMO_PFCP_IEI_NUMBER_OF_REPS, "Number of Reports" }, + { OSMO_PFCP_IEI_PFCP_SESS_RETENTION_INFO_IN_ASSOC_SETUP_REQ, "OSMO_PFCP Session Retention Information (within OSMO_PFCP Association Setup Request)" }, + { OSMO_PFCP_IEI_PFCPASRSP_FLAGS, "OSMO_PFCPASRsp-Flags" }, + { OSMO_PFCP_IEI_CP_ENTITY_IP_ADDRESS, "CP OSMO_PFCP Entity IP Address" }, + { OSMO_PFCP_IEI_PFCPSEREQ_FLAGS, "OSMO_PFCPSEReq-Flags" }, + { OSMO_PFCP_IEI_USER_PLANE_PATH_RECOVERY_REP, "User Plane Path Recovery Report" }, + { OSMO_PFCP_IEI_IP_MULTICAST_ADDR_INFO_IN_SESS_EST_REQ, "IP Multicast Addressing Info within OSMO_PFCP Session Establishment Request" }, + { OSMO_PFCP_IEI_JOIN_IP_MULTICAST_INFO_IE_IN_USAGE_REP, "Join IP Multicast Information IE within Usage Report" }, + { OSMO_PFCP_IEI_LEAVE_IP_MULTICAST_INFO_IE_IN_USAGE_REP, "Leave IP Multicast Information IE within Usage Report" }, + { OSMO_PFCP_IEI_IP_MULTICAST_ADDRESS, "IP Multicast Address" }, + { OSMO_PFCP_IEI_SOURCE_IP_ADDRESS, "Source IP Address" }, + { OSMO_PFCP_IEI_PACKET_RATE_STATUS, "Packet Rate Status" }, + { OSMO_PFCP_IEI_CREATE_BRIDGE_INFO_FOR_TSC, "Create Bridge Info for TSC" }, + { OSMO_PFCP_IEI_CREATED_BRIDGE_INFO_FOR_TSC, "Created Bridge Info for TSC" }, + { OSMO_PFCP_IEI_DS_TT_PORT_NUMBER, "DS-TT Port Number" }, + { OSMO_PFCP_IEI_NW_TT_PORT_NUMBER, "NW-TT Port Number" }, + { OSMO_PFCP_IEI_TSN_BRIDGE_ID, "TSN Bridge ID" }, + { OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_REQ, "TSC Management Information IE within OSMO_PFCP Session Modification Request" }, + { OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_MOD_RESP, "TSC Management Information IE within OSMO_PFCP Session Modification Response" }, + { OSMO_PFCP_IEI_TSC_MGMT_INFO_IE_IN_SESS_REP_REQ, "TSC Management Information IE within OSMO_PFCP Session Report Request" }, + { OSMO_PFCP_IEI_PORT_MGMT_INFO_CONTAINER, "Port Management Information Container" }, + { OSMO_PFCP_IEI_CLOCK_DRIFT_CTRL_INFO, "Clock Drift Control Information" }, + { OSMO_PFCP_IEI_REQUESTED_CLOCK_DRIFT_INFO, "Requested Clock Drift Information" }, + { OSMO_PFCP_IEI_CLOCK_DRIFT_REP, "Clock Drift Report" }, + { OSMO_PFCP_IEI_TSN_TIME_DOMAIN_NUMBER, "TSN Time Domain Number" }, + { OSMO_PFCP_IEI_TIME_OFFSET_THRESH, "Time Offset Threshold" }, + { OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_THRESH, "Cumulative rateRatio Threshold" }, + { OSMO_PFCP_IEI_TIME_OFFSET_MEAS, "Time Offset Measurement" }, + { OSMO_PFCP_IEI_CUMULATIVE_RATERATIO_MEAS, "Cumulative rateRatio Measurement" }, + { OSMO_PFCP_IEI_REMOVE_SRR, "Remove SRR" }, + { OSMO_PFCP_IEI_CREATE_SRR, "Create SRR" }, + { OSMO_PFCP_IEI_UPD_SRR, "Update SRR" }, + { OSMO_PFCP_IEI_SESS_REP, "Session Report" }, + { OSMO_PFCP_IEI_SRR_ID, "SRR ID" }, + { OSMO_PFCP_IEI_ACCESS_AVAIL_CTRL_INFO, "Access Availability Control Information" }, + { OSMO_PFCP_IEI_REQUESTED_ACCESS_AVAIL_INFO, "Requested Access Availability Information" }, + { OSMO_PFCP_IEI_ACCESS_AVAIL_REP, "Access Availability Report" }, + { OSMO_PFCP_IEI_ACCESS_AVAIL_INFO, "Access Availability Information" }, + { OSMO_PFCP_IEI_PROVIDE_ATSSS_CTRL_INFO, "Provide ATSSS Control Information" }, + { OSMO_PFCP_IEI_ATSSS_CTRL_PARAMS, "ATSSS Control Parameters" }, + { OSMO_PFCP_IEI_MPTCP_CTRL_INFO, "MPTCP Control Information" }, + { OSMO_PFCP_IEI_ATSSS_LL_CTRL_INFO, "ATSSS-LL Control Information" }, + { OSMO_PFCP_IEI_PMF_CTRL_INFO, "PMF Control Information" }, + { OSMO_PFCP_IEI_MPTCP_PARAMS, "MPTCP Parameters" }, + { OSMO_PFCP_IEI_ATSSS_LL_PARAMS, "ATSSS-LL Parameters" }, + { OSMO_PFCP_IEI_PMF_PARAMS, "PMF Parameters" }, + { OSMO_PFCP_IEI_MPTCP_ADDRESS_INFO, "MPTCP Address Information" }, + { OSMO_PFCP_IEI_UE_LINK_SPECIFIC_IP_ADDRESS, "UE Link-Specific IP Address" }, + { OSMO_PFCP_IEI_PMF_ADDRESS_INFO, "PMF Address Information" }, + { OSMO_PFCP_IEI_ATSSS_LL_INFO, "ATSSS-LL Information" }, + { OSMO_PFCP_IEI_DATA_NETWORK_ACCESS_IDENTIFIER, "Data Network Access Identifier" }, + { OSMO_PFCP_IEI_UE_IP_ADDRESS_POOL_INFO, "UE IP address Pool Information" }, + { OSMO_PFCP_IEI_AVERAGE_PACKET_DELAY, "Average Packet Delay" }, + { OSMO_PFCP_IEI_MIN_PACKET_DELAY, "Minimum Packet Delay" }, + { OSMO_PFCP_IEI_MAX_PACKET_DELAY, "Maximum Packet Delay" }, + { OSMO_PFCP_IEI_QOS_REP_TRIGGER, "QoS Report Trigger" }, + { OSMO_PFCP_IEI_GTP_U_PATH_QOS_CTRL_INFO, "GTP-U Path QoS Control Information" }, + { OSMO_PFCP_IEI_GTP_U_PATH_QOS_REP_NODE_REP_REQ, "GTP-U Path QoS Report (OSMO_PFCP Node Report Request)" }, + { OSMO_PFCP_IEI_QOS_INFO_IN_GTP_U_PATH_QOS_REP, "QoS Information in GTP-U Path QoS Report" }, + { OSMO_PFCP_IEI_GTP_U_PATH_IFACE_TYPE, "GTP-U Path Interface Type" }, + { OSMO_PFCP_IEI_QOS_MONITORING_PER_QOS_FLOW_CTRL_INFO, "QoS Monitoring per QoS flow Control Information" }, + { OSMO_PFCP_IEI_REQUESTED_QOS_MONITORING, "Requested QoS Monitoring" }, + { OSMO_PFCP_IEI_REPORTING_FREQUENCY, "Reporting Frequency" }, + { OSMO_PFCP_IEI_PACKET_DELAY_THRESHOLDS, "Packet Delay Thresholds" }, + { OSMO_PFCP_IEI_MIN_WAIT_TIME, "Minimum Wait Time" }, + { OSMO_PFCP_IEI_QOS_MONITORING_REP, "QoS Monitoring Report" }, + { OSMO_PFCP_IEI_QOS_MONITORING_MEAS, "QoS Monitoring Measurement" }, + { OSMO_PFCP_IEI_MT_EDT_CTRL_INFO, "MT-EDT Control Information" }, + { OSMO_PFCP_IEI_DL_DATA_PACKETS_SIZE, "DL Data Packets Size" }, + { OSMO_PFCP_IEI_QER_CTRL_INDICATIONS, "QER Control Indications" }, + { OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP, "Packet Rate Status Report" }, + { OSMO_PFCP_IEI_NF_INST_ID, "NF Instance ID" }, + { OSMO_PFCP_IEI_ETHERNET_CONTEXT_INFO, "Ethernet Context Information" }, + { OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_PARAMS, "Redundant Transmission Parameters" }, + { OSMO_PFCP_IEI_UPDATED_PDR, "Updated PDR" }, + { OSMO_PFCP_IEI_S_NSSAI, "S-NSSAI" }, + { OSMO_PFCP_IEI_IP_VERSION, "IP version" }, + { OSMO_PFCP_IEI_PFCPASREQ_FLAGS, "OSMO_PFCPASReq-Flags" }, + { OSMO_PFCP_IEI_DATA_STATUS, "Data Status" }, + { OSMO_PFCP_IEI_PROVIDE_RDS_CONF_INFO, "Provide RDS configuration information" }, + { OSMO_PFCP_IEI_RDS_CONF_INFO, "RDS configuration information" }, + { OSMO_PFCP_IEI_QUERY_PACKET_RATE_STATUS_IE_IN_SESS_MOD_REQ, "Query Packet Rate Status IE within OSMO_PFCP Session Modification Request" }, + { OSMO_PFCP_IEI_PACKET_RATE_STATUS_REP_IE_IN_SESS_MOD_RESP, "Packet Rate Status Report IE within OSMO_PFCP Session Modification Response" }, + { OSMO_PFCP_IEI_MPTCP_APPLICABLE_IND, "MPTCP Applicable Indication" }, + { OSMO_PFCP_IEI_BRIDGE_MGMT_INFO_CONTAINER, "Bridge Management Information Container" }, + { OSMO_PFCP_IEI_UE_IP_ADDRESS_USAGE_INFO, "UE IP Address Usage Information" }, + { OSMO_PFCP_IEI_NUMBER_OF_UE_IP_ADDRS, "Number of UE IP Addresses" }, + { OSMO_PFCP_IEI_VALIDITY_TIMER, "Validity Timer" }, + { OSMO_PFCP_IEI_REDUNDANT_TRANSMISSION_FORW_PARAMS, "Redundant Transmission Forwarding Parameters" }, + { OSMO_PFCP_IEI_TRANSPORT_DELAY_REPORTING, "Transport Delay Reporting" }, + { 0 } +}; + +const struct value_string osmo_pfcp_cause_strs[] = { + { OSMO_PFCP_CAUSE_RESERVED, "0" }, + { OSMO_PFCP_CAUSE_REQUEST_ACCEPTED, "Request accepted (success)" }, + { OSMO_PFCP_CAUSE_MORE_USAGE_REPORT_TO_SEND, "More Usage Report to send" }, + { OSMO_PFCP_CAUSE_REQUEST_REJECTED, "Request rejected (reason not specified)" }, + { OSMO_PFCP_CAUSE_SESSION_CTX_NOT_FOUND, "Session context not found" }, + { OSMO_PFCP_CAUSE_MANDATORY_IE_MISSING, "Mandatory IE missing" }, + { OSMO_PFCP_CAUSE_CONDITIONAL_IE_MISSING, "Conditional IE missing" }, + { OSMO_PFCP_CAUSE_INVALID_LENGTH, "Invalid length" }, + { OSMO_PFCP_CAUSE_MANDATORY_IE_INCORRECT, "Mandatory IE incorrect" }, + { OSMO_PFCP_CAUSE_INVALID_FORW_POLICY, "Invalid Forwarding Policy" }, + { OSMO_PFCP_CAUSE_INVALID_F_TEID_ALLOC_OPTION, "Invalid F-TEID allocation option" }, + { OSMO_PFCP_CAUSE_NO_ESTABLISHED_PFCP_ASSOC, "No established OSMO_PFCP Association" }, + { OSMO_PFCP_CAUSE_RULE_CREATION_MOD_FAILURE, "Rule creation/modification Failure" }, + { OSMO_PFCP_CAUSE_PFCP_ENTITY_IN_CONGESTION, "OSMO_PFCP entity in congestion" }, + { OSMO_PFCP_CAUSE_NO_RESOURCES_AVAILABLE, "No resources available" }, + { OSMO_PFCP_CAUSE_SERVICE_NOT_SUPPORTED, "Service not supported" }, + { OSMO_PFCP_CAUSE_SYSTEM_FAILURE, "System failure" }, + { OSMO_PFCP_CAUSE_REDIRECTION_REQUESTED, "Redirection Requested" }, + { OSMO_PFCP_CAUSE_ALL_DYNAMIC_ADDRESSES_ARE_OCCUPIED, "All dynamic addresses are occupied" }, + { 0 } +}; + +const struct value_string osmo_pfcp_up_feature_strs[] = { + { OSMO_PFCP_UP_FEAT_BUCP, "BUCP" }, + { OSMO_PFCP_UP_FEAT_DDND, "DDND" }, + { OSMO_PFCP_UP_FEAT_DLBD, "DLBD" }, + { OSMO_PFCP_UP_FEAT_TRST, "TRST" }, + { OSMO_PFCP_UP_FEAT_FTUP, "FTUP" }, + { OSMO_PFCP_UP_FEAT_PFDM, "PFDM" }, + { OSMO_PFCP_UP_FEAT_HEEU, "HEEU" }, + { OSMO_PFCP_UP_FEAT_TREU, "TREU" }, + { OSMO_PFCP_UP_FEAT_EMPU, "EMPU" }, + { OSMO_PFCP_UP_FEAT_PDIU, "PDIU" }, + { OSMO_PFCP_UP_FEAT_UDBC, "UDBC" }, + { OSMO_PFCP_UP_FEAT_QUOAC, "QUOAC" }, + { OSMO_PFCP_UP_FEAT_TRACE, "TRACE" }, + { OSMO_PFCP_UP_FEAT_FRRT, "FRRT" }, + { OSMO_PFCP_UP_FEAT_PFDE, "PFDE" }, + { OSMO_PFCP_UP_FEAT_EPFAR, "EPFAR" }, + { OSMO_PFCP_UP_FEAT_DPDRA, "DPDRA" }, + { OSMO_PFCP_UP_FEAT_ADPDP, "ADPDP" }, + { OSMO_PFCP_UP_FEAT_UEIP, "UEIP" }, + { OSMO_PFCP_UP_FEAT_SSET, "SSET" }, + { OSMO_PFCP_UP_FEAT_MNOP, "MNOP" }, + { OSMO_PFCP_UP_FEAT_MTE, "MTE" }, + { OSMO_PFCP_UP_FEAT_BUNDL, "BUNDL" }, + { OSMO_PFCP_UP_FEAT_GCOM, "GCOM" }, + { OSMO_PFCP_UP_FEAT_MPAS, "MPAS" }, + { OSMO_PFCP_UP_FEAT_RTTL, "RTTL" }, + { OSMO_PFCP_UP_FEAT_VTIME, "VTIME" }, + { OSMO_PFCP_UP_FEAT_NORP, "NORP" }, + { OSMO_PFCP_UP_FEAT_IP6PL, "IP6PL" }, + { OSMO_PFCP_UP_FEAT_TSCU, "TSCU" }, + { OSMO_PFCP_UP_FEAT_MPTCP, "MPTCP" }, + { OSMO_PFCP_UP_FEAT_ATSSSLL, "ATSSSLL" }, + { OSMO_PFCP_UP_FEAT_QFQM, "QFQM" }, + { OSMO_PFCP_UP_FEAT_GPQM, "GPQM" }, + { OSMO_PFCP_UP_FEAT_MTEDT, "MTEDT" }, + { OSMO_PFCP_UP_FEAT_CIOT, "CIOT" }, + { OSMO_PFCP_UP_FEAT_ETHAR, "ETHAR" }, + { OSMO_PFCP_UP_FEAT_DDDS, "DDDS" }, + { OSMO_PFCP_UP_FEAT_RDS, "RDS" }, + { OSMO_PFCP_UP_FEAT_RTTWP, "RTTWP" }, + {0} +}; + + +const struct value_string osmo_pfcp_cp_feature_strs[] = { + { OSMO_PFCP_CP_FEAT_LOAD, "LOAD" }, + { OSMO_PFCP_CP_FEAT_OVRL, "OVRL" }, + { OSMO_PFCP_CP_FEAT_EPFAR, "EPFAR" }, + { OSMO_PFCP_CP_FEAT_SSET, "SSET" }, + { OSMO_PFCP_CP_FEAT_BUNDL, "BUNDL" }, + { OSMO_PFCP_CP_FEAT_MPAS, "MPAS" }, + { OSMO_PFCP_CP_FEAT_ARDR, "ARDR" }, + { OSMO_PFCP_CP_FEAT_UIAUR, "UIAUR" }, + {0} +}; + +const struct value_string osmo_pfcp_apply_action_strs[] = { + { OSMO_PFCP_APPLY_ACTION_DROP, "DROP" }, + { OSMO_PFCP_APPLY_ACTION_FORW, "FORW" }, + { OSMO_PFCP_APPLY_ACTION_BUFF, "BUFF" }, + { OSMO_PFCP_APPLY_ACTION_NOCP, "NOCP" }, + { OSMO_PFCP_APPLY_ACTION_DUPL, "DUPL" }, + { OSMO_PFCP_APPLY_ACTION_IPMA, "IPMA" }, + { OSMO_PFCP_APPLY_ACTION_IPMD, "IPMD" }, + { OSMO_PFCP_APPLY_ACTION_DFRT, "DFRT" }, + { OSMO_PFCP_APPLY_ACTION_EDRT, "EDRT" }, + { OSMO_PFCP_APPLY_ACTION_BDPN, "BDPN" }, + { OSMO_PFCP_APPLY_ACTION_DDPN, "DDPN" }, + {0} +}; + +const struct value_string osmo_pfcp_outer_header_creation_strs[] = { + { OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4, "GTP_U_UDP_IPV4" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6, "GTP_U_UDP_IPV6" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4, "UDP_IPV4" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6, "UDP_IPV6" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_IPV4, "IPV4" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_IPV6, "IPV6" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG, "C_TAG" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG, "S_TAG" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_N19_INDICATION, "N19_INDICATION" }, + { OSMO_PFCP_OUTER_HEADER_CREATION_N6_INDICATION, "N6_INDICATION" }, + {0} +}; + +const struct value_string osmo_pfcp_outer_header_removal_desc_strs[] = { + { OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV4, "GTP_U_UDP_IPV4" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IPV6, "GTP_U_UDP_IPV6" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV4, "UDP_IPV4" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_UDP_IPV6, "UDP_IPV6" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV4, "IPV4" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_IPV6, "IPV6" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_GTP_U_UDP_IP, "GTP_U_UDP_IP" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_VLAN_S_TAG, "VLAN_S_TAG" }, + { OSMO_PFCP_OUTER_HEADER_REMOVAL_S_TAG_AND_C_TAG, "S_TAG_AND_C_TAG" }, + {0} +}; + +const struct value_string osmo_pfcp_source_iface_strs[] = { + { OSMO_PFCP_SOURCE_IFACE_ACCESS, "Access" }, + { OSMO_PFCP_SOURCE_IFACE_CORE, "Core" }, + { OSMO_PFCP_SOURCE_IFACE_SGI_LAN_N6_LAN, "SGi-LAN/N6-LAN" }, + { OSMO_PFCP_SOURCE_IFACE_CP_FUNCTION, "CP-function" }, + { OSMO_PFCP_SOURCE_IFACE_5G_VN_INTERNAL, "5G-VN-Internal" }, + {0} +}; + +const struct value_string osmo_pfcp_dest_iface_strs[] = { + { OSMO_PFCP_DEST_IFACE_ACCESS, "Access" }, + { OSMO_PFCP_DEST_IFACE_CORE, "Core" }, + { OSMO_PFCP_DEST_IFACE_SGI_LAN_N6_LAN, "SGi-LAN/N6-LAN" }, + { OSMO_PFCP_DEST_IFACE_CP_FUNCTION, "CP-function" }, + { OSMO_PFCP_DEST_IFACE_LI_FUNCTION, "LI-function" }, + { OSMO_PFCP_DEST_IFACE_5G_VN_INTERNAL, "5G-VN-Internal" }, + {0} +}; -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27221 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: I568b821e89007ed52eeefcdbcb6edd8052a8b5be Gerrit-Change-Number: 27221 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in osmo-upf[master]: libosmo-pfcp: implement/generate TLV and IE value coding

by neels

neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27222 ) Change subject: libosmo-pfcp: implement/generate TLV and IE value coding ...................................................................... libosmo-pfcp: implement/generate TLV and IE value coding Related: SYS#5599 Change-Id: I3069045b2d42dac88d955c636230adc64a7a4aa7 --- M include/osmocom/pfcp/Makefile.am A include/osmocom/pfcp/pfcp_ies_custom.h M src/libosmo-pfcp/Makefile.am A src/libosmo-pfcp/gen__pfcp_ies_auto.c A src/libosmo-pfcp/pfcp_ies_custom.c 5 files changed, 1,360 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/22/27222/1 diff --git a/include/osmocom/pfcp/Makefile.am b/include/osmocom/pfcp/Makefile.am index ff7df5e..5e551d4 100644 --- a/include/osmocom/pfcp/Makefile.am +++ b/include/osmocom/pfcp/Makefile.am @@ -1,6 +1,22 @@ pfcp_HEADERS = \ + pfcp_ies_custom.h \ pfcp_proto.h \ pfcp_strs.h \ $(NULL) pfcpdir = $(includedir)/osmocom/pfcp + +BUILT_SOURCES = \ + pfcp_ies_auto.h \ + $(NULL) + +CLEANFILES = \ + pfcp_ies_auto.h \ + $(NULL) + +pfcp_ies_auto.h: $(top_srcdir)/src/libosmo-pfcp/gen__pfcp_ies_auto.c \ + $(top_srcdir)/src/libosmo-tlv/tlv_gen.c \ + $(top_srcdir)/include/osmocom/tlv/tlv_gen.h + $(MAKE) -C $(top_builddir)/src/libosmo-tlv + $(MAKE) -C $(top_builddir)/src/libosmo-pfcp gen__pfcp_ies_auto + $(top_builddir)/src/libosmo-pfcp/gen__pfcp_ies_auto h > $(builddir)/pfcp_ies_auto.h diff --git a/include/osmocom/pfcp/pfcp_ies_custom.h b/include/osmocom/pfcp/pfcp_ies_custom.h new file mode 100644 index 0000000..940afbe --- /dev/null +++ b/include/osmocom/pfcp/pfcp_ies_custom.h @@ -0,0 +1,135 @@ +/* Definitions for decoded PFCP IEs, to be used by the auto-generated pfcp_ies_auto.c. */ +#pragma once + +#include <osmocom/core/socket.h> + +#include <osmocom/pfcp/pfcp_proto.h> + +/* Common pattern used in various PFCP IEs. */ +struct osmo_pfcp_ip_addrs { + bool v4_present; + struct osmo_sockaddr v4; + bool v6_present; + struct osmo_sockaddr v6; +}; + +int osmo_pfcp_ip_addrs_set(struct osmo_pfcp_ip_addrs *dst, const struct osmo_sockaddr *addr); + +/* 3GPP TS 29.244 8.2.38, IETF RFC 1035 3.1 */ +struct osmo_pfcp_ie_node_id { + enum osmo_pfcp_node_id_type type; + union { + struct osmo_sockaddr ip; + /* Fully qualified domain name in "dot" notation ("host.example.com") */ + char fqdn[254]; + }; +}; + +/* 3GPP TS 29.244 8.2.25 + * Usage: + * struct osmo_pfcp_ie_up_function_features x; + * osmo_pfcp_bits_set(x.bits, OSMO_PFCP_UP_FEAT_BUNDL, true); + * if (osmo_pfcp_bits_get(x.bits, OSMO_PFCP_UP_FEAT_BUNDL)) + * foo(); + * printf("%s\n", osmo_pfcp_bits_to_str_c(x.bits, osmo_pfcp_up_feature_strs)); + */ +struct osmo_pfcp_ie_up_function_features { + uint8_t bits[6]; +}; + +/* 3GPP TS 29.244 8.2.58 + * struct osmo_pfcp_ie_cp_function_features x; + * osmo_pfcp_bits_set(x.bits, OSMO_PFCP_CP_FEAT_BUNDL, true); + * if (osmo_pfcp_bits_get(x.bits, OSMO_PFCP_CP_FEAT_BUNDL)) + * foo(); + * printf("%s\n", osmo_pfcp_bits_to_str_c(x.bits, osmo_pfcp_cp_feature_strs)); + */ +struct osmo_pfcp_ie_cp_function_features { + uint8_t bits[3]; +}; + +/* 3GPP TS 29.244 8.2.37 */ +struct osmo_pfcp_ie_f_seid { + uint64_t seid; + struct osmo_pfcp_ip_addrs ip_addr; +}; + +void osmo_pfcp_ie_f_seid_set(struct osmo_pfcp_ie_f_seid *f_seid, uint64_t seid, + const struct osmo_sockaddr *remote_addr); + +/* 3GPP TS 29.244 8.3.2 */ +struct osmo_pfcp_ie_f_teid { + bool choose_flag; + union { + struct { + uint32_t teid; + struct osmo_pfcp_ip_addrs ip_addr; + } fixed; + struct { + bool ipv4_addr; + bool ipv6_addr; + bool choose_id_present; + uint8_t choose_id; + } choose; + }; +}; + +/* 3GPP TS 29.244 8.2.62 */ +struct osmo_pfcp_ie_ue_ip_address { + bool chv6; + bool chv4; + bool ip_is_destination; + struct osmo_pfcp_ip_addrs ip_addr; + bool ipv6_prefix_delegation_bits_present; + uint8_t ipv6_prefix_delegation_bits; + bool ipv6_prefix_length_present; + uint8_t ipv6_prefix_length; +}; + +/* 3GPP TS 29.244 8.2.26. + * Usage: + * struct osmo_pfcp_ie_apply_action x; + * osmo_pfcp_bits_set(x.bits, OSMO_PFCP_APPLY_ACTION_FORW, true); + * if (osmo_pfcp_bits_get(x.bits, OSMO_PFCP_APPLY_ACTION_FORW)) + * foo(); + * printf("%s\n", osmo_pfcp_bits_to_str_c(x.bits, osmo_pfcp_apply_action_strs)); + */ +struct osmo_pfcp_ie_apply_action { + uint8_t bits[2]; +}; + +struct osmo_pfcp_ie_network_inst { + /* A domain name may have up to 253 characters; plus nul. */ + char str[253+1]; +}; + +struct osmo_pfcp_ie_activate_predefined_rules { + char str[256]; +}; + +/* 3GPP TS 29.244 8.2.56 */ +struct osmo_pfcp_ie_outer_header_creation { + /* desc_bits Usage: + * osmo_pfcp_bits_set(x.desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4, true); + * if (osmo_pfcp_bits_get(x.desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4)) + * foo(); + * printf("%s\n", osmo_pfcp_bits_to_str_c(x.desc_bits, osmo_pfcp_outer_header_creation_strs)); + */ + uint8_t desc_bits[2]; + bool teid_present; + uint32_t teid; + struct osmo_pfcp_ip_addrs ip_addr; + bool port_number_present; + uint16_t port_number; + bool c_tag_present; + uint32_t c_tag; + bool s_tag_present; + uint32_t s_tag; +}; + +/* 3GPP TS 29.244 8.2.64. */ +struct osmo_pfcp_ie_outer_header_removal { + enum osmo_pfcp_outer_header_removal_desc desc; + bool gtp_u_extension_header_del_present; + uint8_t gtp_u_extension_header_del_bits[1]; +}; diff --git a/src/libosmo-pfcp/Makefile.am b/src/libosmo-pfcp/Makefile.am index f2dacfe..16ed680 100644 --- a/src/libosmo-pfcp/Makefile.am +++ b/src/libosmo-pfcp/Makefile.am @@ -24,5 +24,37 @@ $(NULL) libosmo_pfcp_a_SOURCES = \ + pfcp_ies_custom.c \ pfcp_strs.c \ + \ + pfcp_ies_auto.c \ + $(NULL) + +BUILT_SOURCES = \ + pfcp_ies_auto.c \ + $(NULL) + +CLEANFILES = \ + pfcp_ies_auto.c \ + $(NULL) + +pfcp_ies_auto.c: $(srcdir)/gen__pfcp_ies_auto.c \ + $(top_srcdir)/src/libosmo-tlv/tlv_gen.c \ + $(top_srcdir)/include/osmocom/tlv/tlv_gen.h + $(MAKE) -C $(top_builddir)/src/libosmo-tlv + $(MAKE) gen__pfcp_ies_auto + $(builddir)/gen__pfcp_ies_auto c > $(builddir)/pfcp_ies_auto.c + +noinst_PROGRAMS = \ + gen__pfcp_ies_auto \ + $(NULL) + +gen__pfcp_ies_auto_SOURCES = \ + gen__pfcp_ies_auto.c \ + $(NULL) + +gen__pfcp_ies_auto_LDADD = \ + $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \ + $(LIBOSMOCORE_LIBS) \ + $(COVERAGE_LDFLAGS) \ $(NULL) diff --git a/src/libosmo-pfcp/gen__pfcp_ies_auto.c b/src/libosmo-pfcp/gen__pfcp_ies_auto.c new file mode 100644 index 0000000..c90cbdd --- /dev/null +++ b/src/libosmo-pfcp/gen__pfcp_ies_auto.c @@ -0,0 +1,448 @@ +/* Tool to generate C source code of structs and IE arrays for de- and encoding PFCP messages. */ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <stdbool.h> +#include <stdio.h> +#include <osmocom/core/utils.h> +#include <osmocom/core/linuxlist.h> +#include <osmocom/core/talloc.h> +#include <osmocom/tlv/tlv_gen.h> + +/* o_ means optional */ + +#define O(IE_INST) { .optional = true, .ie = &IE_INST } +#define M(IE_INST) { .ie = &(IE_INST) } +#define MULTI(MAX, IE_INST) { .multi = MAX, .ie = &(IE_INST) } + +static const struct osmo_tlv_gen_ie recovery_time_stamp = { + "recovery_time_stamp", + "uint32_t", + .dec_enc = "32be", + .spec_ref = "7.4.2", +}; + +static const struct osmo_tlv_gen_ie node_id = { + "node_id", + .spec_ref = "8.2.38", +}; + +static const struct osmo_tlv_gen_ie up_function_features = { + "up_function_features", + .spec_ref = "8.2.25", +}; + +static const struct osmo_tlv_gen_ie cp_function_features = { + "cp_function_features", + .spec_ref = "8.2.58", +}; + +static const struct osmo_tlv_gen_ie cause = { + "cause", + "enum osmo_pfcp_cause", + .spec_ref = "8.2.1", +}; + +static const struct osmo_tlv_gen_ie offending_ie = { + "offending_ie", + .decoded_type = "enum osmo_pfcp_iei", + .spec_ref = "8.2.22", +}; + +static const struct osmo_tlv_gen_ie cp_f_seid = { + "cp_f_seid", + .tag_name = "f_seid", + .spec_ref = "8.2.37", +}; + +static const struct osmo_tlv_gen_ie up_f_seid = { + "up_f_seid", + .tag_name = "f_seid", + .spec_ref = "8.2.37", +}; + +static const struct osmo_tlv_gen_ie pdr_id = { + "pdr_id", + .decoded_type = "uint16_t", + .dec_enc = "16be", + .spec_ref = "8.2.36", +}; + +static const struct osmo_tlv_gen_ie precedence = { + "precedence", + .decoded_type = "uint32_t", + .dec_enc = "32be", + .spec_ref = "8.2.11", +}; + +static const struct osmo_tlv_gen_ie source_iface = { + "source_iface", + .decoded_type = "enum osmo_pfcp_source_iface", + .spec_ref = "8.2.2", +}; + +static const struct osmo_tlv_gen_ie source_iface_type = { + "source_iface_type", + .decoded_type = "enum osmo_pfcp_3gpp_iface_type", + .tag_name = "3gpp_iface_type", + .spec_ref = "8.2.118", +}; + +static const struct osmo_tlv_gen_ie local_f_teid = { + "local_f_teid", + .tag_name = "f_teid", + .spec_ref = "8.2.3", +}; + +static const struct osmo_tlv_gen_ie ue_ip_address = { + "ue_ip_address", + .spec_ref = "8.2.62", +}; + +static const struct osmo_tlv_gen_ie traffic_endpoint_id = { + "traffic_endpoint_id", + .decoded_type = "uint8_t", + .dec_enc = "8", + .spec_ref = "8.2.92", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_pdi[] = { + M(source_iface), + O(local_f_teid), + O(ue_ip_address), + O(traffic_endpoint_id), + O(source_iface_type), + {0} +}; + +static const struct osmo_tlv_gen_ie pdi = { + "pdi", + .nested_ies = ies_in_pdi, + .spec_ref = "7.5.2.2-2", +}; + +static const struct osmo_tlv_gen_ie outer_header_removal = { + "outer_header_removal", + .spec_ref = "8.2.64", +}; + +static const struct osmo_tlv_gen_ie far_id = { + "far_id", + .decoded_type = "uint32_t", + .dec_enc = "32be", + .spec_ref = "8.2.74", +}; + +static const struct osmo_tlv_gen_ie activate_predefined_rules = { + "activate_predefined_rules", + .spec_ref = "8.2.72", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_create_pdr[] = { + M(pdr_id), + M(precedence), + M(pdi), + O(outer_header_removal), + O(far_id), + O(activate_predefined_rules), + {0} +}; + +static const struct osmo_tlv_gen_ie create_pdr = { + "create_pdr", + .nested_ies = ies_in_create_pdr, + .spec_ref = "7.5.2.2", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_created_pdr[] = { + M(pdr_id), + O(local_f_teid), + {0} +}; + +static const struct osmo_tlv_gen_ie created_pdr = { + "created_pdr", + .nested_ies = ies_in_created_pdr, + .spec_ref = "7.5.3.2", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_upd_pdr[] = { + M(pdr_id), + O(outer_header_removal), + O(pdi), + O(far_id), + O(activate_predefined_rules), + {0} +}; + +static const struct osmo_tlv_gen_ie upd_pdr = { + "upd_pdr", + .nested_ies = ies_in_upd_pdr, + .spec_ref = "7.5.4.2", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_updated_pdr[] = { + M(pdr_id), + O(local_f_teid), + {0} +}; + +static const struct osmo_tlv_gen_ie updated_pdr = { + "updated_pdr", + .nested_ies = ies_in_updated_pdr, + .spec_ref = "7.5.9.3", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_remove_pdr[] = { + M(pdr_id), + {0} +}; + +static const struct osmo_tlv_gen_ie remove_pdr = { + "remove_pdr", + .nested_ies = ies_in_remove_pdr, + .spec_ref = "7.5.4.6", +}; + +static const struct osmo_tlv_gen_ie apply_action = { + "apply_action", + .decoded_type = "struct osmo_pfcp_ie_apply_action", + .spec_ref = "8.2.26", +}; + +static const struct osmo_tlv_gen_ie destination_iface = { + "destination_iface", + .decoded_type = "enum osmo_pfcp_dest_iface", + .dec_enc = "dest_iface", + .spec_ref = "8.2.24", +}; + +static const struct osmo_tlv_gen_ie destination_iface_type = { + "destination_iface_type", + .decoded_type = "enum osmo_pfcp_3gpp_iface_type", + .tag_name = "3gpp_iface_type", + .spec_ref = "8.2.118", +}; + +static const struct osmo_tlv_gen_ie network_inst = { + "network_inst", + .spec_ref = "8.2.4", +}; + +static const struct osmo_tlv_gen_ie outer_header_creation = { + "outer_header_creation", + .spec_ref = "8.2.56", +}; + +static const struct osmo_tlv_gen_ie linked_te_id = { + "linked_te_id", + .tag_name = "traffic_endpoint_id", + .decoded_type = "uint8_t", + .dec_enc = "8", + .spec_ref = "8.2.92", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_forw_params[] = { + M(destination_iface), + O(network_inst), + O(outer_header_creation), + O(linked_te_id), + O(destination_iface_type), + {0} +}; + +static const struct osmo_tlv_gen_ie forw_params = { + "forw_params", + .nested_ies = ies_in_forw_params, + .spec_ref = "7.5.2.3-2", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_upd_forw_params[] = { + O(destination_iface), + O(network_inst), + O(outer_header_creation), + O(linked_te_id), + O(destination_iface_type), + {0} +}; + +static const struct osmo_tlv_gen_ie upd_forw_params = { + "upd_forw_params", + .nested_ies = ies_in_upd_forw_params, + .spec_ref = "7.5.4.3-2", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_create_far[] = { + M(far_id), + M(apply_action), + O(forw_params), + {0} +}; + +static const struct osmo_tlv_gen_ie create_far = { + "create_far", + .nested_ies = ies_in_create_far, + .spec_ref = "7.5.2.3", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_remove_far[] = { + M(far_id), + {0} +}; + +static const struct osmo_tlv_gen_ie remove_far = { + "remove_far", + .nested_ies = ies_in_remove_far, + .spec_ref = "7.5.4.6", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_upd_far[] = { + M(far_id), + O(apply_action), + O(upd_forw_params), + {0} +}; + +static const struct osmo_tlv_gen_ie upd_far = { + "upd_far", + .nested_ies = ies_in_upd_far, + .spec_ref = "7.5.4.3", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_heartbeat_req[] = { + M(recovery_time_stamp), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_heartbeat_resp[] = { + M(recovery_time_stamp), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_assoc_setup_req[] = { + M(node_id), + M(recovery_time_stamp), + O(up_function_features), + O(cp_function_features), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_assoc_setup_resp[] = { + M(node_id), + M(cause), + M(recovery_time_stamp), + O(up_function_features), + O(cp_function_features), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_assoc_release_req[] = { + M(node_id), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_assoc_release_resp[] = { + M(node_id), + M(cause), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_session_est_req[] = { + M(node_id), + O(cp_f_seid), + MULTI(32, create_pdr), + MULTI(32, create_far), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_session_est_resp[] = { + M(node_id), + M(cause), + O(offending_ie), + O(up_f_seid), + MULTI(32, created_pdr), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_session_mod_req[] = { + O(cp_f_seid), + MULTI(32, remove_pdr), + MULTI(32, remove_far), + MULTI(32, create_pdr), + MULTI(32, create_far), + MULTI(32, upd_pdr), + MULTI(32, upd_far), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_session_mod_resp[] = { + M(cause), + O(offending_ie), + MULTI(32, created_pdr), + MULTI(32, updated_pdr), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_session_del_req[] = { + /* no IEs */ + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_msg_session_del_resp[] = { + M(cause), + {0} +}; + +static const struct osmo_tlv_gen_msg pfcp_msg_defs[] = { + { "heartbeat_req", ies_in_msg_heartbeat_req }, + { "heartbeat_resp", ies_in_msg_heartbeat_resp }, + { "assoc_setup_req", ies_in_msg_assoc_setup_req }, + { "assoc_setup_resp", ies_in_msg_assoc_setup_resp }, + { "assoc_release_req", ies_in_msg_assoc_release_req }, + { "assoc_release_resp", ies_in_msg_assoc_release_resp }, + { "session_est_req", ies_in_msg_session_est_req }, + { "session_est_resp", ies_in_msg_session_est_resp }, + { "session_mod_req", ies_in_msg_session_mod_req }, + { "session_mod_resp", ies_in_msg_session_mod_resp }, + { "session_del_req", ies_in_msg_session_del_req }, + { "session_del_resp", ies_in_msg_session_del_resp }, + {0} +}; + +int main(int argc, const char **argv) +{ + struct osmo_tlv_gen_cfg cfg = { + .proto_name = "osmo_pfcp", + .spec_ref_prefix = "3GPP TS 29.244 ", + .message_type_enum = "enum osmo_pfcp_message_type", + .message_type_prefix = "OSMO_PFCP_MSGT_", + .tag_enum = "enum osmo_pfcp_iei", + .tag_prefix = "OSMO_PFCP_IEI_", + .decoded_type_prefix = "struct osmo_pfcp_ie_", + .h_header = "#include <osmocom/pfcp/pfcp_ies_custom.h>", + .c_header = "#include <osmocom/pfcp/pfcp_ies_auto.h>", + .msg_defs = pfcp_msg_defs, + }; + return osmo_tlv_gen_main(&cfg, argc, argv); +} diff --git a/src/libosmo-pfcp/pfcp_ies_custom.c b/src/libosmo-pfcp/pfcp_ies_custom.c new file mode 100644 index 0000000..b7c7116 --- /dev/null +++ b/src/libosmo-pfcp/pfcp_ies_custom.c @@ -0,0 +1,729 @@ +/* Decoded PFCP IEs, to be used by the auto-generated pfcp_ies_auto.c. + * + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <errno.h> + +#include <osmocom/tlv/tlv.h> +#include <osmocom/pfcp/pfcp_msg.h> + +/* Assumes presence of local variable osmo_pfcp_msg *m. m->log_ctx may be NULL. */ +#define RETURN_ERROR(RC, FMT, ARGS...) \ + do {\ + OSMO_ASSERT(decoded_struct); \ + OSMO_LOG_PFCP_MSG((struct osmo_pfcp_msg*)decoded_struct, LOGL_ERROR, FMT " (%d: %s)\n", ##ARGS, RC, \ + strerror((RC) > 0? (RC) : -(RC))); \ + return RC; \ + } while (0) + +/* Assumes presence of local variable osmo_tlv_load *tlv. Usage: + * ENSURE_LENGTH_IS(> 1); + */ +#define ENSURE_LENGTH_IS(CONDITION) \ + if (!(tlv->len CONDITION)) \ + RETURN_ERROR(-EINVAL, "IE has length = %zu, expected length " #CONDITION, tlv->len); + +/* Assumes presence of local variable osmo_tlv_load *tlv. Usage: + * const uint8_t *pos = tlv->val; + * ENSURE_REMAINING_LENGTH_IS("first part", pos, >= 23); + * <parse first part> + * pos += 23; + * ENSURE_REMAINING_LENGTH_IS("very long part", pos, >= 235); + * <parse very long part> + * pos += 235; + */ +#define ENSURE_REMAINING_LENGTH_IS(NAME, POS, CONDITION) \ + if (!((tlv->len - ((POS) - tlv->val)) CONDITION)) \ + RETURN_ERROR(-EINVAL, \ + "at value octet %d: %zu octets remaining, but " #NAME " requires length " #CONDITION, \ + (int)((POS) - tlv->val), \ + tlv->len - ((POS) - tlv->val)); + +void osmo_pfcp_ie_f_seid_set(struct osmo_pfcp_ie_f_seid *f_seid, uint64_t seid, const struct osmo_sockaddr *remote_addr) +{ + *f_seid = (struct osmo_pfcp_ie_f_seid) { + .seid = seid, + }; + osmo_pfcp_ip_addrs_set(&f_seid->ip_addr, remote_addr); +} + +int osmo_pfcp_dec_cause(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + enum osmo_pfcp_cause *cause = decode_to; + ENSURE_LENGTH_IS(== 1); + *cause = *tlv->val; + return 0; +} + +int osmo_pfcp_enc_cause(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + const enum osmo_pfcp_cause *cause = encode_from; + msgb_put_u8(tlv->dst, *cause); + return 0; +} + +int osmo_pfcp_dec_offending_ie(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + enum osmo_pfcp_iei *offending_ie = decode_to; + ENSURE_LENGTH_IS(== 2); + *offending_ie = osmo_load16be(tlv->val); + return 0; +} + +int osmo_pfcp_enc_offending_ie(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + const enum osmo_pfcp_iei *offending_ie = encode_from; + msgb_put_u16(tlv->dst, *offending_ie); + return 0; +} + +int osmo_pfcp_dec_8(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + uint8_t *u8 = decode_to; + ENSURE_LENGTH_IS(>= 1); + *u8 = tlv->val[0]; + return 0; +} + +int osmo_pfcp_enc_8(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + uint8_t *u8 = encode_from; + msgb_put_u8(tlv->dst, *u8); + return 0; +} + +int osmo_pfcp_dec_16be(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + uint16_t *u16 = decode_to; + ENSURE_LENGTH_IS(>= 2); + *u16 = osmo_load16be(tlv->val); + return 0; +} + +int osmo_pfcp_enc_16be(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + uint16_t *u16 = encode_from; + msgb_put_u16(tlv->dst, *u16); + return 0; +} + +int osmo_pfcp_dec_32be(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + uint32_t *u32 = decode_to; + ENSURE_LENGTH_IS(>= 4); + *u32 = osmo_load32be(tlv->val); + return 0; +} + +int osmo_pfcp_enc_32be(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + uint32_t *u32 = encode_from; + msgb_put_u32(tlv->dst, *u32); + return 0; +} + +int osmo_pfcp_dec_3gpp_iface_type(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + enum osmo_pfcp_3gpp_iface_type *_3gpp_iface_type = decode_to; + ENSURE_LENGTH_IS(>= 1); + *_3gpp_iface_type = tlv->val[0] & 0x3f; + return 0; +} + +int osmo_pfcp_enc_3gpp_iface_type(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + enum osmo_pfcp_3gpp_iface_type *_3gpp_iface_type = encode_from; + msgb_put_u8(tlv->dst, (uint8_t)(*_3gpp_iface_type) & 0x3f); + return 0; +} + +int osmo_pfcp_dec_source_iface(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + enum osmo_pfcp_source_iface *source_interface = decode_to; + ENSURE_LENGTH_IS(>= 1); + *source_interface = tlv->val[0] & 0xf; + return 0; +} + +int osmo_pfcp_enc_source_iface(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + enum osmo_pfcp_source_iface *source_interface = encode_from; + msgb_put_u8(tlv->dst, (uint8_t)(*source_interface) & 0xf); + return 0; +} + +int osmo_pfcp_dec_dest_iface(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + enum osmo_pfcp_dest_iface *dest_interface = decode_to; + ENSURE_LENGTH_IS(>= 1); + *dest_interface = tlv->val[0] & 0xf; + return 0; +} + +int osmo_pfcp_enc_dest_iface(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + enum osmo_pfcp_dest_iface *dest_interface = encode_from; + msgb_put_u8(tlv->dst, (uint8_t)(*dest_interface) & 0xf); + return 0; +} + +int osmo_pfcp_dec_node_id(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_node_id *node_id = decode_to; + const void *ip; + unsigned int ip_len; + unsigned int want_len; + ENSURE_LENGTH_IS(>= 1); + node_id->type = *(uint8_t*)tlv->val; + ip = &tlv->val[1]; + ip_len = tlv->len - 1; + + switch (node_id->type) { + case OSMO_PFCP_NODE_ID_T_IPV4: + want_len = sizeof(node_id->ip.u.sin.sin_addr); + if (ip_len != want_len) + RETURN_ERROR(-EINVAL, "Node ID: wrong IPv4 address value length %u, expected %u", + ip_len, want_len); + osmo_sockaddr_from_octets(&node_id->ip, ip, ip_len); + break; + case OSMO_PFCP_NODE_ID_T_IPV6: + want_len = sizeof(node_id->ip.u.sin6.sin6_addr); + if (ip_len != want_len) + RETURN_ERROR(-EINVAL, "Node ID: wrong IPv6 address value length %u, expected %u", + ip_len, want_len); + osmo_sockaddr_from_octets(&node_id->ip, ip, ip_len); + break; + case OSMO_PFCP_NODE_ID_T_FQDN: + /* Copy and add a trailing nul */ + osmo_strlcpy(node_id->fqdn, ip, ip_len); + break; + default: + RETURN_ERROR(-EINVAL, "Invalid Node ID Type: %d", node_id->type); + } + return 0; +} + +int osmo_pfcp_enc_node_id(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + unsigned int l; + struct osmo_pfcp_ie_node_id *node_id = encode_from; + msgb_put_u8(tlv->dst, node_id->type); + switch (node_id->type) { + case OSMO_PFCP_NODE_ID_T_IPV4: + l = sizeof(node_id->ip.u.sin.sin_addr); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &node_id->ip); + break; + case OSMO_PFCP_NODE_ID_T_IPV6: + l = sizeof(node_id->ip.u.sin6.sin6_addr); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &node_id->ip); + break; + case OSMO_PFCP_NODE_ID_T_FQDN: + l = strlen(node_id->fqdn); + /* Copy without trailing nul */ + strncpy((char*)msgb_put(tlv->dst, l), node_id->fqdn, l); + break; + default: + RETURN_ERROR(-EINVAL, "Invalid Node ID Type: %d", node_id->type); + } + return 0; +} + +int osmo_pfcp_dec_up_function_features(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_up_function_features *up_function_features = decode_to; + ENSURE_LENGTH_IS(>= 6); + memcpy(up_function_features->bits, tlv->val, 6); + return 0; +} + +int osmo_pfcp_enc_up_function_features(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_up_function_features *up_function_features = encode_from; + memcpy(msgb_put(tlv->dst, 6), up_function_features->bits, 6); + return 0; +} + +int osmo_pfcp_dec_cp_function_features(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_cp_function_features *cp_function_features = decode_to; + ENSURE_LENGTH_IS(>= sizeof(cp_function_features->bits)); + memcpy(cp_function_features->bits, tlv->val, sizeof(cp_function_features->bits)); + return 0; +} + +int osmo_pfcp_enc_cp_function_features(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_cp_function_features *cp_function_features = encode_from; + memcpy(msgb_put(tlv->dst, sizeof(cp_function_features->bits)), + cp_function_features->bits, sizeof(cp_function_features->bits)); + return 0; +} + +int osmo_pfcp_dec_f_seid(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_f_seid *f_seid = decode_to; + uint8_t flags; + uint8_t pos; + unsigned int l; + /* flags and 8 octet seid */ + ENSURE_LENGTH_IS(>= 9); + flags = tlv->val[0]; + f_seid->ip_addr.v6_present = flags & 1; + f_seid->ip_addr.v4_present = flags & 2; + f_seid->seid = osmo_load64be(&tlv->val[1]); + pos = 9; + if (f_seid->ip_addr.v4_present) { + l = sizeof(f_seid->ip_addr.v4.u.sin.sin_addr); + if (pos + l > tlv->len) + RETURN_ERROR(-EINVAL, "F-SEID IE is too short for the IPv4 address: %zu", tlv->len); + osmo_sockaddr_from_octets(&f_seid->ip_addr.v4, &tlv->val[pos], l); + pos += l; + } + if (f_seid->ip_addr.v6_present) { + l = sizeof(f_seid->ip_addr.v4.u.sin6.sin6_addr); + if (pos + l > tlv->len) + RETURN_ERROR(-EINVAL, "F-SEID IE is too short for the IPv6 address: %zu", tlv->len); + osmo_sockaddr_from_octets(&f_seid->ip_addr.v6, &tlv->val[pos], l); + pos += l; + } + return 0; +} + +int osmo_pfcp_enc_f_seid(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_f_seid *f_seid = encode_from; + unsigned int l; + uint8_t flags = (f_seid->ip_addr.v6_present? 1 : 0) + (f_seid->ip_addr.v4_present ? 2 : 0); + /* flags and 8 octet seid */ + msgb_put_u8(tlv->dst, flags); + osmo_store64be(f_seid->seid, msgb_put(tlv->dst, 8)); + + if (f_seid->ip_addr.v4_present) { + if (f_seid->ip_addr.v4.u.sin.sin_family != AF_INET) + RETURN_ERROR(-EINVAL, + "f_seid IE indicates IPv4 address, but there is no ipv4_addr"); + l = sizeof(f_seid->ip_addr.v4.u.sin.sin_addr); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &f_seid->ip_addr.v4); + } + if (f_seid->ip_addr.v6_present) { + if (f_seid->ip_addr.v6.u.sin6.sin6_family != AF_INET6) + RETURN_ERROR(-EINVAL, + "f_seid IE indicates IPv6 address, but there is no ipv6_addr"); + l = sizeof(f_seid->ip_addr.v6.u.sin6.sin6_addr); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &f_seid->ip_addr.v6); + } + return 0; +} + +int osmo_pfcp_dec_f_teid(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_f_teid *f_teid = decode_to; + uint8_t flags; + const uint8_t *pos; + + *f_teid = (struct osmo_pfcp_ie_f_teid){0}; + + pos = tlv->val; + + ENSURE_REMAINING_LENGTH_IS("flags", pos, >= 1); + flags = *pos; + pos++; + f_teid->choose_flag = flags & 4; + + if (!f_teid->choose_flag) { + /* A fixed TEID and address are provided */ + f_teid->fixed.ip_addr.v4_present = flags & 1; + f_teid->fixed.ip_addr.v6_present = flags & 2; + + ENSURE_REMAINING_LENGTH_IS("TEID", pos, >= 4); + f_teid->fixed.teid = osmo_load32be(pos); + pos += 4; + + if (f_teid->fixed.ip_addr.v4_present) { + osmo_static_assert(sizeof(f_teid->fixed.ip_addr.v4.u.sin.sin_addr) == 4, sin_addr_size_is_4); + ENSURE_REMAINING_LENGTH_IS("IPv4 address", pos, >= 4); + osmo_sockaddr_from_octets(&f_teid->fixed.ip_addr.v4, pos, 4); + pos += 4; + } + if (f_teid->fixed.ip_addr.v6_present) { + osmo_static_assert(sizeof(f_teid->fixed.ip_addr.v6.u.sin6.sin6_addr) == 16, sin6_addr_size_is_16); + ENSURE_REMAINING_LENGTH_IS("IPv6 address", pos, >= 16); + osmo_sockaddr_from_octets(&f_teid->fixed.ip_addr.v6, pos, 16); + pos += 16; + } + } else { + /* CH flag is 1, choose an F-TEID. */ + f_teid->choose.ipv4_addr = flags & 1; + f_teid->choose.ipv6_addr = flags & 2; + f_teid->choose.choose_id_present = flags & 8; + + if (f_teid->choose.choose_id_present) { + ENSURE_REMAINING_LENGTH_IS("CHOOSE ID", pos, >= 1); + f_teid->choose.choose_id = *pos; + pos++; + } + } + return 0; +} + +int osmo_pfcp_enc_f_teid(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_f_teid *f_teid = encode_from; + uint8_t flags; + + flags = (f_teid->choose_flag ? 4 : 0); + + if (!f_teid->choose_flag) { + /* A fixed TEID and address are provided */ + flags |= (f_teid->fixed.ip_addr.v4_present ? 1 : 0) + + (f_teid->fixed.ip_addr.v6_present ? 2 : 0); + + msgb_put_u8(tlv->dst, flags); + msgb_put_u32(tlv->dst, f_teid->fixed.teid); + + if (f_teid->fixed.ip_addr.v4_present) { + if (f_teid->fixed.ip_addr.v4.u.sin.sin_family != AF_INET) + RETURN_ERROR(-EINVAL, + "f_teid IE indicates IPv4 address, but there is no ipv4_addr" + " (sin_family = %d != AF_INET)", f_teid->fixed.ip_addr.v4.u.sin.sin_family); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, 4), 4, &f_teid->fixed.ip_addr.v4); + } + if (f_teid->fixed.ip_addr.v6_present) { + if (f_teid->fixed.ip_addr.v6.u.sin6.sin6_family != AF_INET6) + RETURN_ERROR(-EINVAL, + "f_teid IE indicates IPv6 address, but there is no ipv6_addr" + " (sin6_family = %d != AF_INET6)", f_teid->fixed.ip_addr.v6.u.sin6.sin6_family); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, 16), 16, &f_teid->fixed.ip_addr.v6); + } + } else { + flags |= (f_teid->choose.ipv4_addr ? 1 : 0) + + (f_teid->choose.ipv6_addr ? 2 : 0) + + (f_teid->choose.choose_id_present ? 8 : 0); + msgb_put_u8(tlv->dst, flags); + if (f_teid->choose.choose_id_present) + msgb_put_u8(tlv->dst, f_teid->choose.choose_id); + } + return 0; +} + +int osmo_pfcp_dec_apply_action(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_apply_action *apply_action = decode_to; + ENSURE_LENGTH_IS(>= 1); + *apply_action = (struct osmo_pfcp_ie_apply_action){0}; + memcpy(apply_action->bits, tlv->val, OSMO_MIN(tlv->len, sizeof(apply_action->bits))); + return 0; +} + +int osmo_pfcp_enc_apply_action(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_apply_action *apply_action = encode_from; + memcpy(msgb_put(tlv->dst, sizeof(apply_action->bits)), + apply_action->bits, sizeof(apply_action->bits)); + return 0; +} + +int osmo_pfcp_dec_network_inst(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_network_inst *network_inst = decode_to; + osmo_strlcpy(network_inst->str, (const char *)tlv->val, OSMO_MIN(sizeof(network_inst->str), tlv->len+1)); + return 0; +} + +int osmo_pfcp_enc_network_inst(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_network_inst *network_inst = encode_from; + unsigned int l = strlen(network_inst->str); + if (l) + memcpy(msgb_put(tlv->dst, l), network_inst->str, l); + return 0; +} + +int osmo_pfcp_dec_outer_header_creation(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_outer_header_creation *ohc = decode_to; + const uint8_t *pos; + bool gtp_u_udp_ipv4; + bool gtp_u_udp_ipv6; + bool udp_ipv4; + bool udp_ipv6; + bool ipv4; + bool ipv6; + bool c_tag; + bool s_tag; + + *ohc = (struct osmo_pfcp_ie_outer_header_creation){0}; + + ENSURE_LENGTH_IS(>= 2); + + memcpy(ohc->desc_bits, tlv->val, 2); + + gtp_u_udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4); + udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4); + ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV4); + gtp_u_udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6); + udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6); + ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV6); + c_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG); + s_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG); + + pos = tlv->val + 2; + if (gtp_u_udp_ipv4 || gtp_u_udp_ipv6) { + ENSURE_REMAINING_LENGTH_IS("TEID", pos, >= 4); + ohc->teid_present = true; + ohc->teid = osmo_load32be(pos); + pos += 4; + } + if (gtp_u_udp_ipv4 || udp_ipv4 || ipv4) { + ENSURE_REMAINING_LENGTH_IS("IPv4 address", pos, >= 4); + ohc->ip_addr.v4_present = true; + osmo_sockaddr_from_octets(&ohc->ip_addr.v4, pos, 4); + pos += 4; + } + if (gtp_u_udp_ipv6 || udp_ipv6 || ipv6) { + ENSURE_REMAINING_LENGTH_IS("IPv6 address", pos, >= 16); + ohc->ip_addr.v6_present = true; + osmo_sockaddr_from_octets(&ohc->ip_addr.v6, pos, 16); + pos += 16; + } + if (udp_ipv4 || udp_ipv6) { + ENSURE_REMAINING_LENGTH_IS("UDP port number", pos, >= 2); + ohc->port_number_present = true; + ohc->port_number = osmo_load16be(pos); + pos += 2; + } + if (c_tag) { + ohc->c_tag_present = true; + ENSURE_REMAINING_LENGTH_IS("C-TAG", pos, >= 3); + ohc->c_tag_present = true; + ohc->c_tag = osmo_load32be_ext_2(pos, 3); + pos += 3; + } + if (s_tag) { + ohc->s_tag_present = true; + ENSURE_REMAINING_LENGTH_IS("S-TAG", pos, >= 3); + ohc->s_tag_present = true; + ohc->s_tag = osmo_load32be_ext_2(pos, 3); + pos += 3; + } + + return 0; +} + +int osmo_pfcp_enc_outer_header_creation(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_outer_header_creation *ohc = encode_from; + bool gtp_u_udp_ipv4; + bool gtp_u_udp_ipv6; + bool udp_ipv4; + bool udp_ipv6; + bool ipv4; + bool ipv6; + bool c_tag; + bool s_tag; + + memcpy(msgb_put(tlv->dst, sizeof(ohc->desc_bits)), ohc->desc_bits, sizeof(ohc->desc_bits)); + + gtp_u_udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV4); + udp_ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV4); + ipv4 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV4); + gtp_u_udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_GTP_U_UDP_IPV6); + udp_ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_UDP_IPV6); + ipv6 = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_IPV6); + c_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_C_TAG); + s_tag = osmo_pfcp_bits_get(ohc->desc_bits, OSMO_PFCP_OUTER_HEADER_CREATION_S_TAG); + + if ((gtp_u_udp_ipv4 || gtp_u_udp_ipv6) != (ohc->teid_present)) + RETURN_ERROR(-EINVAL, "teid_present = %s does not match the description bits 0x%02x\n", + ohc->teid_present ? "true" : "false", + ohc->desc_bits[0]); + if (ohc->teid_present) + msgb_put_u32(tlv->dst, ohc->teid); + + if ((gtp_u_udp_ipv4 || udp_ipv4 || ipv4) != ohc->ip_addr.v4_present) + RETURN_ERROR(-EINVAL, "ipv4_addr_present = %s does not match the description bits 0x%02x\n", + ohc->ip_addr.v4_present ? "true" : "false", + ohc->desc_bits[0]); + if (ohc->ip_addr.v4_present) + osmo_sockaddr_to_octets(msgb_put(tlv->dst, 4), 4, &ohc->ip_addr.v4); + + if ((gtp_u_udp_ipv6 || udp_ipv6 || ipv6) != ohc->ip_addr.v6_present) + RETURN_ERROR(-EINVAL, "ipv6_addr_present = %s does not match the description bits 0x%02x\n", + ohc->ip_addr.v6_present ? "true" : "false", + ohc->desc_bits[0]); + if (ohc->ip_addr.v6_present) + osmo_sockaddr_to_octets(msgb_put(tlv->dst, 16), 16, &ohc->ip_addr.v6); + + if ((udp_ipv4 || udp_ipv6) != ohc->port_number_present) + RETURN_ERROR(-EINVAL, "port_number_present = %s does not match the description bits 0x%02x\n", + ohc->port_number_present ? "true" : "false", + ohc->desc_bits[0]); + if (ohc->port_number_present) + msgb_put_u16(tlv->dst, ohc->port_number); + + if (c_tag != ohc->c_tag_present) + RETURN_ERROR(-EINVAL, "c_tag_present = %s does not match the description bits 0x%02x%02x\n", + ohc->c_tag_present ? "true" : "false", + ohc->desc_bits[1], ohc->desc_bits[0]); + if (ohc->c_tag_present) + osmo_store32be_ext(ohc->c_tag, msgb_put(tlv->dst, 3), 3); + + if (s_tag != ohc->s_tag_present) + RETURN_ERROR(-EINVAL, "s_tag_present = %s does not match the description bits 0x%02x%02x\n", + ohc->s_tag_present ? "true" : "false", + ohc->desc_bits[1], ohc->desc_bits[0]); + if (ohc->s_tag_present) + osmo_store32be_ext(ohc->s_tag, msgb_put(tlv->dst, 3), 3); + + return 0; +} + +int osmo_pfcp_dec_activate_predefined_rules(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_activate_predefined_rules *activate_predefined_rules = decode_to; + osmo_strlcpy(activate_predefined_rules->str, (const char *)tlv->val, OSMO_MIN(sizeof(activate_predefined_rules->str), tlv->len+1)); + return 0; +} + +int osmo_pfcp_enc_activate_predefined_rules(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_activate_predefined_rules *activate_predefined_rules = encode_from; + unsigned int l = strlen(activate_predefined_rules->str); + if (l) + memcpy(msgb_put(tlv->dst, l), activate_predefined_rules->str, l); + return 0; +} + +int osmo_pfcp_dec_outer_header_removal(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_outer_header_removal *outer_header_removal = decode_to; + ENSURE_LENGTH_IS(>= 1); + outer_header_removal->desc = tlv->val[0]; + + if (tlv->len > 1) { + outer_header_removal->gtp_u_extension_header_del_present = true; + memcpy(outer_header_removal->gtp_u_extension_header_del_bits, &tlv->val[1], + sizeof(outer_header_removal->gtp_u_extension_header_del_bits)); + } + return 0; +} + +int osmo_pfcp_enc_outer_header_removal(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_outer_header_removal *outer_header_removal = encode_from; + msgb_put_u8(tlv->dst, outer_header_removal->desc); + if (outer_header_removal->gtp_u_extension_header_del_present) { + memcpy(msgb_put(tlv->dst, sizeof(outer_header_removal->gtp_u_extension_header_del_bits)), + outer_header_removal->gtp_u_extension_header_del_bits, + sizeof(outer_header_removal->gtp_u_extension_header_del_bits)); + } + return 0; +} + +int osmo_pfcp_dec_ue_ip_address(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct osmo_pfcp_ie_ue_ip_address *ue_ip_address = decode_to; + const uint8_t *pos; + uint8_t flags; + + pos = tlv->val; + + ENSURE_REMAINING_LENGTH_IS("flags", pos, >= 1); + flags = *pos; + pos++; + + ue_ip_address->ipv6_prefix_length_present = flags & (1 << 6); + ue_ip_address->chv6 = flags & (1 << 5); + ue_ip_address->chv4 = flags & (1 << 4); + ue_ip_address->ipv6_prefix_delegation_bits_present = flags & (1 << 3); + ue_ip_address->ip_is_destination = flags & (1 << 2); + ue_ip_address->ip_addr.v4_present = flags & (1 << 1); + ue_ip_address->ip_addr.v6_present = flags & (1 << 0); + + if (ue_ip_address->ip_addr.v4_present) { + ENSURE_REMAINING_LENGTH_IS("IPv4 address", pos, >= 4); + osmo_sockaddr_from_octets(&ue_ip_address->ip_addr.v4, pos, 4); + pos += 4; + } + if (ue_ip_address->ip_addr.v6_present) { + ENSURE_REMAINING_LENGTH_IS("IPv6 address", pos, >= 16); + osmo_sockaddr_from_octets(&ue_ip_address->ip_addr.v6, pos, 16); + pos += 16; + } + + if (ue_ip_address->ipv6_prefix_delegation_bits_present) { + ENSURE_REMAINING_LENGTH_IS("IPv6 prefix delegation bits", pos, >= 1); + ue_ip_address->ipv6_prefix_delegation_bits = *pos; + pos++; + } + if (ue_ip_address->ipv6_prefix_length_present) { + ENSURE_REMAINING_LENGTH_IS("IPv6 prefix length", pos, >= 1); + ue_ip_address->ipv6_prefix_length = *pos; + pos++; + } + + return 0; +} + +int osmo_pfcp_enc_ue_ip_address(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct osmo_pfcp_ie_ue_ip_address *ue_ip_address = encode_from; + unsigned int l; + uint8_t flags; + + flags = 0 + | (ue_ip_address->ipv6_prefix_length_present ? (1 << 6) : 0) + | (ue_ip_address->chv6 ? (1 << 5) : 0) + | (ue_ip_address->chv4 ? (1 << 4) : 0) + | (ue_ip_address->ipv6_prefix_delegation_bits_present ? (1 << 3) : 0) + | (ue_ip_address->ip_is_destination ? (1 << 2) : 0) + | (ue_ip_address->ip_addr.v4_present ? (1 << 1) : 0) + | (ue_ip_address->ip_addr.v6_present ? (1 << 0) : 0) + ; + + msgb_put_u8(tlv->dst, flags); + + if (ue_ip_address->ip_addr.v4_present) { + if (ue_ip_address->ip_addr.v4.u.sin.sin_family != AF_INET) + RETURN_ERROR(-EINVAL, + "ue_ip_address IE indicates IPv4 address, but there is no ipv4_addr"); + l = sizeof(ue_ip_address->ip_addr.v4.u.sin.sin_addr); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &ue_ip_address->ip_addr.v4); + } + if (ue_ip_address->ip_addr.v6_present) { + if (ue_ip_address->ip_addr.v6.u.sin6.sin6_family != AF_INET6) + RETURN_ERROR(-EINVAL, + "ue_ip_address IE indicates IPv6 address, but there is no ipv6_addr"); + l = sizeof(ue_ip_address->ip_addr.v6.u.sin6.sin6_addr); + osmo_sockaddr_to_octets(msgb_put(tlv->dst, l), l, &ue_ip_address->ip_addr.v6); + } + + if (ue_ip_address->ipv6_prefix_delegation_bits_present) + msgb_put_u8(tlv->dst, ue_ip_address->ipv6_prefix_delegation_bits); + + if (ue_ip_address->ipv6_prefix_length_present) + msgb_put_u8(tlv->dst, ue_ip_address->ipv6_prefix_length); + + return 0; +} -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27222 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: I3069045b2d42dac88d955c636230adc64a7a4aa7 Gerrit-Change-Number: 27222 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in osmo-upf[master]: libosmo-tlv: add auto dec/enc to/from structs

by neels

neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27218 ) Change subject: libosmo-tlv: add auto dec/enc to/from structs ...................................................................... libosmo-tlv: add auto dec/enc to/from structs Add osmo_tlv_coding: describe the value part of a TLV (decode and encode), describe a struct with its members, and get/put readily decoded structs from/to a raw PDU, directly. With osmo_tlv_coding defined for a protocol's tags, we only deal with encoded PDUs or fully decoded C structs, no TLV related re-implementations clutter up the message handling code. A usage example is given in tlv_dec_enc_test. The first real use will be the PFCP protocol in osmo-upf.git. With osmo_tlv_coding, there still is a lot of monkey work involved in describing the decoded structs. A subsequent patch adds a generator for osmo_tlv_coding and message structs from tag value lists. Related: SYS#5599 Change-Id: I65de793105882a452124ee58adb0e58469e6e796 --- M include/osmocom/tlv/Makefile.am A include/osmocom/tlv/tlv_dec_enc.h M src/libosmo-tlv/Makefile.am A src/libosmo-tlv/tlv_dec_enc.c M tests/libosmo-tlv/Makefile.am A tests/libosmo-tlv/tlv_dec_enc_test.c A tests/libosmo-tlv/tlv_dec_enc_test.ok M tests/testsuite.at 8 files changed, 1,268 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/18/27218/1 diff --git a/include/osmocom/tlv/Makefile.am b/include/osmocom/tlv/Makefile.am index f819a41..9843369 100644 --- a/include/osmocom/tlv/Makefile.am +++ b/include/osmocom/tlv/Makefile.am @@ -1,5 +1,6 @@ tlv_HEADERS = \ tlv.h \ + tlv_dec_enc.h \ $(NULL) tlvdir = $(includedir)/osmocom/tlv diff --git a/include/osmocom/tlv/tlv_dec_enc.h b/include/osmocom/tlv/tlv_dec_enc.h new file mode 100644 index 0000000..50a9842 --- /dev/null +++ b/include/osmocom/tlv/tlv_dec_enc.h @@ -0,0 +1,195 @@ +/* Decode and encode the value parts of a TLV structure */ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#pragma once + +#include <stdbool.h> + +#include <osmocom/tlv/tlv.h> + +struct value_string; + +/* User defined function to decode a single TLV value part. See struct osmo_tlv_coding. + * \param decoded_struct Pointer to the root struct, as context information, e.g. for logging. + * \param decode_to Pointer to the struct member, write the decoded value here. + * \param tlv TLV loader, pointing at a tlv->val of tlv->len bytes. + * \return 0 on success, nonzero on error, e.g. -EINVAL if the tlv->val is invalid. + */ +typedef int (*osmo_tlv_dec_func)(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv); + +/* User defined function to encode a single TLV value part. See struct osmo_tlv_coding. + * \param tlv TLV writer, pointing at a tlv->dst to msgb_put() data in. + * \param decoded_struct Pointer to the root struct, as context information, e.g. for logging. + * \param encode_from Pointer to the struct member, obtain the value to encode from here. + * \return 0 on success, nonzero on error, e.g. -EINVAL if encode_from has an un-encodable value. + */ +typedef int (*osmo_tlv_enc_func)(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from); + +/* Optional user defined function to convert a decoded IE struct (the Value part stored as C struct) to string. See + * struct osmo_tlv_coding. + * \param buf Return string in this buffer. + * \param buflen Size of buf. + * \param str_of Pointer to the struct member described by an osmo_tlv_coding, obtain the value to encode from here. + * \return number of characters that would be written if the buffer is large enough, like snprintf(). + */ +typedef int (*osmo_tlv_enc_to_str_func)(char *buf, size_t buflen, void *str_of); + +/* Whether TLV structures nested inside the value data of an outer IE should be parsed in the same order. */ +enum osmo_tlv_coding_nested_ies_ordered { + OSMO_TLV_NESTED_IES_ORDERED_SAME = 0, + OSMO_TLV_NESTED_IES_ORDERED, + OSMO_TLV_NESTED_IES_UNORDERED, +}; + +#define OSMO_ARRAY_PITCH(arr) ((char*)(&(arr)[1]) - (char*)(arr)) +#define OSMO_MEMB_ARRAY_PITCH(obj_type, arr_memb) OSMO_ARRAY_PITCH(((obj_type*)0)->arr_memb) + +/*! Definition of how to decode/encode a IE to/from a struct. + * Kept in lists describing TLV structures, and nestable. + * + * Instance lists of this can be composed manually, or auto-generated using tlv_gen.c. Auto-generating has the benefit + * that the decoded structs to match the IEs are also generated at the same time and thus always match the message + * definitions. For an example, see tests/libosmo-tlv/test_tlv_gen/. */ +struct osmo_tlv_coding { + /*! the IEI value */ + unsigned int tag; + + /*! Decoding function callback. Invoked for each defined and present IE encountered in the message. + * Return 0 on success, negative on failure. */ + osmo_tlv_dec_func dec_func; + /*! Encoding function callback. Invoked for each defined and present IE encountered in the message. + * Return 0 on success, negative on failure. */ + osmo_tlv_enc_func enc_func; + + /*! Means to output the decoded value to a human readable string, optional. */ + osmo_tlv_enc_to_str_func enc_to_str_func; + + /*! offsetof(decoded_struct_type, member_var): how far into the base struct you find a specific field for decoded + * value. For example, memb_ofs = offsetof(struct foo_msg, ies.bar_response.cause). + * When decoding, the decoded value is written here, when encoding it is read from here. */ + unsigned int memb_ofs; + /*! For repeated IEs (.has_count = true), the array pitch / the offset to add to get to the next array index. */ + unsigned int memb_array_pitch; + + /*! True for optional/conditional IEs. */ + bool has_presence_flag; + /* For optional/conditional IEs (has_presence_flag = true), the offset of the bool foo_present flag, + * For example, if there are + * + * struct foo_msg { + * struct baz baz; + * bool baz_present; + * }; + * + * then set + * memb_ofs = offsetof(struct foo_msg, baz); + * has_presence_flag = true; + * presence_flag_ofs = offsetof(struct foo_msg, baz_present); + */ + unsigned int presence_flag_ofs; + + /*! True for repeated IEs, for array members: + * + * struct foo_msg { + * struct moo moo[10]; + * unsigned int moo_count; + * }; + * + * memb_ofs = offsetof(struct foo_msg, moo); + * has_count = true; + * count_ofs = offsetof(struct foo_msg, moo_count); + * max_count = 10; + */ + bool has_count; + /*! For repeated IEs, the offset of the unsigned int foo_count indicator of how many array indexes are + * in use. See has_count. */ + unsigned int count_ofs; + /*! Maximum array size for member_var[]. See has_count. */ + unsigned int max_count; + /*! If nonzero, it is an error when less than this amount of the repeated IE have been decoded. */ + unsigned int mandatory_count; + + /*! For nested TLVs: if this IE's value part is itself a separate TLV structure, point this at the list of IE + * coding definitions for the inner IEs. + * In this example, the nested IEs decode/encode to different goo sub structs depending on the tag value. + * + * struct goo { + * int aaa; + * int bbb; + * }; + * + * struct foo_msg { + * struct goo goo; + * struct goo other_goo; + * }; + * + * struct osmo_tlv_coding goo_nested_ies[] = { + * { FOO_IEI_AAA, .memb_ofs = offsetof(struct goo, aaa), }, + * { FOO_IEI_BBB, .memb_ofs = offsetof(struct goo, bbb), }, + * {0} + * }; + * + * struct osmo_tlv_coding foo_msg_ies[] = { + * { FOO_IEI_GOO, .memb_ofs = offsetof(struct foo_msg, goo), .nested_ies = goo_nested_ies, }, + * { FOO_IEI_OTHER_GOO, .memb_ofs = offsetof(struct foo_msg, other_goo), .nested_ies = goo_nested_ies, }, + * {0} + * }; + */ + const struct osmo_tlv_coding *nested_ies; + + /*! If the nested TLV has a different tag/length size than the outer TLV structure, provide a different config + * here. If they are the same, just keep this NULL. */ + const struct osmo_tlv_cfg *nested_ies_cfg; + + /*! What to pass to osmo_tlvs_decode() for tlv_ordered parameter. */ + enum osmo_tlv_coding_nested_ies_ordered nested_ies_ordered; +}; + + +/*! User defined hook for error logging during TLV and value decoding. + * \param decoded_struct Pointer to the base struct describing this message, for context. + * \param file Source file of where the error occured. + * \param line Source file line of where the error occured. + * \param fmt Error message string format. + * \param ... Error message string args. + */ +typedef void (*osmo_tlv_err_cb)(void *decoded_struct, const char *file, int line, const char *fmt, ...); + +int osmo_tlvs_decode(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv, bool tlv_ordered, + const struct osmo_tlv_coding *ie_coding, + osmo_tlv_err_cb err_cb, const struct value_string *iei_strs); + +int osmo_tlvs_encode(struct osmo_tlv_put *tlv, void *decoded_struct, unsigned int obj_ofs, + const struct osmo_tlv_coding *ie_coding, + osmo_tlv_err_cb err_cb, const struct value_string *iei_strs); + +int osmo_tlvs_encode_to_str_buf(char *buf, size_t buflen, const void *decoded_struct, unsigned int obj_ofs, + const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs); +char *osmo_tlvs_encode_to_str_c(void *ctx, const void *decoded_struct, unsigned int obj_ofs, + const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs); + +static inline bool osmo_tlv_coding_end(const struct osmo_tlv_coding *iec) +{ + return iec->dec_func == NULL && iec->enc_func == NULL && iec->nested_ies == NULL; +} diff --git a/src/libosmo-tlv/Makefile.am b/src/libosmo-tlv/Makefile.am index 0f848d3..2b8a374 100644 --- a/src/libosmo-tlv/Makefile.am +++ b/src/libosmo-tlv/Makefile.am @@ -22,4 +22,5 @@ libosmo_tlv_a_SOURCES = \ tlv.c \ + tlv_dec_enc.c \ $(NULL) diff --git a/src/libosmo-tlv/tlv_dec_enc.c b/src/libosmo-tlv/tlv_dec_enc.c new file mode 100644 index 0000000..44e0222 --- /dev/null +++ b/src/libosmo-tlv/tlv_dec_enc.c @@ -0,0 +1,512 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <errno.h> +#include <string.h> + +#include <osmocom/core/utils.h> + +#include <osmocom/tlv/tlv_dec_enc.h> + +/* Reverse offsetof(): return the address of the struct member for a given osmo_tlv_msg and member ofs_foo value. */ +#define MEMB(M, MEMB_OFS) ((void*)( (char*)(M) + (MEMB_OFS) )) + +#define RETURN_ERROR(RC, IEI, FMT, ARGS...) \ + do {\ + if (err_cb) \ + err_cb(decoded_struct, __FILE__, __LINE__, "tag 0x%x = %s: " FMT " (%d: %s)\n", IEI, \ + get_value_string(iei_strs, IEI), ##ARGS, RC, strerror((RC) > 0? (RC) : -(RC))); \ + return RC; \ + } while (0) + + +/*! Decode a TLV structure from raw data to a decoded struct, for unordered TLV IEs. + * How to decode IE values and where to place them in the decoded struct, is defined by ie_coding, an array terminated + * by a '{0}' entry. + * The IEs may appear in any ordering in the TLV data. + * For unordered decoding, only IEs with has_presence_flag == true or has_count == true may repeat. Other IE definitions + * cause the last read TLV to overwrite all previous decodings, all into the first occurence in ie_coding. + * \param[out] decoded_struct Pointer to the struct to write parsed IE data to. + * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct. + * \param[in] tlv TLV data to parse, as given in tlv->msg.*. Must be ready for osmo_tlv_load_start(). + * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding. + * \param[in] err_cb Function to call to report an error message, or NULL. + * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. + * \return 0 on success, negative on error. + */ +static int osmo_tlvs_decode_unordered(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv, + const struct osmo_tlv_coding *ie_coding, + osmo_tlv_err_cb err_cb, const struct value_string *iei_strs) +{ + void *obj = MEMB(decoded_struct, obj_ofs); + const struct osmo_tlv_coding *iec; + unsigned int *multi_count_p; + + /* To check for presence of mandatory IEs, need to keep a flag stack of seen ie_coding entries. This array has + * to have at least the nr of entires that the ie_coding array has. Let's allow up to this many ie_coding + * entries to avoid dynamic allocation. Seems like enough. */ + bool seen_ie_coding_entries[4096] = {0}; + bool *seen_p; +#define CHECK_SEEN(IEC) do { \ + unsigned int ie_coding_idx = (IEC) - ie_coding; \ + if (ie_coding_idx >= ARRAY_SIZE(seen_ie_coding_entries)) \ + RETURN_ERROR(-ENOTSUP, tlv->tag, \ + "Too many IE definitions for decoding an unordered TLV structure"); \ + seen_p = &seen_ie_coding_entries[ie_coding_idx]; \ + } while (0) + + + osmo_tlv_load_start(tlv); + + /* IEs are allowed to come in any order. So traverse the TLV structure once, and find an IE parser for each (if + * any). */ + for (;;) { + int rc; + bool *presence_flag_p; + unsigned int memb_next_array_idx; + unsigned int memb_ofs; + unsigned int ie_max_allowed_count; + + rc = osmo_tlv_load_next(tlv); + if (rc) + RETURN_ERROR(rc, tlv->tag, "Decoding IEs failed on or after this tag"); + if (!tlv->val) { + /* End of the TLV structure */ + break; + } + + /* ie_max_allowed_count counts how often the same IEI may appear in a message until all struct members + * that can store them are filled up. */ + ie_max_allowed_count = 0; + + do { + /* Find the IE coding for this tag */ + for (iec = ie_coding; !osmo_tlv_coding_end(iec) && iec->tag != tlv->tag; iec++); + /* No such IE coding found. */ + if (osmo_tlv_coding_end(iec)) + break; + + /* Keep track how often this tag can occur */ + ie_max_allowed_count += iec->has_count ? iec->max_count : 1; + + /* Was this iec instance already decoded? Then skip to the next one, if any. */ + presence_flag_p = iec->has_presence_flag ? MEMB(obj, iec->presence_flag_ofs) : NULL; + multi_count_p = iec->has_count ? MEMB(obj, iec->count_ofs) : NULL; + if ((presence_flag_p && *presence_flag_p) + || (multi_count_p && *multi_count_p >= iec->max_count)) + continue; + /* For IEs with a presence flag or a multi count, the decoded struct provides the information + * whether the IE has already been decoded. Do the same for mandatory IEs, using local state in + * seen_ie_coding_entries[]. */ + CHECK_SEEN(iec); + if (*seen_p) + continue; + } while (0); + if (osmo_tlv_coding_end(iec)) { + if (ie_max_allowed_count) { + /* There have been IE definitions for this IEI, but all slots to decode it are already + * filled. */ + RETURN_ERROR(-ENOTSUP, tlv->tag, "Only %u instances of this IE are supported per message", + ie_max_allowed_count); + } + /* No such IE defined in ie_coding, just skip the TLV. */ + continue; + } + + /* If this is a repeated IE, decode into the correct array index memb[idx], + * next idx == (*multi_count_p). We've already guaranteed above that *multi_count_p < max_count. */ + memb_next_array_idx = multi_count_p ? *multi_count_p : 0; + memb_ofs = iec->memb_ofs + memb_next_array_idx * iec->memb_array_pitch; + + /* Decode IE value part */ + if (iec->nested_ies) { + /* A nested IE: the value part of this TLV is in turn a TLV structure. Decode the inner + * IEs. */ + struct osmo_tlv_load inner_tlv = { + .cfg = iec->nested_ies_cfg ? : tlv->cfg, + .src = { + .data = tlv->val, + .len = tlv->len, + } + }; + bool ordered; + switch (iec->nested_ies_ordered) { + case OSMO_TLV_NESTED_IES_ORDERED: + ordered = true; + break; + case OSMO_TLV_NESTED_IES_ORDERED_SAME: + case OSMO_TLV_NESTED_IES_UNORDERED: + ordered = false; + break; + default: + OSMO_ASSERT(0); + } + rc = osmo_tlvs_decode(decoded_struct, obj_ofs + memb_ofs, &inner_tlv, ordered, iec->nested_ies, + err_cb, iei_strs); + if (rc) + RETURN_ERROR(rc, tlv->tag, "Error while decoding TLV structure nested inside this IE"); + } else { + /* Normal IE, decode the specific IE data. */ + if (!iec->dec_func) + RETURN_ERROR(-EIO, tlv->tag, "IE definition lacks a dec_func()"); + rc = iec->dec_func(decoded_struct, MEMB(obj, memb_ofs), tlv); + if (rc) + RETURN_ERROR(rc, tlv->tag, "Error while decoding this IE"); + } + + if (multi_count_p) { + /* A repeated IE, record that we've added one entry. This increments the foo_count value in the + * decoded osmo_tlv_msg.ies.*. + * For example, multi_count_p points at osmo_tlv_msg_session_est_req.create_pdr_count, + * and memb_ofs points at osmo_tlv_msg_session_est_req.create_pdr. */ + (*multi_count_p)++; + } + if (presence_flag_p) { + *presence_flag_p = true; + } + CHECK_SEEN(iec); + *seen_p = true; + } + + /* Check presence of mandatory IEs */ + for (iec = ie_coding; !osmo_tlv_coding_end(iec); iec++) { + if (iec->has_presence_flag) + continue; + multi_count_p = iec->has_count ? MEMB(obj, iec->count_ofs) : NULL; + if (multi_count_p) { + if (*multi_count_p < iec->mandatory_count) + RETURN_ERROR(-EINVAL, iec->tag, "%u instances of this IE are mandatory, got %u", + iec->mandatory_count, *multi_count_p); + continue; + } + /* Neither an optional nor a multi member, hence it must be mandatory. */ + CHECK_SEEN(iec); + if (!*seen_p) + RETURN_ERROR(-EINVAL, iec->tag, "Missing mandatory IE"); + } + return 0; +} + +/*! Decode a TLV structure from raw data to a decoded struct, for ordered TLV IEs. + * How to decode IE values and where to place them in the decoded struct, is defined by ie_coding, an array terminated + * by a '{0}' entry. + * The IEs in the TLV structure must appear in the same order as they are defined in ie_coding. + * cause the last read TLV to overwrite all previous decodings, all into the first occurence in ie_coding. + * \param[out] decoded_struct Pointer to the struct to write parsed IE data to. + * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct. + * \param[in] tlv TLV data to parse, as given in tlv->msg.*. Must be ready for osmo_tlv_load_start(). + * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding. + * \param[in] err_cb Function to call to report an error message, or NULL. + * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. + * \return 0 on success, negative on error. + */ +static int osmo_tlvs_decode_ordered(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv, + const struct osmo_tlv_coding *ie_coding, + osmo_tlv_err_cb err_cb, const struct value_string *iei_strs) +{ + void *obj = MEMB(decoded_struct, obj_ofs); + + osmo_tlv_load_start(tlv); + + for (; !osmo_tlv_coding_end(ie_coding); ie_coding++) { + int rc; + bool *presence_flag = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL; + unsigned int *multi_count = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL; + + rc = osmo_tlv_load_next_by_tag(tlv, ie_coding->tag); + switch (rc) { + case 0: + break; + case -ENOENT: + if (!presence_flag && (!multi_count || *multi_count < ie_coding->mandatory_count)) + RETURN_ERROR(rc, ie_coding->tag, "Missing mandatory IE"); + if (presence_flag) + *presence_flag = false; + continue; + default: + RETURN_ERROR(rc, ie_coding->tag, "Error in TLV structure"); + } + + for (;;) { + /* If this is a repeated IE, decode into the correct array index memb[idx], + * next idx == (*multi_count) */ + unsigned int memb_next_array_idx = multi_count ? *multi_count : 0; + unsigned int memb_ofs = ie_coding->memb_ofs + memb_next_array_idx * ie_coding->memb_array_pitch; + + if (multi_count && memb_next_array_idx >= ie_coding->max_count) + RETURN_ERROR(-ENOTSUP, ie_coding->tag, "Only %u instances of this IE are supported per message", + ie_coding->max_count); + + /* Decode IE value part */ + if (ie_coding->nested_ies) { + /* A nested IE: the value part of this TLV is in turn a TLV structure. Decode the inner + * IEs. */ + struct osmo_tlv_load inner_tlv = { + .cfg = ie_coding->nested_ies_cfg ? : tlv->cfg, + .src = { + .data = tlv->val, + .len = tlv->len, + } + }; + bool ordered; + switch (ie_coding->nested_ies_ordered) { + case OSMO_TLV_NESTED_IES_ORDERED_SAME: + case OSMO_TLV_NESTED_IES_ORDERED: + ordered = true; + break; + case OSMO_TLV_NESTED_IES_UNORDERED: + ordered = false; + break; + default: + OSMO_ASSERT(0); + } + rc = osmo_tlvs_decode(decoded_struct, obj_ofs + memb_ofs, &inner_tlv, ordered, + ie_coding->nested_ies, err_cb, iei_strs); + if (rc) + RETURN_ERROR(rc, ie_coding->tag, + "Error while decoding TLV structure nested inside this IE"); + } else { + /* Normal IE, decode the specific IE data. */ + if (!ie_coding->dec_func) + RETURN_ERROR(-EIO, ie_coding->tag, "IE definition lacks a dec_func()"); + rc = ie_coding->dec_func(decoded_struct, MEMB(obj, memb_ofs), tlv); + if (rc) + RETURN_ERROR(rc, ie_coding->tag, "Error while decoding this IE"); + } + + if (presence_flag) + *presence_flag = true; + + if (!multi_count) { + /* Not a repeated IE. */ + break; + } + + /* A repeated IE, record that we've added one entry. This increments the foo_count value in the + * decoded osmo_pfcp_msg.ies.*. + * For example, multi_count points at osmo_pfcp_msg_session_est_req.create_pdr_count, + * and memb_ofs points at osmo_pfcp_msg_session_est_req.create_pdr. */ + (*multi_count)++; + + /* Does another one of these IEs follow? */ + if (osmo_tlv_load_peek_tag(tlv) != tlv->tag) { + /* Next tag is a different IE, end the repetition. */ + break; + } + + /* continue, parsing the next repetition of this tag. */ + rc = osmo_tlv_load_next(tlv); + if (rc) + return rc; + } + /* continue parsing the next tag. */ + } + return 0; +} + +/*! Decode an entire TLV message from raw data to decoded struct. + * How to decode IE values and where to put them in the decoded struct is defined by ie_coding, an array terminated by + * a '{0}' entry. + * \param[out] decoded_struct Pointer to the struct to write parsed IE data to. + * \param[in] obj_ofs Pass as zero. Used for nested IEs: offset added to decoded_struct to get to a sub-struct. + * \param[in] tlv TLV data to parse, as given in tlv->msg.*. Must be ready for osmo_tlv_load_start(). + * \param[in] ie_coding A list of permitted/expected IEI tags and instructions for decoding. + * \param[in] err_cb Function to call to report an error message, or NULL. + * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. + * \return 0 on success, negative on error. + */ +int osmo_tlvs_decode(void *decoded_struct, unsigned int obj_ofs, struct osmo_tlv_load *tlv, bool tlv_ordered, + const struct osmo_tlv_coding *ie_coding, + osmo_tlv_err_cb err_cb, const struct value_string *iei_strs) +{ + if (!ie_coding) + return -ENOTSUP; + if (tlv_ordered) + return osmo_tlvs_decode_ordered(decoded_struct, obj_ofs, tlv, ie_coding, err_cb, iei_strs); + else + return osmo_tlvs_decode_unordered(decoded_struct, obj_ofs, tlv, ie_coding, err_cb, iei_strs); +} + +/*! Encode a TLV structure from decoded struct to raw data. + * How to encode IE values and where to read them in the decoded struct is defined by ie_coding, an array terminated by + * a '{0}' entry. + * The IEs will be encoded in the order they appear in ie_coding. + * \param[out] tlv Write data using this TLV definition to tlv->dst. + * \param[in] decoded_struct C struct data to encode. + * \param[in] obj_ofs Nesting offset, pass as 0. + * \param[in] ie_coding A {0} terminated list of IEI tags to encode (if present) and instructions for encoding. + * \param[in] err_cb Function to call to report an error message, or NULL. + * \param[in] iei_strs value_string array to give IEI names in error messages passed to err_cb(), or NULL. + * \return 0 on success, negative on error. + */ +int osmo_tlvs_encode(struct osmo_tlv_put *tlv, void *decoded_struct, unsigned int obj_ofs, + const struct osmo_tlv_coding *ie_coding, + osmo_tlv_err_cb err_cb, const struct value_string *iei_strs) +{ + void *obj = MEMB(decoded_struct, obj_ofs); + + if (!ie_coding) + return -ENOTSUP; + + for (; !osmo_tlv_coding_end(ie_coding); ie_coding++) { + int rc; + bool *presence_flag_p = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL; + unsigned int *multi_count_p = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL; + unsigned int n; + unsigned int i; + + if (presence_flag_p && !*presence_flag_p) + continue; + + if (multi_count_p) { + n = *multi_count_p; + if (!ie_coding->memb_array_pitch) + RETURN_ERROR(-EFAULT, ie_coding->tag, + "Error in protocol definition: The ie_coding lacks a memb_array_pitch" + " value, cannot be used as multi-IE\n"); + } else { + n = 1; + } + + for (i = 0; i < n; i++) { + unsigned int memb_ofs; + + osmo_tlv_put_tl(tlv, ie_coding->tag, 0); + + /* If this is a repeated IE, encode from the correct array index */ + if (multi_count_p && i >= ie_coding->max_count) + RETURN_ERROR(-ENOTSUP, ie_coding->tag, + "Only %u instances of this IE are supported per message", ie_coding->max_count); + memb_ofs = ie_coding->memb_ofs + i * ie_coding->memb_array_pitch; + + if (ie_coding->nested_ies) { + struct osmo_tlv_put nested_tlv = { + .cfg = ie_coding->nested_ies_cfg ? : tlv->cfg, + .dst = tlv->dst, + }; + rc = osmo_tlvs_encode(&nested_tlv, decoded_struct, obj_ofs + memb_ofs, + ie_coding->nested_ies, err_cb, iei_strs); + if (rc) + RETURN_ERROR(rc, ie_coding->tag, + "Error while encoding TLV structure nested inside this IE"); + } else { + rc = ie_coding->enc_func(tlv, decoded_struct, MEMB(obj, memb_ofs)); + if (rc) + RETURN_ERROR(rc, ie_coding->tag, "Error while encoding this IE"); + } + + osmo_tlv_put_update_tl(tlv); + } + } + return 0; +} + +/*! Compose a human readable string describing a decoded struct. + * How to encode IE values and where to read them in the decoded struct is defined by ie_coding, an array terminated by + * a '{0}' entry. + * The IEs will be encoded in the order they appear in ie_coding. + * \param[out] buf Return the string in this buffer. + * \param[in] buflen Size of buf. + * \param[in] decoded_struct C struct data to encode. + * \param[in] obj_ofs Nesting offset, pass as 0. + * \param[in] ie_coding A {0} terminated list of IEI tags to encode (if present) and instructions for encoding. + * \param[in] iei_strs value_string array to give IEI names in tag headers, or NULL. + * \return number of characters that would be written if the buffer is large enough, like snprintf(). + */ +int osmo_tlvs_encode_to_str_buf(char *buf, size_t buflen, const void *decoded_struct, unsigned int obj_ofs, + const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs) +{ + struct osmo_strbuf sb = { .buf = buf, .len = buflen }; + + void *obj = MEMB(decoded_struct, obj_ofs); + + if (!ie_coding) + return -ENOTSUP; + + for (; !osmo_tlv_coding_end(ie_coding); ie_coding++) { + bool *presence_flag_p = ie_coding->has_presence_flag ? MEMB(obj, ie_coding->presence_flag_ofs) : NULL; + unsigned int *multi_count_p = ie_coding->has_count ? MEMB(obj, ie_coding->count_ofs) : NULL; + unsigned int n; + unsigned int i; + + if (presence_flag_p && !*presence_flag_p) + continue; + + if (multi_count_p) { + n = *multi_count_p; + } else { + n = 1; + } + + if (!n) + continue; + + OSMO_STRBUF_PRINTF(sb, " %s=", get_value_string(iei_strs, ie_coding->tag)); + if (multi_count_p) + OSMO_STRBUF_PRINTF(sb, "{ "); + + for (i = 0; i < n; i++) { + unsigned int memb_ofs; + + /* If this is a repeated IE, encode from the correct array index */ + if (multi_count_p && i >= ie_coding->max_count) + return -ENOTSUP; + if (i > 0) + OSMO_STRBUF_PRINTF(sb, ", "); + + memb_ofs = ie_coding->memb_ofs + i * ie_coding->memb_array_pitch; + + if (ie_coding->nested_ies) { + OSMO_STRBUF_PRINTF(sb, "{"); + OSMO_STRBUF_APPEND(sb, osmo_tlvs_encode_to_str_buf, decoded_struct, obj_ofs + memb_ofs, + ie_coding->nested_ies, iei_strs); + OSMO_STRBUF_PRINTF(sb, " }"); + } else { + if (ie_coding->enc_to_str_func) + OSMO_STRBUF_APPEND(sb, ie_coding->enc_to_str_func, MEMB(obj, memb_ofs)); + else + OSMO_STRBUF_PRINTF(sb, "(enc_to_str_func==NULL)"); + } + } + + if (multi_count_p) + OSMO_STRBUF_PRINTF(sb, " }"); + } + return sb.chars_needed; +} + +/*! Compose a human readable string describing a decoded struct. + * Like osmo_tlvs_encode_to_str_buf() but returns a talloc allocated string. + * \param[in] ctx talloc context to allocate from, e.g. OTC_SELECT. + * \param[in] decoded_struct C struct data to encode. + * \param[in] obj_ofs Nesting offset, pass as 0. + * \param[in] ie_coding A {0} terminated list of IEI tags to encode (if present) and instructions for encoding. + * \param[in] iei_strs value_string array to give IEI names in tag headers, or NULL. + * \return human readable string. + */ +char *osmo_tlvs_encode_to_str_c(void *ctx, const void *decoded_struct, unsigned int obj_ofs, + const struct osmo_tlv_coding *ie_coding, const struct value_string *iei_strs) +{ + OSMO_NAME_C_IMPL(ctx, 256, "ERROR", osmo_tlvs_encode_to_str_buf, decoded_struct, obj_ofs, ie_coding, iei_strs) +} diff --git a/tests/libosmo-tlv/Makefile.am b/tests/libosmo-tlv/Makefile.am index 250dc5e..ff3fba9 100644 --- a/tests/libosmo-tlv/Makefile.am +++ b/tests/libosmo-tlv/Makefile.am @@ -10,10 +10,12 @@ noinst_PROGRAMS = \ tlv_test \ + tlv_dec_enc_test \ $(NULL) EXTRA_DIST = \ tlv_test.ok \ + tlv_dec_enc_test.ok \ $(NULL) tlv_test_SOURCES = \ @@ -25,6 +27,16 @@ $(LIBOSMOCORE_LIBS) \ $(NULL) +tlv_dec_enc_test_SOURCES = \ + tlv_dec_enc_test.c \ + $(NULL) + +tlv_dec_enc_test_LDADD = \ + $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \ + $(LIBOSMOCORE_LIBS) \ + $(NULL) + .PHONY: update_exp update_exp: $(builddir)/tlv_test >$(srcdir)/tlv_test.ok + $(builddir)/tlv_dec_enc_test >$(srcdir)/tlv_dec_enc_test.ok diff --git a/tests/libosmo-tlv/tlv_dec_enc_test.c b/tests/libosmo-tlv/tlv_dec_enc_test.c new file mode 100644 index 0000000..709eba8 --- /dev/null +++ b/tests/libosmo-tlv/tlv_dec_enc_test.c @@ -0,0 +1,413 @@ +/* (C) 2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +#include <stdio.h> +#include <errno.h> + +#include <osmocom/core/application.h> +#include <osmocom/core/utils.h> +#include <osmocom/core/msgb.h> + +#include <osmocom/tlv/tlv_dec_enc.h> + +void *ctx; + +enum tags { + TAG_FOO = 1, + TAG_BAR, + TAG_BAZ, + TAG_REPEAT_INT, + TAG_REPEAT_STRUCT, + TAG_NEST, +}; + +const struct value_string tag_names[] = { + { TAG_FOO, "FOO" }, + { TAG_BAR, "BAR" }, + { TAG_BAZ, "BAZ" }, + { TAG_REPEAT_INT, "REPEAT_INT" }, + { TAG_REPEAT_STRUCT, "REPEAT_STRUCT" }, + { TAG_NEST, "NEST" }, + {0} +}; + +struct bar { + char str[23]; +}; + +struct baz { + int v_int; + bool v_bool; +}; + +enum repeat_enum { + R_A, + R_B, + R_C, +}; + +const struct value_string repeat_enum_names[] = { + OSMO_VALUE_STRING(R_A), + OSMO_VALUE_STRING(R_B), + OSMO_VALUE_STRING(R_C), + {0} +}; + +struct repeat { + int v_int; + bool v_bool; + enum repeat_enum v_enum; +}; + +struct nested_inner_msg { + int foo; + struct bar bar; + struct baz baz; +}; + +struct decoded_msg { + int foo; + struct bar bar; + + bool baz_present; + struct baz baz; + + unsigned int repeat_int_count; + int repeat_int[32]; + + unsigned int repeat_struct_count; + struct repeat repeat_struct[32]; + + bool nest_present; + struct nested_inner_msg nest; +}; + +int dec_u16(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + int *foo = decode_to; + if (tlv->len != 2) + return -EINVAL; + *foo = osmo_load16be(tlv->val); + return 0; +} + +int enc_u16(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + int *foo = encode_from; + if (*foo > INT16_MAX) + return -EINVAL; + msgb_put_u16(tlv->dst, *foo); + return 0; +} + +int enc_to_str_u16(char *buf, size_t buflen, void *encode_from) +{ + int *foo = encode_from; + return snprintf(buf, buflen, "%d", *foo); +} + +int dec_bar(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct bar *bar = decode_to; + if (tlv->len > sizeof(bar->str) - 1) + return -EINVAL; + osmo_strlcpy(bar->str, (const char*)tlv->val, OSMO_MIN(tlv->len + 1, sizeof(bar->str))); + return 0; +} + +int enc_bar(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct bar *bar = encode_from; + int len = strnlen(bar->str, sizeof(bar->str)); + memcpy(msgb_put(tlv->dst, len), bar, len); + return 0; +} + +int enc_to_str_bar(char *buf, size_t buflen, void *encode_from) +{ + struct bar *bar = encode_from; + return osmo_quote_str_buf3(buf, buflen, bar->str, -1); +} + +int dec_baz(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct baz *baz = decode_to; + uint16_t l; + if (tlv->len != 2) + return -EINVAL; + l = osmo_load16be(tlv->val); + baz->v_int = l & 0x7fff; + baz->v_bool = (l & 0x8000) ? true : false; + return 0; +} + +int enc_baz(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct baz *baz = encode_from; + if (baz->v_int > 0x7fff) + return -EINVAL; + msgb_put_u16(tlv->dst, (baz->v_bool ? 0x8000 : 0) + (baz->v_int & 0x7fff)); + return 0; +} + +int enc_to_str_baz(char *buf, size_t buflen, void *encode_from) +{ + struct baz *baz = encode_from; + return snprintf(buf, buflen, "{%d,%s}", baz->v_int, baz->v_bool ? "true" : "false"); +} + +int dec_repeat_struct(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct repeat *repeat_struct = decode_to; + if (tlv->len != 3) + return -EINVAL; + repeat_struct->v_int = osmo_load16be(tlv->val); + repeat_struct->v_bool = tlv->val[2] & 0x80; + repeat_struct->v_enum = tlv->val[2] & 0x7f; + return 0; +} + +int enc_repeat_struct(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct repeat *repeat_struct = encode_from; + msgb_put_u16(tlv->dst, repeat_struct->v_int); + msgb_put_u8(tlv->dst, (repeat_struct->v_bool ? 0x80 : 0) + (repeat_struct->v_enum & 0x7f)); + return 0; +} + +int enc_to_str_repeat_struct(char *buf, size_t buflen, void *encode_from) +{ + struct repeat *repeat_struct = encode_from; + return snprintf(buf, buflen, "{%d,%s,%s}", repeat_struct->v_int, repeat_struct->v_bool ? "true" : "false", + get_value_string(repeat_enum_names, repeat_struct->v_enum)); +} + +struct osmo_tlv_coding nested_inner_msg_ies[] = { + { + .tag = TAG_FOO, + .dec_func = dec_u16, + .enc_func = enc_u16, + .enc_to_str_func = enc_to_str_u16, + .memb_ofs = offsetof(struct nested_inner_msg, foo), + }, + { + .tag = TAG_BAR, + .dec_func = dec_bar, + .enc_func = enc_bar, + .enc_to_str_func = enc_to_str_bar, + .memb_ofs = offsetof(struct nested_inner_msg, bar), + }, + { + .tag = TAG_BAZ, + .dec_func = dec_baz, + .enc_func = enc_baz, + .enc_to_str_func = enc_to_str_baz, + .memb_ofs = offsetof(struct nested_inner_msg, baz), + }, + {0} +}; + +struct osmo_tlv_coding msg_ie_coding[] = { + { + .tag = TAG_FOO, + .dec_func = dec_u16, + .enc_func = enc_u16, + .enc_to_str_func = enc_to_str_u16, + .memb_ofs = offsetof(struct decoded_msg, foo), + }, + { + .tag = TAG_BAR, + .dec_func = dec_bar, + .enc_func = enc_bar, + .enc_to_str_func = enc_to_str_bar, + .memb_ofs = offsetof(struct decoded_msg, bar), + }, + { + .tag = TAG_BAZ, + .dec_func = dec_baz, + .enc_func = enc_baz, + .enc_to_str_func = enc_to_str_baz, + .memb_ofs = offsetof(struct decoded_msg, baz), + .has_presence_flag = true, + .presence_flag_ofs = offsetof(struct decoded_msg, baz_present), + }, + { + .tag = TAG_REPEAT_INT, + .dec_func = dec_u16, + .enc_func = enc_u16, + .enc_to_str_func = enc_to_str_u16, + .memb_ofs = offsetof(struct decoded_msg, repeat_int), + .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(struct decoded_msg, repeat_int), + .has_count = true, + .count_ofs = offsetof(struct decoded_msg, repeat_int_count), + .max_count = ARRAY_SIZE( ((struct decoded_msg*)0)->repeat_int ), + }, + { + .tag = TAG_REPEAT_STRUCT, + .dec_func = dec_repeat_struct, + .enc_func = enc_repeat_struct, + .enc_to_str_func = enc_to_str_repeat_struct, + .memb_ofs = offsetof(struct decoded_msg, repeat_struct), + .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(struct decoded_msg, repeat_struct), + .has_count = true, + .count_ofs = offsetof(struct decoded_msg, repeat_struct_count), + .max_count = ARRAY_SIZE( ((struct decoded_msg*)0)->repeat_struct ), + }, + { + .tag = TAG_NEST, + .memb_ofs = offsetof(struct decoded_msg, nest), + .nested_ies = nested_inner_msg_ies, + .has_presence_flag = true, + .presence_flag_ofs = offsetof(struct decoded_msg, nest_present), + }, + {0} +}; + +char *decoded_msg_to_str(const struct decoded_msg *m) +{ + return osmo_tlvs_encode_to_str_c(ctx, m, 0, msg_ie_coding, tag_names); +} + + +const struct decoded_msg enc_dec_tests[] = { + { + .foo = 23, + .bar = { "twentythree" }, + }, + { + .foo = 23, + .bar = { "twentythree" }, + + .baz_present = true, + .baz = { + .v_int = 2323, + .v_bool = true, + }, + }, + { + .foo = 23, + .bar = { "twentythree" }, + + .baz_present = true, + .baz = { + .v_int = 2323, + .v_bool = true, + }, + + .repeat_int_count = 3, + .repeat_int = { 1, 2, 0x7fff }, + }, + { + .foo = 23, + .bar = { "twentythree" }, + + .baz_present = true, + .baz = { + .v_int = 2323, + .v_bool = true, + }, + + .repeat_int_count = 3, + .repeat_int = { 1, 2, 0x7fff }, + + .repeat_struct_count = 2, + .repeat_struct = { + { + .v_int = 1001, + .v_bool = true, + .v_enum = R_A, + }, + { + .v_int = 1002, + .v_bool = false, + .v_enum = R_B, + }, + }, + + .nest_present = true, + .nest = { + .foo = 42, + .bar = { "fortytwo" }, + .baz = { + .v_int = 4242, + .v_bool = false, + }, + }, + }, +}; + +void err_cb(void *decoded_struct, const char *file, int line, const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + //printf("ERR: %s:%d ", file, line); + printf("ERR: "); + vprintf(fmt, args); + va_end(args); +} + +void test_enc_dec(const char *label, const struct osmo_tlv_cfg *cfg, bool ordered) +{ + int i; + for (i = 0; i < ARRAY_SIZE(enc_dec_tests); i++) { + int rc; + const struct decoded_msg *orig = &enc_dec_tests[i]; + struct decoded_msg parsed = {0}; + struct osmo_tlv_load load; + struct osmo_tlv_put put; + + printf("\n=== start %s %s[%d]\n", label, __func__, i); + printf("encoded: %s\n", decoded_msg_to_str(orig)); + + put = (struct osmo_tlv_put){ + .cfg = cfg, + .dst = msgb_alloc(1024, __func__), + }; + rc = osmo_tlvs_encode(&put, (void*)orig, 0, msg_ie_coding, err_cb, tag_names); + printf("osmo_tlvs_encode() rc = %d\n", rc); + printf("%s.\n", osmo_hexdump(put.dst->data, put.dst->len)); + + load = (struct osmo_tlv_load){ + .cfg = cfg, + .src = { put.dst->data, put.dst->len }, + }; + rc = osmo_tlvs_decode(&parsed, 0, &load, ordered, msg_ie_coding, err_cb, tag_names); + printf("osmo_tlvs_decode() rc = %d\n", rc); + printf("decoded: %s\n", decoded_msg_to_str(&parsed)); + if (strcmp(decoded_msg_to_str(orig), decoded_msg_to_str(&parsed))) { + printf(" ERROR: parsed != orig\n"); + exit(1); + } + printf("=== end %s %s[%d]\n", label, __func__, i); + } +} + +int main() +{ + ctx = talloc_named_const(NULL, 0, "tlv_test"); + msgb_talloc_ctx_init(ctx, 0); + + test_enc_dec("t8l8v ordered", &osmo_t8l8v_cfg, true); + test_enc_dec("t8l8v unordered", &osmo_t8l8v_cfg, false); + + test_enc_dec("t16l16v ordered", &osmo_t16l16v_cfg, true); + test_enc_dec("t16l16v unordered", &osmo_t16l16v_cfg, false); + + talloc_free(ctx); + return 0; +} diff --git a/tests/libosmo-tlv/tlv_dec_enc_test.ok b/tests/libosmo-tlv/tlv_dec_enc_test.ok new file mode 100644 index 0000000..03f7375 --- /dev/null +++ b/tests/libosmo-tlv/tlv_dec_enc_test.ok @@ -0,0 +1,128 @@ + +=== start t8l8v ordered test_enc_dec[0] +encoded: FOO=23 BAR="twentythree" +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" +=== end t8l8v ordered test_enc_dec[0] + +=== start t8l8v ordered test_enc_dec[1] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} +=== end t8l8v ordered test_enc_dec[1] + +=== start t8l8v ordered test_enc_dec[2] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +=== end t8l8v ordered test_enc_dec[2] + +=== start t8l8v ordered test_enc_dec[3] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +=== end t8l8v ordered test_enc_dec[3] + +=== start t8l8v unordered test_enc_dec[0] +encoded: FOO=23 BAR="twentythree" +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" +=== end t8l8v unordered test_enc_dec[0] + +=== start t8l8v unordered test_enc_dec[1] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} +=== end t8l8v unordered test_enc_dec[1] + +=== start t8l8v unordered test_enc_dec[2] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +=== end t8l8v unordered test_enc_dec[2] + +=== start t8l8v unordered test_enc_dec[3] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +osmo_tlvs_encode() rc = 0 +01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +=== end t8l8v unordered test_enc_dec[3] + +=== start t16l16v ordered test_enc_dec[0] +encoded: FOO=23 BAR="twentythree" +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" +=== end t16l16v ordered test_enc_dec[0] + +=== start t16l16v ordered test_enc_dec[1] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} +=== end t16l16v ordered test_enc_dec[1] + +=== start t16l16v ordered test_enc_dec[2] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +=== end t16l16v ordered test_enc_dec[2] + +=== start t16l16v ordered test_enc_dec[3] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +=== end t16l16v ordered test_enc_dec[3] + +=== start t16l16v unordered test_enc_dec[0] +encoded: FOO=23 BAR="twentythree" +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" +=== end t16l16v unordered test_enc_dec[0] + +=== start t16l16v unordered test_enc_dec[1] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} +=== end t16l16v unordered test_enc_dec[1] + +=== start t16l16v unordered test_enc_dec[2] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } +=== end t16l16v unordered test_enc_dec[2] + +=== start t16l16v unordered test_enc_dec[3] +encoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +osmo_tlvs_encode() rc = 0 +00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . +osmo_tlvs_decode() rc = 0 +decoded: FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } +=== end t16l16v unordered test_enc_dec[3] diff --git a/tests/testsuite.at b/tests/testsuite.at index 86ef4d3..3f7fcee 100644 --- a/tests/testsuite.at +++ b/tests/testsuite.at @@ -6,3 +6,9 @@ cat $abs_srcdir/libosmo-tlv/tlv_test.ok > expout AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_test], [], [expout], [ignore]) AT_CLEANUP + +AT_SETUP([tlv_dec_enc]) +AT_KEYWORDS([tlv_dec_enc]) +cat $abs_srcdir/libosmo-tlv/tlv_dec_enc_test.ok > expout +AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_dec_enc_test], [], [expout], [ignore]) +AT_CLEANUP -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27218 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: I65de793105882a452124ee58adb0e58469e6e796 Gerrit-Change-Number: 27218 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in osmo-upf[master]: libosmo-tlv: add C code generator for IE structs and arrays

by neels

neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27219 ) Change subject: libosmo-tlv: add C code generator for IE structs and arrays ...................................................................... libosmo-tlv: add C code generator for IE structs and arrays Defining a protocol of message types with lists of IEs bears a lot of repetitive, copy-paste-error-prone writing out of data structures. Add a third layer to libosmo-tlv, which allows helpful code generation. By non-repetitive data structures that briefly describe the protocol's messages and IEs, generate possibly repetitive IE list arrays and decoded-struct definitions automatically, avoiding grunt work errors. I tried C macros for this at first, but it became too convoluted. Generating C code that can be read and grepped makes things easier. A usage example is found in tests/libosmo-tlv/test_tlv_gen/. Related: SYS#5599 Change-Id: Ifb3ea54d2797ce060b95834aa117725ec2d6c4cf --- M configure.ac M include/osmocom/tlv/Makefile.am A include/osmocom/tlv/tlv_gen.h M src/libosmo-tlv/Makefile.am A src/libosmo-tlv/tlv_gen.c M tests/libosmo-tlv/Makefile.am A tests/libosmo-tlv/test_tlv_gen/Makefile.am A tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c A tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c A tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h A tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c A tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok M tests/testsuite.at 13 files changed, 1,324 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/19/27219/1 diff --git a/configure.ac b/configure.ac index 70879e9..f9e85ce 100644 --- a/configure.ac +++ b/configure.ac @@ -205,6 +205,7 @@ tests/Makefile tests/atlocal tests/libosmo-tlv/Makefile + tests/libosmo-tlv/test_tlv_gen/Makefile doc/Makefile doc/examples/Makefile doc/manuals/Makefile diff --git a/include/osmocom/tlv/Makefile.am b/include/osmocom/tlv/Makefile.am index 9843369..979bd13 100644 --- a/include/osmocom/tlv/Makefile.am +++ b/include/osmocom/tlv/Makefile.am @@ -1,6 +1,7 @@ tlv_HEADERS = \ tlv.h \ tlv_dec_enc.h \ + tlv_gen.h \ $(NULL) tlvdir = $(includedir)/osmocom/tlv diff --git a/include/osmocom/tlv/tlv_gen.h b/include/osmocom/tlv/tlv_gen.h new file mode 100644 index 0000000..9537371 --- /dev/null +++ b/include/osmocom/tlv/tlv_gen.h @@ -0,0 +1,111 @@ +/* Write h and c source files for TLV protocol definitions, based on very sparse TLV definitions. + * For a usage example see tests/libosmo-tlv/test_tlv_gen/. */ +#pragma once + +#include <stdbool.h> + +struct osmo_tlv_gen_ie; + +/*! Modifier for Mandatory/Optional/Multiple around an osmo_tlv_gen_ie. */ +struct osmo_tlv_gen_ie_o { + /*! Whether to add a bool foo_present, and to skip the coding if false. */ + bool optional; + /*! If non-null, the member is an array: foo[123] with an unsigned int foo_count. + * Set to the maximum number of array elements. */ + unsigned int multi; + /*! IE decoding / encoding instructions */ + const struct osmo_tlv_gen_ie *ie; +}; + +/*! Define decoding and encoding of a single IE, i.e. one full TLV. */ +struct osmo_tlv_gen_ie { + /*! Member name. + * The C name of the member in a decoded struct. + * Some other names, if NULL, are derived from this name. + * + * For example, simply this + * + * struct osmo_tlv_gen_ie bar { + * .name = "bar", + * }; + * + * Generates an osmo_tlv_coding entry of + * + * { MYPROTO_IEI_BAR, + * .memb_ofs = offsetof(struct myproto_foo, bar), + * .dec_func = myproto_dec_bar, + * .enc_func = myproto_enc_bar, + * } + */ + const char *name; + + /*! like "uint32_t". + * If NULL, auto-generate a "struct myproto_ie_foo" instead, useful only for an IE that contains nested IEs + * where the struct members can be derived from the nested_ies list. + */ + const char *decoded_type; + + /*! C name of this tag value, e.g. "MYPROTO_IEI_FOO". If NULL, take "MYPROTO_IEI_"+upper(name) instead. */ + const char *tag_name; + + /*! Name of the dec/enc functions. "foo" -> myproto_dec_foo(), myproto_enc_foo(). + * These functions need to be implemented by the caller in a myproto_ies_custom.c. */ + const char *dec_enc; + + /*! Name of the enc_to_str function. "foo" -> myproto_enc_to_str_foo(). optional. */ + const char *to_str; + + /*! List of inner IEs terminated by {0}. If non-NULL, this is a "Grouped IE" with an inner TLV structure inside + * this IE's V part. */ + const struct osmo_tlv_gen_ie_o *nested_ies; + + /*! To place a spec comment in the generated code. */ + const char *spec_ref; +}; + +/*! General TLV decoding and encoding definitions applying to all IEs (and nested IEs). */ +struct osmo_tlv_gen_cfg { + /*! Name of the protocol for use in C type or function names, like "myproto". */ + const char *proto_name; + + /*! When placing comments to spec references, prefix with this. For example, "3GPP TS 12.345 ". */ + const char *spec_ref_prefix; + + /*! The type to pass a message discriminator as, like 'enum myproto_message_types' */ + const char *message_type_enum; + /*! To reference a message type discriminator like MYPROTO_MSGT_FOO, this would be "MYPROTO_MSGT_". */ + const char *message_type_prefix; + + /*! Type to use to represent tag IEI in decoded form. + * For example "enum foo_msg_iei". */ + const char *tag_enum; + /*! The tag IEI enum value is uppercase(tag_prefix + (iedef->tag_name or iedef->name)). + * For example, with tag_prefix = "OSMO_FOO_IEI_", we would generate code like + * enum osmo_foo_iei tag = OSMO_FOO_IEI_BAR; */ + const char *tag_prefix; + + /*! When an osmo_tlv_gen_ie provides no decoded_type string, it is derived from .name and this prefix is + * added. For example, with decoded_type_prefix = "struct foo_ie_", the decoded_type defaults to + * struct foo_ie_bar for an IE definition with name = "bar". */ + const char *decoded_type_prefix; + + /*! To include user defined headers, set to something like "#include <osmocom/foo/foo_tlv_devs.h". This is put at + * the head of the generated .h file. */ + const char *h_header; + + /*! To include user defined headers, set to something like "#include <osmocom/foo/foo_msg.h". This is put at + * the head of the generated .c file. */ + const char *c_header; + + /*! Array of message IE definitions, indexed by message type. */ + const struct osmo_tlv_gen_msg *msg_defs; +}; + +/*! For generating the outer union that composes a protocol's PDU variants, an entry of the list of message names and + * IEs in each message. */ +struct osmo_tlv_gen_msg { + const char *name; + const struct osmo_tlv_gen_ie_o *ies; +}; + +int osmo_tlv_gen_main(const struct osmo_tlv_gen_cfg *cfg, int argc, const char **argv); diff --git a/src/libosmo-tlv/Makefile.am b/src/libosmo-tlv/Makefile.am index 2b8a374..6c3b3d9 100644 --- a/src/libosmo-tlv/Makefile.am +++ b/src/libosmo-tlv/Makefile.am @@ -23,4 +23,5 @@ libosmo_tlv_a_SOURCES = \ tlv.c \ tlv_dec_enc.c \ + tlv_gen.c \ $(NULL) diff --git a/src/libosmo-tlv/tlv_gen.c b/src/libosmo-tlv/tlv_gen.c new file mode 100644 index 0000000..17c5588 --- /dev/null +++ b/src/libosmo-tlv/tlv_gen.c @@ -0,0 +1,385 @@ +/* Write h and c source files for TLV protocol definitions, based on very sparse TLV definitions. + * For a usage example see tests/libosmo-tlv/test_tlv_gen/. + * + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <string.h> + +#include <osmocom/core/linuxlist.h> +#include <osmocom/core/talloc.h> +#include <osmocom/core/utils.h> + +#include <osmocom/tlv/tlv_gen.h> + +static const struct osmo_tlv_gen_cfg *g_cfg = NULL; + +/* Helps avoid redundant defintions of the same type. */ +struct seen_entry { + struct llist_head entry; + char str[256]; +}; +static LLIST_HEAD(seen_list); + +static bool seen(const char *str) +{ + struct seen_entry *s; + llist_for_each_entry(s, &seen_list, entry) { + if (!strcmp(s->str, str)) + return true; + } + s = talloc_zero(NULL, struct seen_entry); + OSMO_STRLCPY_ARRAY(s->str, str); + llist_add(&s->entry, &seen_list); + return false; +} +static void clear_seen() +{ + struct seen_entry *s; + while ((s = llist_first_entry_or_null(&seen_list, struct seen_entry, entry))) { + llist_del(&s->entry); + talloc_free(s); + } +} + +/* Return "struct foo_ie_bar" from g_cfg->decoded_type_prefix and ie. */ +static inline const char *decoded_type(const struct osmo_tlv_gen_ie *ie) +{ + static char b[255]; + if (ie->decoded_type) + return ie->decoded_type; + /* "struct foo_ie_" + "bar" = struct foo_ie_bar*/ + snprintf(b, sizeof(b), "%s%s", g_cfg->decoded_type_prefix, ie->tag_name ? : ie->name); + return b; +} + +/* --- .h file --- */ + +/* Write a listing of struct members like + * bool foo_present; + * int foo; + * struct myproto_ie_bar bar; + * struct abc abc[10]; + * int abc_count; + */ +static void write_ie_members(const struct osmo_tlv_gen_ie_o ies[]) +{ + for (; ies->ie; ies++) { + const struct osmo_tlv_gen_ie *ie = ies->ie; + if (ies->optional) + printf("\tbool %s_present;\n", ie->name); + printf("\t%s %s", decoded_type(ie), ie->name); + if (ies->multi) { + printf("[%u];\n", ies->multi); + printf("\tunsigned int %s_count", ie->name); + } + printf(";\n"); + } +} + +/* Traverse nesting levels in the message definitions and generate the structs for all as needed. */ +static void write_ie_auto_structs(const struct osmo_tlv_gen_ie_o ies[]) +{ + if (!ies) + return; + for (; ies->ie; ies++) { + const struct osmo_tlv_gen_ie *ie = ies->ie; + if (!ie->nested_ies) + continue; + /* Recurse to write inner layers first, so that they can be referenced in outer layers. */ + write_ie_auto_structs(ie->nested_ies); + + /* Various IE definitions can use the same underlying type. Only generate each type once. */ + if (seen(decoded_type(ie))) + continue; + + /* Print: + * + * \* spec ref *\ + * struct myproto_ie_goo { + * bool foo_present; + * int foo; + * struct myproto_ie_bar bar; + * struct abc abc[10]; + * int abc_count; + * }; + */ + printf("\n"); + if (ie->spec_ref) + printf("/* %s%s */\n", g_cfg->spec_ref_prefix, ie->spec_ref); + printf("%s {\n", decoded_type(ie)); + write_ie_members(ie->nested_ies); + printf("};\n"); + } +} + +/* Write all auto-generated structs, starting with the outer message definitions and nesting into all contained IE + * definitions. */ +static void write_auto_structs() +{ + const struct osmo_tlv_gen_msg *gen_msg; + clear_seen(); + for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { + write_ie_auto_structs(gen_msg->ies); + } +} + +/* Write the struct definitions for each message, i.e. for each entry in the outer PDU's message union, as well as the + * union itself. + * + * struct myproto_msg_foo { + * ... + * }: + * struct myproto_msg_goo { + * ... + * }; + * union myproto_ies { + * myproto_msg_foo foo; + * myproto_msg_goo goo; + * }; + */ +static void write_msg_union() { + const struct osmo_tlv_gen_msg *gen_msg; + for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { + /* "struct foo_msg" + "_%s" { * + * struct foo_msg_goo_request { ... }; */ + printf("\nstruct %s_msg_%s {\n", + g_cfg->proto_name, + gen_msg->name); + write_ie_members(gen_msg->ies); + printf("};\n"); + } + + printf("\nunion %s_ies {\n", g_cfg->proto_name); + for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { + printf("\tstruct %s_msg_%s %s;\n", g_cfg->proto_name, + gen_msg->name, gen_msg->name); + } + printf("};\n"); +} + +/* Write the C header, myproto_ies_auto.h */ +static void write_h() +{ + printf("/* THIS FILE IS GENERATED FROM %s */\n", __FILE__); + printf("#include <stdint.h>\n"); + printf("#include <osmocom/tlv/tlv_dec_enc.h>\n"); + if (g_cfg->h_header) + printf("\n%s\n", g_cfg->h_header); + write_auto_structs(); + write_msg_union(); + printf("\nconst struct osmo_tlv_coding *%s_get_msg_coding(%s message_type);\n", + g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); + printf("\n" + "int %s_ies_decode(union %s_ies *dst, struct osmo_tlv_load *tlv, bool tlv_ordered,\n" + " %s message_type, osmo_tlv_err_cb err_cb, const struct value_string *iei_strs);\n", + g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); + printf("\n" + "int %s_ies_encode(struct osmo_tlv_put *tlv, union %s_ies *src,\n" + " %s message_type, osmo_tlv_err_cb err_cb, const struct value_string *iei_strs);\n", + g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); +} + +/* --- .c file --- */ + +/* Write a listing of: + * extern int myproto_dec_foo(...); + * extern int myproto_enc_foo(...); + */ +static void write_extern_dec_enc(const struct osmo_tlv_gen_ie_o *ies) +{ + for (; ies->ie; ies++) { + const struct osmo_tlv_gen_ie *ie = ies->ie; + const char *dec_enc = ie->dec_enc ? : (ie->tag_name ? : ie->name); + if (ie->nested_ies) { + write_extern_dec_enc(ie->nested_ies); + continue; + } + if (seen(dec_enc)) + continue; + printf("extern int %s_dec_%s(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv);\n", + g_cfg->proto_name, dec_enc); + printf("extern int %s_enc_%s(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from);\n", + g_cfg->proto_name, dec_enc); + if (ie->to_str) + printf("extern int %s_enc_to_str_%s(char *buf, size_t buflen, void *encode_from);\n", + g_cfg->proto_name, ie->to_str); + } +} + +/* For a nested IE, write the struct osmo_tlv_coding array of the inner IEs. + * { MYPROTO_IEI_BAR, + * .memb_ofs = offsetof(struct myproto_foo, bar), + * .dec_func = myproto_dec_bar, + * .enc_func = myproto_enc_bar, + * }, + */ +static void write_ies_array(const char *indent, const struct osmo_tlv_gen_ie_o *ies, const char *obj_type, const char *substruct) +{ +#define printi(FMT, ARGS...) printf("%s" FMT, indent, ##ARGS) + + for (; ies->ie; ies++) { + const struct osmo_tlv_gen_ie *ie = ies->ie; + const char *tag_name = ie->tag_name ? : ie->name; + printi("{ %s%s,\n", g_cfg->tag_prefix, osmo_str_toupper(tag_name)); + printi(" .memb_ofs = offsetof(%s, %s%s),\n", obj_type, substruct, ie->name); + if (ie->nested_ies) { + printi(" .nested_ies = ies_in_%s,\n", ie->name); + } else { + const char *dec_enc = ie->dec_enc ? : (ie->tag_name ? : ie->name); + printi(" .dec_func = %s_dec_%s,\n", g_cfg->proto_name, dec_enc); + printi(" .enc_func = %s_enc_%s,\n", g_cfg->proto_name, dec_enc); + if (ie->to_str) + printi(" .enc_to_str_func = %s_enc_to_str_%s,\n", g_cfg->proto_name, ie->to_str); + } + if (ies->multi) { + printi(" .memb_array_pitch = OSMO_MEMB_ARRAY_PITCH(%s, %s%s),\n", + obj_type, substruct, ie->name); + printi(" .has_count = true, .max_count = %u,\n", ies->multi); + printi(" .count_ofs = offsetof(%s, %s%s_count),\n", obj_type, substruct, ie->name); + } + if (ies->optional) { + printi(" .has_presence_flag = true,\n"); + printi(" .presence_flag_ofs = offsetof(%s, %s%s_present),\n", obj_type, substruct, ie->name); + } + printi("},\n"); + } +} + +/* For a nested IE, write the struct osmo_tlv_coding array of the inner IEs. + * static const struct osmo_tlv_coding ies_in_foo[] = { + * { MYPROTO_IEI_BAR, + * .memb_ofs = offsetof(struct myproto_foo, bar), + * .dec_func = myproto_dec_bar, + * .enc_func = myproto_enc_bar, + * }, + * ... + * }; + */ +static void write_nested_ies_array(const struct osmo_tlv_gen_ie_o *ies) +{ + const char *indent = "\t"; + for (; ies->ie; ies++) { + const struct osmo_tlv_gen_ie *ie = ies->ie; + if (!ie->nested_ies) + continue; + write_nested_ies_array(ie->nested_ies); + + if (seen(ie->name)) + continue; + + printf("\nstatic const struct osmo_tlv_coding ies_in_%s[] = {\n", ie->name); + write_ies_array(indent, ie->nested_ies, decoded_type(ie), ""); + printi("{0}\n"); + printf("};\n"); + } +} + +/* Write the bulk of the C code: on the basis of the list of messages (g_cfg->msg_defs), write all dec/enc function + * declarations, all IEs arrays as well as the list of message types, first triggering to write the C code for any inner + * layers. */ +static void write_c() +{ + const struct osmo_tlv_gen_msg *gen_msg; + + printf("/* THIS FILE IS GENERATED FROM %s */\n", __FILE__); + printf("#include <stddef.h>\n"); + printf("#include <errno.h>\n"); + printf("#include <osmocom/core/utils.h>\n"); + printf("#include <osmocom/tlv/tlv.h>\n"); + printf("#include <osmocom/tlv/tlv_dec_enc.h>\n"); + printf("#include <osmocom/tlv/tlv_gen.h>\n"); + if (g_cfg->c_header) + printf("\n%s\n", g_cfg->c_header); + + printf("\n"); + clear_seen(); + for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { + write_extern_dec_enc(gen_msg->ies); + } + + clear_seen(); + for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { + write_nested_ies_array(gen_msg->ies); + } + + for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { + char *obj_type = talloc_asprintf(NULL, "union %s_ies", g_cfg->proto_name); + char *substruct = talloc_asprintf(NULL, "%s.", gen_msg->name); + printf("\nstatic const struct osmo_tlv_coding ies_in_msg_%s[] = {\n", gen_msg->name); + write_ies_array("\t", gen_msg->ies, obj_type, substruct); + printf("\t{0}\n};\n"); + talloc_free(substruct); + talloc_free(obj_type); + } + printf("\nstatic const struct osmo_tlv_coding *msg_defs[] = {\n"); + for (gen_msg = g_cfg->msg_defs; gen_msg->name; gen_msg++) { + printf("\t[%s%s] = ies_in_msg_%s,\n", g_cfg->message_type_prefix, osmo_str_toupper(gen_msg->name), gen_msg->name); + } + printf("};\n"); + + /* print this code snippet into the .c file, because only there can we do ARRAY_SIZE(foo_msg_coding). */ + printf("\n" + "const struct osmo_tlv_coding *%s_get_msg_coding(%s message_type)\n" + "{\n" + " if (message_type >= ARRAY_SIZE(msg_defs))\n" + " return NULL;\n" + " return msg_defs[message_type];\n" + "}\n", + g_cfg->proto_name, g_cfg->message_type_enum ? : "int"); + + printf("\n" + "int %s_ies_decode(union %s_ies *dst, struct osmo_tlv_load *tlv, bool tlv_ordered,\n" + " %s message_type,\n" + " osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)\n" + "{\n" + " return osmo_tlvs_decode(dst, 0, tlv, tlv_ordered, %s_get_msg_coding(message_type), err_cb, iei_strs);\n" + "}\n", + g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int", g_cfg->proto_name); + printf("\n" + "int %s_ies_encode(struct osmo_tlv_put *tlv, union %s_ies *src,\n" + " %s message_type, osmo_tlv_err_cb err_cb, const struct value_string *iei_strs)\n" + "{\n" + " return osmo_tlvs_encode(tlv, src, 0, %s_get_msg_coding(message_type), err_cb, iei_strs);\n" + "}\n", + g_cfg->proto_name, g_cfg->proto_name, g_cfg->message_type_enum ? : "int", g_cfg->proto_name); +} + +/* Call this from your main(). */ +int osmo_tlv_gen_main(const struct osmo_tlv_gen_cfg *cfg, int argc, const char **argv) +{ + if (argc < 2) + return 1; + + g_cfg = cfg; + + if (strcmp(argv[1], "h") == 0) + write_h(); + else if (strcmp(argv[1], "c") == 0) + write_c(); + else + return 1; + + clear_seen(); + return 0; +} diff --git a/tests/libosmo-tlv/Makefile.am b/tests/libosmo-tlv/Makefile.am index ff3fba9..64e3bdd 100644 --- a/tests/libosmo-tlv/Makefile.am +++ b/tests/libosmo-tlv/Makefile.am @@ -1,3 +1,7 @@ +SUBDIRS = \ + test_tlv_gen \ + $(NULL) + AM_CPPFLAGS = \ $(all_includes) \ -I$(top_srcdir)/include \ @@ -40,3 +44,4 @@ update_exp: $(builddir)/tlv_test >$(srcdir)/tlv_test.ok $(builddir)/tlv_dec_enc_test >$(srcdir)/tlv_dec_enc_test.ok + $(MAKE) -C test_tlv_gen update_exp diff --git a/tests/libosmo-tlv/test_tlv_gen/Makefile.am b/tests/libosmo-tlv/test_tlv_gen/Makefile.am new file mode 100644 index 0000000..79c925c --- /dev/null +++ b/tests/libosmo-tlv/test_tlv_gen/Makefile.am @@ -0,0 +1,60 @@ +AM_CPPFLAGS = \ + $(all_includes) \ + -I$(top_srcdir)/include \ + -I$(bulddir) \ + $(NULL) + +AM_CFLAGS = \ + -Wall \ + $(LIBOSMOCORE_CFLAGS) \ + $(NULL) + +noinst_PROGRAMS = \ + gen__myproto_ies_auto \ + tlv_gen_test \ + $(NULL) + +EXTRA_DIST = \ + myproto_ies_custom.h \ + tlv_gen_test.ok \ + $(NULL) + +BUILT_SOURCES = \ + myproto_ies_auto.h \ + myproto_ies_auto.c \ + $(NULL) + +CLEANFILES = \ + myproto_ies_auto.h \ + myproto_ies_auto.c \ + $(NULL) + +gen__myproto_ies_auto_SOURCES = \ + gen__myproto_ies_auto.c \ + myproto_ies_custom.c \ + $(NULL) + +gen__myproto_ies_auto_LDADD = \ + $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \ + $(LIBOSMOCORE_LIBS) \ + $(NULL) + +myproto_ies_auto.h: $(builddir)/gen__myproto_ies_auto + $(builddir)/gen__myproto_ies_auto h > $(builddir)/myproto_ies_auto.h +myproto_ies_auto.c: $(builddir)/gen__myproto_ies_auto + $(builddir)/gen__myproto_ies_auto c > $(builddir)/myproto_ies_auto.c + +tlv_gen_test_SOURCES = \ + tlv_gen_test.c \ + myproto_ies_custom.c \ + myproto_ies_auto.c \ + $(NULL) + +tlv_gen_test_LDADD = \ + $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \ + $(LIBOSMOCORE_LIBS) \ + $(NULL) + +.PHONY: update_exp +update_exp: + $(builddir)/tlv_gen_test >$(srcdir)/tlv_gen_test.ok diff --git a/tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c b/tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c new file mode 100644 index 0000000..1d5ea4a --- /dev/null +++ b/tests/libosmo-tlv/test_tlv_gen/gen__myproto_ies_auto.c @@ -0,0 +1,135 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <stdbool.h> +#include <stdio.h> +#include <osmocom/core/utils.h> +#include <osmocom/core/linuxlist.h> +#include <osmocom/core/talloc.h> +#include <osmocom/tlv/tlv_gen.h> + +#define O(IE_INST) { .optional = true, .ie = &IE_INST } +#define M(IE_INST) { .ie = &(IE_INST) } +#define MULTI(MAX, IE_INST) { .multi = MAX, .ie = &(IE_INST) } + +static const struct osmo_tlv_gen_ie foo = { + .name = "foo", + .decoded_type = "int", /* adds 'int foo;' to the struct */ + .dec_enc = "u16", /* uses myproto_dec_u16() and myproto_enc_u16() for the TLV value part */ + .to_str = "u16", /* uses myproto_enc_to_str_u16() */ + .spec_ref = "an int coded as uint16_t", +}; + +static const struct osmo_tlv_gen_ie bar = { + .name = "bar", + /* uses 'struct ie_bar bar;' and dec_bar()/enc_bar() */ + .to_str = "bar", /* uses myproto_enc_to_str_bar() */ +}; + +static const struct osmo_tlv_gen_ie baz = { + .name = "baz", + /* uses 'struct ie_baz baz;' and dec_baz()/enc_baz() */ + .to_str = "baz", +}; + +static const struct osmo_tlv_gen_ie repeat_int = { + .name = "repeat_int", + .decoded_type = "int", /* adds 'int repeat_int;' to the struct */ + .dec_enc = "u16", /* uses dec_u16() and enc_u16() for the TLV value part */ + .to_str = "u16", +}; + +static const struct osmo_tlv_gen_ie repeat_struct = { + .name = "repeat_struct", + .to_str = "repeat_struct", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_moo_nest[] = { + M(foo), + M(bar), + M(baz), + {0} +}; + +static const struct osmo_tlv_gen_ie moo_nest = { + .name = "moo_nest", + .nested_ies = ies_in_moo_nest, +}; + +static const struct osmo_tlv_gen_ie val = { + .name = "val", + .decoded_type = "uint64_t", + .dec_enc = "u64", + .to_str = "u64", +}; + +static const struct osmo_tlv_gen_ie_o ies_in_goo_nest[] = { + O(val), + M(moo_nest), + {0} +}; + +static const struct osmo_tlv_gen_ie goo_nest = { + .name = "goo_nest", + .nested_ies = ies_in_goo_nest, +}; + +static const struct osmo_tlv_gen_ie_o ies_in_moo_msg[] = { + M(foo), + M(bar), + O(baz), + MULTI(32, repeat_int), + MULTI(32, repeat_struct), + O(moo_nest), + {0} +}; + +static const struct osmo_tlv_gen_ie_o ies_in_goo_msg[] = { + M(foo), + O(bar), + MULTI(8, goo_nest), + {0} +}; + +static const struct osmo_tlv_gen_msg msg_defs[] = { + { "moo", ies_in_moo_msg }, + { "goo", ies_in_goo_msg }, + {0} +}; + +int main(int argc, const char **argv) +{ + struct osmo_tlv_gen_cfg cfg = { + .proto_name = "myproto", + .message_type_enum = "enum myproto_msg_type", + .message_type_prefix = "MYPROTO_MSGT_", + .tag_enum = "enum myproto_iei", + .tag_prefix = "MYPROTO_IEI_", + .decoded_type_prefix = "struct myproto_ie_", + .h_header = "#include \"myproto_ies_custom.h\"", + .c_header = "#include <myproto_ies_auto.h>", + .msg_defs = msg_defs, + }; + return osmo_tlv_gen_main(&cfg, argc, argv); +} diff --git a/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c new file mode 100644 index 0000000..c45eae5 --- /dev/null +++ b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.c @@ -0,0 +1,156 @@ +#include <errno.h> +#include <inttypes.h> + +#include <osmocom/core/bits.h> +#include <osmocom/core/msgb.h> +#include <osmocom/tlv/tlv.h> + +#include <myproto_ies_custom.h> + +int myproto_dec_u16(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + int *foo = decode_to; + if (tlv->len != 2) + return -EINVAL; + *foo = osmo_load16be(tlv->val); + return 0; +} + +int myproto_enc_u16(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + int *foo = encode_from; + if (*foo > INT16_MAX) + return -EINVAL; + msgb_put_u16(tlv->dst, *foo); + return 0; +} + +int myproto_enc_to_str_u16(char *buf, size_t buflen, void *encode_from) +{ + int *foo = encode_from; + return snprintf(buf, buflen, "%d", *foo); +} + +int myproto_dec_u64(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + uint64_t *val = decode_to; + if (tlv->len != sizeof(uint64_t)) + return -EINVAL; + *val = osmo_load64be(tlv->val); + return 0; +} + +int myproto_enc_u64(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + uint64_t *val = encode_from; + osmo_store64be(*val, msgb_put(tlv->dst, sizeof(*val))); + return 0; +} + +int myproto_enc_to_str_u64(char *buf, size_t buflen, void *encode_from) +{ + uint64_t *val = encode_from; + return snprintf(buf, buflen, "0x%"PRIx64, *val); +} + +int myproto_dec_bar(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct myproto_ie_bar *bar = decode_to; + if (tlv->len > sizeof(bar->str) - 1) + return -EINVAL; + osmo_strlcpy(bar->str, (const char*)tlv->val, OSMO_MIN(tlv->len + 1, sizeof(bar->str))); + return 0; +} + +int myproto_enc_bar(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct myproto_ie_bar *bar = encode_from; + int len = strnlen(bar->str, sizeof(bar->str)); + memcpy(msgb_put(tlv->dst, len), bar, len); + return 0; +} + +int myproto_enc_to_str_bar(char *buf, size_t buflen, void *encode_from) +{ + struct myproto_ie_bar *bar = encode_from; + return osmo_quote_str_buf3(buf, buflen, bar->str, -1); +} + +int myproto_dec_baz(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct myproto_ie_baz *baz = decode_to; + uint16_t l; + if (tlv->len != 2) + return -EINVAL; + l = osmo_load16be(tlv->val); + baz->v_int = l & 0x7fff; + baz->v_bool = (l & 0x8000) ? true : false; + return 0; +} + +int myproto_enc_baz(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct myproto_ie_baz *baz = encode_from; + if (baz->v_int > 0x7fff) + return -EINVAL; + msgb_put_u16(tlv->dst, (baz->v_bool ? 0x8000 : 0) + (baz->v_int & 0x7fff)); + return 0; +} + +int myproto_enc_to_str_baz(char *buf, size_t buflen, void *encode_from) +{ + struct myproto_ie_baz *baz = encode_from; + return snprintf(buf, buflen, "{%d,%s}", baz->v_int, baz->v_bool ? "true" : "false"); +} + +int myproto_dec_repeat_struct(void *decoded_struct, void *decode_to, const struct osmo_tlv_load *tlv) +{ + struct myproto_ie_repeat_struct *repeat_struct = decode_to; + if (tlv->len != 3) + return -EINVAL; + repeat_struct->v_int = osmo_load16be(tlv->val); + repeat_struct->v_bool = tlv->val[2] & 0x80; + repeat_struct->v_enum = tlv->val[2] & 0x7f; + return 0; +} + +int myproto_enc_repeat_struct(struct osmo_tlv_put *tlv, void *decoded_struct, void *encode_from) +{ + struct myproto_ie_repeat_struct *repeat_struct = encode_from; + msgb_put_u16(tlv->dst, repeat_struct->v_int); + msgb_put_u8(tlv->dst, (repeat_struct->v_bool ? 0x80 : 0) + (repeat_struct->v_enum & 0x7f)); + return 0; +} + +int myproto_enc_to_str_repeat_struct(char *buf, size_t buflen, void *encode_from) +{ + struct myproto_ie_repeat_struct *repeat_struct = encode_from; + return snprintf(buf, buflen, "{%d,%s,%s}", + repeat_struct->v_int, repeat_struct->v_bool ? "true" : "false", + get_value_string(myproto_repeat_enum_names, repeat_struct->v_enum)); +} + +const struct value_string myproto_msg_type_names[] = { + { MYPROTO_MSGT_MOO, "MOO" }, + { MYPROTO_MSGT_GOO, "GOO" }, + {0} +}; + +const struct value_string myproto_iei_names[] = { + { MYPROTO_IEI_FOO, "FOO" }, + { MYPROTO_IEI_BAR, "BAR" }, + { MYPROTO_IEI_BAZ, "BAZ" }, + { MYPROTO_IEI_REPEAT_INT, "REPEAT_INT" }, + { MYPROTO_IEI_REPEAT_STRUCT, "REPEAT_STRUCT" }, + { MYPROTO_IEI_MOO_NEST, "MOO_NEST" }, + { MYPROTO_IEI_VAL, "VAL" }, + { MYPROTO_IEI_GOO_NEST, "GOO_NEST" }, + {0} +}; + +const struct value_string myproto_repeat_enum_names[] = { + OSMO_VALUE_STRING(R_A), + OSMO_VALUE_STRING(R_B), + OSMO_VALUE_STRING(R_C), + {0} +}; diff --git a/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h new file mode 100644 index 0000000..bf65f4d --- /dev/null +++ b/tests/libosmo-tlv/test_tlv_gen/myproto_ies_custom.h @@ -0,0 +1,47 @@ +/* Definitions for decoded message IEs, to be used by the auto-generated tlv_gen_test_tlv.c. */ +#pragma once + +#include <osmocom/core/utils.h> + +enum myproto_msg_type { + MYPROTO_MSGT_MOO = 1, + MYPROTO_MSGT_GOO = 7, +}; + +extern const struct value_string myproto_msg_type_names[]; + +enum myproto_iei { + MYPROTO_IEI_FOO = 1, + MYPROTO_IEI_BAR, + MYPROTO_IEI_BAZ, + MYPROTO_IEI_REPEAT_INT, + MYPROTO_IEI_REPEAT_STRUCT, + MYPROTO_IEI_MOO_NEST, + MYPROTO_IEI_VAL, + MYPROTO_IEI_GOO_NEST, +}; + +extern const struct value_string myproto_iei_names[]; + +struct myproto_ie_bar { + char str[23]; +}; + +struct myproto_ie_baz { + int v_int; + bool v_bool; +}; + +enum myproto_repeat_enum { + R_A, + R_B, + R_C, +}; + +extern const struct value_string myproto_repeat_enum_names[]; + +struct myproto_ie_repeat_struct { + int v_int; + bool v_bool; + enum myproto_repeat_enum v_enum; +}; diff --git a/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c new file mode 100644 index 0000000..4135f50 --- /dev/null +++ b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.c @@ -0,0 +1,256 @@ +/* (C) 2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +#include <stdio.h> +#include <errno.h> + +#include <osmocom/core/application.h> +#include <osmocom/core/utils.h> +#include <osmocom/core/msgb.h> + +#include <osmocom/tlv/tlv.h> + +#include <myproto_ies_auto.h> + +struct myproto_msg { + enum myproto_msg_type type; + union myproto_ies ies; +}; + +static void err_cb(void *decoded_struct, const char *file, int line, const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + //printf("ERR: %s:%d ", file, line); + printf("ERR: "); + vprintf(fmt, args); + va_end(args); +} + +static int myproto_msg_enc(struct msgb *dst, const struct myproto_msg *msg, const struct osmo_tlv_cfg *cfg) +{ + struct osmo_tlv_put tlv = { + .cfg = cfg, + .dst = dst, + }; + + msgb_put_u8(tlv.dst, msg->type); + return myproto_ies_encode(&tlv, (void*)&msg->ies, msg->type, err_cb, myproto_iei_names); +} + +static int myproto_msg_dec(struct myproto_msg *msg, const uint8_t *data, size_t data_len, + const struct osmo_tlv_cfg *cfg, bool ordered) +{ + struct osmo_tlv_load tlv; + if (data_len < 1) + return -EINVAL; + msg->type = data[0]; + tlv = (struct osmo_tlv_load){ + .cfg = cfg, + .src = { data + 1, data_len - 1 }, + }; + return myproto_ies_decode(&msg->ies, &tlv, ordered, msg->type, err_cb, myproto_iei_names); +} + +void *ctx; + +struct myproto_msg tests[] = { + { + MYPROTO_MSGT_MOO, + { + .moo = { + .foo = 23, + .bar = { "twentythree" }, + }, + }, + }, + { + MYPROTO_MSGT_MOO, + { + .moo = { + .foo = 23, + .bar = { "twentythree" }, + + .baz_present = true, + .baz = { + .v_int = 2323, + .v_bool = true, + }, + }, + }, + }, + { + MYPROTO_MSGT_MOO, + { + .moo = { + .foo = 23, + .bar = { "twentythree" }, + + .baz_present = true, + .baz = { + .v_int = 2323, + .v_bool = true, + }, + + .repeat_int_count = 3, + .repeat_int = { 1, 2, 0x7fff }, + }, + }, + }, + { + MYPROTO_MSGT_MOO, + { + .moo = { + .foo = 23, + .bar = { "twentythree" }, + + .baz_present = true, + .baz = { + .v_int = 2323, + .v_bool = true, + }, + + .repeat_int_count = 3, + .repeat_int = { 1, 2, 0x7fff }, + + .repeat_struct_count = 2, + .repeat_struct = { + { + .v_int = 1001, + .v_bool = true, + .v_enum = R_A, + }, + { + .v_int = 1002, + .v_bool = false, + .v_enum = R_B, + }, + }, + + .moo_nest_present = true, + .moo_nest = { + .foo = 42, + .bar = { "fortytwo" }, + .baz = { + .v_int = 4242, + .v_bool = false, + }, + }, + }, + }, + }, + { + MYPROTO_MSGT_GOO, + { + .goo = { + .foo = 17, + + .bar_present = true, + .bar = { "gooei" }, + + .goo_nest_count = 2, + .goo_nest = { + { + .val_present = true, + .val = 0x0123456789abcdef, + .moo_nest = { + .foo = 11, + .bar = { "eleven" }, + .baz = { + .v_int = 1111, + .v_bool = true, + }, + }, + }, + { + .val_present = false, + .moo_nest = { + .foo = 12, + .bar = { "twelve" }, + .baz = { + .v_int = 1212, + .v_bool = false, + }, + }, + }, + }, + }, + }, + }, +}; + +int myproto_msg_to_str_buf(char *buf, size_t buflen, const struct myproto_msg *m) +{ + struct osmo_strbuf sb = { .buf = buf, .len = buflen }; + OSMO_STRBUF_PRINTF(sb, "%s={", get_value_string(myproto_msg_type_names, m->type)); + OSMO_STRBUF_APPEND(sb, osmo_tlvs_encode_to_str_buf, &m->ies, 0, myproto_get_msg_coding(m->type), + myproto_iei_names); + OSMO_STRBUF_PRINTF(sb, " }"); + return sb.chars_needed; + +} + +char *myproto_msg_to_str(const struct myproto_msg *m) +{ + OSMO_NAME_C_IMPL(ctx, 256, "ERROR", myproto_msg_to_str_buf, m) +} + +void test_enc_dec(const char *label, const struct osmo_tlv_cfg *cfg, bool ordered) +{ + int i; + for (i = 0; i < ARRAY_SIZE(tests); i++) { + int rc; + const struct myproto_msg *orig = &tests[i]; + struct myproto_msg parsed = {0}; + struct msgb *msg; + + printf("\n=== start %s %s[%d]\n", label, __func__, i); + printf("encoded: %s\n", myproto_msg_to_str(orig)); + + msg = msgb_alloc(1024, __func__), + rc = myproto_msg_enc(msg, orig, cfg); + printf("myproto_msg_enc() rc = %d\n", rc); + printf("%s.\n", osmo_hexdump(msg->data, msg->len)); + + rc = myproto_msg_dec(&parsed, msg->data, msg->len, cfg, ordered); + printf("myproto_msg_dec() rc = %d\n", rc); + printf("decoded: %s\n", myproto_msg_to_str(&parsed)); + if (strcmp(myproto_msg_to_str(orig), myproto_msg_to_str(&parsed))) { + printf(" ERROR: parsed != orig\n"); + exit(1); + } + + msgb_free(msg); + printf("=== end %s %s[%d]\n", label, __func__, i); + } +} + +int main() +{ + ctx = talloc_named_const(NULL, 0, "test_gen_tlv"); + msgb_talloc_ctx_init(ctx, 0); + + test_enc_dec("t8l8v ordered", &osmo_t8l8v_cfg, true); + test_enc_dec("t8l8v unordered", &osmo_t8l8v_cfg, false); + + test_enc_dec("t16l16v ordered", &osmo_t16l16v_cfg, true); + test_enc_dec("t16l16v unordered", &osmo_t16l16v_cfg, false); + + talloc_free(ctx); + return 0; +} diff --git a/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok new file mode 100644 index 0000000..9974d67 --- /dev/null +++ b/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok @@ -0,0 +1,160 @@ + +=== start t8l8v ordered test_enc_dec[0] +encoded: MOO={ FOO=23 BAR="twentythree" } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" } +=== end t8l8v ordered test_enc_dec[0] + +=== start t8l8v ordered test_enc_dec[1] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +=== end t8l8v ordered test_enc_dec[1] + +=== start t8l8v ordered test_enc_dec[2] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +=== end t8l8v ordered test_enc_dec[2] + +=== start t8l8v ordered test_enc_dec[3] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +=== end t8l8v ordered test_enc_dec[3] + +=== start t8l8v ordered test_enc_dec[4] +encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +myproto_msg_enc() rc = 0 +07 01 02 00 11 02 05 67 6f 6f 65 69 08 1c 07 08 01 23 45 67 89 ab cd ef 06 10 01 02 00 0b 02 06 65 6c 65 76 65 6e 03 02 84 57 08 12 06 10 01 02 00 0c 02 06 74 77 65 6c 76 65 03 02 04 bc . +myproto_msg_dec() rc = 0 +decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +=== end t8l8v ordered test_enc_dec[4] + +=== start t8l8v unordered test_enc_dec[0] +encoded: MOO={ FOO=23 BAR="twentythree" } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" } +=== end t8l8v unordered test_enc_dec[0] + +=== start t8l8v unordered test_enc_dec[1] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +=== end t8l8v unordered test_enc_dec[1] + +=== start t8l8v unordered test_enc_dec[2] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +=== end t8l8v unordered test_enc_dec[2] + +=== start t8l8v unordered test_enc_dec[3] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +myproto_msg_enc() rc = 0 +01 01 02 00 17 02 0b 74 77 65 6e 74 79 74 68 72 65 65 03 02 89 13 04 02 00 01 04 02 00 02 04 02 7f ff 05 03 03 e9 80 05 03 03 ea 01 06 12 01 02 00 2a 02 08 66 6f 72 74 79 74 77 6f 03 02 10 92 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +=== end t8l8v unordered test_enc_dec[3] + +=== start t8l8v unordered test_enc_dec[4] +encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +myproto_msg_enc() rc = 0 +07 01 02 00 11 02 05 67 6f 6f 65 69 08 1c 07 08 01 23 45 67 89 ab cd ef 06 10 01 02 00 0b 02 06 65 6c 65 76 65 6e 03 02 84 57 08 12 06 10 01 02 00 0c 02 06 74 77 65 6c 76 65 03 02 04 bc . +myproto_msg_dec() rc = 0 +decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +=== end t8l8v unordered test_enc_dec[4] + +=== start t16l16v ordered test_enc_dec[0] +encoded: MOO={ FOO=23 BAR="twentythree" } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" } +=== end t16l16v ordered test_enc_dec[0] + +=== start t16l16v ordered test_enc_dec[1] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +=== end t16l16v ordered test_enc_dec[1] + +=== start t16l16v ordered test_enc_dec[2] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +=== end t16l16v ordered test_enc_dec[2] + +=== start t16l16v ordered test_enc_dec[3] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +=== end t16l16v ordered test_enc_dec[3] + +=== start t16l16v ordered test_enc_dec[4] +encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +myproto_msg_enc() rc = 0 +07 00 01 00 02 00 11 00 02 00 05 67 6f 6f 65 69 00 08 00 26 00 07 00 08 01 23 45 67 89 ab cd ef 00 06 00 16 00 01 00 02 00 0b 00 02 00 06 65 6c 65 76 65 6e 00 03 00 02 84 57 00 08 00 1a 00 06 00 16 00 01 00 02 00 0c 00 02 00 06 74 77 65 6c 76 65 00 03 00 02 04 bc . +myproto_msg_dec() rc = 0 +decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +=== end t16l16v ordered test_enc_dec[4] + +=== start t16l16v unordered test_enc_dec[0] +encoded: MOO={ FOO=23 BAR="twentythree" } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" } +=== end t16l16v unordered test_enc_dec[0] + +=== start t16l16v unordered test_enc_dec[1] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} } +=== end t16l16v unordered test_enc_dec[1] + +=== start t16l16v unordered test_enc_dec[2] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } } +=== end t16l16v unordered test_enc_dec[2] + +=== start t16l16v unordered test_enc_dec[3] +encoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +myproto_msg_enc() rc = 0 +01 00 01 00 02 00 17 00 02 00 0b 74 77 65 6e 74 79 74 68 72 65 65 00 03 00 02 89 13 00 04 00 02 00 01 00 04 00 02 00 02 00 04 00 02 7f ff 00 05 00 03 03 e9 80 00 05 00 03 03 ea 01 00 06 00 18 00 01 00 02 00 2a 00 02 00 08 66 6f 72 74 79 74 77 6f 00 03 00 02 10 92 . +myproto_msg_dec() rc = 0 +decoded: MOO={ FOO=23 BAR="twentythree" BAZ={2323,true} REPEAT_INT={ 1, 2, 32767 } REPEAT_STRUCT={ {1001,true,R_A}, {1002,false,R_B} } MOO_NEST={ FOO=42 BAR="fortytwo" BAZ={4242,false} } } +=== end t16l16v unordered test_enc_dec[3] + +=== start t16l16v unordered test_enc_dec[4] +encoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +myproto_msg_enc() rc = 0 +07 00 01 00 02 00 11 00 02 00 05 67 6f 6f 65 69 00 08 00 26 00 07 00 08 01 23 45 67 89 ab cd ef 00 06 00 16 00 01 00 02 00 0b 00 02 00 06 65 6c 65 76 65 6e 00 03 00 02 84 57 00 08 00 1a 00 06 00 16 00 01 00 02 00 0c 00 02 00 06 74 77 65 6c 76 65 00 03 00 02 04 bc . +myproto_msg_dec() rc = 0 +decoded: GOO={ FOO=17 BAR="gooei" GOO_NEST={ { VAL=0x123456789abcdef MOO_NEST={ FOO=11 BAR="eleven" BAZ={1111,true} } }, { MOO_NEST={ FOO=12 BAR="twelve" BAZ={1212,false} } } } } +=== end t16l16v unordered test_enc_dec[4] diff --git a/tests/testsuite.at b/tests/testsuite.at index 3f7fcee..2df6e19 100644 --- a/tests/testsuite.at +++ b/tests/testsuite.at @@ -12,3 +12,9 @@ cat $abs_srcdir/libosmo-tlv/tlv_dec_enc_test.ok > expout AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_dec_enc_test], [], [expout], [ignore]) AT_CLEANUP + +AT_SETUP([tlv_gen]) +AT_KEYWORDS([tlv_gen]) +cat $abs_srcdir/libosmo-tlv/test_tlv_gen/tlv_gen_test.ok > expout +AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/test_tlv_gen/tlv_gen_test], [], [expout], [ignore]) +AT_CLEANUP -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27219 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ifb3ea54d2797ce060b95834aa117725ec2d6c4cf Gerrit-Change-Number: 27219 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in osmo-upf[master]: libosmo-tlv: add versatile TLV de- and encoder

by neels

neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-upf/+/27217 ) Change subject: libosmo-tlv: add versatile TLV de- and encoder ...................................................................... libosmo-tlv: add versatile TLV de- and encoder An all new TLV parser supporting: - Any size of T and L (determined by callback function), - "Grouped IEs", so that an IE payload is a nested IE structure, - optional/mandatory/multi-occurence IEs. Will be used for PFCP message decoding and encoding, a T16L16V protocol which requires above features. Previously, the way we deal with TLVs causes a lot of code re-implementation. The TL decoding is taken care of by the API, but for encoding, we essentially re-implement the TL encoding for each protocol and each encoded message. This API is an improvement in that we only once implement the TL coding (or just use osmo_t8l8v_cfg / osmo_t16l16v_cfg), get symmetric de- and encoding of the TL, and only need to deal with the value part of each IE. The common pattern of - store TL preliminarily, - write V data and - update L after V is complete is conveniently done by osmo_tlv_put_update_tl(). Related: SYS#5599 Change-Id: Ib0fd00d9f288ffe13b7e67701f3e47073587404a --- M configure.ac M include/osmocom/Makefile.am A include/osmocom/tlv/Makefile.am A include/osmocom/tlv/tlv.h M src/Makefile.am A src/libosmo-tlv/Makefile.am A src/libosmo-tlv/tlv.c M tests/Makefile.am A tests/libosmo-tlv/Makefile.am A tests/libosmo-tlv/tlv_test.c A tests/libosmo-tlv/tlv_test.ok M tests/testsuite.at 12 files changed, 1,260 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-upf refs/changes/17/27217/1 diff --git a/configure.ac b/configure.ac index 4995146..70879e9 100644 --- a/configure.ac +++ b/configure.ac @@ -197,11 +197,14 @@ AC_OUTPUT( include/Makefile include/osmocom/Makefile + include/osmocom/tlv/Makefile include/osmocom/upf/Makefile src/Makefile + src/libosmo-tlv/Makefile src/osmo-upf/Makefile tests/Makefile tests/atlocal + tests/libosmo-tlv/Makefile doc/Makefile doc/examples/Makefile doc/manuals/Makefile diff --git a/include/osmocom/Makefile.am b/include/osmocom/Makefile.am index 3f929f1..4d56df0 100644 --- a/include/osmocom/Makefile.am +++ b/include/osmocom/Makefile.am @@ -1,3 +1,4 @@ SUBDIRS = \ + tlv \ upf \ $(NULL) diff --git a/include/osmocom/tlv/Makefile.am b/include/osmocom/tlv/Makefile.am new file mode 100644 index 0000000..f819a41 --- /dev/null +++ b/include/osmocom/tlv/Makefile.am @@ -0,0 +1,5 @@ +tlv_HEADERS = \ + tlv.h \ + $(NULL) + +tlvdir = $(includedir)/osmocom/tlv diff --git a/include/osmocom/tlv/tlv.h b/include/osmocom/tlv/tlv.h new file mode 100644 index 0000000..404bbba --- /dev/null +++ b/include/osmocom/tlv/tlv.h @@ -0,0 +1,139 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#pragma once + +#include <stdint.h> +#include <stdio.h> + +struct msgb; +struct osmo_tlv_load; +struct osmo_tlv_put; + +/*! TL configuration for osmo_tlv_load*() and osmo_tlv_put*(). Depending on these implementations provided by the caller, + * osmo_tlv can load any sizes of tag and length fields (that don't surpass the value range of unsigned int and size_t, + * respectively), as well as TV (fixed-length) or TvLV (variable-sized length). + * + * See osmo_t8l8v_cfg and osmo_t16l16v_cfg, ready implementations for plain 8bit and 16bit TLV protocols. + * + * libosmo-pfcp serves as example for using this entire TLV API, uncluding de/encoding to structs and generating parts + * of the TLV parsing code based on message definitions. It uses osmo_t16l16v_cfg. + */ +struct osmo_tlv_cfg { + /*! The length in bytes of the shortest possible TL header (e.g. 4 for T16L16V, or 1 for 8bit tags where TV IEs + * without a length exist). A src_data_len passed to store_tl() below is guaranteed to be >= this value. If at + * any point there is remaining message data smaller than this value, a parsing error is returned. + */ + size_t tl_min_size; + + /*! Read one TL from the start of src_data. + * \param tag Return the T value read from src_data in *tag. + * \param len Return the L value read from src_data in *len. + * \param val Return the position just after the TL in *val. If there is V data, point at the start of the V + * data in src_data. If there is no V data, point at the byte just after the TL part in src_data. + * \param src_data Part of raw message being decoded. + * \param src_data_len Remaining message data length at src_data. + * \param tlv Backpointer to the osmo_tlv_load struct. + * \return 0 on success, negative on error. + */ + int (*load_tl)(unsigned int *tag, size_t *len, const uint8_t **val, + const uint8_t *src_data, size_t src_data_len, struct osmo_tlv_load *tlv); + + /*! Write a TL to dst_data, and return the size of the TL written. + * This is also invoked by osmo_tlv_put_update_tl() to overwrite a previous TL header. If the TL part's size + * can be different than the first time (e.g. due to a large L value in a TvLV protocol), an implementation can + * use the 'tlv' arg to figure out how to memmove the message data: + * When invoked by osmo_tlv_put_tl(), dst_data == tlv->dst->tail and dst_data_avail == msgb_tailroom(). + * When invoked by osmo_tlv_put_update_tl(), dst_data < tlv->dst->tail, dst_data points at the start of the + * TL section written earlier by osmo_tlv_put_tl() and dst_data_avail == the size of the TL written earlier. + * + * \param dst_data Write TL data to the start of this buffer. + * \param dst_data_avail Remaining available space in dst_data. + * \param tag The T value to store in dst_data. + * \param len The L value to store in dst_data. + * \param tlv Backpointer to the osmo_tlv_put struct, including tlv->dst, the underlying msgb. + * \return the size of the TL part in bytes on success, -EINVAL if tag is invalid, -EMSGSIZE if len is too large + * or dst_data_avail is too small for the TL. + */ + int (*store_tl)(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len, struct osmo_tlv_put *tlv); +}; + +/*! Configuration that allows parsing an 8bit tag and 8bit length TLV. */ +extern const struct osmo_tlv_cfg osmo_t8l8v_cfg; + +/*! Configuration that allows parsing a 16bit tag and 16bit length TLV (see for example PFCP). */ +extern const struct osmo_tlv_cfg osmo_t16l16v_cfg; + +/*! State for loading a TLV structure from raw data. */ +struct osmo_tlv_load { + /*! Caller-defined context pointer available for use by load_tl() and store_tl() implementations. */ + void *priv; + + /*! Definition of tag and length sizes (by function pointers). */ + const struct osmo_tlv_cfg *cfg; + + /*! Overall message buffer being parsed. */ + struct { + const uint8_t *data; + size_t len; + } src; + + /*! Return value from last invocation of osmo_tlv_load_next*(): tag value of parsed IE. */ + unsigned int tag; + /*! Return value from last invocation of osmo_tlv_load_next*(): Start of the IE's payload data (after tag and + * length). If the end of the src buffer is reached, val == NULL. If a TLV contained no value part, len == 0, + * but this still points just after the TL. */ + const uint8_t *val; + /*! Return value from last invocation of osmo_tlv_load_next*(): Length of the IE's payload data (without tag and + * length) */ + size_t len; +}; + +/* Start or restart the tlv from the first IE in the overall TLV data. */ +static inline void osmo_tlv_load_start(struct osmo_tlv_load *tlv) +{ + tlv->val = NULL; +} + +int osmo_tlv_load_next(struct osmo_tlv_load *tlv); +int osmo_tlv_load_peek_tag(const struct osmo_tlv_load *tlv); +int osmo_tlv_load_next_by_tag(struct osmo_tlv_load *tlv, unsigned int tag); + +/* State for storing a TLV structure into a msgb. */ +struct osmo_tlv_put { + /*! Caller-defined context pointer available for use by load_tl() and store_tl() implementations. */ + void *priv; + + /* Definition of tag and length sizes (by function pointers). */ + const struct osmo_tlv_cfg *cfg; + + /* msgb to append new TL to */ + struct msgb *dst; + /* Where was the last TL head written */ + unsigned int last_tag; + uint8_t *last_tl; + uint8_t *last_val; +}; + +int osmo_tlv_put_tl(struct osmo_tlv_put *tlv, unsigned int tag, size_t len); +int osmo_tlv_put_update_tl(struct osmo_tlv_put *tlv); diff --git a/src/Makefile.am b/src/Makefile.am index a8ba763..0e44dcc 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,3 +1,4 @@ SUBDIRS = \ + libosmo-tlv \ osmo-upf \ $(NULL) diff --git a/src/libosmo-tlv/Makefile.am b/src/libosmo-tlv/Makefile.am new file mode 100644 index 0000000..0f848d3 --- /dev/null +++ b/src/libosmo-tlv/Makefile.am @@ -0,0 +1,25 @@ +AM_CPPFLAGS = \ + $(all_includes) \ + -I$(top_srcdir)/include \ + -I$(top_builddir) \ + -I$(builddir) \ + $(NULL) + +AM_CFLAGS = \ + -Wall \ + $(LIBOSMOCORE_CFLAGS) \ + $(COVERAGE_CFLAGS) \ + $(NULL) + +AM_LDFLAGS = \ + $(LIBOSMOCORE_LIBS) \ + $(COVERAGE_LDFLAGS) \ + $(NULL) + +noinst_LIBRARIES = \ + libosmo-tlv.a \ + $(NULL) + +libosmo_tlv_a_SOURCES = \ + tlv.c \ + $(NULL) diff --git a/src/libosmo-tlv/tlv.c b/src/libosmo-tlv/tlv.c new file mode 100644 index 0000000..3426597 --- /dev/null +++ b/src/libosmo-tlv/tlv.c @@ -0,0 +1,284 @@ +/* + * (C) 2021-2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved. + * + * Author: Neels Janosch Hofmeyr <nhofmeyr(a)sysmocom.de> + * + * SPDX-License-Identifier: GPL-2.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include <errno.h> + +#include <osmocom/core/bits.h> +#include <osmocom/core/msgb.h> +#include <osmocom/tlv/tlv.h> + +static int next_tl_valid(const struct osmo_tlv_load *tlv, const uint8_t **ie_start_p, size_t *buflen_left_p) +{ + const uint8_t *ie_start; + size_t buflen_left; + + /* Start of next IE, or first IE for first invocation. */ + if (!tlv->val) + ie_start = tlv->src.data; + else + ie_start = tlv->val + tlv->len; + + /* Sanity */ + if (ie_start < tlv->src.data || ie_start > tlv->src.data + tlv->src.len) + return -ENOSPC; + + buflen_left = tlv->src.len - (ie_start - tlv->src.data); + + /* Too short for parsing an IE? Check also against integer overflow. */ + if (buflen_left && ((buflen_left < tlv->cfg->tl_min_size) || (buflen_left > tlv->src.len))) + return -EBADMSG; + + *ie_start_p = ie_start; + *buflen_left_p = buflen_left; + return 0; +} + +/* Return a TLV IE from a message buffer. + * + * Return the first or next TLV data found in the data buffer, based on the state of the tlv parameter. + * When tlv->val is NULL, return the first IE in the data buffer. + * Otherwise assume that tlv points at a valid IE in the data structure, and return the subsequent IE. + * + * Usage example: + * + * struct osmo_tlv tlv = { + * .cfg = osmo_t16l16v_cfg, + * .src = { .data = msgb_l3(msg), .len = msgb_l3len(msg) }, + * }; + * for (;;) { + * if (osmo_tlv_next(&tlv)) { + * printf("Error\n"); + * break; + * } + * if (!tlv.val) { + * printf("End\n"); + * break; + * } + * printf("Tag %u: %zu octets: %s\n", tlv.tag, tlv.len, osmo_hexdump(tlv.val, tlv.len)); + * } + * + * \param[inout] tlv Buffer to return the IE data, and state for TLV parsing position. tlv->msg should indicate the + * overall message buffer. The other tlv members should be zero initialized before the first call, and + * remain unchanged between invocations of this function. + * \returns 0 on success, negative on TLV parsing error. The IE data is returned in tlv->tag, tlv->len and tlv->val; + * tlv->val == NULL if no more IEs remain in the buffer. + */ +int osmo_tlv_load_next(struct osmo_tlv_load *tlv) +{ + const uint8_t *ie_start; + const uint8_t *ie_end; + size_t buflen_left; + int rc; + + rc = next_tl_valid(tlv, &ie_start, &buflen_left); + if (rc) + return rc; + + /* No more IEs? */ + if (!buflen_left) { + tlv->val = NULL; + return 0; + } + + /* Locate next IE */ + OSMO_ASSERT(tlv->cfg->load_tl); + rc = tlv->cfg->load_tl(&tlv->tag, &tlv->len, &tlv->val, ie_start, buflen_left, tlv); + if (rc) + return rc; + + /* Sanity */ + ie_end = tlv->val + tlv->len; + if (ie_end < tlv->src.data || ie_end > tlv->src.data + tlv->src.len) + return -EBADMSG; + + return 0; +} + +/* Return the tag of the IE that osmo_tlv_next() would yield, do not change the tlv state. + * + * \param[inout] tlv state for TLV parsing position. + * \returns the tag number on success, negative on TLV parsing error, -ENOENT when no more tags + * follow. + */ +int osmo_tlv_load_peek_tag(const struct osmo_tlv_load *tlv) +{ + const uint8_t *ie_start; + size_t buflen_left; + int rc; + unsigned int tag; + size_t len; + const uint8_t *val; + /* Guard against modification by load_tl(). */ + struct osmo_tlv_load mtlv = *tlv; + + rc = next_tl_valid(&mtlv, &ie_start, &buflen_left); + if (rc) + return rc; + + if (!buflen_left) + return -ENOENT; + + /* Return next IE tag*/ + OSMO_ASSERT(mtlv.cfg->load_tl); + rc = tlv->cfg->load_tl(&tag, &len, &val, ie_start, buflen_left, &mtlv); + if (rc) + return -EBADMSG; + return tag; +} + +/* Same as osmo_tlv_next(), but skip any IEs until the given tag is reached. Change the tlv state only when + * success is returned. + * \return 0 when the tag is found. Return -ENOENT when no such tag follows and keep the tlv unchanged. */ +int osmo_tlv_load_next_by_tag(struct osmo_tlv_load *tlv, unsigned int tag) +{ + struct osmo_tlv_load work = *tlv; + for (;;) { + int rc = osmo_tlv_load_next(&work); + if (rc) + return rc; + if (!work.val) + return -ENOENT; + if (work.tag == tag) { + *tlv = work; + return 0; + } + } +} + +/* Put tag header and length at the end of the msgb. + * If the length is not known yet, it can be passed as 0 at first, and osmo_tlv_put_update_tl() can determine the + * resulting length after the value part was put into the msgb. + * + * Usage example: + * + * struct msgb *msg = msgb_alloc(1024, "foo"), + * struct osmo_tlv_put tlv = { + * .cfg = osmo_t16l16v_cfg, + * .dst = msg, + * } + * + * osmo_tlv_put_tl(tlv, 23, 0); // tag 23, length 0 = not known yet + * + * msgb_put(msg, 42); + * ... + * msgb_put(msg, 42); + * ... + * msgb_put(msg, 42); + * + * osmo_tlv_put_update_tl(tlv); + * + * Return 0 on success, -EINVAL if the tag value is invalid, -EMSGSIZE if len is too large. + */ +int osmo_tlv_put_tl(struct osmo_tlv_put *tlv, unsigned int tag, size_t len) +{ + int rc; + uint8_t *last_tl; + OSMO_ASSERT(tlv->cfg->store_tl); + last_tl = tlv->dst->tail; + rc = tlv->cfg->store_tl(tlv->dst->tail, msgb_tailroom(tlv->dst), tag, len, tlv); + if (rc < 0) + return rc; + if (rc > 0) + msgb_put(tlv->dst, rc); + tlv->last_tag = tag; + tlv->last_tl = last_tl; + tlv->last_val = tlv->dst->tail; + return 0; +} + +/* Update the length of the last put IE header (last call to osmo_tlv_put_tl()) to match with the current + * tlv->dst->tail. + * Return 0 on success, -EMSGSIZE if the amount of data written since osmo_tlv_put_tl() is too large. + */ +int osmo_tlv_put_update_tl(struct osmo_tlv_put *tlv) +{ + size_t len = tlv->dst->tail - tlv->last_val; + int rc = tlv->cfg->store_tl(tlv->last_tl, tlv->last_val - tlv->last_tl, tlv->last_tag, len, tlv); + if (rc < 0) + return rc; + /* In case the TL has changed in size, hopefully the implementation has moved the msgb data. Make sure last_val + * points at the right place now. */ + tlv->last_val = tlv->last_tl + rc; + return 0; +} + +static int t8l8v_load_tl(unsigned int *tag, size_t *len, const uint8_t **val, + const uint8_t *src_data, size_t src_data_len, struct osmo_tlv_load *tlv) +{ + /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 2. */ + *tag = src_data[0]; + *len = src_data[1]; + *val = src_data + 2; + return 0; +} + +static int t8l8v_store_tl(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len, + struct osmo_tlv_put *tlv) +{ + if (tag > UINT8_MAX) + return -EINVAL; + if (len > UINT8_MAX) + return -EMSGSIZE; + if (dst_data_avail < 2) + return -ENOSPC; + dst_data[0] = tag; + dst_data[1] = len; + return 2; +} + +const struct osmo_tlv_cfg osmo_t8l8v_cfg = { + .tl_min_size = 2, + .load_tl = t8l8v_load_tl, + .store_tl = t8l8v_store_tl, +}; + +static int t16l16v_load_tl(unsigned int *tag, size_t *len, const uint8_t **val, + const uint8_t *src_data, size_t src_data_len, struct osmo_tlv_load *tlv) +{ + /* already validated in next_tl_valid(): src_data_len >= cfg->tl_min_size == 4. */ + *tag = osmo_load16be(src_data); + *len = osmo_load16be(src_data + 2); + *val = src_data + 4; + return 0; +} + +static int t16l16v_store_tl(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len, + struct osmo_tlv_put *tlv) +{ + if (tag > UINT16_MAX) + return -EINVAL; + if (len > UINT16_MAX) + return -EMSGSIZE; + if (dst_data_avail < 4) + return -ENOSPC; + osmo_store16be(tag, dst_data); + osmo_store16be(len, dst_data + 2); + return 4; +} + +const struct osmo_tlv_cfg osmo_t16l16v_cfg = { + .tl_min_size = 4, + .load_tl = t16l16v_load_tl, + .store_tl = t16l16v_store_tl, +}; diff --git a/tests/Makefile.am b/tests/Makefile.am index 6d14cc0..fb1680e 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -1,4 +1,5 @@ SUBDIRS = \ + libosmo-tlv \ $(NULL) # The `:;' works around a Bash 3.2 bug when the output is not writeable. diff --git a/tests/libosmo-tlv/Makefile.am b/tests/libosmo-tlv/Makefile.am new file mode 100644 index 0000000..250dc5e --- /dev/null +++ b/tests/libosmo-tlv/Makefile.am @@ -0,0 +1,30 @@ +AM_CPPFLAGS = \ + $(all_includes) \ + -I$(top_srcdir)/include \ + $(NULL) + +AM_CFLAGS = \ + -Wall \ + $(LIBOSMOCORE_CFLAGS) \ + $(NULL) + +noinst_PROGRAMS = \ + tlv_test \ + $(NULL) + +EXTRA_DIST = \ + tlv_test.ok \ + $(NULL) + +tlv_test_SOURCES = \ + tlv_test.c \ + $(NULL) + +tlv_test_LDADD = \ + $(top_builddir)/src/libosmo-tlv/libosmo-tlv.a \ + $(LIBOSMOCORE_LIBS) \ + $(NULL) + +.PHONY: update_exp +update_exp: + $(builddir)/tlv_test >$(srcdir)/tlv_test.ok diff --git a/tests/libosmo-tlv/tlv_test.c b/tests/libosmo-tlv/tlv_test.c new file mode 100644 index 0000000..ed3c12b --- /dev/null +++ b/tests/libosmo-tlv/tlv_test.c @@ -0,0 +1,509 @@ +/* (C) 2022 by sysmocom - s.f.m.c. GmbH <info(a)sysmocom.de> + * All Rights Reserved + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +#include <stdio.h> +#include <errno.h> + +#include <osmocom/core/application.h> +#include <osmocom/core/utils.h> +#include <osmocom/core/msgb.h> + +#include <osmocom/tlv/tlv.h> + +void *ctx; + +struct ie { + int tag; + const char *val; +}; + +/* write all IEs to a msgb */ +struct msgb *test_tlv_enc(const struct osmo_tlv_cfg *cfg, const struct ie *ies) +{ + const struct ie *ie; + struct osmo_tlv_put tlv = { + .cfg = cfg, + .dst = msgb_alloc(1024, __func__), + }; + + for (ie = ies; ie->val; ie++) { + /* put header without knowing length yet */ + OSMO_ASSERT( osmo_tlv_put_tl(&tlv, ie->tag, 0) == 0); + /* put value data, as much as desired */ + msgb_put(tlv.dst, osmo_hexparse(ie->val, tlv.dst->tail, msgb_tailroom(tlv.dst))); + /* update header len from amount of written data */ + OSMO_ASSERT( osmo_tlv_put_update_tl(&tlv) == 0); + } + + printf("- encoded: %s.\n", osmo_hexdump(tlv.dst->data, tlv.dst->len)); + return tlv.dst; +} + +/* read all IEs from the msgb, and verify that it matches the given list of IEs */ +void test_tlv_dec(const struct osmo_tlv_cfg *cfg, const struct ie *ies, struct msgb *msg) +{ + const struct ie *ie; + struct osmo_tlv_load tlv = { + .cfg = cfg, + .src = { msg->data, msg->len }, + }; + + printf("- decoding:\n"); + osmo_tlv_load_start(&tlv); + + for (ie = ies; ie->val; ie++) { + int rc = osmo_tlv_load_next(&tlv); + if (rc) { + printf(" ERROR loading TLV structure: osmo_tlv_load_next() rc = %d\n", rc); + exit(1); + } + /* end of TLV structure? */ + if (!tlv.val) + break; + printf(" T=%d L=%zu v=%s\n", tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len)); + if (tlv.tag != ie->tag) { + printf(" ERROR loading TLV structure: expected tag %d, got tag %d\n", ie->tag, tlv.tag); + exit(1); + } + if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len))) { + printf(" ERROR loading TLV structure: expected val %s, got val %s\n", ie->val, + osmo_hexdump_nospc(tlv.val, tlv.len)); + exit(1); + } + } +} + +void test_tlv_peek(const struct osmo_tlv_cfg *cfg, const struct ie *ies, struct msgb *msg) +{ + const struct ie *ie; + struct osmo_tlv_load tlv = { + .cfg = cfg, + .src = { msg->data, msg->len }, + }; + + printf("- peeking:\n"); + osmo_tlv_load_start(&tlv); + + ie = ies; + while (1) { + int rc; + int next_tag = osmo_tlv_load_peek_tag(&tlv); + if (next_tag == -ENOENT) + printf(" peek T=-ENOENT\n"); + else + printf(" peek T=%d\n", next_tag); + + if (ie->val && next_tag != ie->tag) { + printf(" ERROR peeking tag: expected tag %d, got tag %d\n", ie->tag, next_tag); + exit(1); + } + if (!ie->val && next_tag != -ENOENT) { + printf(" ERROR peeking tag: expected -ENOENT, got tag %d\n", next_tag); + exit(1); + } + + if (next_tag == -ENOENT) + break; + + /* go to the next TLV */ + rc = osmo_tlv_load_next(&tlv); + if (rc) { + printf(" ERROR loading TLV structure: osmo_tlv_load_next() rc = %d\n", rc); + exit(1); + } + if (ie->val) + ie++; + } +} + +/* Decode TLV in random order, each time searching for a tag in the raw data */ +void test_tlv_dec_by_tag(const struct osmo_tlv_cfg *cfg, const struct ie *ies, struct msgb *msg) +{ + const struct ie *last_ie; + const struct ie *ie; + int rc; + struct osmo_tlv_load tlv = { + .cfg = cfg, + .src = { msg->data, msg->len }, + }; + + printf("- decoding in reverse order:\n"); + + last_ie = ies; + while (last_ie->val) last_ie++; + last_ie--; + + for (ie = last_ie; ie >= ies; ie--) { + /* each time, look from the beginning */ + osmo_tlv_load_start(&tlv); + rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag); + if (rc) { + printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) rc = %d\n", ie->tag, rc); + exit(1); + } + if (!tlv.val) { + printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) returned NULL val\n", + ie->tag); + exit(1); + } + if (tlv.tag != ie->tag) { + printf(" ERROR loading TLV structure: expected tag %d, got tag %d\n", ie->tag, tlv.tag); + exit(1); + } + if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len))) { + while (1) { + printf(" (mismatch: T=%d L=%zu v=%s, checking for another occurence of T=%d)\n", + tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len), tlv.tag); + rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag); + if (rc || !tlv.val) { + printf(" ERROR val not found\n"); + exit(1); + } + if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len)) == 0) { + break; + } + } + } + printf(" T=%d L=%zu v=%s\n", tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len)); + } + + printf("- decoding every second tag:\n"); + + osmo_tlv_load_start(&tlv); + for (ie = ies; ie->val; ie++) { + /* skip one tag */ + ie++; + if (!ie->val) + break; + + rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag); + if (rc) { + printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) rc = %d\n", ie->tag, rc); + exit(1); + } + if (!tlv.val) { + printf(" ERROR loading TLV structure: osmo_tlv_load_next_by_tag(%d) returned NULL val\n", + ie->tag); + exit(1); + } + if (tlv.tag != ie->tag) { + printf(" ERROR loading TLV structure: expected tag %d, got tag %d\n", ie->tag, tlv.tag); + exit(1); + } + if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len))) { + while (1) { + printf(" (mismatch: T=%d L=%zu v=%s, checking for another occurence of T=%d)\n", + tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len), tlv.tag); + rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag); + if (rc || !tlv.val) { + printf(" ERROR val not found\n"); + exit(1); + } + if (strcmp(ie->val, osmo_hexdump_nospc(tlv.val, tlv.len)) == 0) { + break; + } + } + } + printf(" T=%d L=%zu v=%s\n", tlv.tag, tlv.len, osmo_hexdump_nospc(tlv.val, tlv.len)); + } + + printf("- enforcing order: without restart, a past tag is not parsed again:\n"); + /* Try to read the first tag, expect that it isn't found because we're already halfway in the message data */ + ie = ies; + rc = osmo_tlv_load_next_by_tag(&tlv, ie->tag); + printf(" osmo_tlv_load_next_by_tag(%d) rc=", ie->tag); + if (rc == -ENOENT) { + printf("-ENOENT\n"); + } else { + printf("%d\n", rc); + printf(" ERROR: expected -ENOENT\n"); + exit(1); + } +} + +void test_tlv(const char *label, struct ie *tests[], size_t tests_len, const struct osmo_tlv_cfg *cfg) +{ + int i; + for (i = 0; i < tests_len; i++) { + const struct ie *ies = tests[i]; + struct msgb *msg; + printf("\n=== start: %s[%d]\n", label, i); + + msg = test_tlv_enc(cfg, ies); + test_tlv_dec(cfg, ies, msg); + test_tlv_peek(cfg, ies, msg); + test_tlv_dec_by_tag(cfg, ies, msg); + + msgb_free(msg); + + printf("=== end: %s[%d]\n", label, i); + } +} + +struct ie t8l8v_test1[] = { + /* smallest T */ + { 0, "2342" }, + /* largest T */ + { 255, "2342" }, + + /* smallest V (no V data) */ + { 1, "" }, + /* largest V, 255 bytes is the largest that an 8bit size length can express. */ + { 123, "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" + }, + + /* arbitrary test data */ + { 101, "11" }, + { 102, "2222" }, + { 103, "333333" }, + {} +}; + +struct ie t8l8v_test_multi[] = { + { 42, "42" }, + { 2, "0101" }, + { 2, "2222" }, + { 3, "11" }, + { 3, "2222" }, + { 3, "333333" }, + { 23, "23" }, + { 42, "666f72747974776f" }, + { 23, "7477656e74797468726565" }, + {} +}; + +struct ie *t8l8v_tests[] = { + t8l8v_test1, + t8l8v_test_multi, +}; + +void test_t8l8v() +{ + test_tlv("t8l8v_tests", t8l8v_tests, ARRAY_SIZE(t8l8v_tests), &osmo_t8l8v_cfg); +} + +struct ie t16l16v_test1[] = { + /* smallest T */ + { 0, "2342" }, + /* largest T */ + { 65535, "2342" }, + + /* smallest V (no V data) */ + { 1, "" }, + /* 256 bytes is one more than an 8bit size length can express. */ + { 123, "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + }, + + /* arbitrary test data */ + { 1001, "11" }, + { 1002, "2222" }, + { 1003, "333333" }, + {} +}; + +struct ie t16l16v_test_multi[] = { + { 1042, "42" }, + { 102, "0101" }, + { 102, "2222" }, + { 103, "11" }, + { 103, "2222" }, + { 103, "333333" }, + { 1023, "23" }, + { 1042, "666f72747974776f" }, + { 1023, "7477656e74797468726565" }, + {} +}; + +struct ie *t16l16v_tests[] = { + t16l16v_test1, + t16l16v_test_multi, +}; + +void test_t16l16v() +{ + test_tlv("t16l16v_tests", t16l16v_tests, ARRAY_SIZE(t16l16v_tests), &osmo_t16l16v_cfg); +} + +struct ie txlxv_test1[] = { + /* smallest T */ + { 0, "2342" }, + /* largest T that still fits in one encoded octet (highest bit serves as flag) */ + { 0x7f, "2342" }, + /* smallest T that needs two octets to be encoded (first octet = 0x80 flag + 0, second octet = 0x1) */ + { 0x80, "2342" }, + /* largest T that can be encoded in 16bit - one flag bit. */ + { 0x7fff, "2342" }, + + /* smallest V (no V data) */ + { 1, "" }, + /* 256 bytes is one more than an 8bit size length can express. */ + { 123, "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + "0000000000000000000000000000000000000000000000000000000000000000" + }, + + /* arbitrary test data */ + { 1002, "2222" }, + { 1003, "333333" }, + {} +}; + +struct ie txlxv_test_multi[] = { + { 1042, "42" }, + { 1002, "0101" }, + { 1002, "2222" }, + { 103, "11" }, + { 103, "2222" }, + { 103, "333333" }, + { 1023, "23" }, + { 1042, "666f72747974776f" }, + { 1023, "7477656e74797468726565" }, + {} +}; + +struct ie *txlxv_tests[] = { + txlxv_test1, + txlxv_test_multi, +}; + +/* Example of defining a variable TL, where size of T and L depend on the actual tag and length values: load. */ +int txlxv_load_tl(unsigned int *tag, size_t *len, const uint8_t **val, const uint8_t *src_data, size_t src_data_len, + struct osmo_tlv_load *tlv) +{ + const uint8_t *pos = src_data; + const uint8_t *end = src_data + src_data_len; + if (pos[0] & 0x80) { + if (pos + 2 > end) + return -EINVAL; + *tag = (((int)pos[1]) << 7) + (pos[0] & 0x7f); + pos += 2; + } else { + *tag = pos[0]; + pos++; + } + + switch (*tag) { + case 1002: + /* fixed-length IE */ + *len = 2; + break; + case 123: + /* 16bit length IE */ + if (pos + 2 > end) + return -EINVAL; + *len = osmo_load16be(pos); + pos += 2; + break; + default: + /* 8bit length IE */ + if (pos + 1 > end) + return -EINVAL; + *len = *pos; + pos++; + break; + } + *val = pos; + return 0; +} + +/* Example of defining a variable TL, where size of T and L depend on the actual tag and length values: store. */ +int txlxv_store_tl(uint8_t *dst_data, size_t dst_data_avail, unsigned int tag, size_t len, struct osmo_tlv_put *tlv) +{ + uint8_t *pos = dst_data; + uint8_t *end = dst_data + dst_data_avail; + if (tag < 0x80) { + if (pos + 1 > end) + return -ENOSPC; + pos[0] = tag; + pos++; + } else { + if (pos + 2 > end) + return -ENOSPC; + pos[0] = 0x80 + (tag & 0x7f); + pos[1] = tag >> 7; + pos += 2; + } + + switch (tag) { + case 1002: + /* fixed-length IE, write no len */ + break; + case 123: + /* 16bit length IE */ + if (len > UINT16_MAX) + return -ERANGE; + if (pos + 2 > end) + return -ENOSPC; + osmo_store16be(len, pos); + pos += 2; + break; + default: + /* 8bit length IE */ + if (len > UINT8_MAX) + return -ERANGE; + if (pos + 1 > end) + return -ENOSPC; + pos[0] = len; + pos++; + break; + } + return pos - dst_data; +} + +const struct osmo_tlv_cfg txlxv_cfg = { + .tl_min_size = 1, + .load_tl = txlxv_load_tl, + .store_tl = txlxv_store_tl, +}; + +void test_txlxv() +{ + test_tlv("txlxv_tests", txlxv_tests, ARRAY_SIZE(txlxv_tests), &txlxv_cfg); +} + +int main() +{ + ctx = talloc_named_const(NULL, 0, "tlv_test"); + msgb_talloc_ctx_init(ctx, 0); + + test_t8l8v(); + test_t16l16v(); + test_txlxv(); + + talloc_free(ctx); + return 0; +} diff --git a/tests/libosmo-tlv/tlv_test.ok b/tests/libosmo-tlv/tlv_test.ok new file mode 100644 index 0000000..6ad7e7a --- /dev/null +++ b/tests/libosmo-tlv/tlv_test.ok @@ -0,0 +1,256 @@ + +=== start: t8l8v_tests[0] +- encoded: 00 02 23 42 ff 02 23 42 01 00 7b ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 65 01 11 66 02 22 22 67 03 33 33 33 . +- decoding: + T=0 L=2 v=2342 + T=255 L=2 v=2342 + T=1 L=0 v= + T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff + T=101 L=1 v=11 + T=102 L=2 v=2222 + T=103 L=3 v=333333 +- peeking: + peek T=0 + peek T=255 + peek T=1 + peek T=123 + peek T=101 + peek T=102 + peek T=103 + peek T=-ENOENT +- decoding in reverse order: + T=103 L=3 v=333333 + T=102 L=2 v=2222 + T=101 L=1 v=11 + T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff + T=1 L=0 v= + T=255 L=2 v=2342 + T=0 L=2 v=2342 +- decoding every second tag: + T=255 L=2 v=2342 + T=123 L=255 v=ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff + T=102 L=2 v=2222 +- enforcing order: without restart, a past tag is not parsed again: + osmo_tlv_load_next_by_tag(0) rc=-ENOENT +=== end: t8l8v_tests[0] + +=== start: t8l8v_tests[1] +- encoded: 2a 01 42 02 02 01 01 02 02 22 22 03 01 11 03 02 22 22 03 03 33 33 33 17 01 23 2a 08 66 6f 72 74 79 74 77 6f 17 0b 74 77 65 6e 74 79 74 68 72 65 65 . +- decoding: + T=42 L=1 v=42 + T=2 L=2 v=0101 + T=2 L=2 v=2222 + T=3 L=1 v=11 + T=3 L=2 v=2222 + T=3 L=3 v=333333 + T=23 L=1 v=23 + T=42 L=8 v=666f72747974776f + T=23 L=11 v=7477656e74797468726565 +- peeking: + peek T=42 + peek T=2 + peek T=2 + peek T=3 + peek T=3 + peek T=3 + peek T=23 + peek T=42 + peek T=23 + peek T=-ENOENT +- decoding in reverse order: + (mismatch: T=23 L=1 v=23, checking for another occurence of T=23) + T=23 L=11 v=7477656e74797468726565 + (mismatch: T=42 L=1 v=42, checking for another occurence of T=42) + T=42 L=8 v=666f72747974776f + T=23 L=1 v=23 + (mismatch: T=3 L=1 v=11, checking for another occurence of T=3) + (mismatch: T=3 L=2 v=2222, checking for another occurence of T=3) + T=3 L=3 v=333333 + (mismatch: T=3 L=1 v=11, checking for another occurence of T=3) + T=3 L=2 v=2222 + T=3 L=1 v=11 + (mismatch: T=2 L=2 v=0101, checking for another occurence of T=2) + T=2 L=2 v=2222 + T=2 L=2 v=0101 + T=42 L=1 v=42 +- decoding every second tag: + T=2 L=2 v=0101 + T=3 L=1 v=11 + (mismatch: T=3 L=2 v=2222, checking for another occurence of T=3) + T=3 L=3 v=333333 + T=42 L=8 v=666f72747974776f +- enforcing order: without restart, a past tag is not parsed again: + osmo_tlv_load_next_by_tag(42) rc=-ENOENT +=== end: t8l8v_tests[1] + +=== start: t16l16v_tests[0] +- encoded: 00 00 00 02 23 42 ff ff 00 02 23 42 00 01 00 00 00 7b 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 03 e9 00 01 11 03 ea 00 02 22 22 03 eb 00 03 33 33 33 . +- decoding: + T=0 L=2 v=2342 + T=65535 L=2 v=2342 + T=1 L=0 v= + T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 + T=1001 L=1 v=11 + T=1002 L=2 v=2222 + T=1003 L=3 v=333333 +- peeking: + peek T=0 + peek T=65535 + peek T=1 + peek T=123 + peek T=1001 + peek T=1002 + peek T=1003 + peek T=-ENOENT +- decoding in reverse order: + T=1003 L=3 v=333333 + T=1002 L=2 v=2222 + T=1001 L=1 v=11 + T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 + T=1 L=0 v= + T=65535 L=2 v=2342 + T=0 L=2 v=2342 +- decoding every second tag: + T=65535 L=2 v=2342 + T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 + T=1002 L=2 v=2222 +- enforcing order: without restart, a past tag is not parsed again: + osmo_tlv_load_next_by_tag(0) rc=-ENOENT +=== end: t16l16v_tests[0] + +=== start: t16l16v_tests[1] +- encoded: 04 12 00 01 42 00 66 00 02 01 01 00 66 00 02 22 22 00 67 00 01 11 00 67 00 02 22 22 00 67 00 03 33 33 33 03 ff 00 01 23 04 12 00 08 66 6f 72 74 79 74 77 6f 03 ff 00 0b 74 77 65 6e 74 79 74 68 72 65 65 . +- decoding: + T=1042 L=1 v=42 + T=102 L=2 v=0101 + T=102 L=2 v=2222 + T=103 L=1 v=11 + T=103 L=2 v=2222 + T=103 L=3 v=333333 + T=1023 L=1 v=23 + T=1042 L=8 v=666f72747974776f + T=1023 L=11 v=7477656e74797468726565 +- peeking: + peek T=1042 + peek T=102 + peek T=102 + peek T=103 + peek T=103 + peek T=103 + peek T=1023 + peek T=1042 + peek T=1023 + peek T=-ENOENT +- decoding in reverse order: + (mismatch: T=1023 L=1 v=23, checking for another occurence of T=1023) + T=1023 L=11 v=7477656e74797468726565 + (mismatch: T=1042 L=1 v=42, checking for another occurence of T=1042) + T=1042 L=8 v=666f72747974776f + T=1023 L=1 v=23 + (mismatch: T=103 L=1 v=11, checking for another occurence of T=103) + (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103) + T=103 L=3 v=333333 + (mismatch: T=103 L=1 v=11, checking for another occurence of T=103) + T=103 L=2 v=2222 + T=103 L=1 v=11 + (mismatch: T=102 L=2 v=0101, checking for another occurence of T=102) + T=102 L=2 v=2222 + T=102 L=2 v=0101 + T=1042 L=1 v=42 +- decoding every second tag: + T=102 L=2 v=0101 + T=103 L=1 v=11 + (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103) + T=103 L=3 v=333333 + T=1042 L=8 v=666f72747974776f +- enforcing order: without restart, a past tag is not parsed again: + osmo_tlv_load_next_by_tag(1042) rc=-ENOENT +=== end: t16l16v_tests[1] + +=== start: txlxv_tests[0] +- encoded: 00 02 23 42 7f 02 23 42 80 01 02 23 42 ff ff 02 23 42 01 00 7b 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ea 07 22 22 eb 07 03 33 33 33 . +- decoding: + T=0 L=2 v=2342 + T=127 L=2 v=2342 + T=128 L=2 v=2342 + T=32767 L=2 v=2342 + T=1 L=0 v= + T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 + T=1002 L=2 v=2222 + T=1003 L=3 v=333333 +- peeking: + peek T=0 + peek T=127 + peek T=128 + peek T=32767 + peek T=1 + peek T=123 + peek T=1002 + peek T=1003 + peek T=-ENOENT +- decoding in reverse order: + T=1003 L=3 v=333333 + T=1002 L=2 v=2222 + T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 + T=1 L=0 v= + T=32767 L=2 v=2342 + T=128 L=2 v=2342 + T=127 L=2 v=2342 + T=0 L=2 v=2342 +- decoding every second tag: + T=127 L=2 v=2342 + T=32767 L=2 v=2342 + T=123 L=256 v=00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000 + T=1003 L=3 v=333333 +- enforcing order: without restart, a past tag is not parsed again: + osmo_tlv_load_next_by_tag(0) rc=-ENOENT +=== end: txlxv_tests[0] + +=== start: txlxv_tests[1] +- encoded: 92 08 01 42 ea 07 01 01 ea 07 22 22 67 01 11 67 02 22 22 67 03 33 33 33 ff 07 01 23 92 08 08 66 6f 72 74 79 74 77 6f ff 07 0b 74 77 65 6e 74 79 74 68 72 65 65 . +- decoding: + T=1042 L=1 v=42 + T=1002 L=2 v=0101 + T=1002 L=2 v=2222 + T=103 L=1 v=11 + T=103 L=2 v=2222 + T=103 L=3 v=333333 + T=1023 L=1 v=23 + T=1042 L=8 v=666f72747974776f + T=1023 L=11 v=7477656e74797468726565 +- peeking: + peek T=1042 + peek T=1002 + peek T=1002 + peek T=103 + peek T=103 + peek T=103 + peek T=1023 + peek T=1042 + peek T=1023 + peek T=-ENOENT +- decoding in reverse order: + (mismatch: T=1023 L=1 v=23, checking for another occurence of T=1023) + T=1023 L=11 v=7477656e74797468726565 + (mismatch: T=1042 L=1 v=42, checking for another occurence of T=1042) + T=1042 L=8 v=666f72747974776f + T=1023 L=1 v=23 + (mismatch: T=103 L=1 v=11, checking for another occurence of T=103) + (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103) + T=103 L=3 v=333333 + (mismatch: T=103 L=1 v=11, checking for another occurence of T=103) + T=103 L=2 v=2222 + T=103 L=1 v=11 + (mismatch: T=1002 L=2 v=0101, checking for another occurence of T=1002) + T=1002 L=2 v=2222 + T=1002 L=2 v=0101 + T=1042 L=1 v=42 +- decoding every second tag: + T=1002 L=2 v=0101 + T=103 L=1 v=11 + (mismatch: T=103 L=2 v=2222, checking for another occurence of T=103) + T=103 L=3 v=333333 + T=1042 L=8 v=666f72747974776f +- enforcing order: without restart, a past tag is not parsed again: + osmo_tlv_load_next_by_tag(1042) rc=-ENOENT +=== end: txlxv_tests[1] diff --git a/tests/testsuite.at b/tests/testsuite.at index 09a77c3..86ef4d3 100644 --- a/tests/testsuite.at +++ b/tests/testsuite.at @@ -1,2 +1,8 @@ AT_INIT AT_BANNER([Regression tests.]) + +AT_SETUP([tlv]) +AT_KEYWORDS([tlv]) +cat $abs_srcdir/libosmo-tlv/tlv_test.ok > expout +AT_CHECK([$abs_top_builddir/tests/libosmo-tlv/tlv_test], [], [expout], [ignore]) +AT_CLEANUP -- To view, visit https://gerrit.osmocom.org/c/osmo-upf/+/27217 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-upf Gerrit-Branch: master Gerrit-Change-Id: Ib0fd00d9f288ffe13b7e67701f3e47073587404a Gerrit-Change-Number: 27217 Gerrit-PatchSet: 1 Gerrit-Owner: neels <nhofmeyr(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in osmo-ci[master]: Use docker image debian-bullseye-erlang instead of debian-buster-erlang

by pespin

pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/osmo-ci/+/27216 ) Change subject: Use docker image debian-bullseye-erlang instead of debian-buster-erlang ...................................................................... Use docker image debian-bullseye-erlang instead of debian-buster-erlang Let's use newer debian to avoid problems with older erlang. Furthermore, the new image builds rebar3 to avoid issues with unmatching erlang versions. Change-Id: I7b1956c515daccf6ab1ff87031c6fec649cadb4b --- M jobs/gerrit-verifications.yml M scripts/osmo-ci-docker-rebuild.sh 2 files changed, 2 insertions(+), 2 deletions(-) git pull ssh://gerrit.osmocom.org:29418/osmo-ci refs/changes/16/27216/1 diff --git a/jobs/gerrit-verifications.yml b/jobs/gerrit-verifications.yml index 84fe805..32c3e3b 100644 --- a/jobs/gerrit-verifications.yml +++ b/jobs/gerrit-verifications.yml @@ -41,7 +41,7 @@ -v "$PWD:/build" \ -v "$ARTIFACT_STORE:/artifact_store" \ docker_img: '$USER/debian-stretch-jenkins' - docker_img_erlang: '$USER/debian-buster-erlang' + docker_img_erlang: '$USER/debian-bullseye-erlang' timeout_cmd: '/usr/bin/timeout 30m' cmd: '{docker_run} {docker_img} {timeout_cmd} /build/contrib/jenkins.sh' gerrit_url: 'ssh://jenkins@gerrit.osmocom.org:29418' diff --git a/scripts/osmo-ci-docker-rebuild.sh b/scripts/osmo-ci-docker-rebuild.sh index 73b3508..cf0b102 100755 --- a/scripts/osmo-ci-docker-rebuild.sh +++ b/scripts/osmo-ci-docker-rebuild.sh @@ -5,7 +5,7 @@ docker_images_require \ "debian-stretch-jenkins" \ "debian-buster-jenkins" \ - "debian-buster-erlang" \ + "debian-bullseye-erlang" \ if [ "$(arch)" = "x86_64" ]; then docker_images_require \ -- To view, visit https://gerrit.osmocom.org/c/osmo-ci/+/27216 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-ci Gerrit-Branch: master Gerrit-Change-Id: I7b1956c515daccf6ab1ff87031c6fec649cadb4b Gerrit-Change-Number: 27216 Gerrit-PatchSet: 1 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in docker-playground[master]: Add debian-bullseye-erlang docker image

by pespin

pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/docker-playground/+/27213 ) Change subject: Add debian-bullseye-erlang docker image ...................................................................... Add debian-bullseye-erlang docker image Copied from debian-buster-erlang, references to debian 10 and buster modified to debian11 and bullseye. Change-Id: I5c13eedcbfa721b7e1939e571470ea7044c00211 --- A debian-bullseye-erlang/Dockerfile A debian-bullseye-erlang/Makefile 2 files changed, 57 insertions(+), 0 deletions(-) git pull ssh://gerrit.osmocom.org:29418/docker-playground refs/changes/13/27213/1 diff --git a/debian-bullseye-erlang/Dockerfile b/debian-bullseye-erlang/Dockerfile new file mode 100644 index 0000000..b5d8f5b --- /dev/null +++ b/debian-bullseye-erlang/Dockerfile @@ -0,0 +1,54 @@ +ARG REGISTRY=docker.io +FROM ${REGISTRY}/debian:bullseye +# Arguments used after FROM must be specified again +ARG OSMOCOM_REPO_MIRROR="http://download.opensuse.org" +ARG OSMOCOM_REPO_PATH="repositories/network:/osmocom:" + +MAINTAINER Harald Welte <laforge(a)gnumonks.org> + +ARG OSMOCOM_REPO="${OSMOCOM_REPO_MIRROR}/${OSMOCOM_REPO_PATH}/latest/Debian_11/" + +# install the erlang vm and rebar (2) +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get -y install \ + erlang \ + rebar + +# add rebar3 +ADD https://s3.amazonaws.com/rebar3/rebar3 /usr/bin/rebar3 +RUN chmod 0755 /usr/bin/rebar3 + +# install ninimal build utilities as well as system utilities +RUN apt-get update && \ + apt-get -y install \ + build-essential \ + git \ + procps \ + tcpdump \ + vim \ + netcat-openbsd \ + wget \ + && \ + apt-get clean + +# install additional C-language / system dependencies of our Erlang projects +RUN apt-get update && \ + apt-get -y install \ + libpcap-dev \ + && \ + apt-get clean + +# add osmocom latest repo, should we ever require packages from there +RUN apt-get update && apt-get install -y \ + gnupg +COPY .common/Release.key /tmp/Release.key +RUN apt-key add /tmp/Release.key && \ + rm /tmp/Release.key && \ + echo "deb " $OSMOCOM_REPO " ./" > /etc/apt/sources.list.d/osmocom-latest.list +ADD $OSMOCOM_REPO/Release /tmp/Release + +# add a non-root user under which we will normaly execute build tests +RUN useradd -m build +WORKDIR /home/build +USER build diff --git a/debian-bullseye-erlang/Makefile b/debian-bullseye-erlang/Makefile new file mode 100644 index 0000000..67066b3 --- /dev/null +++ b/debian-bullseye-erlang/Makefile @@ -0,0 +1,3 @@ +UPSTREAM_DISTRO=debian:buster +DISTRO=debian-buster +include ../make/Makefile -- To view, visit https://gerrit.osmocom.org/c/docker-playground/+/27213 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: docker-playground Gerrit-Branch: master Gerrit-Change-Id: I5c13eedcbfa721b7e1939e571470ea7044c00211 Gerrit-Change-Number: 27213 Gerrit-PatchSet: 1 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in docker-playground[master]: debian-bullseye-erlang: Build rebar3 from source

by pespin

pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/docker-playground/+/27214 ) Change subject: debian-bullseye-erlang: Build rebar3 from source ...................................................................... debian-bullseye-erlang: Build rebar3 from source This way we ensure it is always built against the same erland OTP installed in the system. Change-Id: I6cd8a61ca52c7beda98b357f82ce42eba54e196b --- M debian-bullseye-erlang/Dockerfile 1 file changed, 6 insertions(+), 2 deletions(-) git pull ssh://gerrit.osmocom.org:29418/docker-playground refs/changes/14/27214/1 diff --git a/debian-bullseye-erlang/Dockerfile b/debian-bullseye-erlang/Dockerfile index b5d8f5b..15da137 100644 --- a/debian-bullseye-erlang/Dockerfile +++ b/debian-bullseye-erlang/Dockerfile @@ -16,8 +16,12 @@ rebar # add rebar3 -ADD https://s3.amazonaws.com/rebar3/rebar3 /usr/bin/rebar3 -RUN chmod 0755 /usr/bin/rebar3 +ARG REBAR3_VERSION="3.18.0" +ADD https://github.com/erlang/rebar3/archive/refs/tags/${REBAR3_VERSION}.tar.gz /tmp/rebar3.tar.gz +RUN tar -zxf /tmp/rebar3.tar.gz && \ + cd rebar3-${REBAR3_VERSION} && \ + ./bootstrap && \ + install -Dm0755 "rebar3" "/usr/bin/rebar3" # install ninimal build utilities as well as system utilities RUN apt-get update && \ -- To view, visit https://gerrit.osmocom.org/c/docker-playground/+/27214 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: docker-playground Gerrit-Branch: master Gerrit-Change-Id: I6cd8a61ca52c7beda98b357f82ce42eba54e196b Gerrit-Change-Number: 27214 Gerrit-PatchSet: 1 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Change in docker-playground[master]: Remove debian-buster-erlang

by pespin

pespin has uploaded this change for review. ( https://gerrit.osmocom.org/c/docker-playground/+/27215 ) Change subject: Remove debian-buster-erlang ...................................................................... Remove debian-buster-erlang We don't need the image anymore, we use debian-bullseye-erlang. Change-Id: I6f22642f5f67a173b17db55aa7a7bda3d9debd54 --- D debian-buster-erlang/Dockerfile D debian-buster-erlang/Makefile 2 files changed, 0 insertions(+), 57 deletions(-) git pull ssh://gerrit.osmocom.org:29418/docker-playground refs/changes/15/27215/1 diff --git a/debian-buster-erlang/Dockerfile b/debian-buster-erlang/Dockerfile deleted file mode 100644 index 10b2c88..0000000 --- a/debian-buster-erlang/Dockerfile +++ /dev/null @@ -1,54 +0,0 @@ -ARG REGISTRY=docker.io -FROM ${REGISTRY}/debian:buster -# Arguments used after FROM must be specified again -ARG OSMOCOM_REPO_MIRROR="http://download.opensuse.org" -ARG OSMOCOM_REPO_PATH="repositories/network:/osmocom:" - -MAINTAINER Harald Welte <laforge(a)gnumonks.org> - -ARG OSMOCOM_REPO="${OSMOCOM_REPO_MIRROR}/${OSMOCOM_REPO_PATH}/latest/Debian_10/" - -# install the erlang vm and rebar (2) -RUN apt-get update && \ - apt-get upgrade -y && \ - apt-get -y install \ - erlang \ - rebar - -# add rebar3 -ADD https://s3.amazonaws.com/rebar3/rebar3 /usr/bin/rebar3 -RUN chmod 0755 /usr/bin/rebar3 - -# install ninimal build utilities as well as system utilities -RUN apt-get update && \ - apt-get -y install \ - build-essential \ - git \ - procps \ - tcpdump \ - vim \ - netcat-openbsd \ - wget \ - && \ - apt-get clean - -# install additional C-language / system dependencies of our Erlang projects -RUN apt-get update && \ - apt-get -y install \ - libpcap-dev \ - && \ - apt-get clean - -# add osmocom latest repo, should we ever require packages from there -RUN apt-get update && apt-get install -y \ - gnupg -COPY .common/Release.key /tmp/Release.key -RUN apt-key add /tmp/Release.key && \ - rm /tmp/Release.key && \ - echo "deb " $OSMOCOM_REPO " ./" > /etc/apt/sources.list.d/osmocom-latest.list -ADD $OSMOCOM_REPO/Release /tmp/Release - -# add a non-root user under which we will normaly execute build tests -RUN useradd -m build -WORKDIR /home/build -USER build diff --git a/debian-buster-erlang/Makefile b/debian-buster-erlang/Makefile deleted file mode 100644 index 67066b3..0000000 --- a/debian-buster-erlang/Makefile +++ /dev/null @@ -1,3 +0,0 @@ -UPSTREAM_DISTRO=debian:buster -DISTRO=debian-buster -include ../make/Makefile -- To view, visit https://gerrit.osmocom.org/c/docker-playground/+/27215 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: docker-playground Gerrit-Branch: master Gerrit-Change-Id: I6f22642f5f67a173b17db55aa7a7bda3d9debd54 Gerrit-Change-Number: 27215 Gerrit-PatchSet: 1 Gerrit-Owner: pespin <pespin(a)sysmocom.de> Gerrit-MessageType: newchange

3 years, 4 months

Jump to page:

2025

2024

2023

2022

gerrit-log February 2022