save it just in case, as VM under risk

Author: renukamanavalan

common/COMPILE_README

@@ -0,0 +1,43 @@
+1) Using ~/source/sonic-buildimage/c_build.sh 
+2) It uses _upd_cmn.sh to update files
+3) On failure, go to  ~/source/sonic-buildimage/target/debs/bullseye
+4) open libswsscommon_1.0.0_amd64.deb.log
+
+Get failing command. Run from inside src/sonic-swss-common/common. Interestingly c compilation alone works fine outside slave too. 
+NOTE: From within slave you can't copy files from another repo as root of slave is at ~/src/sonic-buildimage
+
+/bin/bash ../libtool  --tag=CXX   --mode=compile g++ -DHAVE_CONFIG_H -I. -I.. -I .. -g -DNDEBUG  -ansi -fPIC -std=c++11 -Wall -Wcast-align -Wcast-qual -Wconversion -Wdisabled-optimization -Werror -Wextra -Wfloat-equal -Wformat=2 -Wformat-nonliteral -Wformat-security -Wformat-y2k -Wimport -Winit-self -Winvalid-pch -Wlong-long -Wmissing-field-initializers -Wmissing-format-attribute -Wmissing-include-dirs -Wmissing-noreturn -Wno-aggregate-return -Wno-padded -Wno-switch-enum -Wno-unused-parameter -Wpacked -Wpointer-arith -Wredundant-decls -Wshadow -Wstack-protector -Wstrict-aliasing=3 -Wswitch -Wswitch-default -Wunreachable-code -Wunused -Wvariadic-macros -Wno-write-strings -Wno-missing-format-attribute -Wno-long-long   -Wdate-time -D_FORTIFY_SOURCE=2 -g -DNDEBUG  -ansi -fPIC -std=c++11 -Wall -Wcast-align -Wcast-qual -Wconversion -Wdisabled-optimization -Werror -Wextra -Wfloat-equal -Wformat=2 -Wformat-nonliteral -Wformat-security -Wformat-y2k -Wimport -Winit-self -Winvalid-pch -Wlong-long -Wmissing-field-initializers -Wmissing-format-attribute -Wmissing-include-dirs -Wmissing-noreturn -Wno-aggregate-return -Wno-padded -Wno-switch-enum -Wno-unused-parameter -Wpacked -Wpointer-arith -Wredundant-decls -Wshadow -Wstack-protector -Wstrict-aliasing=3 -Wswitch -Wswitch-default -Wunreachable-code -Wunused -Wvariadic-macros -Wno-write-strings -Wno-missing-format-attribute -Wno-long-long -I/usr/include/libnl3  -g -O2 -ffile-prefix-map=/sonic/src/sonic-swss-common=. -fstack-protector-strong -Wformat -Werror=format-security -c -o libswsscommon_la-events_common.lo `test -f 'events_common.cpp' || echo './'`events_common.cpp:wq
+
+
+
+
+
+
+localadmin@c7cbc0ba3b64:/sonic$ cat c_build.sh 
+#! /bin/bash
+
+set -x
+
+./_upd_cmn.sh
+
+rm -f target/debs/bullseye/libswsscommon*
+rm -f target/sonic-broadcom.bin target/sonic-aboot-broadcom.swi
+# KEEP_SLAVE_ON=yes SONIC_BUILD_JOBS=7 PASSWORD=password make target/debs/bullseye/libswsscommon_1.0.0_amd64.deb
+KEEP_SLAVE_ON=yes make target/debs/bullseye/libswsscommon_1.0.0_amd64.deb
+# make target/debs/bullseye/libswsscommon_1.0.0_amd64.deb
+#SONIC_BUILD_JOBS=7 PASSWORD=password make target/sonic-broadcom.bin
+# SONIC_BUILD_JOBS=7 PASSWORD=password make target/sonic-aboot-broadcom.swi
+
+
+localadmin@c7cbc0ba3b64:/sonic$ cat _upd_cmn.sh 
+#! /bin/bash
+
+SRCD="/home/localadmin/source/fork/syslog_telemetry/remanava/sonic-swss-common/common"
+DSTD="./src/sonic-swss-common/common"
+
+for i in Makefile.am events.h events_common.cpp events_common.h
+do
+    echo "copying $i"
+    cp ${SRCD}/$i ${DSTD}/$i
+done
+localadmin@c7cbc0ba3b64:/sonic$ 

common/events.cpp

@@ -0,0 +1,173 @@
+#include "events_pi.h"
+
+lst_publishers_t EventPublisher::s_publishers = lst_publishers_t();
+
+EventPublisher::EventPublisher(const string source) :
+    m_zmq_ctx(NULL), m_socket(NULL), m_sequence(0), m_init(false)
+{
+    uuuid_clear(m_runtime_id);
+
+}
+
+int EventPublisher::init(const string event_source, int block_ms)
+{
+    m_zmq_ctx = zmq_ctx_new();
+    m_socket = zmq_socket (m_zmq_ctx, ZMQ_PUB);
+
+    int rc = zmq_connect (m_socket, get_config(XSUB_END_KEY));
+    RET_ON_ERR(rc == 0, "Publisher fails to connect %s", get_config(XSUB_END_KEY));
+
+    // REQ socket is connected and a message is sent & received, more to
+    // ensure PUB socket had enough time to establish connection.
+    // Any message published before connection establishment is dropped.
+    //
+    event_service m_event_svc;
+    rc = m_event_svc.init_client(block_ms);
+    RET_ON_ERR (rc == 0, "Failed to init event service");
+
+    rc = m_event_svc.echo_send("hello");
+    RET_ON_ERR (rc == 0, "Failed to echo send in event service");
+
+    zmq_msg_init_size(&m_zmsg_source, event_source.size());
+    memcpy((char *)zmq_msg_data(&m_zmsg_source), event_source, event_source.size());
+
+    m_event_source(event_source);
+
+    uuid_t id;
+    uuid_generate(id);
+    uuid_unparse(id, m_runtime_id);
+
+    m_init = true;
+out:
+    return m_init ? 0 : -1;
+}
+
+EventPublisher::~EventPublisher()
+{
+    zmq_msg_close(&m_zmsg_source);
+    zmq_close(m_socket);
+    zmq_close(m_echo_socket);
+    zmq_ctx_term(m_zmq_ctx);
+}
+
+
+void
+EventPublisher::event_publish(const string tag, const event_params_t *params)
+{
+    zmq_msg_t msg;
+
+    if (m_event_service.is_active()) {
+        string s;
+
+        /* Failure is no-op; The eventd service my be down
+         * NOTE: This call atmost blocks for block_ms milliseconds
+         * as provided in publisher init.
+         */
+        m_event_service.echo_receive(s);
+    }
+
+    string param_str;
+    if ((params != NULL) && (param->find(event_ts) != params->end())) {
+
+        param_str = serialize(*params);
+    }
+    else {
+        event_params_t evt_params = *params;
+        evt_params[event_ts] = get_timestamp();
+        param_str = serialize(evt_params);
+    }
+
+    map_str_str_t event_str = { { m_event_source + ":" + tag, param_str}};
+
+    ++m_sequence;
+    internal_event_t event_data;
+    event_data[EVENT_STR_DATA] = serialize(event_str);
+    {
+        stringstream ss;
+
+        ss << m_sequence;
+
+        event_data[EVENT_SEQUENCE] = ss.str();
+    }
+    event_data[EVENT_RUNTIME_ID] = m_runtime_id;
+
+    map_to_zmsg(event_data, msg);
+
+    // Send the message
+    // First part -- The event-source/pattern
+    // Second part -- Metadata
+    // Third part -- Params, if given
+    //
+    RET_ON_ERR(zmq_msg_send (&m_zmsg_source, m_socket, ZMQ_SNDMORE) != -1,
+            "Failed to publish part 1 to %s", XSUB_PATH);
+    RET_ON_ERR(zmq_msg_send (&msg, m_socket, 0) != -1,
+            "Failed to publish part 2 to %s", XSUB_PATH);
+out:
+    zmq_msg_close(&msg_metadata);
+
+}
+
+event_handle_t
+events_init_publisher(const string event_source, int block_millisecs)
+{
+    event_handle_t ret = NULL;
+    lst_publishers_t::iterator it = s_publishers.find(event_source);
+    if (it != s_publishers.end()) {
+        // Pre-exists
+        ret = it->second;
+    }
+    else {
+        EventPublisher *p =  new EventPublisher();
+
+        int rc = p->init(event_source, block_millisecs);
+
+        if (rc != 0) {
+            delete p;
+        }
+        else {
+            ret = p;
+            s_publishers[key] = ret;
+        }
+    }
+    return ret;
+}
+
+void
+events_deinit_publisher(event_handle_t &handle)
+{
+    lst_publishers_t::iterator it;
+    EventPublisher *pub = dynamic_cast<EventPublisher *>(&handle);
+
+    for(it=s_publishers.begin(); it != s_publishers.end(); ++it) {
+        if (it->second == handle) {
+            break;
+        }
+    }
+
+    if (it != s_publishers.end() {
+        s_publishers.erase(it);
+
+        delete pub;
+    }
+    handle = NULL;
+
+}
+
+void
+event_publish(event_handle_t handle, const string tag, const event_params_t *params)
+{
+    EventPublisher *pub = dynamic_cast<EventPublisher *>(handle);
+
+    for(it=s_publishers.begin(); it != s_publishers.end(); ++it) {
+        if (it->second == handle) {
+            pub->event_publish(tag, params);
+            break;
+        }
+    }
+}
+
+
+
+
+
+

common/events.h

@@ -28,12 +28,21 @@ typedef events_base* event_handle_t;
  *      The YANG module name for the event source. All events published with the handle
  *      returned by this call is tagged with this source, transparently. The receiver
  *      could subscribe with this source as filter.
+ *
+ *  block_millisecs -
+ *      Block either until publisher connects successfully or timeout
+ *      whichever earlier.
+ *      0   - No blocling.
+ *      -1  - Block until connected.
+ *      N   - Count in milli seconds to wait.
+ *      NOTE: The connection is to eventd service, which could be down.
  * Return 
  *  Non NULL handle
  *  NULL on failure
  */
 
-event_handle_t events_init_publisher(std::string &event_source);
+event_handle_t events_init_publisher(std::string event_source,
+        int block_millisecs);
 
 /*
  * De-init/free the publisher
@@ -52,6 +61,11 @@ void events_deinit_publisher(event_handle_t &handle);
  */
 typedef std::map<std::string, std::string> event_params_t;
 
+/*
+ * timestamp param name
+ */
+const string event_ts("timestamp");
+
 /*
  * Publish an event
  *
@@ -79,9 +93,11 @@ typedef std::map<std::string, std::string> event_params_t;
  *  params -
  *      Params associated with event; This may or may not contain
  *      timestamp. In the absence, the timestamp is added, transparently.
+ *      The timestamp should be per rfc3339
+ *      e.g. "2022-08-17T02:39:21.286611Z"
  *
  */
-void event_publish(event_handle_t handle, const std::string &event_tag,
+void event_publish(event_handle_t handle, const std::string event_tag,
         const event_params_t *params=NULL);
 
 

common/events_common.h

@@ -15,6 +15,11 @@
 using namespace std;
 using namespace chrono;
 
+#define RET_ON_ERR(res, ...) {\
+    if (!(res)) \
+        SWSS_LOG_ERROR(__VA_ARGS__); }
+        goto out;
+
 #define ERR_CHECK(res, ...) {\
     if (!(res)) \
         SWSS_LOG_ERROR(__VA_ARGS__); }
@@ -44,21 +49,6 @@ string get_config(const string key);
 
 const string get_timestamp();
 
-/*
- * events are published as two part zmq message.
- * First part only has the event source, so receivers could
- * filter by source.
- *
- * Second part contains event as defined below.
- *
- * The callers would only see, event_str_t
- */
-typedef struct {
-    event_str_t event;
-    uint32_t runtime_id;
-    uint32_t sequence;
-} internal_event_t;
-
 const string serialize(const map_str_str_t & data);
 
 void deserialize(const string& s, map_str_str_t & data);