Fix: sessiond: assertion fails when getting name of trigger
[lttng-tools.git] / src / bin / lttng / conf.c
index 7439c1cdcf4d0fac711f7a5f4acfbd018a83a773..4079d6ed9421273680d102d4bc9cf9353534dfb6 100644 (file)
@@ -1,21 +1,11 @@
 /*
- * Copyright (c)  2011 David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
  *
- * 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.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * 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.
  */
 
-#define _GNU_SOURCE
+#define _LGPL_SOURCE
 #include <limits.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -24,7 +14,9 @@
 #include <sys/types.h>
 #include <unistd.h>
 
-#include <common/error.h>
+#include <common/compat/errno.h>
+#include <common/common.h>
+#include <common/utils.h>
 
 #include "conf.h"
 
@@ -32,7 +24,7 @@
  * Returns the path with '/CONFIG_FILENAME' added to it;
  * path will be NULL if an error occurs.
  */
-char *config_get_file_path(char *path)
+char *config_get_file_path(const char *path)
 {
        int ret;
        char *file_path;
@@ -40,6 +32,7 @@ char *config_get_file_path(char *path)
        ret = asprintf(&file_path, "%s/%s", path, CONFIG_FILENAME);
        if (ret < 0) {
                ERR("Fail allocating config file path");
+               file_path = NULL;
        }
 
        return file_path;
@@ -49,7 +42,7 @@ char *config_get_file_path(char *path)
  * Returns an open FILE pointer to the config file;
  * on error, NULL is returned.
  */
-static FILE *open_config(char *path, const char *mode)
+static FILE *open_config(const char *path, const char *mode)
 {
        FILE *fp = NULL;
        char *file_path;
@@ -74,7 +67,7 @@ error:
  * On success, returns 0;
  * on error, returns -1.
  */
-static int create_config_file(char *path)
+static int create_config_file(const char *path)
 {
        int ret;
        FILE *fp;
@@ -97,7 +90,7 @@ error:
  * On success, returns 0;
  * on error, returns -1.
  */
-static int write_config(char *file_path, size_t size, char *data)
+static int write_config(const char *file_path, size_t size, char *data)
 {
        FILE *fp;
        size_t len;
@@ -121,18 +114,10 @@ end:
        return ret;
 }
 
-/*
- * Returns the HOME directory path. Caller MUST NOT free(3) the return pointer.
- */
-char *config_get_default_path(void)
-{
-       return getenv("HOME");
-}
-
 /*
  * Destroys directory config and file config.
  */
-void config_destroy(char *path)
+void config_destroy(const char *path)
 {
        int ret;
        char *config_path;
@@ -149,7 +134,7 @@ void config_destroy(char *path)
        DBG("Removing %s\n", config_path);
        ret = remove(config_path);
        if (ret < 0) {
-               perror("remove config file");
+               PERROR("remove config file");
        }
 end:
        free(config_path);
@@ -160,7 +145,7 @@ end:
  */
 void config_destroy_default(void)
 {
-       char *path = config_get_default_path();
+       const char *path = utils_get_home_dir();
        if (path == NULL) {
                return;
        }
@@ -182,33 +167,34 @@ int config_exists(const char *path)
        return S_ISREG(info.st_mode) || S_ISDIR(info.st_mode);
 }
 
-/*
- * Returns the session name from the config file.
- * The caller is responsible for freeing the returned string.
- * On error, NULL is returned.
- */
-char *config_read_session_name(char *path)
+static
+int _config_read_session_name(const char *path, char **name)
 {
-       int ret;
+       int ret = 0;
        FILE *fp;
        char var[NAME_MAX], *session_name;
 
-       session_name = malloc(NAME_MAX);
+#if (NAME_MAX == 255)
+#define NAME_MAX_SCANF_IS_A_BROKEN_API "254"
+#endif
+
+       session_name = zmalloc(NAME_MAX);
        if (session_name == NULL) {
+               ret = -ENOMEM;
                ERR("Out of memory");
                goto error;
        }
 
        fp = open_config(path, "r");
        if (fp == NULL) {
-               ERR("Can't find valid lttng config %s/.lttngrc", path);
-               MSG("Did you create a session? (lttng create <my_session>)");
-               free(session_name);
+               ret = -ENOENT;
                goto error;
        }
 
        while (!feof(fp)) {
-               if ((ret = fscanf(fp, "%[^'=']=%s\n", var, session_name)) != 2) {
+               if ((ret = fscanf(fp, "%" NAME_MAX_SCANF_IS_A_BROKEN_API
+                               "[^'=']=%" NAME_MAX_SCANF_IS_A_BROKEN_API "s\n",
+                               var, session_name)) != 2) {
                        if (ret == -1) {
                                ERR("Missing session=NAME in config file.");
                                goto error_close;
@@ -222,22 +208,54 @@ char *config_read_session_name(char *path)
        }
 
 error_close:
-       free(session_name);
-       ret = fclose(fp);
-       if (ret < 0) {
+       if (fclose(fp) < 0) {
                PERROR("close config read session name");
        }
-
 error:
-       return NULL;
-
+       free(session_name);
+       return ret;
 found:
-       ret = fclose(fp);
-       if (ret < 0) {
+       *name = session_name;
+       if (fclose(fp) < 0) {
                PERROR("close config read session name found");
        }
-       return session_name;
+       return ret;
+}
+
+/*
+ * Returns the session name from the config file.
+ *
+ * The caller is responsible for freeing the returned string.
+ * On error, NULL is returned.
+ */
+char *config_read_session_name(const char *path)
+{
+       int ret;
+       char *name = NULL;
+
+       ret = _config_read_session_name(path, &name);
+       if (ret == -ENOENT) {
+               const char *home_dir = utils_get_home_dir();
+
+               ERR("Can't find valid lttng config %s/.lttngrc", home_dir);
+               MSG("Did you create a session? (lttng create <my_session>)");
+       }
+
+       return name;
+}
+
+/*
+ * Returns the session name from the config file. (no warnings/errors emitted)
+ *
+ * The caller is responsible for freeing the returned string.
+ * On error, NULL is returned.
+ */
+char *config_read_session_name_quiet(const char *path)
+{
+       char *name = NULL;
 
+       (void) _config_read_session_name(path, &name);
+       return name;
 }
 
 /*
@@ -245,17 +263,19 @@ found:
  * On success, returns 0;
  * on error, returns -1.
  */
-int config_add_session_name(char *path, char *name)
+int config_add_session_name(const char *path, const char *name)
 {
        int ret;
-       char session_name[NAME_MAX];
+       const char *attr = "session=";
+       /* Max name len accepted plus attribute's len and the NULL byte. */
+       char session_name[NAME_MAX + strlen(attr) + 1];
 
        /*
         * With GNU C <  2.1, snprintf returns -1 if the target buffer is too small;
         * With GNU C >= 2.1, snprintf returns the required size (excluding closing null)
         */
-       ret = snprintf(session_name, NAME_MAX, "session=%s\n", name);
-       if ((ret < 0) || (ret >= NAME_MAX)) {
+       ret = snprintf(session_name, sizeof(session_name), "%s%s\n", attr, name);
+       if (ret < 0) {
                ret = -1;
                goto error;
        }
@@ -269,12 +289,12 @@ error:
  * On success, returns 0;
  * on error, returns -1.
  */
-int config_init(char *session_name)
+int config_init(const char *session_name)
 {
        int ret;
-       char *path;
+       const char *path;
 
-       path = config_get_default_path();
+       path = utils_get_home_dir();
        if (path == NULL) {
                ret = -1;
                goto error;
This page took 0.030321 seconds and 4 git commands to generate.