Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
// 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 *
***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "configuration.h"
#include "log.h"
#include "command.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[] = {
{"help", no_argument, &help_flag, 1},
{"version", no_argument, &version_flag, 1},
{"debug", optional_argument, NULL, 'd'},
{"file", required_argument, NULL, 'f'},
{"search", required_argument, NULL, 's'},
{"log_output", required_argument, NULL, 'l'},
{"command", required_argument, NULL, 'c'},
{"set", required_argument, NULL, 'e'},
{NULL, 0, NULL, 0}
};
int configuration_output_handler(struct command_context *context, const char *line)
{
LOG_USER_N("%s", line);
return ERROR_OK;
}
/* 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)
{
char *exepath = NULL;
do {
#if IS_WIN32 && !IS_CYGWIN
exepath = malloc(MAX_PATH);
if (!exepath)
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)
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;
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
}
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)
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_user_dirs(void)
{
char *path;
#if IS_WIN32
const char *appdata = getenv("APPDATA");
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);
}
}
/* WIN32 may also have HOME defined, particularly under Cygwin, so add those paths below too */
#endif
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);
}
}
}
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", 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;
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);
/* Detect the end of the options. */
if (c == -1)
break;
switch (c) {
case 0:
break;
case 'h': /* --help | -h */
help_flag = 1;
break;
case 'v': /* --version | -v */
version_flag = 1;
break;
case 'f': /* --file | -f */
{
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 */
{
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)
command_run_linef(cmd_ctx, "log_output %s", optarg);
break;
case 'c': /* --command | -c */
if (optarg)
add_config_command(optarg);
break;
case 'e':
if (optarg)
{
char *command = alloc_printf("set %s", optarg);
add_config_command(command);
free(command);
}
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 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) {
/* Nothing to do, version gets printed automatically. */
/* It is not an error to request the VERSION number. */
exit(0);
}
/* dump full command line */
for (int i = 0; i < argc; i++)
LOG_DEBUG("ARGV[%d] = \"%s\"", i, argv[i]);
/* paths specified on the command line take precedence over these
* built-in paths
*/
add_default_dirs();
return ERROR_OK;
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
Click anywhere in the source to view detailed information here...