Skip to contentSkip to conversation

MI: mi-lttng into libcommon, global option lttng_mi_opt , command version

MI-prototype David Goulet 2 participants 4 messages Mar 25, 2014 – Mar 28, 2014 3 messages not in the archive

lore
Share & tools
lore
#1 lore raw
In reply to a message not in the archive
Quoted 47 lines · Jonathan Rajotte

Hi guys,
This is our current machine interface backend.
You can test it by applying this patch to master.

Finally after discussion with Jeremie Galard and David Goulet, we chosed to use a global option for the machine interface.

	lttng --mi <output_type> <command>

The only output_type supported is xml.

Currently you can test it with the command version (nothing spectatular). We will send patch for list before monday.

That's it.

Thx

---
 include/lttng/lttng-error.h               |    6 +
 include/lttng/lttng.h                     |   20 +++
 src/bin/lttng-consumerd/lttng-consumerd.c |    2 +
 src/bin/lttng/commands/version.c          |   73 +++++++-
 src/bin/lttng/lttng.c                     |   32 +++-
 src/common/Makefile.am                    |    5 +-
 src/common/error.h                        |    6 +-
 src/common/mi-lttng.c                     |  273 +++++++++++++++++++++++++++++
 src/common/mi-lttng.h                     |  212 ++++++++++++++++++++++
 src/lib/lttng-ctl/lttng-ctl.c             |    1 +
 tests/unit/ini_config/ini_config.c        |    1 +
 tests/unit/test_kernel_data.c             |    1 +
 tests/unit/test_session.c                 |    1 +
 tests/unit/test_uri.c                     |    1 +
 tests/unit/test_ust_data.c                |    1 +
 tests/unit/test_utils_expand_path.c       |    1 +
 tests/unit/test_utils_parse_size_suffix.c |    1 +
 17 files changed, 629 insertions(+), 8 deletions(-)
 create mode 100644 src/common/mi-lttng.c
 create mode 100644 src/common/mi-lttng.h
include/lttng/lttng-error.h +0 -0
index 06baa04..18924dd 100644

include/lttng/lttng-error.h enum lttng_error_code { · line 148

Quoted 7 lines
include/lttng/lttng-error.h +4 -0
@@ -142,6 +142,12 @@ enum lttng_error_code {
 	LTTNG_ERR_NO_CONSUMER            = 109, /* No consumer exist for the session */
 	LTTNG_ERR_EXCLUSION_INVAL        = 110, /* Invalid event exclusion data */
 	LTTNG_ERR_EXCLUSION_NOMEM        = 111, /* Lack of memory while processing event exclusions */
+	/* 112 */
+	/* 113 */
+	/* 114 */
+	/* 115 */

Why adding 4 numbers here? You should actually use the empty values above before adding more. This is a long time legacy situation here when we refactored the error code but didn't want to break the API value thus there is empty slots...

Quoted 22 lines
include/lttng/lttng-error.h +2 -0
+	LTTNG_ERR_MI_OUTPUT_TYPE         = 116, /* Invalid MI output format */
+	LTTNG_ERR_MI_IO_FAIL             = 117, /* IO error while writing machine interface output */
 
 	/* MUST be last element */
 	LTTNG_ERR_NR,                           /* Last element */
include/lttng/lttng.h +5 -0
index f0be224..b0a1380 100644
@@ -170,6 +170,11 @@ enum lttng_buffer_type {
 	LTTNG_BUFFER_GLOBAL,	/* Only supported by the Kernel. */
 };
 
+/* Machine interface output type */
+enum lttng_mi_output_type {
+	LTTNG_MI_XML                          = 1 /* XML output */
+};
+
 /*
  * The structures should be initialized to zero before use.
  */

include/lttng/lttng.h struct lttng_handle { · line 384

Quoted 8 lines
include/lttng/lttng.h +5 -0
@@ -372,6 +377,21 @@ struct lttng_handle {
 };
 
 /*
+ * Version information for the machine interface.
+ */
+#define LTTNG_VERSION_PADDING1		16
+struct lttng_version {
+	char version[NAME_MAX];

Just to clarify, this holds for instance "2.4.0-rc2" full string?

include/lttng/lttng.h struct lttng_handle { · line 387

Quoted 3 lines
include/lttng/lttng.h +3 -0
+	int version_major;
+	int version_minor;
+	int version_patchlevel;

Should be uint32_t here.

include/lttng/lttng.h struct lttng_handle { · line 392

Quoted 5 lines
include/lttng/lttng.h +5 -0
+	char version_name[NAME_MAX];
+	char package_url[NAME_MAX];
+
+	char padding[LTTNG_VERSION_PADDING1];
+};

So this should not be in lttng.h but rather in mi-lttng.h probably. lttng.h is the *public* ABI thus data structure being used for the public API used by lttng_* function calls.

Thus padding won't be necessary.

Quoted 69 lines
include/lttng/lttng.h +2 -0
+
+/*
  * Public LTTng control API
  *
  * For functions having an lttng domain type as parameter, if a bad value is
src/bin/lttng-consumerd/lttng-consumerd.c +2 -0
index e226ebc..0ce163e 100644
@@ -65,6 +65,8 @@ static int sigintcount = 0;
 /* Argument variables */
 int lttng_opt_quiet;    /* not static in error.h */
 int lttng_opt_verbose;  /* not static in error.h */
+int lttng_opt_mi;       /* not static in error.h */
+
 static int opt_daemon;
 static const char *progname;
 static char command_sock_path[PATH_MAX]; /* Global command socket path */
src/bin/lttng/commands/version.c +19 -0
index 7f69de3..80a663e 100644
@@ -25,6 +25,8 @@
 #include <unistd.h>
 #include <config.h>
 
+#include <common/mi-lttng.h>
+
 #include "../command.h"
 
 enum {
@@ -32,6 +34,8 @@ enum {
 	OPT_LIST_OPTIONS,
 };
 
+static const char lttng_license[] = "lttng is free software and under the GPL license and part LGPL";
+
 static struct poptOption long_options[] = {
 	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
 	{"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
@@ -53,12 +57,27 @@ static void usage(FILE *ofp)
 }
 
 /*
+ *  create_version
+ */
+static void create_version(struct lttng_version *version)
+{
+	strncpy(version->version, VERSION, NAME_MAX);
+	version->version_major = VERSION_MAJOR;
+	version->version_minor = VERSION_MINOR;
+	version->version_patchlevel = VERSION_PATCHLEVEL;
+	strncpy(version->version_name, VERSION_NAME, NAME_MAX);
+	strncpy(version->package_url, PACKAGE_URL, NAME_MAX);
+}
+
+/*
  *  cmd_version
  */
 int cmd_version(int argc, const char **argv)
 {
 	int opt, ret = CMD_SUCCESS;
 	static poptContext pc;
+	struct mi_writer *writer = NULL;
+	struct lttng_version version;
 
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);

src/bin/lttng/commands/version.c int cmd_version(int argc, const char **argv) · line 100

Quoted 8 lines
src/bin/lttng/commands/version.c +1 -4
@@ -78,12 +97,58 @@ int cmd_version(int argc, const char **argv)
 		}
 	}
 
-	MSG("lttng version " VERSION " - " VERSION_NAME);
-	MSG("\n" VERSION_DESCRIPTION "\n");
-	MSG("Web site: http://lttng.org");
-	MSG("\nlttng is free software and under the GPL license and part LGPL");
+	if (lttng_opt_mi) {

I would go for a function to print the mi like maybe "print_mi()" since this *may* change depending on what output type we use. For now, only one but let's think ahead :) and this allow to handle the mi writer destruction in one specific call also, cleaner in the long run I think.

Quoted 79 lines
src/bin/lttng/commands/version.c +49 -0
+		create_version(&version);
+
+		writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
+
+		if (!writer) {
+			ret = -LTTNG_ERR_NOMEM;
+			goto end;
+		}
+
+		/* Open the command element */
+		ret = mi_lttng_writer_command_open(writer,
+				mi_lttng_element_command_version);
+		if (ret) {
+			goto end;
+		}
+
+		/* Beginning of output */
+		ret = mi_lttng_writer_open_element(writer,
+				mi_lttng_element_command_output);
+		if (ret) {
+			goto end;
+		}
+
+		ret = mi_lttng_version(writer, &version,
+				VERSION_DESCRIPTION,
+				lttng_license);
+		if (ret) {
+			goto end;
+		}
+
+		/* Close the output element */
+		ret = mi_lttng_writer_close_element(writer);
+		if (ret) {
+			goto end;
+		}
+
+		/* Close the command  */
+		ret = mi_lttng_writer_command_close(writer);
+
+	} else {
+		MSG("lttng version " VERSION " - " VERSION_NAME);
+		MSG("\n" VERSION_DESCRIPTION "\n");
+		MSG("Web site: http://lttng.org");
+		MSG("\n%s", lttng_license);
+	}
 
 end:
+	if (writer && mi_lttng_writer_destroy(writer)) {
+		/* Preserve original error code */
+		ret = ret ? ret : LTTNG_ERR_MI_IO_FAIL;
+	}
 	poptFreeContext(pc);
 	return ret;
 }
src/bin/lttng/lttng.c +3 -0
index bc7577d..ebfe6f2 100644
@@ -55,6 +55,7 @@ static struct option long_options[] = {
 	{"group",            1, NULL, 'g'},
 	{"verbose",          0, NULL, 'v'},
 	{"quiet",            0, NULL, 'q'},
+	{"mi",               1, NULL, 'm'},
 	{"no-sessiond",      0, NULL, 'n'},
 	{"sessiond-path",    1, NULL, OPT_SESSION_PATH},
 	{"relayd-path",      1, NULL, OPT_RELAYD_PATH},
@@ -99,6 +100,8 @@ static void usage(FILE *ofp)
 	fprintf(ofp, "      --list-commands        Simple listing of lttng commands\n");
 	fprintf(ofp, "  -v, --verbose              Increase verbosity\n");
 	fprintf(ofp, "  -q, --quiet                Quiet mode\n");
+	fprintf(ofp, "  -m, --mi TYPE              Machine Interface mode.\n");
+	fprintf(ofp, "                                 Type: xml\n");
 	fprintf(ofp, "  -g, --group NAME           Unix tracing group name. (default: tracing)\n");
 	fprintf(ofp, "  -n, --no-sessiond          Don't spawn a session daemon\n");
 	fprintf(ofp, "      --sessiond-path PATH   Session daemon full path\n");
@@ -136,6 +139,26 @@ static void version(FILE *ofp)
 }
 
 /*

src/bin/lttng/lttng.c static void version(FILE *ofp) · line 151

Quoted 10 lines
src/bin/lttng/lttng.c +10 -0
+ * mi_output_type
+ *
+ * Find the MI output type enum from a string
+ * This function is for the support of
+ * new output language.
+ */
+static int mi_output_type(const char *output_type)
+{
+	int ret = 0;
+	if (!strncmp("xml", output_type, 3)) {

Maybe we could also allow "XML" or a anything looking like that like "XmL". Isn't there a libc call that ignores the case ?

Quoted 68 lines
src/bin/lttng/lttng.c +18 -1
+		ret = LTTNG_MI_XML;
+	} else {
+		/* Invalid output format */
+		ERR("MI output format not supported");
+		ret = -LTTNG_ERR_MI_OUTPUT_TYPE;
+	}
+	return ret;
+}
+
+/*
  *  list_options
  *
  *  List options line by line. This is mostly for bash auto completion and to
@@ -426,7 +449,7 @@ static int parse_args(int argc, char **argv)
 		clean_exit(EXIT_FAILURE);
 	}
 
-	while ((opt = getopt_long(argc, argv, "+Vhnvqg:", long_options, NULL)) != -1) {
+	while ((opt = getopt_long(argc, argv, "+Vhnvqg:m:", long_options, NULL)) != -1) {
 		switch (opt) {
 		case 'V':
 			version(stdout);
@@ -442,6 +465,13 @@ static int parse_args(int argc, char **argv)
 		case 'q':
 			lttng_opt_quiet = 1;
 			break;
+		case 'm':
+			lttng_opt_mi = mi_output_type(optarg);
+			if (lttng_opt_mi < 0) {
+				ret = lttng_opt_mi;
+				goto error;
+			}
+			break;
 		case 'g':
 			lttng_set_tracing_group(optarg);
 			break;
src/common/Makefile.am +4 -1
index 1a764ae..dffab06 100644
@@ -16,8 +16,11 @@ noinst_LTLIBRARIES = libcommon.la
 libcommon_la_SOURCES = error.h error.c utils.c utils.h runas.c runas.h \
                        common.h futex.c futex.h uri.c uri.h defaults.c \
                        pipe.c pipe.h readwrite.c readwrite.h \
+                       mi-lttng.h mi-lttng.c \
                        daemonize.c daemonize.h
-libcommon_la_LIBADD = -luuid
+libcommon_la_LIBADD = \
+		-luuid \
+		$(top_builddir)/src/common/config/libconfig.la
 
 # Consumer library
 noinst_LTLIBRARIES += libconsumer.la
src/common/error.h +1 -0
index f8c0a1d..2e21463 100644
@@ -36,6 +36,7 @@
 
 extern int lttng_opt_quiet;
 extern int lttng_opt_verbose;
+extern int lttng_opt_mi;
 
 /* Error type. */
 #define PRINT_ERR   0x1
@@ -51,9 +52,10 @@ extern int lttng_opt_verbose;
  */
 #define __lttng_print(type, fmt, args...)                           \

src/common/error.h extern int lttng_opt_verbose; · line 61

Quoted 10 lines
src/common/error.h +3 -2
 	do {                                                            \
-		if (lttng_opt_quiet == 0 && type == PRINT_MSG) {            \
+		if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 &&            \
+				type == PRINT_MSG) {                                \
 			fprintf(stdout, fmt, ## args);                          \
-		} else if (lttng_opt_quiet == 0 &&                          \
+		} else if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 &&     \
 				(((type & PRINT_DBG) && lttng_opt_verbose == 1) ||  \
 				((type & (PRINT_DBG | PRINT_DBG2)) &&               \
 					lttng_opt_verbose == 2) ||                      \

Can you add a comment here just above this define explaining exactly why we suppress stdout output with the MI option.

Quoted 66 lines
src/common/mi-lttng.c new file +60 -0
new file mode 100644
index 0000000..2f3ee68
@@ -0,0 +1,273 @@
+/*
+ * Copyright (C) 2014   - Jonathan Rajotte <[email protected]>
+ *                      - Olivier Cotte <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License, version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <include/config.h>
+#include <common/config/config.h>
+#include "mi-lttng.h"
+
+/* Strings related to command */
+const char * const mi_lttng_element_command = "command";
+const char * const mi_lttng_element_command_version = "version";
+const char * const mi_lttng_element_command_list = "list";
+const char * const mi_lttng_element_command_name = "name";
+const char * const mi_lttng_element_command_output = "output";
+
+/* Strings related to command: version */
+const char * const mi_lttng_element_version_str = "string";
+const char * const mi_lttng_element_version_web = "url";
+const char * const mi_lttng_element_version_major = "major";
+const char * const mi_lttng_element_version_minor = "minor";
+const char * const mi_lttng_element_version_license = "license";
+const char * const mi_lttng_element_version_patch_level = "patchLevel";
+const char * const mi_lttng_element_version_description = "description";
+
+LTTNG_HIDDEN
+struct mi_writer *mi_lttng_writer_create(int fd_output, int mi_output_type)
+{
+	struct mi_writer *mi_writer;
+
+	mi_writer = zmalloc(sizeof(struct mi_writer));
+	if (!mi_writer) {
+		PERROR("zmalloc mi_writer_create");
+		goto end;
+	}
+	if (mi_output_type == LTTNG_MI_XML) {
+		mi_writer->writer = config_writer_create(fd_output);
+		if (!mi_writer->writer) {
+			goto err_destroy;
+		}
+		mi_writer->type = LTTNG_MI_XML;
+	} else {
+		goto err_destroy;
+	}
+
+end:
+	return mi_writer;

src/common/mi-lttng.c line 70

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+
+err_destroy:
+	free(mi_writer);
+	return NULL;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_destroy(struct mi_writer *writer)
+{
+	int ret = 0;

No default return values. In the long run of the bad and forsaken history of "maintaining code" this will just be your worst ennemy :P.

Quoted 46 lines
src/common/mi-lttng.c new file +46 -0
+
+	if (!writer) {
+		ret = -EINVAL;
+		goto end;
+	}
+
+	ret = config_writer_destroy(writer->writer);
+	if (ret < 0) {
+		goto end;
+	}
+
+	free(writer);
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_open(struct mi_writer *writer, const char *command)
+{
+	int ret;
+	ret = mi_lttng_writer_open_element(writer, mi_lttng_element_command);
+	if (ret) {
+		goto end;
+	}
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_command_name, command);
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_close(struct mi_writer *writer)
+{
+	return mi_lttng_writer_close_element(writer);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_open_element(struct mi_writer *writer,
+		const char *element_name)
+{
+	return config_writer_open_element(writer->writer, element_name);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_close_element(struct mi_writer *writer)
+{

src/common/mi-lttng.c line 126

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+	return config_writer_close_element(writer->writer);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer,
+		const char *element_name, uint64_t value)
+{
+	int ret;
+	ret = config_writer_write_element_unsigned_int(writer->writer,
+			element_name, value);

Maybe just "return config_writer_write_element_unsigned_int(...)" ?

Quoted 22 lines
src/common/mi-lttng.c new file +22 -0
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer,
+		const char *element_name, int64_t value)
+{
+	return config_writer_write_element_signed_int(writer->writer,
+			element_name, value);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_bool(struct mi_writer *writer,
+		const char *element_name, int value)
+{
+	return config_writer_write_element_bool(writer->writer,
+			element_name, value);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_string(struct mi_writer *writer,
+		const char *element_name, const char *value)

src/common/mi-lttng.c line 158

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+{
+	return config_writer_write_element_string(writer->writer,
+			element_name, value);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_version(struct mi_writer *writer, struct lttng_version *version,
+	char *lttng_description, char *lttng_license)
+{
+	int ret = 0;

Same as above, no default ret values.

Quoted 53 lines
src/common/mi-lttng.c new file +53 -0
+
+	/* Version string (contain info like rc etc.) */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_str, VERSION);
+	if (ret) {
+		goto end;
+	}
+
+	/* Major version number */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			mi_lttng_element_version_major, version->version_major);
+	if (ret) {
+		goto end;
+	}
+
+	/* Minor version number */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			mi_lttng_element_version_minor, version->version_minor);
+	if (ret) {
+		goto end;
+	}
+
+	/* Patch number */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			mi_lttng_element_version_patch_level, version->version_patchlevel);
+	if (ret) {
+		goto end;
+	}
+
+	/* Name of the version */
+	ret = mi_lttng_writer_write_element_string(writer,
+			config_element_name, version->version_name);
+	if (ret) {
+		goto end;
+	}
+
+	/* Description mostly related to beer... */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_description, lttng_description);
+	if (ret) {
+		goto end;
+	}
+
+	/* url */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_web, version->package_url);
+	if (ret) {
+		goto end;
+	}
+
+	/* License: free as in free beer...no...*speech* */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_license, lttng_license);

src/common/mi-lttng.c line 221

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_session(struct mi_writer *writer,
+		struct lttng_session *session, int isOpen)
+{
+	int ret = 0;

Same as above, no default ret values.

Quoted 110 lines
src/common/mi-lttng.c new file +52 -0
+
+	/* open sessions element */
+	ret = mi_lttng_writer_open_element(writer,
+			config_element_session);
+	if (ret) {
+		goto end;
+	}
+
+	/* Name of the session */
+	ret = mi_lttng_writer_write_element_string(writer,
+			config_element_name, session->name);
+	if (ret) {
+		goto end;
+	}
+
+	/* path */
+	ret = mi_lttng_writer_write_element_string(writer,
+			config_element_path, session->path);
+	if (ret) {
+		goto end;
+	}
+
+	/* enabled ? */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			config_element_enabled, session->enabled);
+	if (ret) {
+		goto end;
+	}
+
+	/* snapshot mode */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			config_element_snapshot_mode, session->snapshot_mode);
+	if (ret) {
+		goto end;
+	}
+
+	/* live timer interval in usec */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			config_element_live_timer_interval,
+			session->live_timer_interval);
+	if (ret) {
+		goto end;
+	}
+
+	if (!isOpen) {
+		/* Closing session element */
+		ret = mi_lttng_writer_close_element(writer);
+	}
+end:
+	return ret;
+
+}
src/common/mi-lttng.h new file +52 -0
new file mode 100644
index 0000000..534c1db
@@ -0,0 +1,212 @@
+/*
+ * Copyright (C) 2014   - Jonathan Rajotte <[email protected]>
+ *                      - Olivier Cotte <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License, version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef _MI_LTTNG_H
+#define _MI_LTTNG_H
+
+#include <common/error.h>
+#include <common/macros.h>
+#include <common/config/config.h>
+
+#include <lttng/lttng.h>
+
+#include <stdint.h>
+
+
+/* Instance of a machine interface writer. */
+struct mi_writer {
+	struct config_writer *writer;
+	enum lttng_mi_output_type type;
+};
+
+/* Strings related to command */
+const char * const mi_lttng_element_command;
+const char * const mi_lttng_element_command_version;
+const char * const mi_lttng_element_command_list;
+const char * const mi_lttng_element_command_name;
+const char * const mi_lttng_element_command_output;
+
+/* Strings related to command: version */
+const char * const mi_lttng_element_version_str;
+const char * const mi_lttng_element_version_web;
+const char * const mi_lttng_element_version_major;
+const char * const mi_lttng_element_version_minor;
+const char * const mi_lttng_element_version_license;
+const char * const mi_lttng_element_version_patch_level;
+const char * const mi_lttng_element_version_description;
+

src/common/mi-lttng.h line 62

Quoted 10 lines
src/common/mi-lttng.h new file +10 -0
+/*
+ * Create an instance of a machine interface writer.
+ *
+ * fd_output File to which the XML content must be written. The file will be
+ * closed once the mi_writer has been destroyed.
+ *
+ * Returns an instance of a machine interface writer on success, NULL on
+ * error.
+ */
+LTTNG_HIDDEN

Don't think you need the HIDDEN attribute here since they are assigned in the C file. Same for all of them below.

This is the end. Apart from those small changes, this looks great! Confident you next patch summit would be the last one which already means great job guys!

Ideally, if you can send me a patch with "git format-patch" or "git show <commit>" so it retains your commit message and signed-off. You can also send me a branch for me to pull in based on upstream/master.

Cheers!
David

Quoted 260 lines
src/common/mi-lttng.h new file +150 -0
+struct mi_writer *mi_lttng_writer_create(int fd_output, int mi_output_type);
+
+/*
+ * Destroy an instance of a configuration writer.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * Returns zero if the XML document could be closed cleanly. Negative values
+ * indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_destroy(struct mi_writer *writer);
+
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_open(struct mi_writer *writer, const char *command);
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_close(struct mi_writer *writer);
+
+/*
+ * Open an element tag.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element tag name.
+ *
+ * Returns zero if the XML document could be closed cleanly.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_open_element(struct mi_writer *writer,
+		const char *element_name);
+
+/*
+ * Close the current element tag.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * Returns zero if the XML document could be closed cleanly.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_close_element(struct mi_writer *writer);
+
+/*
+ * Write an element of type unsigned int.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value Unsigned int value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer,
+		const char *element_name, uint64_t value);
+
+/*
+ * Write an element of type signed int.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value Signed int value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer,
+		const char *element_name, int64_t value);
+
+/*
+ * Write an element of type boolean.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value Boolean value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_bool(struct mi_writer *writer,
+		const char *element_name, int value);
+
+/*
+ * Write an element of type string.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value String value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_string(struct mi_writer *writer,
+		const char *element_name, const char *value);
+
+/*
+ * Machine interface of struct version.
+ *
+ * writer An instance of a mi writer.
+ *
+ * version Version struct.
+ *
+ * lttng_description String value of the version description.
+ *
+ * lttng_license String value of the version license.
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_version(struct mi_writer *writer, struct lttng_version *version,
+	char *lttng_description, char *lttng_license);
+
+/*
+ * Machine interface of struct session.
+ *
+ * writer An instance of a mi writer
+ *
+ * session An instance of a session
+ *
+ * isOpen Define if we close the session element
+ *        This should be use carefully and the client
+ *        need to close the session element.
+ *        Use case: nested addition information on a session
+ *                  ex: domain,channel event.
+ *        0-> False
+ *        1-> True
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_session(struct mi_writer *writer,
+		struct lttng_session *session, int isOpen);
+
+#endif /* _MI_LTTNG_H */
src/lib/lttng-ctl/lttng-ctl.c +1 -0
index 8e2593d..1112484 100644
@@ -74,6 +74,7 @@ static int connected;
  */
 int lttng_opt_quiet;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 /*
  * Copy string from src to dst and enforce null terminated byte.
tests/unit/ini_config/ini_config.c +1 -0
index 38fe5f4..29935ef 100644
@@ -31,6 +31,7 @@ struct state {
 
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 0;
+int lttng_opt_mi;
 
 int entry_handler(const struct config_entry *entry,
 		struct state *state)
tests/unit/test_kernel_data.c +1 -0
index e2182e9..2639be4 100644
@@ -38,6 +38,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_session.c +1 -0
index a0e84e9..4f90c33 100644
@@ -46,6 +46,7 @@ static struct ltt_session_list *session_list;
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 0;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_uri.c +1 -0
index 7cac95d..432e2b3 100644
@@ -25,6 +25,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 /* Number of TAP tests in this file */
 #define NUM_TESTS 11
tests/unit/test_ust_data.c +1 -0
index bc3154c..54b96d6 100644
@@ -44,6 +44,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_utils_expand_path.c +1 -0
index fe709ac..f863b5d 100644
@@ -31,6 +31,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 struct valid_test_input {
 	char *input;
tests/unit/test_utils_parse_size_suffix.c +1 -0
index 990aa1b..f81278d 100644
@@ -26,6 +26,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 struct valid_test_input {
 	char *input;
Signature · 13 lines
1.7.9.5


-- 
Jonathan Rajotte Julien
Chargé de laboratoire INF1995
Membre MD6
Polytechnique Montréal

_______________________________________________
lttng-dev mailing list
[email protected]
http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev

_______________________________________________
lttng-dev mailing list
[email protected]
http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev

#3 lore raw
In reply to a message not in the archive
Quoted 52 lines · David Goulet
Quoted 51 lines · Jonathan Rajotte

Hi guys,
This is our current machine interface backend.
You can test it by applying this patch to master.

Finally after discussion with Jeremie Galard and David Goulet, we chosed to use a global option for the machine interface.

	lttng --mi <output_type> <command>

The only output_type supported is xml.

Currently you can test it with the command version (nothing spectatular). We will send patch for list before monday.

That's it.

Thx

---
 include/lttng/lttng-error.h               |    6 +
 include/lttng/lttng.h                     |   20 +++
 src/bin/lttng-consumerd/lttng-consumerd.c |    2 +
 src/bin/lttng/commands/version.c          |   73 +++++++-
 src/bin/lttng/lttng.c                     |   32 +++-
 src/common/Makefile.am                    |    5 +-
 src/common/error.h                        |    6 +-
 src/common/mi-lttng.c                     |  273 +++++++++++++++++++++++++++++
 src/common/mi-lttng.h                     |  212 ++++++++++++++++++++++
 src/lib/lttng-ctl/lttng-ctl.c             |    1 +
 tests/unit/ini_config/ini_config.c        |    1 +
 tests/unit/test_kernel_data.c             |    1 +
 tests/unit/test_session.c                 |    1 +
 tests/unit/test_uri.c                     |    1 +
 tests/unit/test_ust_data.c                |    1 +
 tests/unit/test_utils_expand_path.c       |    1 +
 tests/unit/test_utils_parse_size_suffix.c |    1 +
 17 files changed, 629 insertions(+), 8 deletions(-)
 create mode 100644 src/common/mi-lttng.c
 create mode 100644 src/common/mi-lttng.h
include/lttng/lttng-error.h +1 -0
index 06baa04..18924dd 100644
@@ -142,6 +142,12 @@ enum lttng_error_code {
 	LTTNG_ERR_NO_CONSUMER            = 109, /* No consumer exist for the session */
 	LTTNG_ERR_EXCLUSION_INVAL        = 110, /* Invalid event exclusion data */
 	LTTNG_ERR_EXCLUSION_NOMEM        = 111, /* Lack of memory while processing event exclusions */
+	/* 112 */
Quoted 8 lines

include/lttng/lttng-error.h enum lttng_error_code { · line 148

Quoted 3 lines
include/lttng/lttng-error.h +3 -0
+	/* 113 */
+	/* 114 */
+	/* 115 */

Why adding 4 numbers here? You should actually use the empty values above before adding more. This is a long time legacy situation here when we refactored the error code but didn't want to break the API value thus there is empty slots...

Okai we weren't sure if we had to reserve space for futher error_code.

Quoted 25 lines
Quoted 25 lines
include/lttng/lttng-error.h +2 -0
+	LTTNG_ERR_MI_OUTPUT_TYPE         = 116, /* Invalid MI output format */
+	LTTNG_ERR_MI_IO_FAIL             = 117, /* IO error while writing machine interface output */
 
 	/* MUST be last element */
 	LTTNG_ERR_NR,                           /* Last element */
include/lttng/lttng.h +5 -0
index f0be224..b0a1380 100644
@@ -170,6 +170,11 @@ enum lttng_buffer_type {
 	LTTNG_BUFFER_GLOBAL,	/* Only supported by the Kernel. */
 };
 
+/* Machine interface output type */
+enum lttng_mi_output_type {
+	LTTNG_MI_XML                          = 1 /* XML output */
+};
+
 /*
  * The structures should be initialized to zero before use.
  */
@@ -372,6 +377,21 @@ struct lttng_handle {
 };
 
Quoted 8 lines

include/lttng/lttng.h struct lttng_handle { · line 384

Quoted 6 lines
include/lttng/lttng.h +5 -0
 /*
+ * Version information for the machine interface.
+ */
+#define LTTNG_VERSION_PADDING1		16
+struct lttng_version {
+	char version[NAME_MAX];

Just to clarify, this holds for instance "2.4.0-rc2" full string?

yes, there is no rc field in config.h but a full string.

Quoted 7 lines

include/lttng/lttng.h struct lttng_handle { · line 387

Quoted 4 lines
include/lttng/lttng.h +3 -0
+	int version_major;
+	int version_minor;
+	int version_patchlevel;

Should be uint32_t here.

Quoted 10 lines

include/lttng/lttng.h struct lttng_handle { · line 392

Quoted 5 lines
include/lttng/lttng.h +5 -0
+	char version_name[NAME_MAX];
+	char package_url[NAME_MAX];
+
+	char padding[LTTNG_VERSION_PADDING1];
+};

So this should not be in lttng.h but rather in mi-lttng.h probably. lttng.h is the *public* ABI thus data structure being used for the public API used by lttng_* function calls.

Okai, guess we don't quite understand yet how lttng is organized.

Quoted 74 lines

Thus padding won't be necessary.

Quoted 72 lines
include/lttng/lttng.h +2 -0
+
+/*
  * Public LTTng control API
  *
  * For functions having an lttng domain type as parameter, if a bad value is
src/bin/lttng-consumerd/lttng-consumerd.c +2 -0
index e226ebc..0ce163e 100644
@@ -65,6 +65,8 @@ static int sigintcount = 0;
 /* Argument variables */
 int lttng_opt_quiet;    /* not static in error.h */
 int lttng_opt_verbose;  /* not static in error.h */
+int lttng_opt_mi;       /* not static in error.h */
+
 static int opt_daemon;
 static const char *progname;
 static char command_sock_path[PATH_MAX]; /* Global command socket path */
src/bin/lttng/commands/version.c +19 -0
index 7f69de3..80a663e 100644
@@ -25,6 +25,8 @@
 #include <unistd.h>
 #include <config.h>
 
+#include <common/mi-lttng.h>
+
 #include "../command.h"
 
 enum {
@@ -32,6 +34,8 @@ enum {
 	OPT_LIST_OPTIONS,
 };
 
+static const char lttng_license[] = "lttng is free software and under the GPL license and part LGPL";
+
 static struct poptOption long_options[] = {
 	/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
 	{"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
@@ -53,12 +57,27 @@ static void usage(FILE *ofp)
 }
 
 /*
+ *  create_version
+ */
+static void create_version(struct lttng_version *version)
+{
+	strncpy(version->version, VERSION, NAME_MAX);
+	version->version_major = VERSION_MAJOR;
+	version->version_minor = VERSION_MINOR;
+	version->version_patchlevel = VERSION_PATCHLEVEL;
+	strncpy(version->version_name, VERSION_NAME, NAME_MAX);
+	strncpy(version->package_url, PACKAGE_URL, NAME_MAX);
+}
+
+/*
  *  cmd_version
  */
 int cmd_version(int argc, const char **argv)
 {
 	int opt, ret = CMD_SUCCESS;
 	static poptContext pc;
+	struct mi_writer *writer = NULL;
+	struct lttng_version version;
 
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
@@ -78,12 +97,58 @@ int cmd_version(int argc, const char **argv)
 		}
 	}
 
Quoted 10 lines

src/bin/lttng/commands/version.c int cmd_version(int argc, const char **argv) · line 100

Quoted 5 lines
src/bin/lttng/commands/version.c +1 -4
-	MSG("lttng version " VERSION " - " VERSION_NAME);
-	MSG("\n" VERSION_DESCRIPTION "\n");
-	MSG("Web site: http://lttng.org");
-	MSG("\nlttng is free software and under the GPL license and part LGPL");
+	if (lttng_opt_mi) {

I would go for a function to print the mi like maybe "print_mi()" since this *may* change depending on what output type we use. For now, only one but let's think ahead :) and this allow to handle the mi writer destruction in one specific call also, cleaner in the long run I think.

Okai, we got a patch comming for list ( need some cleanup, internal code review and 2 features) but you might want to check the way we incorporate the mi into the command and tell us what you think. Cause with your comment I think we are heading the wrong way.
https://github.com/PSRCode/lttng-tools-dev/commit/23b3a771083dc9abbf80aa9a46087b0ea9fd5959

Quoted 79 lines
Quoted 79 lines
src/bin/lttng/commands/version.c +49 -0
+		create_version(&version);
+
+		writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
+
+		if (!writer) {
+			ret = -LTTNG_ERR_NOMEM;
+			goto end;
+		}
+
+		/* Open the command element */
+		ret = mi_lttng_writer_command_open(writer,
+				mi_lttng_element_command_version);
+		if (ret) {
+			goto end;
+		}
+
+		/* Beginning of output */
+		ret = mi_lttng_writer_open_element(writer,
+				mi_lttng_element_command_output);
+		if (ret) {
+			goto end;
+		}
+
+		ret = mi_lttng_version(writer, &version,
+				VERSION_DESCRIPTION,
+				lttng_license);
+		if (ret) {
+			goto end;
+		}
+
+		/* Close the output element */
+		ret = mi_lttng_writer_close_element(writer);
+		if (ret) {
+			goto end;
+		}
+
+		/* Close the command  */
+		ret = mi_lttng_writer_command_close(writer);
+
+	} else {
+		MSG("lttng version " VERSION " - " VERSION_NAME);
+		MSG("\n" VERSION_DESCRIPTION "\n");
+		MSG("Web site: http://lttng.org");
+		MSG("\n%s", lttng_license);
+	}
 
 end:
+	if (writer && mi_lttng_writer_destroy(writer)) {
+		/* Preserve original error code */
+		ret = ret ? ret : LTTNG_ERR_MI_IO_FAIL;
+	}
 	poptFreeContext(pc);
 	return ret;
 }
src/bin/lttng/lttng.c +3 -0
index bc7577d..ebfe6f2 100644
@@ -55,6 +55,7 @@ static struct option long_options[] = {
 	{"group",            1, NULL, 'g'},
 	{"verbose",          0, NULL, 'v'},
 	{"quiet",            0, NULL, 'q'},
+	{"mi",               1, NULL, 'm'},
 	{"no-sessiond",      0, NULL, 'n'},
 	{"sessiond-path",    1, NULL, OPT_SESSION_PATH},
 	{"relayd-path",      1, NULL, OPT_RELAYD_PATH},
@@ -99,6 +100,8 @@ static void usage(FILE *ofp)
 	fprintf(ofp, "      --list-commands        Simple listing of lttng commands\n");
 	fprintf(ofp, "  -v, --verbose              Increase verbosity\n");
 	fprintf(ofp, "  -q, --quiet                Quiet mode\n");
+	fprintf(ofp, "  -m, --mi TYPE              Machine Interface mode.\n");
+	fprintf(ofp, "                                 Type: xml\n");
 	fprintf(ofp, "  -g, --group NAME           Unix tracing group name. (default: tracing)\n");
 	fprintf(ofp, "  -n, --no-sessiond          Don't spawn a session daemon\n");
 	fprintf(ofp, "      --sessiond-path PATH   Session daemon full path\n");
@@ -136,6 +139,26 @@ static void version(FILE *ofp)
 }
 
Quoted 14 lines

src/bin/lttng/lttng.c static void version(FILE *ofp) · line 151

Quoted 11 lines
src/bin/lttng/lttng.c +10 -0
 /*
+ * mi_output_type
+ *
+ * Find the MI output type enum from a string
+ * This function is for the support of
+ * new output language.
+ */
+static int mi_output_type(const char *output_type)
+{
+	int ret = 0;
+	if (!strncmp("xml", output_type, 3)) {

Maybe we could also allow "XML" or a anything looking like that like "XmL". Isn't there a libc call that ignores the case ?

:P fail.

Quoted 447 lines
Quoted 69 lines
src/bin/lttng/lttng.c +18 -1
+		ret = LTTNG_MI_XML;
+	} else {
+		/* Invalid output format */
+		ERR("MI output format not supported");
+		ret = -LTTNG_ERR_MI_OUTPUT_TYPE;
+	}
+	return ret;
+}
+
+/*
  *  list_options
  *
  *  List options line by line. This is mostly for bash auto completion and to
@@ -426,7 +449,7 @@ static int parse_args(int argc, char **argv)
 		clean_exit(EXIT_FAILURE);
 	}
 
-	while ((opt = getopt_long(argc, argv, "+Vhnvqg:", long_options, NULL)) != -1) {
+	while ((opt = getopt_long(argc, argv, "+Vhnvqg:m:", long_options, NULL)) != -1) {
 		switch (opt) {
 		case 'V':
 			version(stdout);
@@ -442,6 +465,13 @@ static int parse_args(int argc, char **argv)
 		case 'q':
 			lttng_opt_quiet = 1;
 			break;
+		case 'm':
+			lttng_opt_mi = mi_output_type(optarg);
+			if (lttng_opt_mi < 0) {
+				ret = lttng_opt_mi;
+				goto error;
+			}
+			break;
 		case 'g':
 			lttng_set_tracing_group(optarg);
 			break;
src/common/Makefile.am +4 -1
index 1a764ae..dffab06 100644
@@ -16,8 +16,11 @@ noinst_LTLIBRARIES = libcommon.la
 libcommon_la_SOURCES = error.h error.c utils.c utils.h runas.c runas.h \
                        common.h futex.c futex.h uri.c uri.h defaults.c \
                        pipe.c pipe.h readwrite.c readwrite.h \
+                       mi-lttng.h mi-lttng.c \
                        daemonize.c daemonize.h
-libcommon_la_LIBADD = -luuid
+libcommon_la_LIBADD = \
+		-luuid \
+		$(top_builddir)/src/common/config/libconfig.la
 
 # Consumer library
 noinst_LTLIBRARIES += libconsumer.la
src/common/error.h +1 -0
index f8c0a1d..2e21463 100644
@@ -36,6 +36,7 @@
 
 extern int lttng_opt_quiet;
 extern int lttng_opt_verbose;
+extern int lttng_opt_mi;
 
 /* Error type. */
 #define PRINT_ERR   0x1
@@ -51,9 +52,10 @@ extern int lttng_opt_verbose;
  */
 #define __lttng_print(type, fmt, args...)                           \

src/common/error.h extern int lttng_opt_verbose; · line 61

Quoted 10 lines
src/common/error.h +3 -2
 	do {                                                            \
-		if (lttng_opt_quiet == 0 && type == PRINT_MSG) {            \
+		if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 &&            \
+				type == PRINT_MSG) {                                \
 			fprintf(stdout, fmt, ## args);                          \
-		} else if (lttng_opt_quiet == 0 &&                          \
+		} else if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 &&     \
 				(((type & PRINT_DBG) && lttng_opt_verbose == 1) ||  \
 				((type & (PRINT_DBG | PRINT_DBG2)) &&               \
 					lttng_opt_verbose == 2) ||                      \

Can you add a comment here just above this define explaining exactly why we suppress stdout output with the MI option.

Quoted 66 lines
src/common/mi-lttng.c new file +60 -0
new file mode 100644
index 0000000..2f3ee68
@@ -0,0 +1,273 @@
+/*
+ * Copyright (C) 2014   - Jonathan Rajotte <[email protected]>
+ *                      - Olivier Cotte <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License, version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <include/config.h>
+#include <common/config/config.h>
+#include "mi-lttng.h"
+
+/* Strings related to command */
+const char * const mi_lttng_element_command = "command";
+const char * const mi_lttng_element_command_version = "version";
+const char * const mi_lttng_element_command_list = "list";
+const char * const mi_lttng_element_command_name = "name";
+const char * const mi_lttng_element_command_output = "output";
+
+/* Strings related to command: version */
+const char * const mi_lttng_element_version_str = "string";
+const char * const mi_lttng_element_version_web = "url";
+const char * const mi_lttng_element_version_major = "major";
+const char * const mi_lttng_element_version_minor = "minor";
+const char * const mi_lttng_element_version_license = "license";
+const char * const mi_lttng_element_version_patch_level = "patchLevel";
+const char * const mi_lttng_element_version_description = "description";
+
+LTTNG_HIDDEN
+struct mi_writer *mi_lttng_writer_create(int fd_output, int mi_output_type)
+{
+	struct mi_writer *mi_writer;
+
+	mi_writer = zmalloc(sizeof(struct mi_writer));
+	if (!mi_writer) {
+		PERROR("zmalloc mi_writer_create");
+		goto end;
+	}
+	if (mi_output_type == LTTNG_MI_XML) {
+		mi_writer->writer = config_writer_create(fd_output);
+		if (!mi_writer->writer) {
+			goto err_destroy;
+		}
+		mi_writer->type = LTTNG_MI_XML;
+	} else {
+		goto err_destroy;
+	}
+
+end:
+	return mi_writer;

src/common/mi-lttng.c line 70

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+
+err_destroy:
+	free(mi_writer);
+	return NULL;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_destroy(struct mi_writer *writer)
+{
+	int ret = 0;

No default return values. In the long run of the bad and forsaken history of "maintaining code" this will just be your worst ennemy :P.

Quoted 46 lines
src/common/mi-lttng.c new file +46 -0
+
+	if (!writer) {
+		ret = -EINVAL;
+		goto end;
+	}
+
+	ret = config_writer_destroy(writer->writer);
+	if (ret < 0) {
+		goto end;
+	}
+
+	free(writer);
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_open(struct mi_writer *writer, const char *command)
+{
+	int ret;
+	ret = mi_lttng_writer_open_element(writer, mi_lttng_element_command);
+	if (ret) {
+		goto end;
+	}
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_command_name, command);
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_close(struct mi_writer *writer)
+{
+	return mi_lttng_writer_close_element(writer);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_open_element(struct mi_writer *writer,
+		const char *element_name)
+{
+	return config_writer_open_element(writer->writer, element_name);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_close_element(struct mi_writer *writer)
+{

src/common/mi-lttng.c line 126

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+	return config_writer_close_element(writer->writer);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer,
+		const char *element_name, uint64_t value)
+{
+	int ret;
+	ret = config_writer_write_element_unsigned_int(writer->writer,
+			element_name, value);

Maybe just "return config_writer_write_element_unsigned_int(...)" ?

Quoted 22 lines
src/common/mi-lttng.c new file +22 -0
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer,
+		const char *element_name, int64_t value)
+{
+	return config_writer_write_element_signed_int(writer->writer,
+			element_name, value);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_bool(struct mi_writer *writer,
+		const char *element_name, int value)
+{
+	return config_writer_write_element_bool(writer->writer,
+			element_name, value);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_string(struct mi_writer *writer,
+		const char *element_name, const char *value)

src/common/mi-lttng.c line 158

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+{
+	return config_writer_write_element_string(writer->writer,
+			element_name, value);
+}
+
+LTTNG_HIDDEN
+int mi_lttng_version(struct mi_writer *writer, struct lttng_version *version,
+	char *lttng_description, char *lttng_license)
+{
+	int ret = 0;

Same as above, no default ret values.

Quoted 53 lines
src/common/mi-lttng.c new file +53 -0
+
+	/* Version string (contain info like rc etc.) */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_str, VERSION);
+	if (ret) {
+		goto end;
+	}
+
+	/* Major version number */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			mi_lttng_element_version_major, version->version_major);
+	if (ret) {
+		goto end;
+	}
+
+	/* Minor version number */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			mi_lttng_element_version_minor, version->version_minor);
+	if (ret) {
+		goto end;
+	}
+
+	/* Patch number */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			mi_lttng_element_version_patch_level, version->version_patchlevel);
+	if (ret) {
+		goto end;
+	}
+
+	/* Name of the version */
+	ret = mi_lttng_writer_write_element_string(writer,
+			config_element_name, version->version_name);
+	if (ret) {
+		goto end;
+	}
+
+	/* Description mostly related to beer... */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_description, lttng_description);
+	if (ret) {
+		goto end;
+	}
+
+	/* url */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_web, version->package_url);
+	if (ret) {
+		goto end;
+	}
+
+	/* License: free as in free beer...no...*speech* */
+	ret = mi_lttng_writer_write_element_string(writer,
+			mi_lttng_element_version_license, lttng_license);

src/common/mi-lttng.c line 221

Quoted 10 lines
src/common/mi-lttng.c new file +10 -0
+
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+int mi_lttng_session(struct mi_writer *writer,
+		struct lttng_session *session, int isOpen)
+{
+	int ret = 0;

Same as above, no default ret values.

Quoted 110 lines
src/common/mi-lttng.c new file +52 -0
+
+	/* open sessions element */
+	ret = mi_lttng_writer_open_element(writer,
+			config_element_session);
+	if (ret) {
+		goto end;
+	}
+
+	/* Name of the session */
+	ret = mi_lttng_writer_write_element_string(writer,
+			config_element_name, session->name);
+	if (ret) {
+		goto end;
+	}
+
+	/* path */
+	ret = mi_lttng_writer_write_element_string(writer,
+			config_element_path, session->path);
+	if (ret) {
+		goto end;
+	}
+
+	/* enabled ? */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			config_element_enabled, session->enabled);
+	if (ret) {
+		goto end;
+	}
+
+	/* snapshot mode */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			config_element_snapshot_mode, session->snapshot_mode);
+	if (ret) {
+		goto end;
+	}
+
+	/* live timer interval in usec */
+	ret = mi_lttng_writer_write_element_unsigned_int(writer,
+			config_element_live_timer_interval,
+			session->live_timer_interval);
+	if (ret) {
+		goto end;
+	}
+
+	if (!isOpen) {
+		/* Closing session element */
+		ret = mi_lttng_writer_close_element(writer);
+	}
+end:
+	return ret;
+
+}
src/common/mi-lttng.h new file +52 -0
new file mode 100644
index 0000000..534c1db
@@ -0,0 +1,212 @@
+/*
+ * Copyright (C) 2014   - Jonathan Rajotte <[email protected]>
+ *                      - Olivier Cotte <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License, version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef _MI_LTTNG_H
+#define _MI_LTTNG_H
+
+#include <common/error.h>
+#include <common/macros.h>
+#include <common/config/config.h>
+
+#include <lttng/lttng.h>
+
+#include <stdint.h>
+
+
+/* Instance of a machine interface writer. */
+struct mi_writer {
+	struct config_writer *writer;
+	enum lttng_mi_output_type type;
+};
+
+/* Strings related to command */
+const char * const mi_lttng_element_command;
+const char * const mi_lttng_element_command_version;
+const char * const mi_lttng_element_command_list;
+const char * const mi_lttng_element_command_name;
+const char * const mi_lttng_element_command_output;
+
+/* Strings related to command: version */
+const char * const mi_lttng_element_version_str;
+const char * const mi_lttng_element_version_web;
+const char * const mi_lttng_element_version_major;
+const char * const mi_lttng_element_version_minor;
+const char * const mi_lttng_element_version_license;
+const char * const mi_lttng_element_version_patch_level;
+const char * const mi_lttng_element_version_description;
+

src/common/mi-lttng.h line 62

Quoted 10 lines
src/common/mi-lttng.h new file +10 -0
+/*
+ * Create an instance of a machine interface writer.
+ *
+ * fd_output File to which the XML content must be written. The file will be
+ * closed once the mi_writer has been destroyed.
+ *
+ * Returns an instance of a machine interface writer on success, NULL on
+ * error.
+ */
+LTTNG_HIDDEN

Don't think you need the HIDDEN attribute here since they are assigned in the C file. Same for all of them below.

Quoted 3 lines

This is the end. Apart from those small changes, this looks great! Confident you next patch summit would be the last one which already means great job guys!

Let's hope so.

Quoted 4 lines

Ideally, if you can send me a patch with "git format-patch" or "git show <commit>" so it retains your commit message and signed-off. You can also send me a branch for me to pull in based on upstream/master.

I'm sure you don't want our messy comments. :P

Thx David.

Quoted 264 lines

Cheers!
David

Quoted 260 lines
src/common/mi-lttng.h new file +150 -0
+struct mi_writer *mi_lttng_writer_create(int fd_output, int mi_output_type);
+
+/*
+ * Destroy an instance of a configuration writer.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * Returns zero if the XML document could be closed cleanly. Negative values
+ * indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_destroy(struct mi_writer *writer);
+
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_open(struct mi_writer *writer, const char *command);
+
+LTTNG_HIDDEN
+int mi_lttng_writer_command_close(struct mi_writer *writer);
+
+/*
+ * Open an element tag.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element tag name.
+ *
+ * Returns zero if the XML document could be closed cleanly.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_open_element(struct mi_writer *writer,
+		const char *element_name);
+
+/*
+ * Close the current element tag.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * Returns zero if the XML document could be closed cleanly.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_close_element(struct mi_writer *writer);
+
+/*
+ * Write an element of type unsigned int.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value Unsigned int value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer,
+		const char *element_name, uint64_t value);
+
+/*
+ * Write an element of type signed int.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value Signed int value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer,
+		const char *element_name, int64_t value);
+
+/*
+ * Write an element of type boolean.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value Boolean value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_bool(struct mi_writer *writer,
+		const char *element_name, int value);
+
+/*
+ * Write an element of type string.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value String value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_writer_write_element_string(struct mi_writer *writer,
+		const char *element_name, const char *value);
+
+/*
+ * Machine interface of struct version.
+ *
+ * writer An instance of a mi writer.
+ *
+ * version Version struct.
+ *
+ * lttng_description String value of the version description.
+ *
+ * lttng_license String value of the version license.
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_version(struct mi_writer *writer, struct lttng_version *version,
+	char *lttng_description, char *lttng_license);
+
+/*
+ * Machine interface of struct session.
+ *
+ * writer An instance of a mi writer
+ *
+ * session An instance of a session
+ *
+ * isOpen Define if we close the session element
+ *        This should be use carefully and the client
+ *        need to close the session element.
+ *        Use case: nested addition information on a session
+ *                  ex: domain,channel event.
+ *        0-> False
+ *        1-> True
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+LTTNG_HIDDEN
+int mi_lttng_session(struct mi_writer *writer,
+		struct lttng_session *session, int isOpen);
+
+#endif /* _MI_LTTNG_H */
src/lib/lttng-ctl/lttng-ctl.c +1 -0
index 8e2593d..1112484 100644
@@ -74,6 +74,7 @@ static int connected;
  */
 int lttng_opt_quiet;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 /*
  * Copy string from src to dst and enforce null terminated byte.
tests/unit/ini_config/ini_config.c +1 -0
index 38fe5f4..29935ef 100644
@@ -31,6 +31,7 @@ struct state {
 
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 0;
+int lttng_opt_mi;
 
 int entry_handler(const struct config_entry *entry,
 		struct state *state)
tests/unit/test_kernel_data.c +1 -0
index e2182e9..2639be4 100644
@@ -38,6 +38,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_session.c +1 -0
index a0e84e9..4f90c33 100644
@@ -46,6 +46,7 @@ static struct ltt_session_list *session_list;
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 0;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_uri.c +1 -0
index 7cac95d..432e2b3 100644
@@ -25,6 +25,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 /* Number of TAP tests in this file */
 #define NUM_TESTS 11
tests/unit/test_ust_data.c +1 -0
index bc3154c..54b96d6 100644
@@ -44,6 +44,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_utils_expand_path.c +1 -0
index fe709ac..f863b5d 100644
@@ -31,6 +31,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 struct valid_test_input {
 	char *input;
tests/unit/test_utils_parse_size_suffix.c +1 -0
index 990aa1b..f81278d 100644
@@ -26,6 +26,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 struct valid_test_input {
 	char *input;
Signature · 13 lines
1.7.9.5


-- 
Jonathan Rajotte Julien
Chargé de laboratoire INF1995
Membre MD6
Polytechnique Montréal

_______________________________________________
lttng-dev mailing list
[email protected]
http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
Signature · 4 lines
Jonathan Rajotte Julien
Chargé de laboratoire INF1995
Membre MD6
Polytechnique Montréal
#5 lore raw
In reply to a message not in the archive
Quoted 26 lines
Quoted 16 lines
Quoted 16 lines
(quoted diff) +3 -0
+/*
  *  cmd_version
  */
 int cmd_version(int argc, const char **argv)
 {
 	int opt, ret = CMD_SUCCESS;
 	static poptContext pc;
+	struct mi_writer *writer = NULL;
+	struct lttng_version version;
 
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
@@ -78,12 +97,58 @@ int cmd_version(int argc, const char **argv)
 		}
 	}
 
Quoted 10 lines

Review int cmd_version(int argc, const char **argv) · line 100

Quoted 5 lines
(quoted diff) +1 -4
-	MSG("lttng version " VERSION " - " VERSION_NAME);
-	MSG("\n" VERSION_DESCRIPTION "\n");
-	MSG("Web site: http://lttng.org");
-	MSG("\nlttng is free software and under the GPL license and part LGPL");
+	if (lttng_opt_mi) {

I would go for a function to print the mi like maybe "print_mi()" since this *may* change depending on what output type we use. For now, only one but let's think ahead :) and this allow to handle the mi writer destruction in one specific call also, cleaner in the long run I think.

Quoted 5 lines

Okai, we got a patch comming for list ( need some cleanup, internal code review and 2 features) but you might want to check the way we incorporate the mi into the command and tell us what you think. Cause with your comment I think we are heading the wrong way.
https://github.com/PSRCode/lttng-tools-dev/commit/23b3a771083dc9abbf80aa9a46087b0ea9fd5959

What I meant here is to simply have a static function in the same file that do this job below. This is just easier in terms of code separation in the long run so keep everything but move it to a function that handles "mi printouts".

Cheers!
David

_______________________________________________
lttng-dev mailing list
[email protected]
http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev

#6 lore raw
In reply to a message not in the archive

Hi David,

Here our (hopefully) final patch for a basic mi backend. If this is correct we will send you our pending patch for list.

Thanks

--
Jonathan R

From dd6d7f181717e96103cf5192d3d969bb1b413c12 Mon Sep 17 00:00:00 2001
From: Jonathan Rajotte <[email protected]>
Date: Thu, 27 Mar 2014 21:48:17 -0400
Subject: [Mi] Mi: mi backend + mi for command version
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The machine interface option is now available for version. Other commands will shortly follow.
Mi backend is expected to grow with addition of mi support to other commands.

How to use:

	lttng --mi <mi_output_type> <command>

This syntax will be the same for all commands. Currently *only xml is supported as machine interface output.*

As for errors handling, if an error/warning occurs while using mi it will be reported on stderr as normal. The integrity of the mi output cannot be guaranteed if an error/warning occurs.
The error output format is consistent and easy for a machine client to parse. Thus no mi output format is required for error output.

Example:

	lttng --mi xml version

Output:
<?xml version="1.0" encoding="UTF-8"?>
<command>
<name>version</name>
<output>
<string>2.4.0-rc2</string>
<major>2</major>
<minor>4</minor>
<patchLevel>0</patchLevel>
<name>Époque Opaque</name>
<description>The Époque Opaque is a black IPA from Trou du Diable brewery. The nose is eerily reminiscent of the coffee crisp candy from of our childhood. These strong mocha accents are present on the palate, which are quickly subdued by Japanese and Australian hops leading to a final state of satisfaction enjoyable for any fan of bitter beer.</description>
<url>http://lttng.org</url>
<license>lttng is free software and under the GPL license and part LGPL</license>
</output>
</command>

---
 include/lttng/lttng-error.h               |   6 +-
 include/lttng/lttng.h                     |   5 +
 src/bin/lttng-consumerd/lttng-consumerd.c |   2 +
 src/bin/lttng/commands/add_context.c      |   7 +
 src/bin/lttng/commands/calibrate.c        |   7 +
 src/bin/lttng/commands/create.c           |   7 +
 src/bin/lttng/commands/destroy.c          |   7 +
 src/bin/lttng/commands/disable_channels.c |   7 +
 src/bin/lttng/commands/disable_events.c   |   7 +
 src/bin/lttng/commands/enable_channels.c  |   7 +
 src/bin/lttng/commands/enable_events.c    |   7 +
 src/bin/lttng/commands/list.c             |   7 +
 src/bin/lttng/commands/load.c             |   7 +
 src/bin/lttng/commands/save.c             |   7 +
 src/bin/lttng/commands/set_session.c      |   7 +
 src/bin/lttng/commands/snapshot.c         |   7 +
 src/bin/lttng/commands/start.c            |   7 +
 src/bin/lttng/commands/stop.c             |   7 +
 src/bin/lttng/commands/version.c          |  85 +++++++++-
 src/bin/lttng/commands/view.c             |   4 +
 src/bin/lttng/lttng.c                     |  32 +++-
 src/common/Makefile.am                    |   5 +-
 src/common/error.h                        |  11 +-
 src/common/mi-lttng.c                     | 271 ++++++++++++++++++++++++++++++
 src/common/mi-lttng.h                     | 229 +++++++++++++++++++++++++
 src/lib/lttng-ctl/lttng-ctl.c             |   1 +
 tests/unit/ini_config/ini_config.c        |   1 +
 tests/unit/test_kernel_data.c             |   1 +
 tests/unit/test_session.c                 |   1 +
 tests/unit/test_uri.c                     |   1 +
 tests/unit/test_ust_data.c                |   1 +
 tests/unit/test_utils_expand_path.c       |   1 +
 tests/unit/test_utils_parse_size_suffix.c |   1 +
 33 files changed, 752 insertions(+), 11 deletions(-)
 create mode 100644 src/common/mi-lttng.c
 create mode 100644 src/common/mi-lttng.h
include/lttng/lttng-error.h +3 -3
index 06baa04..1594ba9 100644
@@ -120,9 +120,9 @@ enum lttng_error_code {
 	LTTNG_ERR_LOAD_INVALID_CONFIG    = 87,  /* Invalid session configuration */
 	LTTNG_ERR_LOAD_IO_FAIL           = 88,  /* IO error while reading a session configuration */
 	LTTNG_ERR_LOAD_SESSION_NOENT     = 89,  /* Session file not found */
-	/* 90 */
-	/* 91 */
-	/* 92 */
+	LTTNG_ERR_MI_OUTPUT_TYPE         = 90, /* Invalid MI output format */
+	LTTNG_ERR_MI_IO_FAIL             = 91, /* IO error while writing machine interface output */
+	LTTNG_ERR_MI_NOT_IMPLEMENTED     = 92, /* Mi feature not implemented */
 	/* 93 */
 	/* 94 */
 	/* 95 */
include/lttng/lttng.h +5 -0
index f0be224..9449161 100644
@@ -170,6 +170,11 @@ enum lttng_buffer_type {
 	LTTNG_BUFFER_GLOBAL,	/* Only supported by the Kernel. */
 };
 
+/* Machine interface output type */
+enum lttng_mi_output_type {
+	LTTNG_MI_XML                          = 1 /* XML output */
+};
+
 /*
  * The structures should be initialized to zero before use.
  */
src/bin/lttng-consumerd/lttng-consumerd.c +2 -0
index e226ebc..0ce163e 100644
@@ -65,6 +65,8 @@ static int sigintcount = 0;
 /* Argument variables */
 int lttng_opt_quiet;    /* not static in error.h */
 int lttng_opt_verbose;  /* not static in error.h */
+int lttng_opt_mi;       /* not static in error.h */
+
 static int opt_daemon;
 static const char *progname;
 static char command_sock_path[PATH_MAX]; /* Global command socket path */
src/bin/lttng/commands/add_context.c +7 -0
index 6483c98..2eb0e90 100644
@@ -446,6 +446,13 @@ int cmd_add_context(int argc, const char **argv)
 		goto end;
 	}
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
src/bin/lttng/commands/calibrate.c +7 -0
index 092632c..7d4de29 100644
@@ -133,6 +133,13 @@ static int calibrate_lttng(void)
 		goto error;
 	}
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto error;
+	}
+
 	handle = lttng_create_handle(NULL, &dom);
 	if (handle == NULL) {
 		ret = CMD_ERROR;
src/bin/lttng/commands/create.c +7 -0
index a5f92f1..0a39721 100644
@@ -510,6 +510,13 @@ int cmd_create(int argc, const char **argv)
 		}
 	}
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	if (opt_no_consumer) {
 		MSG("The option --no-consumer is obsolete. Use --no-output now.");
 		ret = CMD_WARNING;
src/bin/lttng/commands/destroy.c +7 -0
index 3fb5fb2..26548b9 100644
@@ -148,6 +148,13 @@ int cmd_destroy(int argc, const char **argv)
 		goto end;
 	}
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	/* Ignore session name in case all sessions are to be destroyed */
 	if (opt_destroy_all) {
 		ret = destroy_all_sessions();
src/bin/lttng/commands/disable_channels.c +7 -0
index 1aa3916..da53d25 100644
@@ -167,6 +167,13 @@ int cmd_disable_channels(int argc, const char **argv)
 		}
 	}
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	opt_channels = (char*) poptGetArg(pc);
 	if (opt_channels == NULL) {
 		ERR("Missing channel name(s).\n");
src/bin/lttng/commands/disable_events.c +7 -0
index e712343..fb96b80 100644
@@ -212,6 +212,13 @@ int cmd_disable_events(int argc, const char **argv)
 		}
 	}
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	opt_event_list = (char*) poptGetArg(pc);
 	if (opt_event_list == NULL && opt_disable_all == 0) {
 		ERR("Missing event name(s).\n");
src/bin/lttng/commands/enable_channels.c +7 -0
index 55fbae6..8ea405e 100644
@@ -327,6 +327,13 @@ int cmd_enable_channels(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/enable_events.c +7 -0
index bd2d997..8c7a73e 100644
@@ -968,6 +968,13 @@ int cmd_enable_events(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	/* Default event type */
 	opt_event_type = LTTNG_EVENT_ALL;
 
src/bin/lttng/commands/list.c +7 -0
index f69b3ba..bbd674c 100644
@@ -850,6 +850,13 @@ int cmd_list(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/load.c +7 -0
index 3f92654..df5b59c 100644
@@ -74,6 +74,13 @@ int cmd_load(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, load_opts, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/save.c +7 -0
index e8a4565..1aeb9f2 100644
@@ -73,6 +73,13 @@ int cmd_save(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, save_opts, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/set_session.c +7 -0
index 4238016..54320df 100644
@@ -92,6 +92,13 @@ int cmd_set_session(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/snapshot.c +7 -0
index c704eee..21b5a05 100644
@@ -446,6 +446,13 @@ int cmd_snapshot(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, snapshot_opts, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/start.c +7 -0
index 82122cc..82b3f5f 100644
@@ -118,6 +118,13 @@ int cmd_start(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/stop.c +7 -0
index 60a1dac..5de96d8 100644
@@ -122,6 +122,13 @@ int cmd_stop(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	/* TODO: mi support */
+	if (lttng_opt_mi) {
+		ret = -LTTNG_ERR_MI_NOT_IMPLEMENTED;
+		ERR("mi option not supported");
+		goto end;
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/commands/version.c +81 -4

109 lines not on this page · raw message

src/bin/lttng/commands/view.c +4 -0
index adedf29..dcd4d66 100644
@@ -445,6 +445,10 @@ int cmd_view(int argc, const char **argv)
 	pc = poptGetContext(NULL, argc, argv, long_options, 0);
 	poptReadDefaultConfig(pc, 0);
 
+	if (lttng_opt_mi) {
+		WARN("mi does not apply to view command");
+	}
+
 	while ((opt = poptGetNextOpt(pc)) != -1) {
 		switch (opt) {
 		case OPT_HELP:
src/bin/lttng/lttng.c +31 -1
index bc7577d..4510057 100644
@@ -55,6 +55,7 @@ static struct option long_options[] = {
 	{"group",            1, NULL, 'g'},
 	{"verbose",          0, NULL, 'v'},
 	{"quiet",            0, NULL, 'q'},
+	{"mi",               1, NULL, 'm'},
 	{"no-sessiond",      0, NULL, 'n'},
 	{"sessiond-path",    1, NULL, OPT_SESSION_PATH},
 	{"relayd-path",      1, NULL, OPT_RELAYD_PATH},
@@ -99,6 +100,8 @@ static void usage(FILE *ofp)
 	fprintf(ofp, "      --list-commands        Simple listing of lttng commands\n");
 	fprintf(ofp, "  -v, --verbose              Increase verbosity\n");
 	fprintf(ofp, "  -q, --quiet                Quiet mode\n");
+	fprintf(ofp, "  -m, --mi TYPE              Machine Interface mode.\n");
+	fprintf(ofp, "                                 Type: xml\n");
 	fprintf(ofp, "  -g, --group NAME           Unix tracing group name. (default: tracing)\n");
 	fprintf(ofp, "  -n, --no-sessiond          Don't spawn a session daemon\n");
 	fprintf(ofp, "      --sessiond-path PATH   Session daemon full path\n");
@@ -136,6 +139,26 @@ static void version(FILE *ofp)
 }
 
 /*
+ * mi_output_type
+ *
+ * Find the MI output type enum from a string
+ * This function is for the support of
+ * new output language.
+ */
+static int mi_output_type(const char *output_type)
+{
+	int ret = 0;
+	if (!strncasecmp("xml", output_type, 3)) {
+		ret = LTTNG_MI_XML;
+	} else {
+		/* Invalid output format */
+		ERR("MI output format not supported");
+		ret = -LTTNG_ERR_MI_OUTPUT_TYPE;
+	}
+	return ret;
+}
+
+/*
  *  list_options
  *
  *  List options line by line. This is mostly for bash auto completion and to
@@ -426,7 +449,7 @@ static int parse_args(int argc, char **argv)
 		clean_exit(EXIT_FAILURE);
 	}
 
-	while ((opt = getopt_long(argc, argv, "+Vhnvqg:", long_options, NULL)) != -1) {
+	while ((opt = getopt_long(argc, argv, "+Vhnvqg:m:", long_options, NULL)) != -1) {
 		switch (opt) {
 		case 'V':
 			version(stdout);
@@ -442,6 +465,13 @@ static int parse_args(int argc, char **argv)
 		case 'q':
 			lttng_opt_quiet = 1;
 			break;
+		case 'm':
+			lttng_opt_mi = mi_output_type(optarg);
+			if (lttng_opt_mi < 0) {
+				ret = lttng_opt_mi;
+				goto error;
+			}
+			break;
 		case 'g':
 			lttng_set_tracing_group(optarg);
 			break;
src/common/Makefile.am +4 -1
index 1a764ae..dffab06 100644
@@ -16,8 +16,11 @@ noinst_LTLIBRARIES = libcommon.la
 libcommon_la_SOURCES = error.h error.c utils.c utils.h runas.c runas.h \
                        common.h futex.c futex.h uri.c uri.h defaults.c \
                        pipe.c pipe.h readwrite.c readwrite.h \
+                       mi-lttng.h mi-lttng.c \
                        daemonize.c daemonize.h
-libcommon_la_LIBADD = -luuid
+libcommon_la_LIBADD = \
+		-luuid \
+		$(top_builddir)/src/common/config/libconfig.la
 
 # Consumer library
 noinst_LTLIBRARIES += libconsumer.la
src/common/error.h +9 -2
index f8c0a1d..4e096b3 100644
@@ -36,6 +36,7 @@
 
 extern int lttng_opt_quiet;
 extern int lttng_opt_verbose;
+extern int lttng_opt_mi;
 
 /* Error type. */
 #define PRINT_ERR   0x1
@@ -48,12 +49,18 @@ extern int lttng_opt_verbose;
 
 /*
  * Macro for printing message depending on command line option and verbosity.
+ *
+ * Machine interface:
+ * We use lttng_opt_mi to suppress all normal msg to stdout. We don't
+ * want any nested msg to show up when printing mi to stdout(if it's the case).
+ * All warnings and errors should be printed to stderr as normal.
  */
 #define __lttng_print(type, fmt, args...)                           \
 	do {                                                            \
-		if (lttng_opt_quiet == 0 && type == PRINT_MSG) {            \
+		if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 &&            \
+				type == PRINT_MSG) {                                \
 			fprintf(stdout, fmt, ## args);                          \
-		} else if (lttng_opt_quiet == 0 &&                          \
+		} else if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 &&     \
 				(((type & PRINT_DBG) && lttng_opt_verbose == 1) ||  \
 				((type & (PRINT_DBG | PRINT_DBG2)) &&               \
 					lttng_opt_verbose == 2) ||                      \
src/common/mi-lttng.c new file +271 -0

271 lines not on this page · raw message

src/common/mi-lttng.h new file +229 -0

229 lines not on this page · raw message

src/lib/lttng-ctl/lttng-ctl.c +1 -0
index 8e2593d..1112484 100644
@@ -74,6 +74,7 @@ static int connected;
  */
 int lttng_opt_quiet;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 /*
  * Copy string from src to dst and enforce null terminated byte.
tests/unit/ini_config/ini_config.c +1 -0
index 38fe5f4..29935ef 100644
@@ -31,6 +31,7 @@ struct state {
 
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 0;
+int lttng_opt_mi;
 
 int entry_handler(const struct config_entry *entry,
 		struct state *state)
tests/unit/test_kernel_data.c +1 -0
index e2182e9..2639be4 100644
@@ -38,6 +38,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_session.c +1 -0
index a0e84e9..4f90c33 100644
@@ -46,6 +46,7 @@ static struct ltt_session_list *session_list;
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 0;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_uri.c +1 -0
index 7cac95d..432e2b3 100644
@@ -25,6 +25,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 /* Number of TAP tests in this file */
 #define NUM_TESTS 11
tests/unit/test_ust_data.c +1 -0
index bc3154c..54b96d6 100644
@@ -44,6 +44,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose;
+int lttng_opt_mi;
 
 int ust_consumerd32_fd;
 int ust_consumerd64_fd;
tests/unit/test_utils_expand_path.c +1 -0
index fe709ac..f863b5d 100644
@@ -31,6 +31,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 struct valid_test_input {
 	char *input;
tests/unit/test_utils_parse_size_suffix.c +1 -0
index 990aa1b..f81278d 100644
@@ -26,6 +26,7 @@
 /* For error.h */
 int lttng_opt_quiet = 1;
 int lttng_opt_verbose = 3;
+int lttng_opt_mi;
 
 struct valid_test_input {
 	char *input;
Signature · 1 line
1.8.3.2

_______________________________________________
lttng-dev mailing list
[email protected]
http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev