1 /***************************************************************************
2 * Copyright (C) 2004, 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
26 #include "configuration.h"
37 #ifdef HAVE_SYS_SYSCTL_H
38 #include <sys/sysctl.h>
40 #if IS_WIN32 && !IS_CYGWIN
44 static int help_flag, version_flag;
46 static const struct option long_options[] = {
47 {"help", no_argument, &help_flag, 1},
48 {"version", no_argument, &version_flag, 1},
49 {"debug", optional_argument, 0, 'd'},
50 {"file", required_argument, 0, 'f'},
51 {"search", required_argument, 0, 's'},
52 {"log_output", required_argument, 0, 'l'},
53 {"command", required_argument, 0, 'c'},
54 {"pipe", no_argument, 0, 'p'},
58 int configuration_output_handler(struct command_context *context, const char *line)
60 LOG_USER_N("%s", line);
65 /* Return the canonical path to the directory the openocd executable is in.
66 * The path should be absolute, use / as path separator and have all symlinks
67 * resolved. The returned string is malloc'd. */
68 static char *find_exe_path(void)
73 #if IS_WIN32 && !IS_CYGWIN
74 exepath = malloc(MAX_PATH);
77 GetModuleFileName(NULL, exepath, MAX_PATH);
79 /* Convert path separators to UNIX style, should work on Windows also. */
80 for (char *p = exepath; *p; p++) {
86 exepath = malloc(PROC_PIDPATHINFO_MAXSIZE);
89 if (proc_pidpath(getpid(), exepath, PROC_PIDPATHINFO_MAXSIZE) <= 0) {
94 #elif defined(CTL_KERN) && defined(KERN_PROC) && defined(KERN_PROC_PATHNAME) /* *BSD */
98 char *path = malloc(PATH_MAX);
101 int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1 };
102 size_t size = PATH_MAX;
104 if (sysctl(mib, (u_int)ARRAY_SIZE(mib), path, &size, NULL, 0) != 0)
108 exepath = realpath(path, NULL);
114 #elif defined(HAVE_REALPATH) /* Assume POSIX.1-2008 */
115 /* Try Unices in order of likelihood. */
116 exepath = realpath("/proc/self/exe", NULL); /* Linux/Cygwin */
118 exepath = realpath("/proc/self/path/a.out", NULL); /* Solaris */
120 exepath = realpath("/proc/curproc/file", NULL); /* FreeBSD (Should be covered above) */
124 if (exepath != NULL) {
125 /* Strip executable file name, leaving path */
126 *strrchr(exepath, '/') = '\0';
128 LOG_WARNING("Could not determine executable path, using configured BINDIR.");
129 LOG_DEBUG("BINDIR = %s", BINDIR);
131 exepath = realpath(BINDIR, NULL);
133 exepath = strdup(BINDIR);
140 static char *find_relative_path(const char *from, const char *to)
144 /* Skip common /-separated parts of from and to */
146 for (size_t n = 0; from[n] == to[n]; n++) {
147 if (from[n] == '\0') {
157 /* Count number of /-separated non-empty parts of from */
159 while (from[0] != '\0') {
162 char *next = strchr(from, '/');
168 /* Prepend that number of ../ in front of to */
169 char *relpath = malloc(i * 3 + strlen(to) + 1);
171 for (size_t n = 0; n < i; n++)
172 strcat(relpath, "../");
178 static void add_default_dirs(void)
181 char *exepath = find_exe_path();
182 char *bin2data = find_relative_path(BINDIR, PKGDATADIR);
184 LOG_DEBUG("bindir=%s", BINDIR);
185 LOG_DEBUG("pkgdatadir=%s", PKGDATADIR);
186 LOG_DEBUG("exepath=%s", exepath);
187 LOG_DEBUG("bin2data=%s", bin2data);
190 * The directory containing OpenOCD-supplied scripts should be
191 * listed last in the built-in search order, so the user can
192 * override these scripts with site-specific customizations.
194 const char *home = getenv("HOME");
197 path = alloc_printf("%s/.openocd", home);
199 add_script_search_dir(path);
204 path = getenv("OPENOCD_SCRIPTS");
207 add_script_search_dir(path);
210 const char *appdata = getenv("APPDATA");
213 path = alloc_printf("%s/OpenOCD", appdata);
215 add_script_search_dir(path);
221 path = alloc_printf("%s/%s/%s", exepath, bin2data, "site");
223 add_script_search_dir(path);
227 path = alloc_printf("%s/%s/%s", exepath, bin2data, "scripts");
229 add_script_search_dir(path);
237 int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
242 /* getopt_long stores the option index here. */
243 int option_index = 0;
245 c = getopt_long(argc, argv, "hvd::l:f:s:c:p", long_options, &option_index);
247 /* Detect the end of the options. */
254 case 'h': /* --help | -h */
257 case 'v': /* --version | -v */
260 case 'f': /* --file | -f */
262 char *command = alloc_printf("script {%s}", optarg);
263 add_config_command(command);
267 case 's': /* --search | -s */
268 add_script_search_dir(optarg);
270 case 'd': /* --debug | -d */
272 char *command = alloc_printf("debug_level %s", optarg ? optarg : "3");
273 int retval = command_run_line(cmd_ctx, command);
275 if (retval != ERROR_OK)
279 case 'l': /* --log_output | -l */
281 char *command = alloc_printf("log_output %s", optarg);
282 command_run_line(cmd_ctx, command);
286 case 'c': /* --command | -c */
288 add_config_command(optarg);
291 /* to replicate the old syntax this needs to be synchronous
292 * otherwise the gdb stdin will overflow with the warning message */
293 command_run_line(cmd_ctx, "gdb_port pipe; log_output openocd.log");
294 LOG_WARNING("deprecated option: -p/--pipe. Use '-c \"gdb_port pipe; "
295 "log_output openocd.log\"' instead.");
298 /* getopt will emit an error message, all we have to do is bail. */
304 /* Catch extra arguments on the command line. */
305 LOG_OUTPUT("Unexpected command line argument: %s\n", argv[optind]);
310 LOG_OUTPUT("Open On-Chip Debugger\nLicensed under GNU GPL v2\n");
311 LOG_OUTPUT("--help | -h\tdisplay this help\n");
312 LOG_OUTPUT("--version | -v\tdisplay OpenOCD version\n");
313 LOG_OUTPUT("--file | -f\tuse configuration file <name>\n");
314 LOG_OUTPUT("--search | -s\tdir to search for config files and scripts\n");
315 LOG_OUTPUT("--debug | -d\tset debug level to 3\n");
316 LOG_OUTPUT(" | -d<n>\tset debug level to <level>\n");
317 LOG_OUTPUT("--log_output | -l\tredirect log output to file <name>\n");
318 LOG_OUTPUT("--command | -c\trun <command>\n");
323 /* Nothing to do, version gets printed automatically. */
324 /* It is not an error to request the VERSION number. */
328 /* paths specified on the command line take precedence over these