Added new backend plugin callback: plugin_statedata() for getting state data; Added generic xml_merge() function.

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Clixon CHANGELOG
 	
-- Yang anyxml and extensions basic support added
+- Added generic xml_merge() function.
+
+- Added new backend plugin callback: "plugin_statedata()" for getting state data
 
 - Added yang dir with ietf-netconf and clixon-config yang specs for internal usage.
 

apps/backend/backend_client.c

@@ -242,7 +242,6 @@ from_client_get_config(clicon_handle h,
 	goto ok;
     }
     cprintf(cbret, "<rpc-reply><data>");
-    /* if empty only <data/>, if any data then <data><config>..</config></data> */
     if (xret!=NULL){
 	if (xml_child_nr(xret)){
 	    if (xml_name_set(xret, "config") < 0)
@@ -265,6 +264,7 @@ from_client_get_config(clicon_handle h,
  * @param[in]  h     Clicon handle
  * @param[in]  xe    Netconf request xml tree   
  * @param[out] cbret Return xml value cligen buffer
+ * @see from_client_get_config
  */
 static int
 from_client_get(clicon_handle h,
@@ -279,6 +279,7 @@ from_client_get(clicon_handle h,
     if ((xfilter = xml_find(xe, "filter")) != NULL)
 	if ((selector = xml_find_value(xfilter, "select"))==NULL)
 	    selector="/";
+    /* Get config */
     if (xmldb_get(h, "running", selector, 0, &xret) < 0){
 	cprintf(cbret, "<rpc-reply><rpc-error>"
 		"<error-tag>operation-failed</error-tag>"
@@ -288,8 +289,12 @@ from_client_get(clicon_handle h,
 		"</rpc-error></rpc-reply>");
 	goto ok;
     }
+    /* Get state data from plugins as defined by plugin_statedata(), if any */
+    assert(xret);
+    if (backend_statedata_call(h, selector, xret) < 0)
+	goto done;
     cprintf(cbret, "<rpc-reply><data>");
-    /* if empty only <data/>, if any data then <data><config>..</config></data> */
+    /* if empty only <config/> */
     if (xret!=NULL){
 	if (xml_child_nr(xret)){
 	    if (xml_name_set(xret, "config") < 0)
@@ -984,7 +989,7 @@ from_client_msg(clicon_handle        h,
 		goto done;
 	}
 	else{
-	    if ((ret = backend_netconf_plugin_callbacks(h, xe, ce, cbret)) < 0)
+	    if ((ret = backend_rpc_cb_call(h, xe, ce, cbret)) < 0)
 		goto done;
 	    if (ret == 0) /* not handled by callback */
 		cprintf(cbret, "<rpc-reply><rpc-error>"

apps/backend/backend_main.c

@@ -87,6 +87,8 @@ backend_terminate(clicon_handle h)
     if ((yspec = clicon_dbspec_yang(h)) != NULL)
 	yspec_free(yspec);
     plugin_finish(h);
+    /* Delete all backend plugin RPC callbacks */
+    backend_rpc_cb_delete_all(); 
     if (pidfile)
 	unlink(pidfile);   
     if (sockpath)

apps/backend/backend_plugin.c

@@ -68,11 +68,22 @@
  * Types
  */
 /* Following are specific to backend. For common see clicon_plugin.h 
- * @note  the following should match the prototypes in clicon_backend.h
+ * @note  the following should match the prototypes in clixon_backend.h
  */
 #define PLUGIN_RESET           "plugin_reset"
 typedef int (plgreset_t)(clicon_handle h, char *dbname); /* Reset system status */
 
+/*! Plugin callback, if defined called to get state data from plugin
+ * @param[in]    h      Clicon handle
+ * @param[in]    xpath  String with XPATH syntax. or NULL for all
+ * @param[in]    xtop   XML tree, <config/> on entry. 
+ * @retval       0      OK
+ * @retval      -1      Error
+ * @see xmldb_get
+ */
+#define PLUGIN_STATEDATA       "plugin_statedata"
+typedef int (plgstatedata_t)(clicon_handle h, char *xpath, cxobj *xtop);
+
 #define PLUGIN_TRANS_BEGIN     "transaction_begin"
 #define PLUGIN_TRANS_VALIDATE  "transaction_validate"
 #define PLUGIN_TRANS_COMPLETE  "transaction_complete"
@@ -80,6 +91,7 @@ typedef int (plgreset_t)(clicon_handle h, char *dbname); /* Reset system status
 #define PLUGIN_TRANS_END       "transaction_end"
 #define PLUGIN_TRANS_ABORT     "transaction_abort"
 
+
 typedef int (trans_cb_t)(clicon_handle h, transaction_data td); /* Transaction cbs */
 
 /* Backend (config) plugins */
@@ -90,12 +102,14 @@ struct plugin {
     plgstart_t	      *p_start;		 /* Start */
     plgexit_t         *p_exit;		 /* Exit */
     plgreset_t	      *p_reset;		 /* Reset state */
+    plgstatedata_t    *p_statedata;      /* State-data callback */
     trans_cb_t        *p_trans_begin;	 /* Transaction start */
     trans_cb_t        *p_trans_validate; /* Transaction validation */
     trans_cb_t        *p_trans_complete; /* Transaction validation complete */
     trans_cb_t        *p_trans_commit;   /* Transaction commit */
     trans_cb_t        *p_trans_end;	 /* Transaction completed  */
     trans_cb_t        *p_trans_abort;	 /* Transaction aborted */
+
 };
 
 /*
@@ -212,6 +226,8 @@ backend_plugin_load (clicon_handle h,
 	 clicon_debug(2, "%s callback registered.", PLUGIN_EXIT);
     if ((new->p_reset    = dlsym(handle, PLUGIN_RESET)) != NULL)
 	 clicon_debug(2, "%s callback registered.", PLUGIN_RESET);
+    if ((new->p_statedata    = dlsym(handle, PLUGIN_STATEDATA)) != NULL)
+	clicon_debug(2, "%s callback registered.", PLUGIN_STATEDATA);
     if ((new->p_trans_begin    = dlsym(handle, PLUGIN_TRANS_BEGIN)) != NULL)
 	clicon_debug(2, "%s callback registered.", PLUGIN_TRANS_BEGIN);
     if ((new->p_trans_validate = dlsym(handle, PLUGIN_TRANS_VALIDATE)) != NULL)
@@ -700,3 +716,82 @@ plugin_transaction_abort(clicon_handle       h,
     return retval;
 }
 	
+/*----------------------------------------------------------------------
+ * Backend state data callbacks
+ */
+
+/*! Go through all backend statedata callbacks and collect state data
+ * This is internal system call, plugin is invoked (does not call) this function
+ * Backend plugins can register 
+ * @param[in]  h       clicon handle
+ * @param[in]  xpath   String with XPATH syntax. or NULL for all
+ * @param[in,out] xml  XML tree.
+ * @retval -1   Error
+ * @retval  0   OK
+ */
+int
+backend_statedata_call(clicon_handle        h,
+		       char                *xpath,
+		       cxobj               *xtop)
+{
+    int            retval = -1;
+    struct plugin *p;
+    int            i;
+    cxobj         *x = NULL;
+    yang_spec     *yspec;
+    cxobj        **xvec = NULL;
+    size_t         xlen;
+
+    if ((yspec =  clicon_dbspec_yang(h)) == NULL){
+	clicon_err(OE_YANG, ENOENT, "No yang spec");
+	goto done;
+    }
+    if (xtop==NULL){
+	clicon_err(OE_CFG, ENOENT, "XML tree expected");
+	goto done;
+    }
+    for (i = 0; i < nplugins; i++)  {
+	p = &plugins[i];
+	if (p->p_statedata) {
+	    if ((x = xml_new("config", NULL)) == NULL)
+		goto done;
+	    if ((p->p_statedata)(h, xpath, x) < 0)
+		goto done;
+	    if (xml_merge(xtop, x, yspec) < 0)
+		goto done;
+	    if (x){
+		xml_free(x);
+		x = NULL;
+	    }
+	}
+    }
+    {
+	/* Code complex to filter out anything that is outside of xpath */
+	if (xpath_vec(xtop, xpath?xpath:"/", &xvec, &xlen) < 0)
+	    goto done;
+
+	/* If vectors are specified then mark the nodes found and
+	 * then filter out everything else,
+	 * otherwise return complete tree.
+	 */
+	if (xvec != NULL){
+	    for (i=0; i<xlen; i++)
+		xml_flag_set(xvec[i], XML_FLAG_MARK);
+	}
+	/* Remove everything that is not marked */
+	if (!xml_flag(xtop, XML_FLAG_MARK))
+	    if (xml_tree_prune_flagged_sub(xtop, XML_FLAG_MARK, 1, NULL) < 0)
+		goto done;
+	/* reset flag */
+	if (xml_apply(xtop, CX_ELMNT, (xml_applyfn_t*)xml_flag_reset, (void*)XML_FLAG_MARK) < 0)
+	    goto done;
+    }
+    retval = 0;
+ done:
+    if (x)
+	xml_free(x);
+    if (xvec)
+	free(xvec);
+    return retval;
+}
+

apps/backend/backend_plugin.h

@@ -69,6 +69,8 @@ int  plugin_finish(clicon_handle h);
 int  plugin_reset_state(clicon_handle h, char *dbname);
 int  plugin_start_hooks(clicon_handle h, int argc, char **argv);
 
+int backend_statedata_call(clicon_handle h, char *xpath, cxobj *xml);
+
 transaction_data_t * transaction_new(void);
 int transaction_free(transaction_data_t *);
 

apps/backend/clixon_backend.h

@@ -72,6 +72,11 @@ int plugin_exit(clicon_handle h);
  */
 int plugin_reset(clicon_handle h, char *dbname);
 
+/*! Retreive statedata, add statedata to XML tree
+ * @see plgstatedata_ t
+ */
+int plugin_statedata(clicon_handle h, char *xpath, cxobj *xtop);
+
 /*! Called before a commit/validate sequence begins. Eg setup state before commit 
  * @see trans_cb_t
  */

apps/backend/clixon_backend_handle.c

@@ -430,48 +430,57 @@ subscription_each(clicon_handle               h,
     return hs;
 }
 
-/* Database dependency description */
+/*--------------------------------------------------------------------
-struct backend_netconf_reg {
+ * Backend netconf rpc callbacks
-    qelem_t 	 nr_qelem;	/* List header */
+ */
-    backend_netconf_cb_t nr_callback;	/* Validation/Commit Callback */
+typedef struct {
-    void	*nr_arg;	/* Application specific argument to cb */
+    qelem_t 	   rc_qelem;	/* List header */
-    char        *nr_tag;	/* Xml tag when matched, callback called */
+    backend_rpc_cb rc_callback;  /* RPC Callback */
-};
+    void	  *rc_arg;	/* Application specific argument to cb */
-typedef struct backend_netconf_reg backend_netconf_reg_t;
+    char          *rc_tag;	/* Xml tag when matched, callback called */
+} backend_rpc_cb_entry;
 
-static backend_netconf_reg_t *deps = NULL;
+/* List of backend rpc callback entries */
-/*! Register netconf callback
+static backend_rpc_cb_entry *rpc_cb_list = NULL;
+
+/*! Register netconf backend rpc callback
  * Called from plugin to register a callback for a specific netconf XML tag.
+ *
+ * @param[in]  h       clicon handle
+ * @param[in]  cb,     Callback called 
+ * @param[in]  arg,    Arg to send to callback 
+ * @param[in]  tag     Xml tag when callback is made 
+ * @see backend_rpc_cb_call
  */
 int
-backend_netconf_register_callback(clicon_handle h,
+backend_rpc_cb_register(clicon_handle  h,
-				  backend_netconf_cb_t cb,      /* Callback called */
+			backend_rpc_cb cb,
-				  void *arg,        /* Arg to send to callback */
+			void          *arg,       
-				  char *tag)        /* Xml tag when callback is made */
+			char          *tag)
 {
-    backend_netconf_reg_t *nr;
+    backend_rpc_cb_entry *rc;
 
-    if ((nr = malloc(sizeof(backend_netconf_reg_t))) == NULL) {
+    if ((rc = malloc(sizeof(backend_rpc_cb_entry))) == NULL) {
 	clicon_err(OE_DB, errno, "malloc: %s", strerror(errno));
 	goto catch;
     }
-    memset (nr, 0, sizeof (*nr));
+    memset (rc, 0, sizeof (*rc));
-    nr->nr_callback = cb;
+    rc->rc_callback = cb;
-    nr->nr_arg  = arg;
+    rc->rc_arg  = arg;
-    nr->nr_tag  = strdup(tag); /* XXX strdup memleak */
+    rc->rc_tag  = strdup(tag); /* XXX strdup memleak */
-    INSQ(nr, deps);
+    INSQ(rc, rpc_cb_list);
     return 0;
 catch:
-    if (nr){
+    if (rc){
-	if (nr->nr_tag)
+	if (rc->rc_tag)
-	    free(nr->nr_tag);
+	    free(rc->rc_tag);
-	free(nr);
+	free(rc);
     }
     return -1;
 }
 
-/*! See if there is any callback registered for this tag
+/*! Search netconf backend callbacks and invoke if match
- *
+ * This is internal system call, plugin is invoked (does not call) this functino
  * @param[in]  h       clicon handle
  * @param[in]  xe      Sub-tree (under xorig) at child of rpc: <rpc><xn></rpc>.
  * @param[in]  ce      Client (session) entry
@@ -480,28 +489,49 @@ catch:
  * @retval -1   Error
  * @retval  0   OK, not found handler.
  * @retval  1   OK, handler called
+ * @see backend_rpc_cb_register
  */
 int
-backend_netconf_plugin_callbacks(clicon_handle        h,
+backend_rpc_cb_call(clicon_handle        h,
 		    cxobj               *xe,
 		    struct client_entry *ce,
 		    cbuf                *cbret)
 {
-    backend_netconf_reg_t *nreg;
+    backend_rpc_cb_entry *rc;
-    int            retval;
+    int                   retval = -1;
 
-    if (deps == NULL)
+    if (rpc_cb_list == NULL)
 	return 0;
-    nreg = deps;
+    rc = rpc_cb_list;
     do {
-	if (strcmp(nreg->nr_tag, xml_name(xe)) == 0){
+	if (strcmp(rc->rc_tag, xml_name(xe)) == 0){
-	    if ((retval = nreg->nr_callback(h, xe, ce, cbret, nreg->nr_arg)) < 0)
+	    if ((retval = rc->rc_callback(h, xe, ce, cbret, rc->rc_arg)) < 0)
-		return -1;
+		goto done;
-	    else
+	    else{
-		return 1; /* handled */
+		retval = 1; /* handled */
+		goto done;
+	    }
+	}
+	rc = NEXTQ(backend_rpc_cb_entry *, rc);
+    } while (rc != rpc_cb_list);
+    retval = 0;
+ done:
+    return retval;
+}
+
+/*! Delete all state data callbacks.
+ */
+int
+backend_rpc_cb_delete_all(void)
+{
+    backend_rpc_cb_entry *rc;
+
+    while((rc = rpc_cb_list) != NULL) {
+	DELQ(rc, rpc_cb_list, backend_rpc_cb_entry *);
+	if (rc->rc_tag)
+	    free(rc->rc_tag);
+	free(rc);
     }
-	nreg = NEXTQ(backend_netconf_reg_t *, nreg);
-    } while (nreg != deps);
     return 0;
 }
 

apps/backend/clixon_backend_handle.h

@@ -44,13 +44,15 @@
  * Types
  */
 struct client_entry;
-typedef int (*backend_netconf_cb_t)(
+typedef int (*backend_rpc_cb)(
     clicon_handle h, 
     cxobj               *xe,   /* Request: <rpc><xn></rpc> */
     struct client_entry *ce,   /* Client session */
-    cbuf  *cbret,            /* Reply eg <rpc-reply>... */
+    cbuf                *cbret,/* Reply eg <rpc-reply>... */
     void                *arg   /* Argument given at register */
 );  
+typedef backend_rpc_cb backend_netconf_cb_t; /* XXX backward compat */
+
 
 /*! Generic downcall registration. 
  * Enables any function to be called from (cli) frontend
@@ -90,12 +92,14 @@ int subscription_delete(clicon_handle h, char *stream,
 struct handle_subscription *subscription_each(clicon_handle h,
 				      struct handle_subscription *hprev);
 
-int backend_netconf_register_callback(clicon_handle h,
+/* XXX backward compat */
-			      backend_netconf_cb_t cb,   /* Callback called */
+#define backend_netconf_register_callback(a,b,c,d) backend_rpc_cb_register(a,b,c,d)
-			      void *arg,       /* Arg to send to callback */
+int backend_rpc_cb_register(clicon_handle h, backend_rpc_cb cb,	void *arg, 
-			      char *tag);      /* Xml tag when callback is made */
+			    char *tag);      
 
-int backend_netconf_plugin_callbacks(clicon_handle h, cxobj *xe, 
+int backend_rpc_cb_call(clicon_handle h, cxobj *xe, struct client_entry *ce, 
-				     struct client_entry *ce, cbuf *cbret);
+			cbuf *cbret);
+
+int backend_rpc_cb_delete_all(void);
 
 #endif /* _CLIXON_BACKEND_HANDLE_H_ */

apps/restconf/restconf_lib.c

@@ -180,6 +180,16 @@ badrequest(FCGX_Request *r)
     return 0;
 }
 
+int
+notimplemented(FCGX_Request *r)
+{
+    clicon_debug(1, "%s", __FUNCTION__);
+    FCGX_FPrintF(r->out, "Status: 501\r\n"); 
+    FCGX_FPrintF(r->out, "Content-Type: text/html\r\n\r\n");
+    FCGX_FPrintF(r->out, "<h1>Not Implemented/h1>\n");
+    return 0;
+}
+
 int
 conflict(FCGX_Request *r)
 {

apps/restconf/restconf_lib.h

@@ -47,6 +47,7 @@ int restconf_err2code(char *tag);
 const char *restconf_code2reason(int code);
 int notfound(FCGX_Request *r);
 int badrequest(FCGX_Request *r);
+int notimplemented(FCGX_Request *r);
 int conflict(FCGX_Request *r);
 int clicon_debug_xml(int dbglevel, char *str, cxobj *cx);
 int test(FCGX_Request *r, int dbg);

apps/restconf/restconf_methods.c

@@ -171,7 +171,7 @@ api_data_get_gen(clicon_handle h,
 	goto done;
     }
     clicon_debug(1, "%s path:%s", __FUNCTION__, cbuf_get(path));
-    if (clicon_rpc_get_config(h, "running", cbuf_get(path), &xret) < 0){
+    if (clicon_rpc_get(h, cbuf_get(path), &xret) < 0){
 	notfound(r);
 	goto done;
     }
@@ -541,8 +541,7 @@ api_data_patch(clicon_handle h,
 	      cvec         *qvec, 
 	      char         *data)
 {
-    badrequest(r);
+    notimplemented(r);
-    //    return api_data_edit(h, r, api_path, pcvec, pi, qvec, data, OP_MERGE);
     return 0;
 }
 

datastore/text/clixon_xmldb_text.c

@@ -331,7 +331,6 @@ text_get(xmldb_handle xh,
     if (xml_apply(xt, CX_ELMNT, xml_spec_populate, yspec) < 0)
 	goto done;
 
-    /* XXX Maybe the below is general function and should be moved to xmldb? */
     if (xpath_vec(xt, xpath?xpath:"/", &xvec, &xlen) < 0)
 	goto done;
 
@@ -460,11 +459,10 @@ match_base_child(cxobj     *x0,
 
 /*! Modify a base tree x0 with x1 with yang spec y according to operation op
  * @param[in]  x0  Base xml tree (can be NULL in add scenarios)
+ * @param[in]  y0  Yang spec corresponding to xml-node x0. NULL if x0 is NULL
  * @param[in]  x0p Parent of x0
  * @param[in]  x1  xml tree which modifies base
  * @param[in]  op  OP_MERGE, OP_REPLACE, OP_REMOVE, etc 
- * @param[in]  y0  Yang spec corresponding to xml-node x0. NULL if x0 is NULL
- * @param[in]  yspec Top-level yang spec (if y is NULL)
  * Assume x0 and x1 are same on entry and that y is the spec
  * @see put in clixon_keyvalue.c
  */

example/routing_backend.c

@@ -129,6 +129,40 @@ routing_downcall(clicon_handle h,
     cprintf(cbret, "<rpc-reply><ok>%s</ok></rpc-reply>", xml_body(xe));    
     return 0;
 }
+
+/*! Called to get state data from plugin
+ * @param[in]    h      Clicon handle
+ * @param[in]    xpath  String with XPATH syntax. or NULL for all
+ * @param[in]    xtop   XML tree, <config/> on entry. 
+ * @retval       0      OK
+ * @retval      -1      Error
+ * @see xmldb_get
+ */
+int 
+plugin_statedata(clicon_handle h, 
+		 char         *xpath,
+		 cxobj        *xstate)
+{
+    int     retval = -1;
+    cxobj **xvec = NULL;
+
+    /* Example of statedata, remove 0 to enable */
+    if (0 && (xml_parse("<interfaces-state><interface>"
+		   "<name>eth0</name>"
+		   "<type>eth</type>"
+		   "<admin-status>up</admin-status>"
+		   "<oper-status>up</oper-status>"
+		   "<if-index>42</if-index>"
+		   "<speed>1000000000</speed>"
+		   "</interface></interfaces-state>", xstate)) < 0)
+	goto done;
+    retval = 0;
+ done:
+    if (xvec)
+	free(xvec);
+    return retval;
+}
+
 /*
  * Plugin initialization
  */
@@ -139,7 +173,8 @@ plugin_init(clicon_handle h)
 
     if (notification_timer_setup(h) < 0)
 	goto done;
-    if (backend_netconf_register_callback(h, routing_downcall, 
+    /* Register callback for netconf application-specific rpc call */
+    if (backend_rpc_cb_register(h, routing_downcall, 
 				NULL, 
 				"myrouting"/* Xml tag when callback is made */
 				) < 0)

lib/clixon/clixon_proto_client.h

@@ -52,6 +52,7 @@ int clicon_rpc_copy_config(clicon_handle h, char *db1, char *db2);
 int clicon_rpc_delete_config(clicon_handle h, char *db);
 int clicon_rpc_lock(clicon_handle h, char *db);
 int clicon_rpc_unlock(clicon_handle h, char *db);
+int clicon_rpc_get(clicon_handle h, char *xpath, cxobj **xret);
 int clicon_rpc_close_session(clicon_handle h);
 int clicon_rpc_kill_session(clicon_handle h, int session_id);
 int clicon_rpc_validate(clicon_handle h, char *db);

lib/clixon/clixon_xml.h

@@ -128,6 +128,7 @@ int       clicon_xml_parse_file(int fd, cxobj **xml_top, char *endtag);
 #define clicon_xml_parse_string(str, x) clicon_xml_parse_str((*str), x) 
 int       clicon_xml_parse_str(char *str, cxobj **xml_top);
 int       clicon_xml_parse(cxobj **cxtop, char *format, ...);
+int       xml_parse(char *str, cxobj *x_up);
 
 int       xmltree2cbuf(cbuf *cb, cxobj *x, int level);
 int       xml_copy(cxobj *x0, cxobj *x1);

lib/clixon/clixon_xml_map.h

@@ -73,5 +73,6 @@ int xml_spec_populate(cxobj *x, void *arg);
 int api_path2xpath_cvv(yang_spec *yspec, cvec *cvv, int offset, cbuf *xpath);
 int api_path2xpath(yang_spec *yspec, char *api_path, cbuf *xpath);
 int api_path2xml(char *api_path, yang_spec *yspec, cxobj *xtop, cxobj **xpathp, yang_node **ypathp);
+int xml_merge(cxobj *x0, cxobj *x1, yang_spec *yspec);
 
 #endif  /* _CLIXON_XML_MAP_H_ */

lib/src/clixon_proto_client.c

@@ -476,6 +476,70 @@ clicon_rpc_unlock(clicon_handle h,
     return retval;
 }
 
+/*! Get database configuration and state data
+ * Same as clicon_proto_change just with a cvec instead of lvec
+ * @param[in]  h        CLICON handle
+ * @param[in]  xpath    XPath (or "")
+ * @param[out] xt       XML tree. Free with xml_free. 
+ *                      Either <config> or <rpc-error>. 
+ * @retval    0         OK
+ * @retval   -1         Error, fatal or xml
+ * @code
+ *    cxobj *xt = NULL;
+ *    if (clicon_rpc_get(h, "/", &xt) < 0)
+ *       err;
+ *   if ((xerr = xpath_first(xt, "/rpc-error")) != NULL){
+ *	clicon_rpc_generate_error(xerr);
+ *      err;
+ *  }
+ *    if (xt)
+ *       xml_free(xt);
+ * @endcode
+ * @see clicon_rpc_generate_error
+ */
+int
+clicon_rpc_get(clicon_handle       h, 
+	       char               *xpath,
+	       cxobj             **xt)
+{
+    int                retval = -1;
+    struct clicon_msg *msg = NULL;
+    cbuf              *cb = NULL;
+    cxobj             *xret = NULL;
+    cxobj             *xd;
+
+    if ((cb = cbuf_new()) == NULL)
+	goto done;
+    cprintf(cb, "<rpc><get>");
+    if (xpath && strlen(xpath))
+	cprintf(cb, "<filter type=\"xpath\" select=\"%s\"/>", xpath);
+    cprintf(cb, "</get></rpc>");
+    if ((msg = clicon_msg_encode("%s", cbuf_get(cb))) == NULL)
+	goto done;
+    if (clicon_rpc_msg(h, msg, &xret, NULL) < 0)
+	goto done;
+    /* Send xml error back: first check error, then ok */
+    if ((xd = xpath_first(xret, "/rpc-reply/rpc-error")) != NULL)
+	xd = xml_parent(xd); /* point to rpc-reply */
+    else if ((xd = xpath_first(xret, "/rpc-reply/data/config")) == NULL)
+	if ((xd = xml_new("config", NULL)) == NULL)
+	    goto done;
+    if (xt){
+	if (xml_rm(xd) < 0)
+	    goto done;
+	*xt = xd;
+    }
+    retval = 0;
+  done:
+    if (cb)
+	cbuf_free(cb);
+    if (xret)
+	xml_free(xret);
+    if (msg)
+	free(msg);
+    return retval;
+}
+
 /*! Close a (user) session
  * @param[in] h        CLICON handle
  */

lib/src/clixon_xml.c

@@ -466,9 +466,14 @@ xml_childvec_get(cxobj *x)
  *
  * @param[in]  name      Name of new 
  * @param[in]  xp        The parent where the new xml node should be inserted
- *
+ * @retval     xml       Created xml object if successful
- * @retval created xml object if successful
+ * @retval     NULL      Error and clicon_err() called
- * @retval NULL          if error and clicon_err() called
+ * @code
+ *   cxobj *x;
+ *   if ((x = xml_new(name, xparent)) == NULL)
+ *     err;
+ * @endcode
+ * @see xml_new_spec     Also sets yang spec.
  */
 cxobj *
 xml_new(char  *name, 
@@ -511,7 +516,6 @@ xml_new_spec(char  *name,
     return x;
 }
 
-
 void *
 xml_spec(cxobj *x)
 {
@@ -961,10 +965,12 @@ clicon_xml2cbuf(cbuf  *cb,
     return 0;
 }
 
-/*! Internal xml parsing function.
+/*! Basic xml parsing function.
+ * @param[in]  str   Pointer to string containing XML definition. 
+ * @param[out] xtop  Top of XML parse tree. Assume created.
  * @see clicon_xml_parse_file clicon_xml_parse_string
  */
-static int 
+int 
 xml_parse(char  *str, 
 	  cxobj *x_up)
 {

lib/src/clixon_xml_db.c

@@ -323,22 +323,17 @@ xmldb_setopt(clicon_handle h,
  * @param[in]  dbname Name of database to search in (filename including dir path
  * @param[in]  xpath  String with XPATH syntax. or NULL for all
  * @param[in]  config If set only configuration data, else also state
- * @param[out] xtop   Single XML tree which xvec points to. Free with xml_free()
+ * @param[out] xtop   Single XML tree. Free with xml_free()
  * @retval     0      OK
  * @retval     -1     Error
  * @code
  *   cxobj   *xt;
  *   if (xmldb_get(xh, "running", "/interfaces/interface[name="eth"]", 1, &xt) < 0)
  *      err;
- *   for (i=0; i<xlen; i++){
- *      xn = xv[i];
- *      ...
- *   }
  *   xml_free(xt);
  * @endcode
  * @note if xvec is given, then purge tree, if not return whole tree.
  * @see xpath_vec
- * @see xmldb_get
  */
 int 
 xmldb_get(clicon_handle h, 

lib/src/clixon_xml_map.c

@@ -1717,5 +1717,194 @@ api_path2xml(char      *api_path,
     return retval;
 }
 
+/*! Given a modification tree, check existing matching child in the base tree 
+ * param[in] x0    Base tree node
+ * param[in] x1c   Modification tree child
+ * param[in] yc    Yang spec of tree child
+ * param[out] x0cp Matching base tree child (if any)
+*/
+static int
+match_base_child(cxobj     *x0, 
+		 cxobj     *x1c,
+		 yang_stmt *yc,
+		 cxobj    **x0cp)
+{
+    int        retval = -1;
+    cxobj     *x0c = NULL;
+    char      *keyname;
+    cvec      *cvk = NULL;
+    cg_var    *cvi;
+    char      *b0;
+    char      *b1;
+    yang_stmt *ykey;
+    char      *cname;
+    int        ok;
+    char      *x1bstr; /* body string */
 
+    cname = xml_name(x1c);
+    switch (yc->ys_keyword){
+    case Y_LEAF_LIST: /* Match with name and value */
+	x1bstr = xml_body(x1c);
+	x0c = NULL;
+	while ((x0c = xml_child_each(x0, x0c, CX_ELMNT)) != NULL) {
+	    if (strcmp(cname, xml_name(x0c)) == 0 && 
+		strcmp(xml_body(x0c), x1bstr)==0)
+		break;
+	}
+	break;
+    case Y_LIST: /* Match with key values */
+	if ((ykey = yang_find((yang_node*)yc, Y_KEY, NULL)) == NULL){
+	    clicon_err(OE_XML, errno, "%s: List statement \"%s\" has no key", 
+		       __FUNCTION__, yc->ys_argument);
+	    goto done;
+	}
+	/* The value is a list of keys: <key>[ <key>]*  */
+	if ((cvk = yang_arg2cvec(ykey, " ")) == NULL)
+	    goto done;
+	x0c = NULL;
+	while ((x0c = xml_child_each(x0, x0c, CX_ELMNT)) != NULL) {
+	    if (strcmp(xml_name(x0c), cname))
+		continue;
+	    cvi = NULL;
+	    ok = 0;
+	    while ((cvi = cvec_each(cvk, cvi)) != NULL) {
+		keyname = cv_string_get(cvi);
+		ok = 1; /* if we come here */
+		if ((b0 = xml_find_body(x0c, keyname)) == NULL)
+		    break; /* error case */
+		if ((b1 = xml_find_body(x1c, keyname)) == NULL)
+		    break; /* error case */
+		if (strcmp(b0, b1))
+		    break;
+		ok = 2; /* and reaches here for all keynames, x0c is found. */
+	    }
+	    if (ok == 2)
+		break;
+	}
+	break;
+    default: /* Just match with name */
+	x0c = xml_find(x0, cname);
+	break;
+    }
+    *x0cp = x0c;
+    retval = 0;
+ done:
+    if (cvk)
+	cvec_free(cvk);
+    return retval;
+}
 
+/*! Merge a base tree x0 with x1 with yang spec y
+ * @param[in]  x0  Base xml tree (can be NULL in add scenarios)
+ * @param[in]  y0  Yang spec corresponding to xml-node x0. NULL if x0 is NULL
+ * @param[in]  x0p Parent of x0
+ * @param[in]  x1  xml tree which modifies base
+ * Assume x0 and x1 are same on entry and that y is the spec
+ * @see put in clixon_keyvalue.c
+ */
+static int
+xml_merge1(cxobj              *x0,
+	   yang_node          *y0,
+	   cxobj              *x0p,
+	   cxobj              *x1)
+{
+    int        retval = -1;
+    char      *x1name;
+    char      *x1cname; /* child name */
+    cxobj     *x0c; /* base child */
+    cxobj     *x0b; /* base body */
+    cxobj     *x1c; /* mod child */
+    char      *x1bstr; /* mod body string */
+    yang_stmt *yc;  /* yang child */
+
+    assert(x1 && xml_type(x1) == CX_ELMNT);
+    assert(y0);
+
+    x1name = xml_name(x1);
+    if (y0->yn_keyword == Y_LEAF_LIST || y0->yn_keyword == Y_LEAF){
+	x1bstr = xml_body(x1);
+	if (x0==NULL){
+	    if ((x0 = xml_new_spec(x1name, x0p, y0)) == NULL)
+		goto done;
+	    if (x1bstr){ /* empty type does not have body */
+		if ((x0b = xml_new("body", x0)) == NULL)
+		    goto done; 
+		xml_type_set(x0b, CX_BODY);
+	    }
+	}
+	if (x1bstr){
+	    if ((x0b = xml_body_get(x0)) == NULL){
+		if ((x0b = xml_new("body", x0)) == NULL)
+		    goto done; 
+		xml_type_set(x0b, CX_BODY);
+	    }
+	    if (xml_value_set(x0b, x1bstr) < 0)
+		goto done;
+	}
+
+    } /* if LEAF|LEAF_LIST */
+    else { /* eg Y_CONTAINER, Y_LIST  */
+	if (x0==NULL){
+	    if ((x0 = xml_new_spec(x1name, x0p, y0)) == NULL)
+		goto done;
+	}
+	/* Loop through children of the modification tree */
+	x1c = NULL;
+	while ((x1c = xml_child_each(x1, x1c, CX_ELMNT)) != NULL) {
+	    x1cname = xml_name(x1c);
+	    /* Get yang spec of the child */
+	    if ((yc = yang_find_syntax(y0, x1cname)) == NULL){
+		clicon_err(OE_YANG, errno, "No yang node found: %s", x1cname);
+		goto done;
+	    }
+	    /* See if there is a corresponding node in the base tree */
+	    x0c = NULL;
+	    if (yc && match_base_child(x0, x1c, yc, &x0c) < 0)
+		goto done;
+	    if (xml_merge1(x0c, (yang_node*)yc, x0, x1c) < 0)
+		goto done;
+	}
+    } /* else Y_CONTAINER  */
+    // ok:
+    retval = 0;
+ done:
+    return retval;
+}
+
+/*! Merge XML trees x1 into x0 according to yang spec yspec
+ * @note both x0 and x1 need to be top-level trees
+ * @see text_modify_top as more generic variant (in datastore text)
+ */
+int
+xml_merge(cxobj     *x0,
+	  cxobj     *x1,
+	  yang_spec *yspec)
+{
+    int        retval = -1;
+    char      *x1cname; /* child name */
+    cxobj     *x0c; /* base child */
+    cxobj     *x1c; /* mod child */
+    yang_stmt *yc;
+
+    /* Assure top-levels are 'config' */
+    assert(x0 && strcmp(xml_name(x0),"config")==0);
+    assert(x1 && strcmp(xml_name(x1),"config")==0);
+    /* Loop through children of the modification tree */
+    x1c = NULL;
+    while ((x1c = xml_child_each(x1, x1c, CX_ELMNT)) != NULL) {
+	x1cname = xml_name(x1c);
+	/* Get yang spec of the child */
+	if ((yc = yang_find_topnode(yspec, x1cname)) == NULL){
+	    clicon_err(OE_YANG, ENOENT, "No yang spec");
+	    goto done;
+	}
+	/* See if there is a corresponding node in the base tree */
+	if (match_base_child(x0, x1c, yc, &x0c) < 0)
+	    goto done;
+	if (xml_merge1(x0c, (yang_node*)yc, x0, x1c) < 0)
+	    goto done;
+    }
+    retval = 0;
+ done:
+    return retval;
+}

lib/src/clixon_xsl.c

@@ -925,12 +925,12 @@ xpath_each(cxobj *cxtop,
  * @retval     -1      error.
  *
  * @code
- *   cxobj **vec;
+ *   cxobj **xvec;
- *   size_t  veclen;
+ *   size_t  xlen;
- *   if (xpath_vec(cxtop, "//symbol/foo", &vec, &veclen) < 0) 
+ *   if (xpath_vec(cxtop, "//symbol/foo", &xvec, &xlen) < 0) 
  *      goto err;
- *   for (i=0; i<veclen; i++){
+ *   for (i=0; i<xlen; i++){
- *      xn = vec[i];
+ *      xn = xvec[i];
  *         ...
  *   }
  *   free(vec);

test/test2.sh

@@ -89,6 +89,9 @@ expecteof "$clixon_netconf -qf $clixon_cf" "<rpc><discard-changes/></rpc>]]>]]>"
 new "netconf edit state operation should fail"
 expecteof "$clixon_netconf -qf $clixon_cf" "<rpc><edit-config><target><candidate/></target><config><interfaces-state><interface><name>eth1</name><type>eth</type></interface></interfaces-state></config></edit-config></rpc>]]>]]>" "^<rpc-reply><rpc-error><error-tag>invalid-value</error-tag>"
 
+new "netconf get state operation"
+expecteof "$clixon_netconf -qf $clixon_cf" "<rpc><get><filter type=\"xpath\" select=\"/interfaces-state\"/></get></rpc>]]>]]>" "^<rpc-reply><data/></rpc-reply>]]>]]>$"
+
 new "netconf lock/unlock"
 expecteof "$clixon_netconf -qf $clixon_cf" "<rpc><lock><target><candidate/></target></lock></rpc>]]>]]><rpc><unlock><target><candidate/></target></unlock></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]><rpc-reply><ok/></rpc-reply>]]>]]>$"
 

test/test4.sh

@@ -82,7 +82,7 @@ new "netconf get leaf-list path"
 expecteof "$clixon_netconf -qf $clixon_cf -y /tmp/test" "<rpc><get-config><source><candidate/></source><filter type=\"xpath\" select=\"/x/f[e=hej]\"/></get-config></rpc>]]>]]>" "^<rpc-reply><data><config><x><f><e>hej</e><e>hopp</e></f></x></config></data></rpc-reply>]]>]]>$"
 
 new "netconf get (state data XXX should be some)"
-expecteof "$clixon_netconf -qf $clixon_cf -y /tmp/test" "<rpc><get><source><candidate/></source><filter type=\"xpath\" select=\"/\"/></get></rpc>]]>]]>" "^<rpc-reply><data><config><x><y><a>1</a><b>2</b><c>5</c></y><d/></x></config></data></rpc-reply>]]>]]>$"
+expecteof "$clixon_netconf -qf $clixon_cf -y /tmp/test" "<rpc><get><filter type=\"xpath\" select=\"/\"/></get></rpc>]]>]]>" "^<rpc-reply><data><config><x><y><a>1</a><b>2</b><c>5</c></y><d/></x></config></data></rpc-reply>]]>]]>$"
 
 new "cli set leaf-list"
 expectfn "$clixon_cli -1f $clixon_cf -y /tmp/test set x f e foo" ""

test/test6.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+# Test6: Yang specifics: rpc and state info
+
+# include err() and new() functions
+. ./lib.sh
+
+# For memcheck
+# clixon_netconf="valgrind --leak-check=full --show-leak-kinds=all clixon_netconf"
+clixon_netconf=clixon_netconf
+clixon_cli=clixon_cli
+
+cat <<EOF > /tmp/rpc.yang
+module ietf-ip{
+     rpc fib-route {
+       input {
+         leaf name {
+           type string;
+           mandatory "true";
+         }
+         leaf destination-address {
+           type string;
+         }
+       }
+       output {
+         container route {
+           leaf address{
+              type string;
+           }
+           leaf address{
+              type string;
+           } 
+         }
+       }
+     }
+}
+EOF
+
+# kill old backend (if any)
+new "kill old backend"
+sudo clixon_backend -zf $clixon_cf -y /tmp/rpc
+if [ $? -ne 0 ]; then
+    err
+fi
+
+new "start backend"
+# start new backend
+sudo clixon_backend -If $clixon_cf -y /tmp/rpc
+if [ $? -ne 0 ]; then
+    err
+fi
+new "netconf rpc (notyet)"
+#expecteof "$clixon_netconf -qf $clixon_cf -y /tmp/rpc" "<rpc><fib-route><name></name></fib-route></rpc>]]>]]>" "^<rpc-reply><ok/></rpc-reply>]]>]]>$"
+
+new "Kill backend"
+# Check if still alive
+pid=`pgrep clixon_backend`
+if [ -z "$pid" ]; then
+    err "backend already dead"
+fi
+# kill backend
+sudo clixon_backend -zf $clixon_cf
+if [ $? -ne 0 ]; then
+    err "kill backend"
+fi