src/bin/lttng/commands/version.cpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #define _LGPL_SOURCE
   9 #include "../command.hpp"
  10 #include "version.hpp"
  11
  12 #include <common/mi-lttng.hpp>
  13
  14 #include <popt.h>
  15 #include <stdio.h>
  16 #include <stdlib.h>
  17 #include <string.h>
  18 #include <sys/stat.h>
  19 #include <sys/types.h>
  20 #include <unistd.h>
  21
  22 #ifdef LTTNG_EMBED_HELP
  23 static const char help_msg[] =
  24 #include <lttng-version.1.h>
  25         ;
  26 #endif
  27
  28 enum {
  29         OPT_HELP = 1,
  30         OPT_LIST_OPTIONS,
  31 };
  32
  33 static const char *lttng_license = "lttng is free software and under the GPL license and part LGPL";
  34
  35 static struct poptOption long_options[] = {
  36         /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
  37         { "help", 'h', POPT_ARG_NONE, nullptr, OPT_HELP, nullptr, nullptr },
  38         { "list-options", 0, POPT_ARG_NONE, nullptr, OPT_LIST_OPTIONS, nullptr, nullptr },
  39         { nullptr, 0, 0, nullptr, 0, nullptr, nullptr }
  40 };
  41
  42 /*
  43  *  create_version
  44  */
  45 static void create_version(struct mi_lttng_version_data *version)
  46 {
  47         strncpy(version->version, VERSION, NAME_MAX);
  48         version->version_major = VERSION_MAJOR;
  49         version->version_minor = VERSION_MINOR;
  50         version->version_patchlevel = VERSION_PATCHLEVEL;
  51         strncpy(version->version_commit, GIT_VERSION, NAME_MAX);
  52         strncpy(version->version_name, VERSION_NAME, NAME_MAX);
  53         strncpy(version->package_url, PACKAGE_URL, NAME_MAX);
  54 }
  55
  56 /*
  57  * Print the machine interface output of this command.
  58  */
  59 static int print_mi()
  60 {
  61         int ret = CMD_SUCCESS;
  62         struct mi_writer *writer = nullptr;
  63         struct mi_lttng_version_data version;
  64
  65         create_version(&version);
  66
  67         writer = mi_lttng_writer_create(fileno(stdout), lttng_opt_mi);
  68         if (!writer) {
  69                 ret = -LTTNG_ERR_NOMEM;
  70                 goto end;
  71         }
  72
  73         /* Open the command element */
  74         ret = mi_lttng_writer_command_open(writer, mi_lttng_element_command_version);
  75         if (ret) {
  76                 ret = CMD_ERROR;
  77                 goto error;
  78         }
  79
  80         /* Beginning of output */
  81         ret = mi_lttng_writer_open_element(writer, mi_lttng_element_command_output);
  82         if (ret) {
  83                 ret = CMD_ERROR;
  84                 goto error;
  85         }
  86
  87         /* Print the machine interface of version */
  88         ret = mi_lttng_version(writer, &version, VERSION_DESCRIPTION, lttng_license);
  89         if (ret) {
  90                 ret = CMD_ERROR;
  91                 goto error;
  92         }
  93
  94         /* Close the output element */
  95         ret = mi_lttng_writer_close_element(writer);
  96         if (ret) {
  97                 ret = CMD_ERROR;
  98                 goto error;
  99         }
 100
 101         /* Close the command  */
 102         ret = mi_lttng_writer_command_close(writer);
 103         if (ret) {
 104                 ret = CMD_ERROR;
 105         }
 106
 107 error:
 108         /* Cleanup */
 109         if (writer && mi_lttng_writer_destroy(writer)) {
 110                 /* Preserve original error code */
 111                 ret = ret ? ret : -LTTNG_ERR_MI_IO_FAIL;
 112         }
 113
 114 end:
 115         return ret;
 116 }
 117
 118 /*
 119  *  cmd_version
 120  */
 121 int cmd_version(int argc, const char **argv)
 122 {
 123         int opt, ret = CMD_SUCCESS;
 124         static poptContext pc;
 125
 126         pc = poptGetContext(nullptr, argc, argv, long_options, 0);
 127         poptReadDefaultConfig(pc, 0);
 128
 129         while ((opt = poptGetNextOpt(pc)) != -1) {
 130                 switch (opt) {
 131                 case OPT_HELP:
 132                         SHOW_HELP();
 133                         goto end;
 134                 case OPT_LIST_OPTIONS:
 135                         list_cmd_options(stdout, long_options);
 136                         goto end;
 137                 default:
 138                         ret = CMD_UNDEFINED;
 139                         goto end;
 140                 }
 141         }
 142
 143         if (lttng_opt_mi) {
 144                 ret = print_mi();
 145         } else {
 146                 MSG("lttng version " VERSION " - " VERSION_NAME "%s",
 147                     GIT_VERSION[0] == '\0' ? "" : " - " GIT_VERSION);
 148                 MSG("\n" VERSION_DESCRIPTION "\n");
 149                 MSG("Web site: https://lttng.org");
 150                 MSG("\n%s", lttng_license);
 151                 if (EXTRA_VERSION_NAME[0] != '\0') {
 152                         MSG("\nExtra version name: " EXTRA_VERSION_NAME);
 153                 }
 154                 if (EXTRA_VERSION_DESCRIPTION[0] != '\0') {
 155                         MSG("\nExtra version description:\n\t" EXTRA_VERSION_DESCRIPTION);
 156                 }
 157                 if (EXTRA_VERSION_PATCHES[0] != '\0') {
 158                         MSG("\nExtra version patches:\n\t" EXTRA_VERSION_PATCHES);
 159                 }
 160         }
 161
 162 end:
 163         poptFreeContext(pc);
 164         return ret;
 165 }