X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Foptions.c;h=12755e010a86c915588a8a72aa692134916a2e34;hp=98cd634bc2cd3c4613c3dbfddcdede1b68451dc0;hb=1ab0303dbc6d00f8fd0036170dd7a10b32fc8713;hpb=ed12a6521f2ad26ab7140d346bc10250cbf869e1

diff --git a/src/helper/options.c b/src/helper/options.c
index 98cd634bc2..12755e010a 100644
--- a/src/helper/options.c
+++ b/src/helper/options.c
@@ -16,9 +16,7 @@
  *   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
@@ -26,11 +24,23 @@
 #endif
 
 #include "configuration.h"
-/* @todo the inclusion of server.h here is a layering violation */
-#include <server/server.h>
+#include "log.h"
+#include "command.h"
 
 #include <getopt.h>
 
+#include <limits.h>
+#include <stdlib.h>
+#if IS_DARWIN
+#include <libproc.h>
+#endif
+#ifdef HAVE_SYS_SYSCTL_H
+#include <sys/sysctl.h>
+#endif
+#if IS_WIN32 && !IS_CYGWIN
+#include <windows.h>
+#endif
+
 static int help_flag, version_flag;
 
 static const struct option long_options[] = {
@@ -52,76 +62,181 @@ int configuration_output_handler(struct command_context *context, const char *li
 	return ERROR_OK;
 }
 
-static void 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
-	 */
-	{
-		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);
-	}
-	/*
-	 * Add support for the default (as of 20091118) layout when
-	 * using autotools and cygwin/MinGW to build native binary.
-	 * Path separator is converted to UNIX style so that MinGW is
-	 * pleased.
-	 *
-	 * bin/openocd.exe
-	 * share/openocd/scripts/interface/dummy.cfg
-	 * share/openocd/scripts/target/at91eb40a.cfg
-	 */
-	{
-		char strExePath[MAX_PATH];
-		char *p;
-		GetModuleFileName(NULL, strExePath, MAX_PATH);
-		*strrchr(strExePath, '\\') = 0;
-		strcat(strExePath, "/../share/"PACKAGE "/scripts");
-		for (p = strExePath; *p; p++) {
+	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 = '/';
 		}
-		add_script_search_dir(strExePath);
-	}
+
+#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.
 	 */
-
 	const char *home = getenv("HOME");
 
 	if (home) {
-		char *path;
-
 		path = alloc_printf("%s/.openocd", home);
-
 		if (path) {
 			add_script_search_dir(path);
 			free(path);
 		}
 	}
 
-	add_script_search_dir(PKGDATADIR "/site");
-	add_script_search_dir(PKGDATADIR "/scripts");
+	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);
+		}
+	}
 #endif
+
+	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 *cmd_ctx, int argc, char *argv[])
 {
 	int c;
-	char command_buffer[128];
 
 	while (1) {
 		/* getopt_long stores the option index here. */
@@ -144,24 +259,28 @@ int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
 				break;
 			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 */
 				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);
+			{
+				char *command = alloc_printf("debug_level %s", optarg ? optarg : "3");
+				int retval = command_run_line(cmd_ctx, command);
+				free(command);
+				if (retval != ERROR_OK)
+					return retval;
 				break;
+			}
 			case 'l':		/* --log_output | -l */
 				if (optarg) {
-					snprintf(command_buffer, 128, "log_output %s", optarg);
-					command_run_line(cmd_ctx, command_buffer);
+					char *command = alloc_printf("log_output %s", optarg);
+					command_run_line(cmd_ctx, command);
+					free(command);
 				}
 				break;
 			case 'c':		/* --command | -c */
@@ -175,16 +294,26 @@ int parse_cmdline_args(struct command_context *cmd_ctx, int argc, char *argv[])
 				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);