+// SPDX-License-Identifier: GPL-2.0-or-later
+
/***************************************************************************
* Copyright (C) 2004, 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
* Copyright (C) 2007-2010 Øyvind Harboe *
* oyvind.harboe@zylin.com *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * 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. *
***************************************************************************/
#ifdef HAVE_CONFIG_H
#include <getopt.h>
+#include <limits.h>
+#include <stdlib.h>
+#include <string.h>
+#if IS_DARWIN
+#include <libproc.h>
+#endif
+/* sys/sysctl.h is deprecated on Linux from glibc 2.30 */
+#ifndef __linux__
+#ifdef HAVE_SYS_SYSCTL_H
+#include <sys/sysctl.h>
+#endif
+#endif
+#if IS_WIN32 && !IS_CYGWIN
+#include <windows.h>
+#endif
+
static int help_flag, version_flag;
static const struct option long_options[] = {
{"search", required_argument, 0, 's'},
{"log_output", required_argument, 0, 'l'},
{"command", required_argument, 0, 'c'},
- {"pipe", no_argument, 0, 'p'},
{0, 0, 0, 0}
};
return ERROR_OK;
}
-#ifdef _WIN32
-static char *find_suffix(const char *text, const char *suffix)
+/* Return the canonical path to the directory the openocd executable is in.
+ * The path should be absolute, use / as path separator and have all symlinks
+ * resolved. The returned string is malloc'd. */
+static char *find_exe_path(void)
{
- size_t text_len = strlen(text);
- size_t suffix_len = strlen(suffix);
+ char *exepath = NULL;
- if (suffix_len == 0)
- return (char *)text + text_len;
+ do {
+#if IS_WIN32 && !IS_CYGWIN
+ exepath = malloc(MAX_PATH);
+ if (!exepath)
+ break;
+ GetModuleFileName(NULL, exepath, MAX_PATH);
- if (suffix_len > text_len || strncmp(text + text_len - suffix_len, suffix, suffix_len) != 0)
- return NULL; /* Not a suffix of text */
+ /* Convert path separators to UNIX style, should work on Windows also. */
+ for (char *p = exepath; *p; p++) {
+ if (*p == '\\')
+ *p = '/';
+ }
- return (char *)text + text_len - suffix_len;
-}
+#elif IS_DARWIN
+ exepath = malloc(PROC_PIDPATHINFO_MAXSIZE);
+ if (!exepath)
+ break;
+ if (proc_pidpath(getpid(), exepath, PROC_PIDPATHINFO_MAXSIZE) <= 0) {
+ free(exepath);
+ exepath = NULL;
+ }
+
+#elif defined(CTL_KERN) && defined(KERN_PROC) && defined(KERN_PROC_PATHNAME) /* *BSD */
+#ifndef PATH_MAX
+#define PATH_MAX 1024
#endif
+ char *path = malloc(PATH_MAX);
+ if (!path)
+ break;
+ int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1 };
+ size_t size = PATH_MAX;
-static void add_default_dirs(void)
-{
- const char *run_prefix;
- char *path;
+ if (sysctl(mib, (u_int)ARRAY_SIZE(mib), path, &size, NULL, 0) != 0)
+ break;
+
+#ifdef HAVE_REALPATH
+ exepath = realpath(path, NULL);
+ free(path);
+#else
+ exepath = path;
+#endif
+
+#elif defined(HAVE_REALPATH) /* Assume POSIX.1-2008 */
+ /* Try Unices in order of likelihood. */
+ exepath = realpath("/proc/self/exe", NULL); /* Linux/Cygwin */
+ if (!exepath)
+ exepath = realpath("/proc/self/path/a.out", NULL); /* Solaris */
+ if (!exepath)
+ exepath = realpath("/proc/curproc/file", NULL); /* FreeBSD (Should be covered above) */
+#endif
+ } while (0);
+
+ if (exepath) {
+ /* Strip executable file name, leaving path */
+ *strrchr(exepath, '/') = '\0';
+ } else {
+ LOG_WARNING("Could not determine executable path, using configured BINDIR.");
+ LOG_DEBUG("BINDIR = %s", BINDIR);
+#ifdef HAVE_REALPATH
+ exepath = realpath(BINDIR, NULL);
+#else
+ exepath = strdup(BINDIR);
+#endif
+ }
-#ifdef _WIN32
- char strExePath[MAX_PATH];
- GetModuleFileName(NULL, strExePath, MAX_PATH);
+ return exepath;
+}
- /* Strip executable file name, leaving path */
- *strrchr(strExePath, '\\') = '\0';
+static char *find_relative_path(const char *from, const char *to)
+{
+ size_t i;
- /* Convert path separators to UNIX style, should work on Windows also. */
- for (char *p = strExePath; *p; p++) {
- if (*p == '\\')
- *p = '/';
+ /* Skip common /-separated parts of from and to */
+ i = 0;
+ for (size_t n = 0; from[n] == to[n]; n++) {
+ if (from[n] == '\0') {
+ i = n;
+ break;
+ }
+ if (from[n] == '/')
+ i = n + 1;
+ }
+ from += i;
+ to += i;
+
+ /* Count number of /-separated non-empty parts of from */
+ i = 0;
+ while (from[0] != '\0') {
+ if (from[0] != '/')
+ i++;
+ char *next = strchr(from, '/');
+ if (!next)
+ break;
+ from = next + 1;
}
- char *end_of_prefix = find_suffix(strExePath, BINDIR);
- if (end_of_prefix != NULL)
- *end_of_prefix = '\0';
+ /* Prepend that number of ../ in front of to */
+ char *relpath = malloc(i * 3 + strlen(to) + 1);
+ relpath[0] = '\0';
+ for (size_t n = 0; n < i; n++)
+ strcat(relpath, "../");
+ strcat(relpath, to);
- run_prefix = strExePath;
-#else
- run_prefix = "";
-#endif
+ return relpath;
+}
- LOG_DEBUG("bindir=%s", BINDIR);
- LOG_DEBUG("pkgdatadir=%s", PKGDATADIR);
- LOG_DEBUG("run_prefix=%s", run_prefix);
+static void add_user_dirs(void)
+{
+ char *path;
- /*
- * The directory containing OpenOCD-supplied scripts should be
- * listed last in the built-in search order, so the user can
- * override these scripts with site-specific customizations.
- */
- const char *home = getenv("HOME");
+#if IS_WIN32
+ const char *appdata = getenv("APPDATA");
- if (home) {
- path = alloc_printf("%s/.openocd", home);
+ if (appdata) {
+ path = alloc_printf("%s/OpenOCD", appdata);
if (path) {
+ /* Convert path separators to UNIX style, should work on Windows also. */
+ for (char *p = path; *p; p++) {
+ if (*p == '\\')
+ *p = '/';
+ }
add_script_search_dir(path);
free(path);
}
}
-#ifdef _WIN32
- const char *appdata = getenv("APPDATA");
+ /* WIN32 may also have HOME defined, particularly under Cygwin, so add those paths below too */
+#endif
- if (appdata) {
- path = alloc_printf("%s/OpenOCD", appdata);
+ const char *home = getenv("HOME");
+#if IS_DARWIN
+ if (home) {
+ path = alloc_printf("%s/Library/Preferences/org.openocd", home);
if (path) {
add_script_search_dir(path);
free(path);
}
}
#endif
+ const char *xdg_config = getenv("XDG_CONFIG_HOME");
+
+ if (xdg_config) {
+ path = alloc_printf("%s/openocd", xdg_config);
+ if (path) {
+ add_script_search_dir(path);
+ free(path);
+ }
+ } else if (home) {
+ path = alloc_printf("%s/.config/openocd", home);
+ if (path) {
+ add_script_search_dir(path);
+ free(path);
+ }
+ }
+
+ if (home) {
+ path = alloc_printf("%s/.openocd", home);
+ if (path) {
+ add_script_search_dir(path);
+ free(path);
+ }
+ }
+}
- path = alloc_printf("%s%s%s", run_prefix, PKGDATADIR, "/site");
+static void add_default_dirs(void)
+{
+ char *path;
+ char *exepath = find_exe_path();
+ char *bin2data = find_relative_path(BINDIR, PKGDATADIR);
+
+ LOG_DEBUG("bindir=%s", BINDIR);
+ LOG_DEBUG("pkgdatadir=%s", PKGDATADIR);
+ LOG_DEBUG("exepath=%s", exepath);
+ LOG_DEBUG("bin2data=%s", bin2data);
+
+ /*
+ * The directory containing OpenOCD-supplied scripts should be
+ * listed last in the built-in search order, so the user can
+ * override these scripts with site-specific customizations.
+ */
+ path = getenv("OPENOCD_SCRIPTS");
+ if (path)
+ add_script_search_dir(path);
+
+ add_user_dirs();
+
+ path = alloc_printf("%s/%s/%s", exepath, bin2data, "site");
if (path) {
add_script_search_dir(path);
free(path);
}
- path = alloc_printf("%s%s%s", run_prefix, PKGDATADIR, "/scripts");
+ path = alloc_printf("%s/%s/%s", exepath, bin2data, "scripts");
if (path) {
add_script_search_dir(path);
free(path);
}
+
+ free(exepath);
+ free(bin2data);
}
int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
/* getopt_long stores the option index here. */
int option_index = 0;
- c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index);
+ c = getopt_long(argc, argv, "hvd::l:f:s:c:", long_options, &option_index);
/* Detect the end of the options. */
if (c == -1)
break;
case 'd': /* --debug | -d */
{
- char *command = alloc_printf("debug_level %s", optarg ? optarg : "3");
- command_run_line(cmd_ctx, command);
- free(command);
+ int retval = command_run_linef(cmd_ctx, "debug_level %s", optarg ? optarg : "3");
+ if (retval != ERROR_OK)
+ return retval;
break;
}
case 'l': /* --log_output | -l */
- if (optarg) {
- char *command = alloc_printf("log_output %s", optarg);
- command_run_line(cmd_ctx, command);
- free(command);
- }
+ if (optarg)
+ command_run_linef(cmd_ctx, "log_output %s", optarg);
break;
case 'c': /* --command | -c */
if (optarg)
add_config_command(optarg);
break;
- case 'p':
- /* to replicate the old syntax this needs to be synchronous
- * otherwise the gdb stdin will overflow with the warning message */
- command_run_line(cmd_ctx, "gdb_port pipe; log_output openocd.log");
- LOG_WARNING("deprecated option: -p/--pipe. Use '-c \"gdb_port pipe; "
- "log_output openocd.log\"' instead.");
- break;
+ default: /* '?' */
+ /* getopt will emit an error message, all we have to do is bail. */
+ return ERROR_FAIL;
}
}
+ if (optind < argc) {
+ /* Catch extra arguments on the command line. */
+ LOG_OUTPUT("Unexpected command line argument: %s\n", argv[optind]);
+ return ERROR_FAIL;
+ }
+
if (help_flag) {
LOG_OUTPUT("Open On-Chip Debugger\nLicensed under GNU GPL v2\n");
LOG_OUTPUT("--help | -h\tdisplay this help\n");
LOG_OUTPUT("--version | -v\tdisplay OpenOCD version\n");
LOG_OUTPUT("--file | -f\tuse configuration file <name>\n");
LOG_OUTPUT("--search | -s\tdir to search for config files and scripts\n");
- LOG_OUTPUT("--debug | -d\tset debug level <0-3>\n");
+ LOG_OUTPUT("--debug | -d\tset debug level to 3\n");
+ LOG_OUTPUT(" | -d<n>\tset debug level to <level>\n");
LOG_OUTPUT("--log_output | -l\tredirect log output to file <name>\n");
LOG_OUTPUT("--command | -c\trun <command>\n");
exit(-1);
Code Review / openocd.git / blobdiff