* Copyright (C) 2004, 2005 by Dominic Rath *
* Dominic.Rath@gmx.de *
* *
- * Copyright (C) 2007,2008 Øyvind Harboe *
+ * Copyright (C) 2007-2010 Øyvind Harboe *
* oyvind.harboe@zylin.com *
* *
* This program is free software; you can redistribute it and/or modify *
* 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., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * along with this program. If not, see <http://www.gnu.org/licenses/>. *
***************************************************************************/
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
-#include "types.h"
-#include "command.h"
#include "configuration.h"
#include "log.h"
+#include "command.h"
-#include <stdio.h>
-#include <stdlib.h>
#include <getopt.h>
-#include <string.h>
+
+#include <limits.h>
+#include <stdlib.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 struct option long_options[] =
-{
- {"help", no_argument, &help_flag, 1},
- {"version", no_argument, &version_flag, 1},
- {"debug", optional_argument, 0, 'd'},
- {"file", required_argument, 0, 'f'},
- {"search", required_argument, 0, 's'},
- {"log_output", required_argument, 0, 'l'},
- {"command", required_argument, 0, 'c'},
+static const struct option long_options[] = {
+ {"help", no_argument, &help_flag, 1},
+ {"version", no_argument, &version_flag, 1},
+ {"debug", optional_argument, 0, 'd'},
+ {"file", required_argument, 0, 'f'},
+ {"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}
};
-int configuration_output_handler(struct command_context_s *context, const char* line)
+int configuration_output_handler(struct command_context *context, const char *line)
{
- LOG_USER_N(line);
+ LOG_USER_N("%s", line);
return ERROR_OK;
}
-int add_default_dirs(void)
+/* 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)
{
-#ifdef _WIN32
- /* Add the parent of the directory where openocd.exe resides to the
- * config script search path.
- * Directory layout:
- * bin\openocd.exe
- * lib\openocd
- * event\at91eb40a_reset.cfg
- * target\at91eb40a.cfg
+ char *exepath = NULL;
+
+ do {
+#if IS_WIN32 && !IS_CYGWIN
+ exepath = malloc(MAX_PATH);
+ if (exepath == NULL)
+ break;
+ GetModuleFileName(NULL, exepath, MAX_PATH);
+
+ /* Convert path separators to UNIX style, should work on Windows also. */
+ for (char *p = exepath; *p; p++) {
+ if (*p == '\\')
+ *p = '/';
+ }
+
+#elif IS_DARWIN
+ exepath = malloc(PROC_PIDPATHINFO_MAXSIZE);
+ if (exepath == NULL)
+ 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 == NULL)
+ break;
+ int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1 };
+ size_t size = PATH_MAX;
+
+ 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 == NULL)
+ exepath = realpath("/proc/self/path/a.out", NULL); /* Solaris */
+ if (exepath == NULL)
+ exepath = realpath("/proc/curproc/file", NULL); /* FreeBSD (Should be covered above) */
+#endif
+ } while (0);
+
+ if (exepath != NULL) {
+ /* 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
+ }
+
+ return exepath;
+}
+
+static char *find_relative_path(const char *from, const char *to)
+{
+ size_t i;
+
+ /* 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 == NULL)
+ break;
+ from = next + 1;
+ }
+
+ /* 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);
+
+ return relpath;
+}
+
+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.
*/
- {
- char strExePath [MAX_PATH];
- GetModuleFileName (NULL, strExePath, MAX_PATH);
- /* Either this code will *always* work or it will SEGFAULT giving
- * excellent information on the culprit.
- */
- *strrchr(strExePath, '\\')=0;
- strcat(strExePath, "\\..");
- add_script_search_dir(strExePath);
+ const char *home = getenv("HOME");
+
+ if (home) {
+ path = alloc_printf("%s/.openocd", home);
+ if (path) {
+ add_script_search_dir(path);
+ free(path);
+ }
+ }
+
+ path = getenv("OPENOCD_SCRIPTS");
+
+ if (path)
+ add_script_search_dir(path);
+
+#ifdef _WIN32
+ const char *appdata = getenv("APPDATA");
+
+ if (appdata) {
+ path = alloc_printf("%s/OpenOCD", appdata);
+ if (path) {
+ add_script_search_dir(path);
+ free(path);
+ }
}
-#else
- /* Add dir for openocd supplied scripts last so that user can over
- ride those scripts if desired. */
- add_script_search_dir(PKGDATADIR);
- add_script_search_dir(PKGLIBDIR);
#endif
- return ERROR_OK;
+
+ path = alloc_printf("%s/%s/%s", exepath, bin2data, "site");
+ if (path) {
+ add_script_search_dir(path);
+ free(path);
+ }
+
+ 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_s *cmd_ctx, int argc, char *argv[])
+int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
{
int c;
- char command_buffer[128];
- while (1)
- {
+ while (1) {
/* getopt_long stores the option index here. */
int option_index = 0;
-
- c = getopt_long(argc, argv, "hvd::l:f:s:c:", long_options, &option_index);
-
+
+ c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index);
+
/* Detect the end of the options. */
if (c == -1)
break;
-
- switch (c)
- {
+
+ switch (c) {
case 0:
break;
- case 'h': /* --help | -h */
+ case 'h': /* --help | -h */
help_flag = 1;
break;
- case 'v': /* --version | -v */
+ case 'v': /* --version | -v */
version_flag = 1;
break;
- case 'f': /* --file | -f */
+ case 'f': /* --file | -f */
{
- snprintf(command_buffer, 128, "script {%s}", optarg);
- add_config_command(command_buffer);
+ char *command = alloc_printf("script {%s}", optarg);
+ add_config_command(command);
+ free(command);
break;
}
- case 's': /* --search | -s */
+ case 's': /* --search | -s */
add_script_search_dir(optarg);
break;
- case 'd': /* --debug | -d */
- if (optarg)
- snprintf(command_buffer, 128, "debug_level %s", optarg);
- else
- snprintf(command_buffer, 128, "debug_level 3");
- command_run_line(cmd_ctx, command_buffer);
+ case 'd': /* --debug | -d */
+ {
+ 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 */
+ }
+ case 'l': /* --log_output | -l */
if (optarg)
- {
- snprintf(command_buffer, 128, "log_output %s", optarg);
- command_run_line(cmd_ctx, command_buffer);
- }
+ command_run_linef(cmd_ctx, "log_output %s", optarg);
break;
- case 'c': /* --command | -c */
+ case 'c': /* --command | -c */
if (optarg)
- {
- add_config_command(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 (help_flag)
- {
- LOG_OUTPUT("Open On-Chip Debugger\n(c) 2005-2008 by Dominic Rath\n\n");
+ 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);
- }
+ }
- if (version_flag)
- {
+ if (version_flag) {
/* Nothing to do, version gets printed automatically. */
- exit(-1);
- }
+ /* It is not an error to request the VERSION number. */
+ exit(0);
+ }
+
+ /* paths specified on the command line take precedence over these
+ * built-in paths
+ */
+ add_default_dirs();
return ERROR_OK;
}
Code Review / openocd.git / blobdiff