Prefix types and functions for ddsi entities

As a result of splitting q_entity into multiple files, more entity
related functions are non-static and thus exported from the shared
library. To reduce the risk of name clashes, all exported symbols
related to DDSI entities are prefixed with ddsi_.

Signed-off-by: Dennis Potman <[email protected]>

Author: dpotman

docs/dev/dds_security_effort.md

@@ -275,7 +275,7 @@ Mainly because in OpenSplice it's quite hard to get a failure state from DDSI
 to the application.
 
 In Cyclone, however, ddsc::dds_create_participant() results in a direct call to
-ddsi::new_participant(). This means that if creation of an entity (or
+ddsi::ddsi_new_participant(). This means that if creation of an entity (or
 participant in this example) fails due to security issues in ddsi, we can fail
 the actual ddsc API call with a proper error result (there's already the
 DDS_RETCODE_NOT_ALLOWED_BY_SECURITY in the ddsc API (not used)).

docs/dev/type_discovery.md

@@ -24,4 +24,4 @@ Note: In the current type discovery implementation a type lookup request is sent
 
 The type discovery implementation introduces a number of additional checks in QoS matching in DDSI (function `qos_match_mask_p`). After the check for matching _topic name_ and _type name_ for reader and writer, the matching function checks if the type information is resolved for the type identifiers of both endpoints. In case any of the types (typically from the proxy endpoint) is not resolved, matching is delayed and a type lookup request for that type identifier is sent.
 
-An incoming type lookup reply triggers the (domain scoped) `tl_resolved_cond` condition variable (so that the type lookup API function can check if the requested type is resolved) and triggers the endpoint matching for all proxy endpoints that are using one of the resolved types. This list of proxy endpoints is retrieved from the type lookup meta-data administration. For each of these proxy endpoints the function `update_proxy_endpoint_matching` is called, which tries to connect the proxy endpoint to local endpoints.
+An incoming type lookup reply triggers the (domain scoped) `tl_resolved_cond` condition variable (so that the type lookup API function can check if the requested type is resolved) and triggers the endpoint matching for all proxy endpoints that are using one of the resolved types. This list of proxy endpoints is retrieved from the type lookup meta-data administration. For each of these proxy endpoints the function `ddsi_update_proxy_endpoint_matching` is called, which tries to connect the proxy endpoint to local endpoints.

docs/dev/volatile_msg_secure.md

@@ -92,7 +92,7 @@ It is also used to determine the gap information that is added to samples to a s
 ### Heartbeats
 
 A writer is triggered to send heartbeats once in a while. Normally, that is broadcasted. But, for the volatile secure writer, it has to be send to each reader specifically. The heartbeat submessage that is send to each reader individually is encoded with a reader specific key. This key is generated from the shared secret which was determined during the authentication phase.
- 
+
 When a writer should send heartbeats, ```handle_xevk_heartbeat()``` is called. For the volatile secure writer, the control is immediately submitted to ```send_heartbeat_to_all_readers()```. This will add heartbeat submessages to an rtps message for every reader it deems necessary.
 
 
@@ -111,15 +111,15 @@ Notes</br>
 
 The following elements are added to the data structures:
 
-* struct wr_prd_match::lst_seq     : Highest seq send to this reader used when filter is applied
-* struct pwr_rd_match::last_seq    : Reader specific last received sequence number from the writer.
-* struct proxy_writer::uses_filter : Indicates that a content-filter is active
-* struct proxy_reader::filter      : The filter to apply for this specific reader
+* struct ddsi_wr_prd_match::lst_seq     : Highest seq send to this reader used when filter is applied
+* struct ddsi_pwr_rd_match::last_seq    : Reader specific last received sequence number from the writer.
+* struct ddsi_proxy_writer::uses_filter : Indicates that a content-filter is active
+* struct ddsi_proxy_reader::filter      : The filter to apply for this specific reader
 
 Functions added:
 
-* writer_hbcontrol_p2p : This function creates a heartbeat destined for a specific reader. The volatile secure writer will use an submessage encoding which uses a distinct key for each reader. Therefor a reader specific heartbeat is needed. 
-* nn_defrag_prune : When a volatile secure reader is deleted then the defragmentation administration could still contain messages destined for this reader. This function removes these messages from the defragmentation administration. 
+* writer_hbcontrol_p2p : This function creates a heartbeat destined for a specific reader. The volatile secure writer will use an submessage encoding which uses a distinct key for each reader. Therefor a reader specific heartbeat is needed.
+* nn_defrag_prune : When a volatile secure reader is deleted then the defragmentation administration could still contain messages destined for this reader. This function removes these messages from the defragmentation administration.
 * volatile_secure_data_filter : The filter applied to the secure volatile messages which filters on the destination participant guid.
 * write_sample_p2p_wrlock_held : This function writes a message to a particular reader.
 

src/core/ddsc/src/dds__builtin.h

@@ -41,11 +41,11 @@ bool dds__validate_builtin_reader_qos (const dds_domain *dom, dds_entity_t topic
 void dds__builtin_init (struct dds_domain *dom);
 void dds__builtin_fini (struct dds_domain *dom);
 
-struct entity_common;
-struct proxy_topic;
-struct ddsi_serdata *dds__builtin_make_sample_endpoint (const struct entity_common *e, ddsrt_wctime_t timestamp, bool alive);
-struct ddsi_serdata *dds__builtin_make_sample_topic (const struct entity_common *e, ddsrt_wctime_t timestamp, bool alive);
-struct ddsi_serdata *dds__builtin_make_sample_proxy_topic (const struct proxy_topic *proxytp, ddsrt_wctime_t timestamp, bool alive);
+struct ddsi_entity_common;
+struct ddsi_proxy_topic;
+struct ddsi_serdata *dds__builtin_make_sample_endpoint (const struct ddsi_entity_common *e, ddsrt_wctime_t timestamp, bool alive);
+struct ddsi_serdata *dds__builtin_make_sample_topic (const struct ddsi_entity_common *e, ddsrt_wctime_t timestamp, bool alive);
+struct ddsi_serdata *dds__builtin_make_sample_proxy_topic (const struct ddsi_proxy_topic *proxytp, ddsrt_wctime_t timestamp, bool alive);
 
 #if defined (__cplusplus)
 }

src/core/ddsc/src/dds__entity.h

@@ -148,7 +148,7 @@ union dds_status_union {
 
 #define STATUS_CB_IMPL(entity_kind_, name_, NAME_, ...)                 \
   STATUS_CB_IMPL_INVOKE(entity_kind_, name_, NAME_, __VA_ARGS__)        \
-  static void status_cb_##name_ (dds_##entity_kind_ * const e, const status_cb_data_t *data) \
+  static void status_cb_##name_ (dds_##entity_kind_ * const e, const ddsi_status_cb_data_t *data) \
   {                                                                     \
     struct dds_listener const * const listener = &e->m_entity.m_listener; \
     update_##name_ (&e->m_##name_##_status, data);                      \

src/core/ddsc/src/dds__reader.h

@@ -19,9 +19,9 @@
 extern "C" {
 #endif
 
-struct status_cb_data;
+struct ddsi_status_cb_data;
 
-void dds_reader_status_cb (void *entity, const struct status_cb_data * data);
+void dds_reader_status_cb (void *entity, const struct ddsi_status_cb_data * data);
 
 dds_return_t dds_return_reader_loan (dds_reader *rd, void **buf, int32_t bufsz);
 

src/core/ddsc/src/dds__serdata_builtintopic.h

@@ -21,7 +21,7 @@
 extern "C" {
 #endif
 
-struct entity_common;
+struct ddsi_entity_common;
 struct ddsi_topic_definition;
 
 enum ddsi_sertype_builtintopic_entity_kind {
@@ -62,7 +62,7 @@ extern const struct ddsi_sertype_ops ddsi_sertype_ops_builtintopic;
 extern const struct ddsi_serdata_ops ddsi_serdata_ops_builtintopic;
 
 struct ddsi_sertype *new_sertype_builtintopic (enum ddsi_sertype_builtintopic_entity_kind entity_kind, const char *typename);
-struct ddsi_serdata *dds_serdata_builtin_from_endpoint (const struct ddsi_sertype *tpcmn, const ddsi_guid_t *guid, struct entity_common *entity, enum ddsi_serdata_kind kind);
+struct ddsi_serdata *dds_serdata_builtin_from_endpoint (const struct ddsi_sertype *tpcmn, const ddsi_guid_t *guid, struct ddsi_entity_common *entity, enum ddsi_serdata_kind kind);
 
 #ifdef DDS_HAS_TOPIC_DISCOVERY
 extern const struct ddsi_serdata_ops ddsi_serdata_ops_builtintopic_topic;

src/core/ddsc/src/dds__types.h

@@ -249,11 +249,11 @@ typedef struct dds_domain {
   struct ddsi_sertype *builtin_reader_type;
   struct ddsi_sertype *builtin_writer_type;
 
-  struct local_orphan_writer *builtintopic_writer_participant;
-  struct local_orphan_writer *builtintopic_writer_publications;
-  struct local_orphan_writer *builtintopic_writer_subscriptions;
+  struct ddsi_local_orphan_writer *builtintopic_writer_participant;
+  struct ddsi_local_orphan_writer *builtintopic_writer_publications;
+  struct ddsi_local_orphan_writer *builtintopic_writer_subscriptions;
 #ifdef DDS_HAS_TOPIC_DISCOVERY
-  struct local_orphan_writer *builtintopic_writer_topics;
+  struct ddsi_local_orphan_writer *builtintopic_writer_topics;
 #endif
 
   struct ddsi_builtin_topic_interface btif;
@@ -295,7 +295,7 @@ struct ktopic_type_guid {
   ddsi_typeid_t *type_id;
   uint32_t refc;
   ddsi_guid_t guid;
-  struct topic *tp;
+  struct ddsi_topic *tp;
 };
 #endif
 
@@ -327,7 +327,7 @@ typedef struct dds_reader {
   struct dds_entity m_entity;
   struct dds_topic *m_topic; /* refc'd, constant, lock(rd) -> lock(tp) allowed */
   struct dds_rhc *m_rhc; /* aliases m_rd->rhc with a wider interface, FIXME: but m_rd owns it for resource management */
-  struct reader *m_rd;
+  struct ddsi_reader *m_rd;
   bool m_loan_out;
   void *m_loan;
   uint32_t m_loan_size;
@@ -351,7 +351,7 @@ typedef struct dds_writer {
   struct dds_entity m_entity;
   struct dds_topic *m_topic; /* refc'd, constant, lock(wr) -> lock(tp) allowed */
   struct nn_xpack *m_xp;
-  struct writer *m_wr;
+  struct ddsi_writer *m_wr;
   struct whc *m_whc; /* FIXME: ownership still with underlying DDSI writer (cos of DDSI built-in writers )*/
   bool whc_batch; /* FIXME: channels + latency budget */
 #ifdef DDS_HAS_SHM

src/core/ddsc/src/dds__write.h

@@ -31,7 +31,7 @@ typedef enum {
 
 dds_return_t dds_write_impl (dds_writer *wr, const void *data, dds_time_t tstamp, dds_write_action action);
 dds_return_t dds_writecdr_impl (dds_writer *wr, struct nn_xpack *xp, struct ddsi_serdata *d, bool flush);
-dds_return_t dds_writecdr_local_orphan_impl (struct local_orphan_writer *lowr, struct ddsi_serdata *d);
+dds_return_t dds_writecdr_local_orphan_impl (struct ddsi_local_orphan_writer *lowr, struct ddsi_serdata *d);
 
 #if defined (__cplusplus)
 }

src/core/ddsc/src/dds__writer.h

@@ -20,14 +20,14 @@ extern "C" {
 
 DEFINE_ENTITY_LOCK_UNLOCK(dds_writer, DDS_KIND_WRITER)
 
-struct status_cb_data;
+struct ddsi_status_cb_data;
 
-void dds_writer_status_cb (void *entity, const struct status_cb_data * data);
+void dds_writer_status_cb (void *entity, const struct ddsi_status_cb_data * data);
 
 DDS_EXPORT dds_return_t dds_return_writer_loan(dds_writer *writer, void **buf,
                                                int32_t bufsz) ddsrt_nonnull_all;
 
-DDS_EXPORT dds_return_t dds__writer_wait_for_acks (struct dds_writer *wr, ddsi_guid_t *rdguid, dds_time_t abstimeout);
+DDS_EXPORT dds_return_t dds__ddsi_writer_wait_for_acks (struct dds_writer *wr, ddsi_guid_t *rdguid, dds_time_t abstimeout);
 
 #if defined (__cplusplus)
 }

src/core/ddsc/src/dds_builtin.c

@@ -171,7 +171,7 @@ bool dds__validate_builtin_reader_qos (const dds_domain *dom, dds_entity_t topic
     /* failing writes on built-in topics are unwelcome complications, so we simply
        forbid the creation of a reader matching a built-in topics writer that has
        resource limits */
-    struct local_orphan_writer *bwr;
+    struct ddsi_local_orphan_writer *bwr;
     switch (topic)
     {
       case DDS_BUILTIN_TOPIC_DCPSPARTICIPANT:
@@ -245,7 +245,7 @@ static bool dds__builtin_is_builtintopic (const struct ddsi_sertype *tp, void *v
 static bool dds__builtin_is_visible (const ddsi_guid_t *guid, nn_vendorid_t vendorid, void *vdomain)
 {
   (void) vdomain;
-  if (is_builtin_endpoint (guid->entityid, vendorid) || is_builtin_topic (guid->entityid, vendorid))
+  if (ddsi_is_builtin_endpoint (guid->entityid, vendorid) || ddsi_is_builtin_topic (guid->entityid, vendorid))
     return false;
   return true;
 }
@@ -263,31 +263,31 @@ static struct ddsi_tkmap_instance *dds__builtin_get_tkmap_entry (const struct dd
   return tk;
 }
 
-struct ddsi_serdata *dds__builtin_make_sample_endpoint (const struct entity_common *e, ddsrt_wctime_t timestamp, bool alive)
+struct ddsi_serdata *dds__builtin_make_sample_endpoint (const struct ddsi_entity_common *e, ddsrt_wctime_t timestamp, bool alive)
 {
   /* initialize to avoid gcc warning ultimately caused by C's horrible type system */
   struct dds_domain *dom = e->gv->builtin_topic_interface->arg;
   struct ddsi_sertype *type = NULL;
   switch (e->kind)
   {
-    case EK_PARTICIPANT:
-    case EK_PROXY_PARTICIPANT:
+    case DDSI_EK_PARTICIPANT:
+    case DDSI_EK_PROXY_PARTICIPANT:
       type = dom->builtin_participant_type;
       break;
-    case EK_WRITER:
-    case EK_PROXY_WRITER:
+    case DDSI_EK_WRITER:
+    case DDSI_EK_PROXY_WRITER:
       type = dom->builtin_writer_type;
       break;
-    case EK_READER:
-    case EK_PROXY_READER:
+    case DDSI_EK_READER:
+    case DDSI_EK_PROXY_READER:
       type = dom->builtin_reader_type;
       break;
     default:
       abort ();
       break;
   }
   assert (type != NULL);
-  struct ddsi_serdata *serdata = dds_serdata_builtin_from_endpoint (type, &e->guid, (struct entity_common *) e, alive ? SDK_DATA : SDK_KEY);
+  struct ddsi_serdata *serdata = dds_serdata_builtin_from_endpoint (type, &e->guid, (struct ddsi_entity_common *) e, alive ? SDK_DATA : SDK_KEY);
   serdata->timestamp = timestamp;
   serdata->statusinfo = alive ? 0 : NN_STATUSINFO_DISPOSE | NN_STATUSINFO_UNREGISTER;
   return serdata;
@@ -305,43 +305,43 @@ static struct ddsi_serdata *dds__builtin_make_sample_topic_impl (const struct dd
   return serdata;
 }
 
-struct ddsi_serdata *dds__builtin_make_sample_topic (const struct entity_common *e, ddsrt_wctime_t timestamp, bool alive)
+struct ddsi_serdata *dds__builtin_make_sample_topic (const struct ddsi_entity_common *e, ddsrt_wctime_t timestamp, bool alive)
 {
-  struct topic *tp = (struct topic *) e;
+  struct ddsi_topic *tp = (struct ddsi_topic *) e;
   ddsrt_mutex_lock (&tp->e.qos_lock);
   struct ddsi_serdata *sd = dds__builtin_make_sample_topic_impl (tp->definition, timestamp, alive);
   ddsrt_mutex_unlock (&tp->e.qos_lock);
   return sd;
 }
 
-struct ddsi_serdata *dds__builtin_make_sample_proxy_topic (const struct proxy_topic *proxytp, ddsrt_wctime_t timestamp, bool alive)
+struct ddsi_serdata *dds__builtin_make_sample_proxy_topic (const struct ddsi_proxy_topic *proxytp, ddsrt_wctime_t timestamp, bool alive)
 {
   return dds__builtin_make_sample_topic_impl (proxytp->definition, timestamp, alive);
 }
 
 #endif /* DDS_HAS_TOPIC_DISCOVERY  */
 
-static void dds__builtin_write_endpoint (const struct entity_common *e, ddsrt_wctime_t timestamp, bool alive, void *vdomain)
+static void dds__builtin_write_endpoint (const struct ddsi_entity_common *e, ddsrt_wctime_t timestamp, bool alive, void *vdomain)
 {
   struct dds_domain *dom = vdomain;
-  if (dds__builtin_is_visible (&e->guid, get_entity_vendorid (e), dom))
+  if (dds__builtin_is_visible (&e->guid, ddsi_get_entity_vendorid (e), dom))
   {
     /* initialize to avoid gcc warning ultimately caused by C's horrible type system */
-    struct local_orphan_writer *bwr = NULL;
+    struct ddsi_local_orphan_writer *bwr = NULL;
     struct ddsi_serdata *serdata = dds__builtin_make_sample_endpoint (e, timestamp, alive);
     assert (e->tk != NULL);
     switch (e->kind)
     {
-      case EK_PARTICIPANT:
-      case EK_PROXY_PARTICIPANT:
+      case DDSI_EK_PARTICIPANT:
+      case DDSI_EK_PROXY_PARTICIPANT:
         bwr = dom->builtintopic_writer_participant;
         break;
-      case EK_WRITER:
-      case EK_PROXY_WRITER:
+      case DDSI_EK_WRITER:
+      case DDSI_EK_PROXY_WRITER:
         bwr = dom->builtintopic_writer_publications;
         break;
-      case EK_READER:
-      case EK_PROXY_READER:
+      case DDSI_EK_READER:
+      case DDSI_EK_PROXY_READER:
         bwr = dom->builtintopic_writer_subscriptions;
         break;
       default:
@@ -356,7 +356,7 @@ static void dds__builtin_write_endpoint (const struct entity_common *e, ddsrt_wc
 static void dds__builtin_write_topic (const struct ddsi_topic_definition *tpd, ddsrt_wctime_t timestamp, bool alive, void *vdomain)
 {
   struct dds_domain *dom = vdomain;
-  struct local_orphan_writer *bwr = dom->builtintopic_writer_topics;
+  struct ddsi_local_orphan_writer *bwr = dom->builtintopic_writer_topics;
   struct ddsi_serdata *serdata = dds__builtin_make_sample_topic_impl (tpd, timestamp, alive);
   dds_writecdr_local_orphan_impl (bwr, serdata);
 }
@@ -409,12 +409,12 @@ void dds__builtin_init (struct dds_domain *dom)
 
   thread_state_awake (lookup_thread_state (), &dom->gv);
   const struct entity_index *gh = dom->gv.entity_index;
-  dom->builtintopic_writer_participant = new_local_orphan_writer (&dom->gv, to_entityid (NN_ENTITYID_SPDP_BUILTIN_PARTICIPANT_WRITER), DDS_BUILTIN_TOPIC_PARTICIPANT_NAME, dom->builtin_participant_type, qos, builtintopic_whc_new (DSBT_PARTICIPANT, gh));
+  dom->builtintopic_writer_participant = ddsi_new_local_orphan_writer (&dom->gv, ddsi_to_entityid (NN_ENTITYID_SPDP_BUILTIN_PARTICIPANT_WRITER), DDS_BUILTIN_TOPIC_PARTICIPANT_NAME, dom->builtin_participant_type, qos, builtintopic_whc_new (DSBT_PARTICIPANT, gh));
 #ifdef DDS_HAS_TOPIC_DISCOVERY
-  dom->builtintopic_writer_topics = new_local_orphan_writer (&dom->gv, to_entityid (NN_ENTITYID_SEDP_BUILTIN_TOPIC_WRITER), DDS_BUILTIN_TOPIC_TOPIC_NAME, dom->builtin_topic_type, qos, builtintopic_whc_new (DSBT_TOPIC, gh));
+  dom->builtintopic_writer_topics = ddsi_new_local_orphan_writer (&dom->gv, ddsi_to_entityid (NN_ENTITYID_SEDP_BUILTIN_TOPIC_WRITER), DDS_BUILTIN_TOPIC_TOPIC_NAME, dom->builtin_topic_type, qos, builtintopic_whc_new (DSBT_TOPIC, gh));
 #endif
-  dom->builtintopic_writer_publications = new_local_orphan_writer (&dom->gv, to_entityid (NN_ENTITYID_SEDP_BUILTIN_PUBLICATIONS_WRITER), DDS_BUILTIN_TOPIC_PUBLICATION_NAME, dom->builtin_writer_type, qos, builtintopic_whc_new (DSBT_WRITER, gh));
-  dom->builtintopic_writer_subscriptions = new_local_orphan_writer (&dom->gv, to_entityid (NN_ENTITYID_SEDP_BUILTIN_SUBSCRIPTIONS_WRITER), DDS_BUILTIN_TOPIC_SUBSCRIPTION_NAME, dom->builtin_reader_type, qos, builtintopic_whc_new (DSBT_READER, gh));
+  dom->builtintopic_writer_publications = ddsi_new_local_orphan_writer (&dom->gv, ddsi_to_entityid (NN_ENTITYID_SEDP_BUILTIN_PUBLICATIONS_WRITER), DDS_BUILTIN_TOPIC_PUBLICATION_NAME, dom->builtin_writer_type, qos, builtintopic_whc_new (DSBT_WRITER, gh));
+  dom->builtintopic_writer_subscriptions = ddsi_new_local_orphan_writer (&dom->gv, ddsi_to_entityid (NN_ENTITYID_SEDP_BUILTIN_SUBSCRIPTIONS_WRITER), DDS_BUILTIN_TOPIC_SUBSCRIPTION_NAME, dom->builtin_reader_type, qos, builtintopic_whc_new (DSBT_READER, gh));
   thread_state_asleep (lookup_thread_state ());
 
   dds_delete_qos (qos);
@@ -429,12 +429,12 @@ void dds__builtin_fini (struct dds_domain *dom)
 {
   /* No more sources for builtin topic samples */
   thread_state_awake (lookup_thread_state (), &dom->gv);
-  delete_local_orphan_writer (dom->builtintopic_writer_participant);
+  ddsi_delete_local_orphan_writer (dom->builtintopic_writer_participant);
 #ifdef DDS_HAS_TOPIC_DISCOVERY
-  delete_local_orphan_writer (dom->builtintopic_writer_topics);
+  ddsi_delete_local_orphan_writer (dom->builtintopic_writer_topics);
 #endif
-  delete_local_orphan_writer (dom->builtintopic_writer_publications);
-  delete_local_orphan_writer (dom->builtintopic_writer_subscriptions);
+  ddsi_delete_local_orphan_writer (dom->builtintopic_writer_publications);
+  ddsi_delete_local_orphan_writer (dom->builtintopic_writer_subscriptions);
   thread_state_asleep (lookup_thread_state ());
   unref_builtin_types (dom);
 }