Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[17559] Update Fast DDS profiles schema with troubleshooting errors #3363

Merged
merged 10 commits into from
Mar 17, 2023
Merged

[17559] Update Fast DDS profiles schema with troubleshooting errors #3363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7f8d1bd
Refs #17559: Move 'library_settings' from profiles to DDS in the schema
JesusPoderoso Mar 14, 2023
408e24f
Refs #17559: Move 'library_settings' from profiles to DDS in the XML …
JesusPoderoso Mar 14, 2023
7a90070
Refs #17559: Add 'topic' as profile in the schema
JesusPoderoso Mar 14, 2023
b490e1c
Refs #17559: Add 'topic' as profile in the XML files
JesusPoderoso Mar 14, 2023
0da8cf4
Refs #17559: Add 'send_buffers' as allocation rtps participant profil…
JesusPoderoso Mar 14, 2023
ffae5d5
Refs #17559: Add 'send_buffers' as allocation rtps participant profil…
JesusPoderoso Mar 14, 2023
2ec1ce8
Refs #17559: Apply rev indent in comment
JesusPoderoso Mar 16, 2023
4d95f59
Refs #17559: Include new XML in validation tests to check 'library_se…
JesusPoderoso Mar 16, 2023
3b668df
Refs #17559: Set all locators ports type as 'uint16'
JesusPoderoso Mar 16, 2023
302a6b7
Refs #17559: Fix XMLParser test error
JesusPoderoso Mar 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 68 additions & 36 deletions resources/xsd/fastRTPS_profiles.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,43 +7,47 @@

<!--| MAIN DOCUMENT HIERARCHY |-->
<!--__ROOT__:
├ dds [0~1],
| ├ profiles [0~1],
| ├ log [0~1],
| └ types [0~1], (rooted definition)
├ dds [0~1],
| ├ profiles [0~1],
| ├ log [0~1],
| ├ types [0~1],
| └ library_settings [0~1] (rooted definition)
|
├ profiles [0~1],
├ log [0~1],
└ types [0~1] (standalone definition) -->
├ profiles [0~1],
├ log [0~1],
├ types [0~1],
└ library_settings [0~1] (standalone definition) -->
MRicoIE2CS marked this conversation as resolved.
Show resolved Hide resolved
<!-- dds, profiles, log or types can be the ROOT element of the profile -->
<xs:element name="dds">
<xs:complexType>
<xs:all>
<xs:element name="profiles" type="profilesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="types" type="typesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="log" type="logType" minOccurs="0" maxOccurs="1"/>
<xs:element name="library_settings" type="LibrarySettingsType" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="profiles" type="profilesType"/>
<xs:element name="types" type="typesType"/>
<xs:element name="log" type="logType"/>
<xs:element name="library_settings" type="LibrarySettingsType"/>
MRicoIE2CS marked this conversation as resolved.
Show resolved Hide resolved


<!--PROFILES:
├ library_settings [0~1],
├ participant [0~*],
├ data_writer [0~*],
├ data_reader [0~*],
└ transport_descriptors [0~1] -->
├ transport_descriptors [0~1],
└ topic [0~*] -->
<xs:complexType name="profilesType">
<xs:sequence minOccurs="1" maxOccurs="unbounded"> <!-- multiple instances of the elements -->
<xs:choice minOccurs="1"> <!-- each instance can be one of the elements below -->
<xs:element name="library_settings" type="LibrarySettingsType" maxOccurs="1"/>
<xs:element name="participant" type="participantProfileType" maxOccurs="unbounded"/>
<xs:element name="data_writer" type="publisherProfileType" maxOccurs="unbounded"/>
<xs:element name="data_reader" type="subscriberProfileType" maxOccurs="unbounded"/>
<xs:element name="transport_descriptors" type="TransportDescriptorListType" maxOccurs="1"/>
<xs:element name="topic" type="topicProfileType" maxOccurs="unbounded"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
Expand All @@ -68,10 +72,6 @@
</xs:sequence>
</xs:complexType>




<!--| PROFILES ELEMENTS |-->
<!--Library settings:
└ intraprocess_delivery [string] ("OFF", "USER_DATA_ONLY", "FULL") -->
<xs:complexType name="LibrarySettingsType">
Expand All @@ -91,6 +91,8 @@
</xs:all>
</xs:complexType>


<!--| PROFILES ELEMENTS |-->
<!--Participant:
| ╠ att. profile_name [string] REQ,
| ╚ att. is_default_profile [bool],
Expand Down Expand Up @@ -169,7 +171,7 @@
└ matchedSubscribersAllocation [0~1]-->
<xs:complexType name="publisherProfileType">
<xs:all>
<xs:element name="topic" type="topicAttributesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="topic" type="topicElementType" minOccurs="0" maxOccurs="1"/>
<xs:element name="qos" type="QosPoliciesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="times" type="writerTimesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="unicastLocatorList" type="locatorListType" minOccurs="0" maxOccurs="1"/>
Expand Down Expand Up @@ -205,7 +207,7 @@
└ matchedPublishersAllocation [0~1]-->
<xs:complexType name="subscriberProfileType">
<xs:all minOccurs="0">
<xs:element name="topic" type="topicAttributesType" minOccurs="0" maxOccurs="1"/>
<xs:element name="topic" type="topicElementType" minOccurs="0" maxOccurs="1"/>
<xs:element name="qos" type="QosPoliciesType" minOccurs="0"/>
<xs:element name="times" type="readerTimesType" minOccurs="0"/>
<xs:element name="unicastLocatorList" type="locatorListType" minOccurs="0"/>
Expand All @@ -231,6 +233,36 @@
</xs:sequence>
</xs:complexType>

<!--Topic (profile):
| ╠ att. profile_name [string] REQ,
| ╚ att. is_default_profile [bool],
|
├ historyQoS [0~1],
└ resourceLimitsQos [0~1],
├ max_samples [uint32],
├ max_instances [uint32],
├ max_samples_per_instance [uint32],
├ allocated_samples [uint32],
└ extra_samples [uint32] -->
<xs:complexType name="topicProfileType">
<xs:all>
<xs:element name="historyQos" type="historyQosPolicyType" minOccurs="0" maxOccurs="1"/>
<xs:element name="resourceLimitsQos" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:all>
<xs:element name="max_samples" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="max_instances" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="max_samples_per_instance" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="allocated_samples" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="extra_samples" type="uint32" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="profile_name" type="string" use="required"/>
<xs:attribute name="is_default_profile" type="boolean" use="optional"/>
</xs:complexType>

<!--Topic:
├ historyQoS [0~1],
└ resourceLimitsQos [0~1],
Expand All @@ -239,7 +271,7 @@
├ max_samples_per_instance [uint32],
├ allocated_samples [uint32],
└ extra_samples [uint32] -->
<xs:complexType name="topicAttributesType">
<xs:complexType name="topicElementType">
<xs:all>
<xs:element name="historyQos" type="historyQosPolicyType" minOccurs="0" maxOccurs="1"/>
<xs:element name="resourceLimitsQos" minOccurs="0" maxOccurs="1">
Expand Down Expand Up @@ -695,7 +727,7 @@
├ total_participants [0~1],
├ total_readers [0~1],
├ total_writers [0~1],
├ send_buffers ??? [0~1], ???
├ send_buffers [0~1],
├ max_properties [uint32],
├ max_user_data [uint32],
└ max_partitions [uint32] -->
Expand All @@ -712,14 +744,14 @@
<xs:element name="total_participants" type="allocationConfigType" minOccurs="0" maxOccurs="1"/>
<xs:element name="total_readers" type="allocationConfigType" minOccurs="0" maxOccurs="1"/>
<xs:element name="total_writers" type="allocationConfigType" minOccurs="0" maxOccurs="1"/>
<!-- <xs:element name="send_buffers" minOccurs="0" maxOccurs="1">
<xs:element name="send_buffers" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:all>
<xs:element name="preallocated_number" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="dynamic" type="boolean" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element> -->
</xs:element>
<xs:element name="max_properties" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="max_user_data" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="max_partitions" type="uint32" minOccurs="0" maxOccurs="1"/>
Expand Down Expand Up @@ -1105,49 +1137,49 @@

<!--| LOCATOR TYPES DEFINITION |-->
<!--udpv4 Locator:
├ port [uint32],
├ port [uint16],
└ address [ipv4Address]-->
<xs:complexType name="udpv4LocatorType">
<xs:all>
<xs:element name="port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="ipv4Address" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>

<!--udpv6 Locator:
├ port [uint32],
├ port [uint16],
└ address [ipv6Address]-->
<xs:complexType name="udpv6LocatorType">
<xs:all>
<xs:element name="port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="ipv6Address" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>

<!--tcpv4 Locator:
├ port [uint32],
├ physical_port [uint32],
├ port [uint16],
├ physical_port [uint16],
├ address [ipv4Address],
├ unique_lan_id [string],
└ wan_address [ipv4AddressFormat]-->
<xs:complexType name="tcpv4LocatorType">
<xs:all>
<xs:element name="port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="physical_port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="physical_port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="ipv4Address" minOccurs="0" maxOccurs="1"/>
<xs:element name="unique_lan_id" type="string" minOccurs="0" maxOccurs="1"/>
<xs:element name="wan_address" type="ipv4AddressFormat" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>

<!--tcpv6 Locator:
├ port [uint32],
├ physical_port [uint32],
├ port [uint16],
├ physical_port [uint16],
└ address [ipv6Address]-->
<xs:complexType name="tcpv6LocatorType">
<xs:all>
<xs:element name="port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="physical_port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="physical_port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="ipv6Address" minOccurs="0" maxOccurs="1"/>
</xs:all>
</xs:complexType>
Expand All @@ -1157,11 +1189,11 @@
| att. cost [uint8] (0~255),
| att. mask [uint8] (1~31),
|
├ port [uint32],
├ port [uint16],
└ address [ipv4Address]-->
<xs:complexType name="udpv4ExternalLocatorType">
<xs:all>
<xs:element name="port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="ipv4Address" minOccurs="0" maxOccurs="1"/>
</xs:all>
<xs:attribute name="externality" default="1">
Expand Down Expand Up @@ -1195,11 +1227,11 @@
| att. cost [uint8] (0~255),
| att. mask [uint8] (1~127),
|
├ port [uint32],
├ port [uint16],
└ address [ipv6Address]-->
<xs:complexType name="udpv6ExternalLocatorType">
<xs:all>
<xs:element name="port" type="uint32" minOccurs="0" maxOccurs="1"/>
<xs:element name="port" type="uint16" minOccurs="0" maxOccurs="1"/>
<xs:element name="address" type="ipv6Address" minOccurs="0" maxOccurs="1"/>
</xs:all>
<xs:attribute name="externality" default="1">
Expand Down
6 changes: 3 additions & 3 deletions test/communication/liveliness_assertion.120.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles" >
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<profiles>
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<participant profile_name="simple_participant_profile" is_default_profile="true">
<rtps>
<builtin>
Expand Down
8 changes: 4 additions & 4 deletions test/communication/liveliness_assertion.360.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles" >
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<profiles>
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<participant profile_name="simple_participant_profile" is_default_profile="true">
<rtps>
<builtin>
Expand All @@ -12,7 +12,7 @@
<sec>360</sec>
</leaseDuration>
</discovery_config>
</builtin>
</builtin>
</rtps>
</participant>
</profiles>
Expand Down
8 changes: 4 additions & 4 deletions test/communication/liveliness_assertion.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles">
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<profiles>
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<participant profile_name="simple_participant_profile" is_default_profile="true">
<rtps>
<builtin>
Expand All @@ -15,7 +15,7 @@
<sec>1</sec>
</leaseAnnouncement>
</discovery_config>
</builtin>
</builtin>
</rtps>
</participant>
</profiles>
Expand Down
8 changes: 4 additions & 4 deletions test/communication/shm_communication_subscriber_dies_while_processing_message.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="utf-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles">
<profiles>
<library_settings>
<intraprocess_delivery>OFF</intraprocess_delivery>
</library_settings>
<library_settings>
<intraprocess_delivery>OFF</intraprocess_delivery>
</library_settings>

<profiles>
<transport_descriptors>
<transport_descriptor>
<transport_id>shm_transport</transport_id>
Expand Down
10 changes: 5 additions & 5 deletions test/communication/simple_besteffort.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles">
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<profiles>
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<publisher profile_name="simple_publisher_profile" is_default_profile="true">
<data_writer profile_name="simple_publisher_profile" is_default_profile="true">
<qos>
<reliability>
<kind>BEST_EFFORT</kind>
</reliability>
</qos>
</publisher>
</data_writer>
<subscriber profile_name="simple_subscriber_profile" is_default_profile="true">
<qos>
<reliability>
Expand Down
10 changes: 5 additions & 5 deletions test/communication/simple_reliable.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles">
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<profiles>
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<publisher profile_name="simple_publisher_profile" is_default_profile="true">
<data_writer profile_name="simple_publisher_profile" is_default_profile="true">
<qos>
<reliability>
<kind>RELIABLE</kind>
</reliability>
</qos>
</publisher>
</data_writer>
<subscriber profile_name="simple_subscriber_profile" is_default_profile="true">
<qos>
<reliability>
Expand Down
10 changes: 5 additions & 5 deletions test/communication/simple_reliable_besteffort.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles">
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<profiles>
<library_settings>
<intraprocess_delivery>FULL</intraprocess_delivery>
</library_settings>
<publisher profile_name="simple_publisher_profile" is_default_profile="true">
<data_writer profile_name="simple_publisher_profile" is_default_profile="true">
<qos>
<reliability>
<kind>RELIABLE</kind>
</reliability>
</qos>
</publisher>
</data_writer>
<subscriber profile_name="simple_subscriber_profile" is_default_profile="true">
<qos>
<reliability>
Expand Down
Loading