Implementing netconf-confirmed-commit

src/common.c

@@ -371,6 +371,246 @@ np_ntf_send(struct nc_session *ncs, const struct timespec *timestamp, struct lyd
     return rc;
 }
 
+/**
+ * @brief Create common session parameters to identify a management session.
+ *
+ * Detail description is in the common-session-parms grouping located in the ietf-netconf-notifications module.
+ *
+ * @param[in] new_session Created NC session.
+ * @param[in,out] notif Notification to which the session parameters are to be added.
+ * @return 0 on success.
+ */
+static LY_ERR
+np_prepare_notif_common_session_parms(const struct nc_session *session, struct lyd_node *notif)
+{
+    char *value;
+    char num32[11]; /* max bytes for 32-bit unsigned number + \0 */
+
+    assert(session && notif);
+
+    /* create 'username' node */
+    value = (char *)nc_session_get_username(session);
+    if (lyd_new_term(notif, notif->schema->module, "username", value, 0, NULL)) {
+        return -1;
+    }
+
+    /* create 'session-id' node */
+    sprintf(num32, "%" PRIu32, nc_session_get_id(session));
+    if (lyd_new_term(notif, notif->schema->module, "session-id", num32, 0, NULL)) {
+        return -1;
+    }
+
+    /* create 'source-host' node */
+    if (nc_session_get_ti(session) != NC_TI_UNIX) {
+        value = (char *)nc_session_get_host(session);
+        if (lyd_new_term(notif, notif->schema->module, "source-host", value, 0, NULL)) {
+            return -1;
+        }
+    }
+
+    return 0;
+}
+
+int
+np_send_notif_session_start(const struct nc_session *new_session, sr_session_ctx_t *sr_session, uint32_t sr_timeout)
+{
+    int rc = 0, r;
+    const struct ly_ctx *ly_ctx;
+    const struct lys_module *mod;
+    struct lyd_node *notif = NULL;
+
+    /* get module */
+    ly_ctx = nc_session_get_ctx(new_session);
+    mod = ly_ctx_get_module_implemented(ly_ctx, "ietf-netconf-notifications");
+    if (!mod) {
+        goto cleanup;
+    }
+
+    /* create 'netconf-session-start' notification */
+    if (lyd_new_inner(NULL, mod, "netconf-session-start", 0, &notif)) {
+        rc = -1;
+        goto cleanup;
+    }
+
+    /* create 'common-session-parms' grouping */
+    if ((rc = np_prepare_notif_common_session_parms(new_session, notif))) {
+        goto cleanup;
+    }
+
+    /* send notification */
+    if ((r = sr_notif_send_tree(sr_session, notif, sr_timeout, 0))) {
+        WRN("Failed to send a notification (%s).", sr_strerror(r));
+        rc = -1;
+        goto cleanup;
+    }
+
+    VRB("Generated new event (netconf-session-start).");
+
+cleanup:
+    lyd_free_tree(notif);
+    return rc;
+}
+
+int
+np_send_notif_session_end(const struct nc_session *session, sr_session_ctx_t *sr_session, uint32_t sr_timeout)
+{
+    int rc = 0, r;
+    const struct ly_ctx *ly_ctx;
+    const struct lys_module *mod;
+    struct lyd_node *notif = NULL;
+    char num32[11]; /* max bytes for 32-bit unsigned number + \0 */
+    char *value;
+
+    /* get module */
+    ly_ctx = nc_session_get_ctx(session);
+    mod = ly_ctx_get_module_implemented(ly_ctx, "ietf-netconf-notifications");
+    if (!mod) {
+        goto cleanup;
+    }
+
+    /* create 'netconf-session-end' notification */
+    if (lyd_new_inner(NULL, mod, "netconf-session-end", 0, &notif)) {
+        rc = -1;
+        goto cleanup;
+    }
+
+    /* create 'common-session-parms' grouping */
+    if ((rc = np_prepare_notif_common_session_parms(session, notif))) {
+        goto cleanup;
+    }
+
+    /* create 'killed-by' node */
+    if (nc_session_get_killed_by(session)) {
+        sprintf(num32, "%" PRIu32, nc_session_get_killed_by(session));
+        if (lyd_new_term(notif, notif->schema->module, "killed-by", num32, 0, NULL)) {
+            rc = -1;
+            goto cleanup;
+        }
+    }
+
+    /* create 'termination-reason' node */
+    switch (nc_session_get_term_reason(session)) {
+    case NC_SESSION_TERM_CLOSED:
+        value = "closed";
+        break;
+    case NC_SESSION_TERM_KILLED:
+        value = "killed";
+        break;
+    case NC_SESSION_TERM_DROPPED:
+        value = "dropped";
+        break;
+    case NC_SESSION_TERM_TIMEOUT:
+        value = "timeout";
+        break;
+    default:
+        value = "other";
+        break;
+    }
+    if (lyd_new_term(notif, notif->schema->module, "termination-reason", value, 0, NULL)) {
+        rc = -1;
+        goto cleanup;
+    }
+
+    /* send notification */
+    if ((r = sr_notif_send_tree(sr_session, notif, sr_timeout, 0))) {
+        WRN("Failed to send a notification (%s).", sr_strerror(r));
+        rc = -1;
+        goto cleanup;
+    }
+
+    VRB("Generated new event (netconf-session-end).");
+
+cleanup:
+    lyd_free_tree(notif);
+    return rc;
+}
+
+int
+np_send_notif_confirmed_commit(const struct nc_session *session, sr_session_ctx_t *sr_session, enum np_cc_event event,
+        uint32_t cc_timeout, uint32_t sr_timeout)
+{
+    int rc = 0, r;
+    const struct ly_ctx *ly_ctx;
+    const struct lys_module *mod;
+    struct lyd_node *notif = NULL;
+    char num32[11]; /* max bytes for 32-bit unsigned number + \0 */
+    char *value;
+
+    /* get context */
+    if (session) {
+        ly_ctx = nc_session_get_ctx(session);
+    } else {
+        assert(event == NP_CC_TIMEOUT);
+        ly_ctx = sr_session_acquire_context(sr_session);
+    }
+
+    /* get module */
+    mod = ly_ctx_get_module_implemented(ly_ctx, "ietf-netconf-notifications");
+    if (!mod) {
+        goto cleanup;
+    }
+
+    /* create 'netconf-confirmed-commit' notification */
+    if (lyd_new_inner(NULL, mod, "netconf-confirmed-commit", 0, &notif)) {
+        rc = -1;
+        goto cleanup;
+    }
+
+    /* create 'common-session-parms' grouping */
+    if ((event != NP_CC_TIMEOUT) && (rc = np_prepare_notif_common_session_parms(session, notif))) {
+        goto cleanup;
+    }
+
+    /* create 'confirm-event' node */
+    switch (event) {
+    case NP_CC_START:
+        value = "start";
+        break;
+    case NP_CC_CANCEL:
+        value = "cancel";
+        break;
+    case NP_CC_TIMEOUT:
+        value = "timeout";
+        break;
+    case NP_CC_EXTEND:
+        value = "extend";
+        break;
+    case NP_CC_COMPLETE:
+        value = "complete";
+        break;
+    default:
+        rc = -1;
+        goto cleanup;
+    }
+    if (lyd_new_term(notif, notif->schema->module, "confirm-event", value, 0, NULL)) {
+        rc = -1;
+        goto cleanup;
+    }
+
+    /* create 'timeout' node */
+    if (cc_timeout) {
+        assert((event == NP_CC_START) || (event == NP_CC_EXTEND));
+        sprintf(num32, "%" PRIu32, cc_timeout);
+        if (lyd_new_term(notif, notif->schema->module, "timeout", num32, 0, NULL)) {
+            rc = -1;
+            goto cleanup;
+        }
+    }
+
+    /* send notification */
+    if ((r = sr_notif_send_tree(sr_session, notif, sr_timeout, 0))) {
+        WRN("Failed to send a notification (%s).", sr_strerror(r));
+        rc = -1;
+        goto cleanup;
+    }
+
+    VRB("Generated new event (netconf-confirmed-commit).");
+
+cleanup:
+    lyd_free_tree(notif);
+    return rc;
+}
+
 const struct ly_ctx *
 np2srv_acquire_ctx_cb(void *cb_data)
 {
@@ -387,12 +627,8 @@ int
 np2srv_new_session_cb(const char *UNUSED(client_name), struct nc_session *new_session, void *UNUSED(user_data))
 {
     int c;
-    sr_val_t *event_data;
     sr_session_ctx_t *sr_sess = NULL;
     struct np2_user_sess *user_sess = NULL;
-    const struct ly_ctx *ly_ctx;
-    const struct lys_module *mod;
-    char *host = NULL;
     uint32_t nc_id;
     const char *username;
 
@@ -443,33 +679,8 @@ np2srv_new_session_cb(const char *UNUSED(client_name), struct nc_session *new_se
         goto error;
     }
 
-    ly_ctx = nc_session_get_ctx(new_session);
-    if ((mod = ly_ctx_get_module_implemented(ly_ctx, "ietf-netconf-notifications"))) {
-        /* generate ietf-netconf-notification's netconf-session-start event for sysrepo */
-        if (nc_session_get_ti(new_session) != NC_TI_UNIX) {
-            host = (char *)nc_session_get_host(new_session);
-        }
-        event_data = calloc(3, sizeof *event_data);
-        event_data[0].xpath = "/ietf-netconf-notifications:netconf-session-start/username";
-        event_data[0].type = SR_STRING_T;
-        event_data[0].data.string_val = (char *)nc_session_get_username(new_session);
-        event_data[1].xpath = "/ietf-netconf-notifications:netconf-session-start/session-id";
-        event_data[1].type = SR_UINT32_T;
-        event_data[1].data.uint32_val = nc_session_get_id(new_session);
-        if (host) {
-            event_data[2].xpath = "/ietf-netconf-notifications:netconf-session-start/source-host";
-            event_data[2].type = SR_STRING_T;
-            event_data[2].data.string_val = host;
-        }
-        c = sr_notif_send(np2srv.sr_sess, "/ietf-netconf-notifications:netconf-session-start", event_data, host ? 3 : 2,
-                np2srv.sr_timeout, 0);
-        if (c != SR_ERR_OK) {
-            WRN("Failed to send a notification (%s).", sr_strerror(c));
-        } else {
-            VRB("Generated new event (netconf-session-start).");
-        }
-        free(event_data);
-    }
+    /* generate ietf-netconf-notification's netconf-session-start event for sysrepo */
+    np_send_notif_session_start(new_session, np2srv.sr_sess, np2srv.sr_timeout);
 
     return 0;
 

src/common.h

@@ -226,6 +226,49 @@ int np_ntf_add_dup(const struct lyd_node *notif, const struct timespec *timestam
  */
 int np_ntf_send(struct nc_session *ncs, const struct timespec *timestamp, struct lyd_node **ly_ntf, int use_ntf);
 
+/**
+ * @brief Send notification netconf-session-start.
+ *
+ * @param[in] new_session Created NC session.
+ * @param[in] sr_session Sysrepo server session.
+ * @param[in] sr_timeout Notification callback timeout in milliseconds.
+ * @return 0 on success.
+ */
+int np_send_notif_session_start(const struct nc_session *new_session, sr_session_ctx_t *sr_session, uint32_t sr_timeout);
+
+/**
+ * @brief Send notification netconf-session-end.
+ *
+ * @param[in] new_session NC session.
+ * @param[in] sr_session Sysrepo server session.
+ * @param[in] sr_timeout Notification callback timeout in milliseconds.
+ * @return 0 on success.
+ */
+int np_send_notif_session_end(const struct nc_session *session, sr_session_ctx_t *sr_session, uint32_t sr_timeout);
+
+enum np_cc_event {
+    NP_CC_START = 0,    /**< The confirmed-commit has started. */
+    NP_CC_CANCEL,       /**< The confirmed-commit has been canceled, e.g., due to the session being terminated,
+                             or an explicit <cancel-commit> operation. */
+    NP_CC_TIMEOUT,      /**< The confirmed-commit has been canceled due to the confirm-timeout interval expiring. */
+    NP_CC_EXTEND,       /**< The confirmed-commit timeout has been extended, e.g., by a new <confirmed-commit> operation. */
+    NP_CC_COMPLETE      /**< The confirmed-commit has been completed. */
+};
+
+/**
+ * @brief Send notification netconf-confirmed-commit.
+ *
+ * @param[in] new_session NC session. For :NP_CC_TIMEOUT can be NULL.
+ * @param[in] sr_session Sysrepo server session.
+ * @param[in] event Type of confirm-commit event.
+ * @param[in] cc_timout For event :NP_CC_START or :NP_CC_EXTEND. Number of seconds when the confirmed-commit 'timeout'
+ * event might occur.
+ * @param[in] sr_timeout Notification callback timeout in milliseconds.
+ * @return 0 on success.
+ */
+int np_send_notif_confirmed_commit(const struct nc_session *session, sr_session_ctx_t *sr_session,
+        enum np_cc_event event, uint32_t cc_timeout, uint32_t sr_timeout);
+
 /**
  * @brief NP2 callback for acquiring context.
  */