src/bin/lttng/commands/version.c

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #define _LGPL_SOURCE
  19 #include <popt.h>
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25 #include <unistd.h>
  26
  27 #include <common/mi-lttng.h>
  28
  29 #include "../command.h"
  30
  31 #ifdef LTTNG_EMBED_HELP
  32 static const char help_msg[] =
  33 #include <lttng-version.1.h>
  34 ;
  35 #endif
  36
  37 enum {
  38         OPT_HELP = 1,
  39         OPT_LIST_OPTIONS,
  40 };
  41
  42 static const char *lttng_license = "lttng is free software and under the GPL license and part LGPL";
  43
  44 static struct poptOption long_options[] = {
  45         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  46         {"help",      'h', POPT_ARG_NONE, 0, OPT_HELP, 0, 0},
  47         {"list-options", 0, POPT_ARG_NONE, NULL, OPT_LIST_OPTIONS, NULL, NULL},
  48         {0, 0, 0, 0, 0, 0, 0}
  49 };
  50
  51 /*
  52  *  create_version
  53  */
  54 static void create_version(struct mi_lttng_version *version)
  55 {
  56         strncpy(version->version, VERSION, NAME_MAX);
  57         version->version_major = VERSION_MAJOR;
  58         version->version_minor = VERSION_MINOR;
  59         version->version_patchlevel = VERSION_PATCHLEVEL;
  60         strncpy(version->version_commit, GIT_VERSION, NAME_MAX);
  61         strncpy(version->version_name, VERSION_NAME, NAME_MAX);
  62         strncpy(version->package_url, PACKAGE_URL, NAME_MAX);
  63 }
  64
  65 /*
  66  * Print the machine interface output of this command.
  67  */
  68 static int print_mi()
  69 {
  70         int ret = CMD_SUCCESS;
  71         struct mi_writer *writer = NULL;
  72         struct mi_lttng_version version;
  73
  74         create_version(&version);
  75
  76         writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
  77         if (!writer) {
  78                 ret = -LTTNG_ERR_NOMEM;
  79                 goto end;
  80         }
  81
  82         /* Open the command element */
  83         ret = mi_lttng_writer_command_open(writer,
  84                         mi_lttng_element_command_version);
  85         if (ret) {
  86                 ret = CMD_ERROR;
  87                 goto error;
  88         }
  89
  90         /* Beginning of output */
  91         ret = mi_lttng_writer_open_element(writer,
  92                         mi_lttng_element_command_output);
  93         if (ret) {
  94                 ret = CMD_ERROR;
  95                 goto error;
  96         }
  97
  98         /* Print the machine interface of version */
  99         ret = mi_lttng_version(writer, &version,
 100                         VERSION_DESCRIPTION, lttng_license);
 101         if (ret) {
 102                 ret = CMD_ERROR;
 103                 goto error;
 104         }
 105
 106         /* Close the output element */
 107         ret = mi_lttng_writer_close_element(writer);
 108         if (ret) {
 109                 ret = CMD_ERROR;
 110                 goto error;
 111         }
 112
 113         /* Close the command  */
 114         ret = mi_lttng_writer_command_close(writer);
 115         if (ret) {
 116                 ret = CMD_ERROR;
 117         }
 118
 119 error:
 120         /* Cleanup */
 121         if (writer && mi_lttng_writer_destroy(writer)) {
 122                 /* Preserve original error code */
 123                 ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
 124         }
 125
 126 end:
 127         return ret;
 128 }
 129
 130 /*
 131  *  cmd_version
 132  */
 133 int cmd_version(int argc, const char **argv)
 134 {
 135         int opt, ret = CMD_SUCCESS;
 136         static poptContext pc;
 137
 138         pc = poptGetContext(NULL, argc, argv, long_options, 0);
 139         poptReadDefaultConfig(pc, 0);
 140
 141         while ((opt = poptGetNextOpt(pc)) != -1) {
 142                 switch (opt) {
 143                 case OPT_HELP:
 144                         SHOW_HELP();
 145                         goto end;
 146                 case OPT_LIST_OPTIONS:
 147                         list_cmd_options(stdout, long_options);
 148                         goto end;
 149                 default:
 150                         ret = CMD_UNDEFINED;
 151                         goto end;
 152                 }
 153         }
 154
 155         if (lttng_opt_mi) {
 156                 ret = print_mi();
 157         } else {
 158                 MSG("lttng version " VERSION " - " VERSION_NAME "%s",
 159                         GIT_VERSION[0] == '\0' ? "" : " - " GIT_VERSION);
 160                 MSG("\n" VERSION_DESCRIPTION "\n");
 161                 MSG("Web site: http://lttng.org");
 162                 MSG("\n%s", lttng_license);
 163         }
 164
 165 end:
 166         poptFreeContext(pc);
 167         return ret;
 168 }