qemu: monitor: Factor out and document code to format QMP command

Move formatting of the qemu command out of qemuMonitorJSONMakeCommandRaw
to qemuMonitorJSONMakeCommandInternal to allow greater reusability and
document the function better.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: John Ferlan <jferlan@redhat.com>

diff --git a/src/qemu/qemu_monitor_json.c b/src/qemu/qemu_monitor_json.c
index 6dcded93691e617a3d7e309a123ffc3700a87944..0b0fb7feba39ecb8b4a03c996fbc80ac9b5ce08a 100644 (file)
--- a/src/qemu/qemu_monitor_json.c
+++ b/src/qemu/qemu_monitor_json.c
@@ -464,40 +464,68 @@ qemuMonitorJSONHasError(virJSONValuePtr reply,
 }
 
 
-/* Top-level commands and nested transaction list elements share a
- * common structure for everything except the dictionary names.  */
+/**
+ * qemuMonitorJSONMakeCommandInternal:
+ * @cmdname: QMP command name
+ * @arguments: a JSON object containing command arguments or NULL
+ * @transaction: format the command as arguments for the 'transaction' command
+ *
+ * Create a JSON object used on the QMP monitor to call a command. If
+ * @transaction is true, the returned object is formatted to be used as a member
+ * of the 'transaction' command.
+ *
+ * Note that @arguments is always consumed and should not be referenced after
+ * the call to this function.
+ */
+static virJSONValuePtr
+qemuMonitorJSONMakeCommandInternal(const char *cmdname,
+                                   virJSONValuePtr arguments,
+                                   bool transaction)
+{
+    virJSONValuePtr cmd = NULL;
+    virJSONValuePtr ret = NULL;
+
+    if (!transaction) {
+        if (virJSONValueObjectCreate(&cmd,
+                                     "s:execute", cmdname,
+                                     "A:arguments", &arguments, NULL) < 0)
+            goto cleanup;
+    } else {
+        if (virJSONValueObjectCreate(&cmd,
+                                     "s:type", cmdname,
+                                     "A:data", &arguments, NULL) < 0)
+            goto cleanup;
+    }
+
+    VIR_STEAL_PTR(ret, cmd);
+
+ cleanup:
+    virJSONValueFree(arguments);
+    virJSONValueFree(cmd);
+    return ret;
+}
+
+
 static virJSONValuePtr ATTRIBUTE_SENTINEL
-qemuMonitorJSONMakeCommandRaw(bool wrap, const char *cmdname, ...)
+qemuMonitorJSONMakeCommandRaw(bool transaction,
+                              const char *cmdname,
+                              ...)
 {
-    virJSONValuePtr obj;
+    virJSONValuePtr obj = NULL;
     virJSONValuePtr jargs = NULL;
     va_list args;
 
     va_start(args, cmdname);
 
-    if (!(obj = virJSONValueNewObject()))
-        goto error;
-
-    if (virJSONValueObjectAppendString(obj, wrap ? "type" : "execute",
-                                       cmdname) < 0)
-        goto error;
-
     if (virJSONValueObjectCreateVArgs(&jargs, args) < 0)
-        goto error;
+        goto cleanup;
 
-    if (jargs &&
-        virJSONValueObjectAppend(obj, wrap ? "data" : "arguments", jargs) < 0)
-        goto error;
+    obj = qemuMonitorJSONMakeCommandInternal(cmdname, jargs, transaction);
 
+ cleanup:
     va_end(args);
 
     return obj;
-
- error:
-    virJSONValueFree(obj);
-    virJSONValueFree(jargs);
-    va_end(args);
-    return NULL;
 }
 
 #define qemuMonitorJSONMakeCommand(cmdname, ...) \