Fix format and variable name create.c
[lttng-tools.git] / src / bin / lttng / commands / create.c
index b1f3e8a777a0420ca4f5de66c7c9032118780015..caa12d93e9e5e10c9efa609ea15e79aa840a926b 100644 (file)
@@ -15,7 +15,9 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#define _GNU_SOURCE
+#define _LGPL_SOURCE
+#include <assert.h>
+#include <ctype.h>
 #include <popt.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <sys/types.h>
 #include <time.h>
 #include <unistd.h>
+#include <signal.h>
+#include <sys/wait.h>
+
+#include <common/mi-lttng.h>
+#include <common/config/session-config.h>
 
 #include "../command.h"
 #include "../utils.h"
 
+#include <common/defaults.h>
 #include <common/sessiond-comm/sessiond-comm.h>
+#include <common/uri.h>
+#include <common/utils.h>
+#include <lttng/snapshot.h>
 
 static char *opt_output_path;
 static char *opt_session_name;
+static char *opt_url;
+static char *opt_ctrl_url;
+static char *opt_data_url;
+static char *opt_shm_path;
+static char *opt_template_path;
+static int opt_no_consumer;
+static int opt_no_output;
+static int opt_snapshot;
+static unsigned int opt_live_timer;
 
 enum {
        OPT_HELP = 1,
        OPT_LIST_OPTIONS,
+       OPT_LIVE_TIMER,
+};
+
+enum output_type {
+       OUTPUT_UNKNOWN = -1,
+       OUTPUT_NONE,
+       OUTPUT_LOCAL,
+       OUTPUT_NET,
+};
+enum session_type {
+       SESSION_UNKNOWN = -1,
+       SESSION_NORMAL,
+       SESSION_LIVE,
+       SESSION_SNAPSHOT,
 };
 
+
+static struct mi_writer *writer;
+
 static struct poptOption long_options[] = {
        /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
        {"help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL},
        {"output", 'o', POPT_ARG_STRING, &opt_output_path, 0, NULL, NULL},
        {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
+       {"set-url",        'U', POPT_ARG_STRING, &opt_url, 0, 0, 0},
+       {"ctrl-url",       'C', POPT_ARG_STRING, &opt_ctrl_url, 0, 0, 0},
+       {"data-url",       'D', POPT_ARG_STRING, &opt_data_url, 0, 0, 0},
+       {"no-output",       0, POPT_ARG_VAL, &opt_no_output, 1, 0, 0},
+       {"no-consumer",     0, POPT_ARG_VAL, &opt_no_consumer, 1, 0, 0},
+       {"snapshot",        0, POPT_ARG_VAL, &opt_snapshot, 1, 0, 0},
+       {"live",            0, POPT_ARG_INT | POPT_ARGFLAG_OPTIONAL, 0, OPT_LIVE_TIMER, 0, 0},
+       {"shm-path",        0, POPT_ARG_STRING, &opt_shm_path, 0, 0, 0},
+       {"template-path",        0, POPT_ARG_STRING, &opt_template_path, 0, 0, 0},
        {0, 0, 0, 0, 0, 0, 0}
 };
 
 /*
- * usage
+ * Please have a look at src/lib/lttng-ctl/lttng-ctl.c for more information on
+ * why this declaration exists and used ONLY in for this command.
+ */
+extern int _lttng_create_session_ext(const char *name, const char *url,
+               const char *datetime);
+
+/*
+ * Retrieve the created session and mi output it based on provided argument
+ * This is currently a summary of what was pretty printed and is subject to
+ * enhancements.
+ */
+static int mi_created_session(const char *session_name)
+{
+       int ret, i, count, found;
+       struct lttng_session *sessions;
+
+       /* session_name should not be null */
+       assert(session_name);
+       assert(writer);
+
+       count = lttng_list_sessions(&sessions);
+       if (count < 0) {
+               ret = count;
+               ERR("%s", lttng_strerror(ret));
+               goto error;
+       }
+
+       if (count == 0) {
+               ERR("Error session creation failed: session %s not found", session_name);
+               ret = -LTTNG_ERR_SESS_NOT_FOUND;
+               goto end;
+       }
+
+       found = 0;
+       for (i = 0; i < count; i++) {
+               if (strncmp(sessions[i].name, session_name, NAME_MAX) == 0) {
+                       found = 1;
+                       ret = mi_lttng_session(writer, &sessions[i], 0);
+                       if (ret) {
+                               goto error;
+                       }
+                       break;
+               }
+       }
+
+       if (!found) {
+               ret = -LTTNG_ERR_SESS_NOT_FOUND;
+       } else {
+               ret = CMD_SUCCESS;
+       }
+
+error:
+       free(sessions);
+end:
+       return ret;
+}
+
+/*
+ * For a session name, set the consumer URLs.
+ */
+static int set_consumer_url(const char *session_name, const char *ctrl_url,
+               const char *data_url)
+{
+       int ret;
+       struct lttng_handle *handle;
+
+       assert(session_name);
+
+       /*
+        * Set handle with the session_name, but no domain. This implies that
+        * the actions taken with this handle apply on the tracing session
+        * rather then the domain-specific session.
+        */
+       handle = lttng_create_handle(session_name, NULL);
+       if (handle == NULL) {
+               ret = CMD_FATAL;
+               goto error;
+       }
+
+       ret = lttng_set_consumer_url(handle, ctrl_url, data_url);
+       if (ret < 0) {
+               goto error;
+       }
+
+error:
+       lttng_destroy_handle(handle);
+       return ret;
+}
+
+static int add_snapshot_output(const char *session_name, const char *ctrl_url,
+               const char *data_url)
+{
+       int ret;
+       struct lttng_snapshot_output *output = NULL;
+
+       assert(session_name);
+
+       output = lttng_snapshot_output_create();
+       if (!output) {
+               ret = CMD_FATAL;
+               goto error_create;
+       }
+
+       if (ctrl_url) {
+               ret = lttng_snapshot_output_set_ctrl_url(ctrl_url, output);
+               if (ret < 0) {
+                       goto error;
+               }
+       }
+
+       if (data_url) {
+               ret = lttng_snapshot_output_set_data_url(data_url, output);
+               if (ret < 0) {
+                       goto error;
+               }
+       }
+
+       /* This call, if successful, populates the id of the output object. */
+       ret = lttng_snapshot_add_output(session_name, output);
+       if (ret < 0) {
+               goto error;
+       }
+
+error:
+       lttng_snapshot_output_destroy(output);
+error_create:
+       return ret;
+}
+
+/*
+ * Validate the combinations of passed options
+ *
+ * CMD_ERROR on error
+ * CMD_SUCCESS on success
+ */
+static int validate_command_options(enum session_type type)
+{
+       int ret = CMD_SUCCESS;
+
+       if (opt_snapshot && opt_live_timer) {
+               ERR("Snapshot and live modes are mutually exclusive.");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       if ((!opt_ctrl_url && opt_data_url) || (opt_ctrl_url && !opt_data_url)) {
+               ERR("Control and data URLs must both be set.");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       if (opt_template_path) {
+               /* Restriction on flags exist when using template */
+               /* Session type flags are not permitted */
+               /* --live & --snapshot */
+               if ((opt_live_timer && type != SESSION_LIVE) ||
+                               (opt_snapshot && type != SESSION_SNAPSHOT)) {
+                       ERR("It is not possible to change the session type of a template");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       }
+
+error:
+       return ret;
+}
+
+/*
+ * Create a session using direct calls to liblttng-ctl.
+ *
+ * Return CMD_SUCCESS on success, negative value on internal lttng errors and positive
+ * value on command errors.
  */
-static void usage(FILE *ofp)
+static int create_session_basic (const char *session_name,
+               enum session_type session_type,
+               int live_timer,
+               enum output_type output_type,
+               const char* url,
+               const char* ctrl_url,
+               const char* data_url,
+               const char* shm_path,
+               const char* datetime)
 {
-       fprintf(ofp, "usage: lttng create [options] [NAME]\n");
-       fprintf(ofp, "\n");
-       fprintf(ofp, "  The default NAME is 'auto-yyyymmdd-hhmmss'\n");
-       fprintf(ofp, "  -h, --help           Show this help\n");
-       fprintf(ofp, "      --list-options   Simple listing of options\n");
-       fprintf(ofp, "  -o, --output PATH    Specify output path for traces\n");
-       fprintf(ofp, "\n");
+       /* Create session based on session creation */
+       int ret = CMD_SUCCESS;
+       const char *pathname;
+
+       assert(datetime);
+
+       if (opt_relayd_path) {
+               pathname = opt_relayd_path;
+       } else {
+               pathname = INSTALL_BIN_PATH "/lttng-relayd";
+       }
+
+       switch (session_type) {
+       case SESSION_NORMAL:
+               ret = _lttng_create_session_ext(session_name, url, datetime);
+               break;
+       case SESSION_SNAPSHOT:
+               if (output_type == OUTPUT_NONE) {
+                       ERR("--no-output on a snapshot session is invalid");
+                       ret = CMD_UNSUPPORTED;
+                       goto error;
+               }
+               ret = lttng_create_session_snapshot(session_name, url);
+               break;
+       case SESSION_LIVE:
+               if (output_type == OUTPUT_NONE) {
+                       ERR("--no-output on a live session is invalid");
+                       ret = CMD_UNSUPPORTED;
+                       goto error;
+               }
+
+               if (output_type == OUTPUT_LOCAL) {
+                       ERR("Local file output on a live session is invalid");
+                       ret = CMD_UNSUPPORTED;
+                       goto error;
+               }
+               if (output_type != OUTPUT_NET && !check_relayd() &&
+                               spawn_relayd(pathname, 0) < 0) {
+                       ret = CMD_FATAL;
+                       goto error;
+               }
+               ret = lttng_create_session_live(session_name, url, live_timer);
+               break;
+       default:
+               ERR("Unknown session type");
+               ret = CMD_UNDEFINED;
+               goto error;
+       }
+
+       if (ret < 0) {
+               /* Don't set ret so the sessiond error is propagated. */
+               switch (-ret) {
+               case LTTNG_ERR_EXIST_SESS:
+                       WARN("Session %s already exists", session_name);
+                       break;
+               default:
+                       break;
+               }
+               goto error;
+       }
+
+       /* Configure the session based on the output type */
+       switch (output_type) {
+       case OUTPUT_LOCAL:
+               break;
+       case OUTPUT_NET:
+               if (!ctrl_url || !data_url) {
+                       break;
+               }
+
+               if (session_type == SESSION_SNAPSHOT) {
+                       ret = add_snapshot_output(session_name, ctrl_url,
+                                       data_url);
+               } else {
+                       /*
+                        * Normal sessions and live sessions behave the same way
+                        * regarding consumer url.
+                        */
+                       ret = set_consumer_url(session_name, ctrl_url, data_url);
+               }
+               if (ret < 0) {
+                       /* Destroy created session on errors */
+                       lttng_destroy_session(session_name);
+                       goto error;
+               }
+               break;
+       case OUTPUT_NONE:
+               break;
+       default:
+               ERR("Unknown output type");
+               ret = CMD_UNDEFINED;
+               goto error;
+       }
+
+       /*
+        * Set the session shared memory path
+        */
+       if (shm_path) {
+               ret = lttng_set_session_shm_path(session_name, shm_path);
+               if (ret < 0) {
+                       lttng_destroy_session(session_name);
+                       goto error;
+               }
+       }
+error:
+       return ret;
+}
+
+static int generate_output(const char *session_name,
+               enum session_type session_type,
+               int live_timer,
+               enum output_type output_type,
+               const char* url,
+               const char* ctrl_url,
+               const char* data_url,
+               const char* shm_path)
+{
+       int ret = CMD_SUCCESS;
+
+       /*
+        * TODO move this to after session name
+        * for now we only emulate previous behaviour.
+        */
+       if (session_type != SESSION_SNAPSHOT) {
+               if (ctrl_url) {
+                       MSG("Control URL %s set for session %s", ctrl_url, session_name);
+               }
+
+               if (data_url) {
+                       MSG("Data URL %s set for session %s", data_url, session_name);
+               }
+       }
+
+       if (url && output_type == OUTPUT_LOCAL) {
+               /* Remove the file:// */
+               if (strlen(url) > strlen("file://")){
+                       url = url + strlen("file://");
+               }
+       }
+
+       MSG("Session %s created.", session_name);
+       if (url && session_type != SESSION_SNAPSHOT) {
+               MSG("Traces will be written in %s", url);
+
+               if (live_timer) {
+                       MSG("Live timer set to %u usec", live_timer);
+               }
+       } else if (session_type == SESSION_SNAPSHOT) {
+               if (url) {
+                       MSG("Default snapshot output set to: %s", url);
+               }
+               MSG("Snapshot mode set. Every channel enabled for that session will "
+                               "be set to mmap output, and default to overwrite mode.");
+       }
+
+       if (shm_path) {
+               MSG("Session %s set to shm_path: %s.", session_name,
+                               shm_path);
+       }
+
+       /* Mi output */
+       if (lttng_opt_mi) {
+               ret = mi_created_session(session_name);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       }
+error:
+       return ret;
+}
+
+static int parse_template (struct config_document *template,
+               char **session_name,
+               enum session_type *session_type,
+               int *live_timer,
+               enum output_type *output_type,
+               char **url,
+               char **ctrl_url,
+               char **data_url,
+               char **shm_path)
+{
+       int ret = 0;
+       int printed_bytes;
+       char *raw_value = NULL;
+
+       assert(template);
+
+       /* Session name */
+       *session_name = config_document_get_element_value(template,"/sessions/session/name");
+
+       /* Check the type of session we have in the template */
+       if(config_document_element_exist(template, "/sessions/session/attributes/snapshot_mode")) {
+               *session_type = SESSION_SNAPSHOT;
+       } else if (config_document_element_exist(template, "/sessions/session/attributes/live_timer_interval")) {
+               *session_type = SESSION_LIVE;
+               raw_value = config_document_get_element_value(template,"/sessions/session/attributes/live_timer_interval");
+               *live_timer = config_parse_value(raw_value);
+               free(raw_value);
+               raw_value = NULL;
+       } else {
+               *session_type = SESSION_NORMAL;
+       }
+
+       /* Output */
+       switch (*session_type) {
+       case SESSION_NORMAL:
+       case SESSION_LIVE:
+               if (!config_document_element_exist(template, "/sessions/session/output/consumer_output/destination")){
+                       break;
+               }
+               if (config_document_element_exist(template, "/sessions/session/output/consumer_output/destination/path")){
+                       raw_value = config_document_get_element_value(template, "/sessions/session/output/consumer_output/destination/path");
+                       if (!raw_value) {
+                               ret = -1;
+                               goto error;
+                       }
+
+                       if (strlen(raw_value) > 0) {
+                               *output_type = OUTPUT_LOCAL;
+                               printed_bytes = asprintf(url, "file://%s", raw_value);
+                               if (printed_bytes < 0) {
+                                       ret = -1;
+                                       goto error;
+                               }
+                       } else {
+                               *output_type = OUTPUT_NONE;
+                       }
+
+                       free(raw_value);
+                       raw_value = NULL;
+                       break;
+               } else if(config_document_element_exist(template, "/sessions/session/output/consumer_output/destination/net_output")) {
+                       *ctrl_url = config_document_get_element_value(template, "/sessions/session/output/consumer_output/destination/net_output/control_uri");
+                       *data_url = config_document_get_element_value(template, "/sessions/session/output/consumer_output/destination/net_output/data_uri");
+                       if (!*ctrl_url || ! *data_url) {
+                               ret = -1;
+                               goto error;
+                       }
+                       *output_type = OUTPUT_NET;
+               } else {
+                       /* There is no output definition */
+               }
+               break;
+       case SESSION_SNAPSHOT:
+               if (!config_document_element_exist(template, "/sessions/session/output/snapshot_outputs/output/consumer_output/destination")){
+                       break;
+               }
+               if (config_document_element_exist(template, "/sessions/session/output/snapshot_outputs/output/consumer_output/destination/path")){
+                       raw_value = config_document_get_element_value(template, "/sessions/session/output/snapshot_outputs/output/consumer_output/destination/path");
+                       if (!raw_value) {
+                               ret = -1;
+                               goto error;
+                       }
+
+                       if (strlen(raw_value) > 0) {
+                               *output_type = OUTPUT_LOCAL;
+                               printed_bytes = asprintf(url, "file://%s", raw_value);
+                               if (printed_bytes < 0) {
+                                       ret = -1;
+                                       goto error;
+                               }
+                       } else {
+                               *output_type = OUTPUT_NONE;
+                       }
+
+                       free(raw_value);
+                       raw_value = NULL;
+                       break;
+               } else if(config_document_element_exist(template, "/sessions/session/output/snapshot_outputs/output/consumer_output/destination/net_output")) {
+                       *ctrl_url = config_document_get_element_value(template, "/sessions/session/output/snapshot_outputs/output/consumer_output/destination/net_output/control_uri");
+                       *data_url = config_document_get_element_value(template, "/sessions/session/output/snapshot_outputs/output/consumer_output/destination/net_output/data_uri");
+                       if (!*ctrl_url || ! *data_url) {
+                               ret = -1;
+                               goto error;
+                       }
+                       *output_type = OUTPUT_NET;
+               } else {
+                       /* There is no output definition */
+               }
+               break;
+       case SESSION_UNKNOWN:
+               ret = -1;
+               goto error;
+       }
+
+
+       /* shared memory path */
+       *shm_path = config_document_get_element_value(template,"/sessions/session/shared_memory_path");
+
+error:
+       free(raw_value);
+       return ret;
+
+}
+static int create_session_from_template(struct config_document *template,
+               const char *session_name,
+               enum session_type session_type,
+               int live_timer,
+               enum output_type output_type,
+               const char *url,
+               const char *ctrl_url,
+               const char *data_url,
+               const char *shm_path,
+               const char *datetime)
+{
+       int ret = CMD_SUCCESS;
+       int printed_bytes;
+       struct config_element *temp_element = NULL;
+       struct config_element *temp_element_child = NULL;
+       char tmp_ctrl_uri[PATH_MAX];
+       char tmp_data_uri[PATH_MAX];
+       struct lttng_uri *uris = NULL;
+       ssize_t uri_array_size = 0;
+       char *tmp_string = NULL;
+
+       assert(template);
+       assert(session_name);
+
+       memset(tmp_ctrl_uri, 0, sizeof(tmp_ctrl_uri));
+       memset(tmp_data_uri, 0, sizeof(tmp_data_uri));
+
+       /* Session name */
+       if (config_document_element_exist(template, "/sessions/session/name")) {
+               /* Replace the node value */
+               config_document_replace_element_value(template, "/sessions/session/name", session_name);
+       } else {
+               /* insert the node */
+               temp_element = config_element_create("name", session_name);
+               if (!temp_element) {
+                       ERR("Could not create session name node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               ret = config_document_insert_element(template, "/sessions/session", temp_element);
+               if (ret) {
+                       ERR("Could not insert session name node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               config_element_free(temp_element);
+       }
+
+       /*
+        * Live timer
+        */
+       if (session_type == SESSION_LIVE) {
+               if (config_document_element_exist(template, "/sessions/session/attributes/live_timer_interval")) {
+                       printed_bytes = asprintf(&tmp_string, "%d", live_timer);
+                       if (printed_bytes < 0) {
+                               ERR("Asprintf failed for live timer");
+                               ret = CMD_ERROR;
+                               goto error;
+                       }
+                       ret = config_document_replace_element_value(template, "/sessions/session/attributes/live_timer_interval", tmp_string);
+
+                       if (ret) {
+                               printf("error: %d\n", ret);
+                               ERR("Replacement of live_timer_interval failed");
+                               ret = CMD_ERROR;
+                               goto error;
+                       }
+
+                       free(tmp_string);
+                       tmp_string = NULL;
+               } else {
+                       ERR("Invalid live timer template. Missing live timer node");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+       }
+
+       /*
+        * Generate the output node
+        */
+
+       /* Get output from urls */
+       if (url) {
+               /* Get lttng uris from single url */
+               uri_array_size = uri_parse_str_urls(url, NULL, &uris);
+               if (uri_array_size < 0) {
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       } else if (ctrl_url && data_url) {
+               uri_array_size = uri_parse_str_urls(ctrl_url, data_url, &uris);
+               if (uri_array_size < 0) {
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       } else {
+               /* --no-output */
+               uri_array_size = 0;
+       }
+
+       /* Validate if the session output type still match the passed data */
+       if ( (uri_array_size == 0 && output_type != OUTPUT_NONE) ||
+                       (uri_array_size == 1 && output_type != OUTPUT_LOCAL) ||
+                       (uri_array_size == 2 && output_type != OUTPUT_NET)) {
+               ERR("Overwriting value for output do not match the base output type");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       switch (output_type) {
+       case OUTPUT_NONE:
+               temp_element_child = config_element_create("path", "");
+               if (!temp_element_child) {
+                       ERR("Could not create empty path node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               break;
+       case OUTPUT_LOCAL:
+               temp_element_child = config_element_create("path", uris[0].dst.path);
+               if (!temp_element_child) {
+                       ERR("Could not create local path node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               break;
+       case OUTPUT_NET:
+               uri_to_str_url(&uris[0], tmp_ctrl_uri, sizeof(tmp_ctrl_uri));
+               uri_to_str_url(&uris[1], tmp_data_uri, sizeof(tmp_data_uri));
+
+               temp_element_child = config_element_create("net_output", NULL);
+               if (!temp_element_child) {
+                       ERR("Could not create net_output node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               temp_element = config_element_create("control_uri", tmp_ctrl_uri);
+               if (!temp_element_child) {
+                       ERR("Could not create ctrl uri node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               ret = config_element_add_child(temp_element_child, temp_element);
+               if (ret) {
+                       ERR("Could not append control uri to the net_output node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               config_element_free(temp_element);
+               temp_element = NULL;
+
+               temp_element = config_element_create("data_uri", tmp_data_uri);
+
+               if (!temp_element_child) {
+                       ERR("Could not create data_uri configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               ret = config_element_add_child(temp_element_child, temp_element);
+               if (ret) {
+                       ERR("Could not append data uri to the net_output node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               config_element_free(temp_element);
+               temp_element = NULL;
+               break;
+       default:
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       temp_element = config_element_create("destination", NULL);
+       if (!temp_element) {
+               ERR("Could not create destination node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       ret = config_element_add_child(temp_element, temp_element_child);
+       if (ret) {
+               ERR("Could not append output data to the destination node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       config_element_free(temp_element_child);
+       temp_element_child = NULL;
+
+       /* Construct the output/consumer_output/ node*/
+       temp_element_child = temp_element;
+       temp_element = config_element_create("consumer_output", NULL);
+       if (!temp_element) {
+               ERR("Could not create consumer_output node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       ret = config_element_add_child(temp_element, temp_element_child);
+       if (ret) {
+               ERR("Could not append output data to the consumer_output node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       config_element_free(temp_element_child);
+       temp_element_child = config_element_create("enabled", "true");
+       if (!temp_element_child) {
+               ERR("Could not create enbaled node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       ret = config_element_add_child(temp_element, temp_element_child);
+       if (ret) {
+               ERR("Could not append node to the consumer_output node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       config_element_free(temp_element_child);
+       temp_element_child = NULL;
+
+
+       temp_element_child = temp_element;
+       temp_element = config_element_create("output", NULL);
+       if (!temp_element) {
+               ERR("Could not create output node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       ret = config_element_add_child(temp_element, temp_element_child);
+       if (ret) {
+               ERR("Could not append output data to the output node configuration");
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       config_element_free(temp_element_child);
+       temp_element_child = NULL;
+
+
+       /*
+        * validate and replace the destination node for each session type
+        * TODO: export string as const and simply assign a base path for the
+        * destination node based on the session type
+        **/
+       switch (session_type) {
+       case SESSION_NORMAL:
+       case SESSION_LIVE:
+               break;
+       case SESSION_SNAPSHOT:
+               /* construct the output/snapshots_outputs/ */
+               temp_element_child = temp_element;
+               temp_element = config_element_create("snapshot_outputs", NULL);
+               if (!temp_element) {
+                       ERR("Could not create snapshot_outputs node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               ret = config_element_add_child(temp_element, temp_element_child);
+               if (ret) {
+                       ERR("Could not append output data to the snapshot_outputs node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               config_element_free(temp_element_child);
+               temp_element_child = NULL;
+
+               temp_element_child = temp_element;
+               temp_element = config_element_create("output", NULL);
+               if (!temp_element) {
+                       ERR("Could not create output node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               ret = config_element_add_child(temp_element, temp_element_child);
+               if (ret) {
+                       ERR("Could not append output data to the output node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               config_element_free(temp_element_child);
+               temp_element_child = NULL;
+               break;
+       default:
+               ERR("Invalid session type");
+               ret = CMD_UNDEFINED;
+               goto error;
+       }
+
+       if (!config_document_element_exist(template, "/sessions/session/output")) {
+               ret = config_document_insert_element(template, "/sessions/session", temp_element);
+       } else {
+               ret = config_document_replace_element(template, "/sessions/session/output", temp_element);
+       }
+
+       config_element_free(temp_element);
+       temp_element = NULL;
+
+       if (ret) {
+               ERR("%s", lttng_strerror(ret));
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+
+       /* Shm path */
+       if (shm_path && config_document_element_exist(template, "/sessions/session/shared_memory_path")) {
+               /* Replace the node value */
+               config_document_replace_element_value(template, "/sessions/session/shared_memory_path", shm_path);
+       } else if (shm_path) {
+               /* insert the node */
+               temp_element = config_element_create("shared_memory_path", shm_path);
+               if (!temp_element) {
+                       ERR("Could not create shared_memory_path node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               ret = config_document_insert_element(template, "/sessions/session", temp_element);
+               if (ret) {
+                       ERR("Could not insert shared_memory_path node configuration");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               config_element_free(temp_element);
+               temp_element = NULL;
+       }
+
+       ret = config_load_configuration_sessions(template, session_name, 0);
+
+
+error:
+       config_element_free(temp_element);
+       config_element_free(temp_element_child);
+       free(tmp_string);
+       free(uris);
+       return ret;
+
 }
 
 /*
@@ -66,92 +929,487 @@ static void usage(FILE *ofp)
  *
  *  Returns one of the CMD_* result constants.
  */
-static int create_session()
+static int create_session(void)
 {
-       int ret, have_name = 0;
+       int ret;
+       int printed_bytes;
+
+
+       /* Template */
+       struct config_document *template = NULL;
+
+       /* Base data */
+       enum session_type base_session_type = SESSION_UNKNOWN;
+       enum output_type base_output_type = OUTPUT_UNKNOWN;
+       char *base_session_name = NULL;
+       char *base_url = NULL;
+       char *base_ctrl_url = NULL;
+       char *base_data_url = NULL;
+       char *base_shm_path = NULL;
+       int base_live_timer = 0;
+
+       /* Time data */
        char datetime[16];
-       char *session_name, *traces_path = NULL, *alloc_path = NULL;
        time_t rawtime;
-       struct tm *timeinfo;
+       struct tm *timeinfo = NULL;
+
+       /* Temporary variables */
+       char *traces_path = NULL;
+       char *temp_url = NULL;
+       char *session_name_date = NULL;
+       char *tmp_url = NULL;
+       char *tmp_home_path = NULL;
+       struct lttng_uri *uris = NULL;
+       ssize_t uri_array_size = 0;
+
 
        /* Get date and time for automatic session name/path */
        time(&rawtime);
        timeinfo = localtime(&rawtime);
        strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
 
-       /* Auto session name creation */
-       if (opt_session_name == NULL) {
-               ret = asprintf(&session_name, "auto-%s", datetime);
-               if (ret < 0) {
-                       perror("asprintf session name");
+       if (opt_template_path) {
+               /* Restriction on flags exist when using template */
+               /* Session type flags are not permitted */
+               /* --live & --snapshot */
+               template = config_document_get(opt_template_path);
+               if (!template) {
+                       ERR("Template could not be parsed");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               /* Load info from template if any */
+               /* TODO: might want to use a struct in the end for the session... */
+               ret = parse_template(template, &base_session_name,
+                               &base_session_type,
+                               &base_live_timer,
+                               &base_output_type,
+                               &base_url,
+                               &base_ctrl_url,
+                               &base_data_url,
+                               &base_shm_path);
+               if (ret) {
                        goto error;
                }
-               DBG("Auto session name set to %s", session_name);
-       } else {
-               session_name = opt_session_name;
-               have_name = 1;
        }
 
-       /* Auto output path */
-       if (opt_output_path == NULL) {
-               alloc_path = strdup(config_get_default_path());
-               if (alloc_path == NULL) {
-                       ERR("Home path not found.\n \
-                                Please specify an output path using -o, --output PATH");
-                       ret = CMD_FATAL;
+       /* Option validation */
+       if (validate_command_options(base_session_type) != CMD_SUCCESS) {
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       /* Find the session type based on options */
+       if(base_session_type == SESSION_UNKNOWN) {
+               if (opt_snapshot) {
+                       base_session_type = SESSION_SNAPSHOT;
+               } else if (opt_live_timer) {
+                       base_session_type = SESSION_LIVE;
+               } else {
+                       base_session_type = SESSION_NORMAL;
+               }
+       }
+
+       /*
+        * Session name handling
+        */
+       if (opt_session_name) {
+               /* Override the session name */
+               if (strlen(opt_session_name) > NAME_MAX) {
+                       ERR("Session name too long. Length must be lower or equal to %d",
+                                       NAME_MAX);
+                       ret = LTTNG_ERR_SESSION_FAIL;
+                       free(session_name_date);
                        goto error;
                }
+               /*
+                * Check if the session name begins with "auto-" or is exactly "auto".
+                * Both are reserved for the default session name. See bug #449 to
+                * understand why we need to check both here.
+                */
+               if ((strncmp(opt_session_name, DEFAULT_SESSION_NAME "-",
+                               strlen(DEFAULT_SESSION_NAME) + 1) == 0) ||
+                       (strncmp(opt_session_name, DEFAULT_SESSION_NAME,
+                               strlen(DEFAULT_SESSION_NAME)) == 0 &&
+                       strlen(opt_session_name) == strlen(DEFAULT_SESSION_NAME))) {
+                       ERR("%s is a reserved keyword for default session(s)",
+                                       DEFAULT_SESSION_NAME);
 
-               if (have_name) {
-                       ret = asprintf(&traces_path, "%s/" DEFAULT_TRACE_DIR_NAME
-                                       "/%s-%s", alloc_path, session_name, datetime);
-               } else {
-                       ret = asprintf(&traces_path, "%s/" DEFAULT_TRACE_DIR_NAME
-                                       "/%s", alloc_path, session_name);
+                       ret = CMD_ERROR;
+                       goto error;
                }
 
-               if (ret < 0) {
-                       perror("asprintf trace dir name");
+               base_session_name = strndup(opt_session_name, NAME_MAX);
+               if (!base_session_name) {
+                       PERROR("Strdup session name");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               printed_bytes = asprintf(&session_name_date, "%s-%s", base_session_name, datetime);
+               if (printed_bytes < 0) {
+                       PERROR("Asprintf session name");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               DBG("Session name from command option set to %s", base_session_name);
+       } else if (base_session_name) {
+               printed_bytes = asprintf(&session_name_date, "%s-%s", base_session_name, datetime);
+               if (printed_bytes < 0) {
+                       PERROR("Asprintf session name");
+                       ret = CMD_ERROR;
                        goto error;
                }
        } else {
-               traces_path = opt_output_path;
+               /* Generate a name */
+               printed_bytes = asprintf(&base_session_name, DEFAULT_SESSION_NAME "-%s", datetime);
+               if (printed_bytes < 0) {
+                       PERROR("Asprintf session name");
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+               session_name_date = strdup(base_session_name);
+               DBG("Auto session name set to %s", base_session_name);
        }
 
-       ret = lttng_create_session(session_name, traces_path);
-       if (ret < 0) {
-               /* Don't set ret so lttng can interpret the sessiond error. */
-               switch (-ret) {
-               case LTTCOMM_EXIST_SESS:
-                       WARN("Session %s already exists", session_name);
+
+       /*
+        * Output handling
+        */
+
+       /*
+        * If any of those options are present clear all output related data.
+        */
+       if (opt_output_path || opt_url || (opt_ctrl_url && opt_data_url) || opt_no_output) {
+               /* Overwrite output */
+               free(base_url);
+               free(base_ctrl_url);
+               free(base_data_url);
+               base_url = NULL;
+               base_ctrl_url = NULL;
+               base_data_url = NULL;
+       }
+
+       if (opt_output_path) {
+
+               traces_path = utils_expand_path(opt_output_path);
+               if (!traces_path) {
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+
+               /* Create URL string from the local file system path */
+               printed_bytes = asprintf(&temp_url, "file://%s", traces_path);
+               if (printed_bytes < 0) {
+                       PERROR("asprintf url path");
+                       ret = CMD_FATAL;
+                       goto error;
+               }
+
+               base_url = temp_url;
+       } else if (opt_url) { /* Handling URL (-U opt) */
+               base_url = strdup(opt_url);
+       } else if (opt_data_url && opt_ctrl_url) {
+               /*
+                * With both control and data, we'll be setting the consumer URL
+                * after session creation thus use no URL.
+                */
+               base_ctrl_url = strdup(opt_ctrl_url);
+               base_data_url = strdup(opt_data_url);
+       } else if (!(opt_no_output || base_output_type == OUTPUT_NONE ||
+                               base_url || base_ctrl_url || base_data_url)) {
+               /* Generate default output depending on the session type */
+               switch (base_session_type) {
+               case SESSION_NORMAL:
+                       /* fallthrough */
+               case SESSION_SNAPSHOT:
+                       /* Default to a local path */
+                       tmp_home_path = utils_get_home_dir();
+                       if (tmp_home_path == NULL) {
+                               ERR("HOME path not found.\n \
+                                               Please specify an output path using -o, --output PATH");
+                               ret = CMD_FATAL;
+                               goto error;
+                       }
+
+                       printed_bytes = asprintf(&tmp_url,
+                                       "file://%s/" DEFAULT_TRACE_DIR_NAME "/%s",
+                                       tmp_home_path, session_name_date);
+
+                       if (printed_bytes < 0) {
+                               PERROR("asprintf trace dir name");
+                               ret = CMD_FATAL;
+                               goto error;
+                       }
+
+                       base_url = tmp_url ;
                        break;
+               case SESSION_LIVE:
+                       /* Default to a net output */
+                       printed_bytes = asprintf(&tmp_url, "net://127.0.0.1");
+                       if (printed_bytes < 0) {
+                               PERROR("asprintf default live URL");
+                               ret = CMD_FATAL;
+                               goto error;
+                       }
+                       base_url = tmp_url ;
+                       break;
+               default:
+                       ERR("Unknown session type");
+                       ret = CMD_FATAL;
+                       goto error;
+               }
+       }
+
+        /*
+         * Shared memory path handling
+         */
+       if (opt_shm_path) {
+               /* Overwrite shm_path so clear any previously defined one */
+               free(base_shm_path);
+               printed_bytes = asprintf(&base_shm_path, "%s/%s", opt_shm_path, session_name_date);
+               if (printed_bytes < 0) {
+                       PERROR("asprintf shm_path");
+                       ret = CMD_FATAL;
+                       goto error;
                }
+       }
+
+        /*
+         * Live timer handling
+         */
+       if (opt_live_timer) {
+               base_live_timer = opt_live_timer;
+       }
+
+       /* Get output type from urls */
+       /* TODO: Find a better way of inferring output type */
+       if (base_url) {
+               /* Get lttng uris from single url */
+               uri_array_size = uri_parse_str_urls(base_url, NULL, &uris);
+               if (uri_array_size < 0) {
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       } else if (base_ctrl_url && base_data_url) {
+               uri_array_size = uri_parse_str_urls(base_ctrl_url, base_data_url, &uris);
+               if (uri_array_size < 0) {
+                       ret = CMD_ERROR;
+                       goto error;
+               }
+       } else {
+               /* --no-output */
+               uri_array_size = 0;
+       }
+
+       switch (uri_array_size) {
+       case 0:
+               base_output_type = OUTPUT_NONE;
+               break;
+       case 1:
+               base_output_type = OUTPUT_LOCAL;
+               break;
+       case 2:
+               base_output_type = OUTPUT_NET;
+               break;
+       default:
+               ret = CMD_ERROR;
+               goto error;
+       }
+
+       if (template) {
+               ret = create_session_from_template(template,
+                               base_session_name,
+                               base_session_type,
+                               base_live_timer,
+                               base_output_type,
+                               base_url,
+                               base_ctrl_url,
+                               base_data_url,
+                               base_shm_path,
+                               datetime);
+       } else {
+               ret = create_session_basic(base_session_name,
+                               base_session_type,
+                               base_live_timer,
+                               base_output_type,
+                               base_url,
+                               base_ctrl_url,
+                               base_data_url,
+                               base_shm_path,
+                               datetime);
+       }
+       if (ret) {
+               goto error;
+       }
+
+       ret = generate_output(base_session_name,
+                       base_session_type,
+                       base_live_timer,
+                       base_output_type,
+                       base_url,
+                       base_ctrl_url,
+                       base_data_url,
+                       base_shm_path);
+       if (ret) {
                goto error;
        }
 
        /* Init lttng session config */
-       ret = config_init(session_name);
+       ret = config_init(base_session_name);
        if (ret < 0) {
                ret = CMD_ERROR;
                goto error;
        }
 
-       MSG("Session %s created.", session_name);
-       MSG("Traces will be written in %s" , traces_path);
-
        ret = CMD_SUCCESS;
 
 error:
-       if (opt_session_name == NULL) {
-               free(session_name);
+       /* Session temp stuff */
+       config_document_free(template);
+       free(session_name_date);
+       free(uris);
+       free(traces_path);
+
+       if (ret < 0) {
+               ERR("%s", lttng_strerror(ret));
        }
 
-       if (alloc_path) {
-               free(alloc_path);
+       free(base_session_name);
+       free(base_url);
+       free(base_ctrl_url);
+       free(base_data_url);
+       free(base_shm_path);
+       return ret;
+}
+
+/*
+ *  spawn_sessiond
+ *
+ *  Spawn a session daemon by forking and execv.
+ */
+static int spawn_sessiond(char *pathname)
+{
+       int ret = 0;
+       pid_t pid;
+
+       MSG("Spawning a session daemon");
+       pid = fork();
+       if (pid == 0) {
+               /*
+                * Spawn session daemon in daemon mode.
+                */
+               execlp(pathname, "lttng-sessiond",
+                               "--daemonize", NULL);
+               /* execlp only returns if error happened */
+               if (errno == ENOENT) {
+                       ERR("No session daemon found. Use --sessiond-path.");
+               } else {
+                       PERROR("execlp");
+               }
+               kill(getppid(), SIGTERM);       /* wake parent */
+               exit(EXIT_FAILURE);
+       } else if (pid > 0) {
+               /*
+                * In daemon mode (--daemonize), sessiond only exits when
+                * it's ready to accept commands.
+                */
+               for (;;) {
+                       int status;
+                       pid_t wait_pid_ret = waitpid(pid, &status, 0);
+
+                       if (wait_pid_ret < 0) {
+                               if (errno == EINTR) {
+                                       continue;
+                               }
+                               PERROR("waitpid");
+                               ret = -errno;
+                               goto end;
+                       }
+
+                       if (WIFSIGNALED(status)) {
+                               ERR("Session daemon was killed by signal %d",
+                                               WTERMSIG(status));
+                               ret = -1;
+                               goto end;
+                       } else if (WIFEXITED(status)) {
+                               DBG("Session daemon terminated normally (exit status: %d)",
+                                               WEXITSTATUS(status));
+
+                               if (WEXITSTATUS(status) != 0) {
+                                       ERR("Session daemon terminated with an error (exit status: %d)",
+                                                       WEXITSTATUS(status));
+                                       ret = -1;
+                                       goto end;
+                               }
+                               break;
+                       }
+               }
+
+               goto end;
+       } else {
+               PERROR("fork");
+               ret = -1;
+               goto end;
+       }
+
+end:
+       return ret;
+}
+
+/*
+ *  launch_sessiond
+ *
+ *  Check if the session daemon is available using
+ *  the liblttngctl API for the check. If not, try to
+ *  spawn a daemon.
+ */
+static int launch_sessiond(void)
+{
+       int ret;
+       char *pathname = NULL;
+
+       ret = lttng_session_daemon_alive();
+       if (ret) {
+               /* Sessiond is alive, not an error */
+               ret = 0;
+               goto end;
+       }
+
+       /* Try command line option path */
+       pathname = opt_sessiond_path;
+
+       /* Try LTTNG_SESSIOND_PATH env variable */
+       if (pathname == NULL) {
+               pathname = getenv(DEFAULT_SESSIOND_PATH_ENV);
        }
 
-       if (traces_path) {
-               free(traces_path);
+       /* Try with configured path */
+       if (pathname == NULL) {
+               if (CONFIG_SESSIOND_BIN[0] != '\0') {
+                       pathname = CONFIG_SESSIOND_BIN;
+               }
+       }
+
+       /* Try the default path */
+       if (pathname == NULL) {
+               pathname = INSTALL_BIN_PATH "/lttng-sessiond";
+       }
+
+       DBG("Session daemon binary path: %s", pathname);
+
+       /* Check existence and permissions */
+       ret = access(pathname, F_OK | X_OK);
+       if (ret < 0) {
+               ERR("No such file or access denied: %s", pathname);
+               goto end;
+       }
+
+       ret = spawn_sessiond(pathname);
+end:
+       if (ret) {
+               ERR("Problem occurred while launching session daemon (%s)",
+                               pathname);
        }
        return ret;
 }
@@ -163,7 +1421,8 @@ error:
  */
 int cmd_create(int argc, const char **argv)
 {
-       int opt, ret = CMD_SUCCESS;
+       int opt, ret = CMD_SUCCESS, command_ret = CMD_SUCCESS, success = 1;
+       char *opt_arg = NULL;
        static poptContext pc;
 
        pc = poptGetContext(NULL, argc, argv, long_options, 0);
@@ -172,23 +1431,132 @@ int cmd_create(int argc, const char **argv)
        while ((opt = poptGetNextOpt(pc)) != -1) {
                switch (opt) {
                case OPT_HELP:
-                       usage(stdout);
+                       SHOW_HELP();
                        goto end;
                case OPT_LIST_OPTIONS:
                        list_cmd_options(stdout, long_options);
                        goto end;
+               case OPT_LIVE_TIMER:
+               {
+                       unsigned long v;
+
+                       errno = 0;
+                       opt_arg = poptGetOptArg(pc);
+                       if (!opt_arg) {
+                               /* Set up default values. */
+                               opt_live_timer = (uint32_t) DEFAULT_LTTNG_LIVE_TIMER;
+                               DBG("Session live timer interval set to default value %d",
+                                               opt_live_timer);
+                               break;
+                       }
+
+                       v = strtoul(opt_arg, NULL, 0);
+                       if (errno != 0 || !isdigit(opt_arg[0])) {
+                               ERR("Wrong value in --live parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       if (v != (uint32_t) v) {
+                               ERR("32-bit overflow in --live parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       if (v == 0) {
+                               ERR("Live timer interval must be greater than zero");
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       opt_live_timer = (uint32_t) v;
+                       DBG("Session live timer interval set to %d", opt_live_timer);
+                       break;
+               }
                default:
-                       usage(stderr);
                        ret = CMD_UNDEFINED;
                        goto end;
                }
        }
 
+       if (opt_no_consumer) {
+               MSG("The option --no-consumer is obsolete. Use --no-output now.");
+               ret = CMD_WARNING;
+               goto end;
+       }
+
+       /* Spawn a session daemon if needed */
+       if (!opt_no_sessiond) {
+               ret = launch_sessiond();
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end;
+               }
+       }
+
+       /* MI initialization */
+       if (lttng_opt_mi) {
+               writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
+               if (!writer) {
+                       ret = -LTTNG_ERR_NOMEM;
+                       goto end;
+               }
+
+               /* Open command element */
+               ret = mi_lttng_writer_command_open(writer,
+                               mi_lttng_element_command_create);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end;
+               }
+
+               /* Open output element */
+               ret = mi_lttng_writer_open_element(writer,
+                               mi_lttng_element_command_output);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end;
+               }
+       }
        opt_session_name = (char*) poptGetArg(pc);
 
-       ret = create_session();
+       command_ret = create_session();
+
+       if (command_ret) {
+               success = 0;
+       }
+
+       if (lttng_opt_mi) {
+               /* Close  output element */
+               ret = mi_lttng_writer_close_element(writer);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end;
+               }
+
+               /* Success ? */
+               ret = mi_lttng_writer_write_element_bool(writer,
+                               mi_lttng_element_command_success, success);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end;
+               }
+
+               /* Command element close */
+               ret = mi_lttng_writer_command_close(writer);
+               if (ret) {
+                       ret = CMD_ERROR;
+                       goto end;
+               }
+       }
 
 end:
+       /* Mi clean-up */
+       if (writer && mi_lttng_writer_destroy(writer)) {
+               /* Preserve original error code */
+               ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
+       }
+
+       /* Overwrite ret if an error occurred in create_session() */
+       ret = command_ret ? command_ret : ret;
+
        poptFreeContext(pc);
        return ret;
 }
This page took 0.041345 seconds and 5 git commands to generate.