Merge branch 'gh/gpg-doc-markup-fix'
[git/debian.git] / exec-cmd.c
blobeeb2ee52b83441fd51bd79cea8bf13682bcd522e
1 #include "cache.h"
2 #include "exec-cmd.h"
3 #include "quote.h"
4 #include "strvec.h"
6 #if defined(RUNTIME_PREFIX)
8 #if defined(HAVE_NS_GET_EXECUTABLE_PATH)
9 #include <mach-o/dyld.h>
10 #endif
12 #if defined(HAVE_BSD_KERN_PROC_SYSCTL)
13 #include <sys/param.h>
14 #include <sys/types.h>
15 #include <sys/sysctl.h>
16 #endif
18 #endif /* RUNTIME_PREFIX */
20 #define MAX_ARGS 32
22 static const char *system_prefix(void);
24 #ifdef RUNTIME_PREFIX
26 /**
27 * When using a runtime prefix, Git dynamically resolves paths relative to its
28 * executable.
30 * The method for determining the path of the executable is highly
31 * platform-specific.
34 /**
35 * Path to the current Git executable. Resolved on startup by
36 * 'git_resolve_executable_dir'.
38 static const char *executable_dirname;
40 static const char *system_prefix(void)
42 static const char *prefix;
44 assert(executable_dirname);
45 assert(is_absolute_path(executable_dirname));
47 if (!prefix &&
48 !(prefix = strip_path_suffix(executable_dirname, GIT_EXEC_PATH)) &&
49 !(prefix = strip_path_suffix(executable_dirname, BINDIR)) &&
50 !(prefix = strip_path_suffix(executable_dirname, "git"))) {
51 prefix = FALLBACK_RUNTIME_PREFIX;
52 trace_printf("RUNTIME_PREFIX requested, "
53 "but prefix computation failed. "
54 "Using static fallback '%s'.\n", prefix);
56 return prefix;
60 * Resolves the executable path from argv[0], only if it is absolute.
62 * Returns 0 on success, -1 on failure.
64 static int git_get_exec_path_from_argv0(struct strbuf *buf, const char *argv0)
66 const char *slash;
68 if (!argv0 || !*argv0)
69 return -1;
71 slash = find_last_dir_sep(argv0);
72 if (slash) {
73 trace_printf("trace: resolved executable path from argv0: %s\n",
74 argv0);
75 strbuf_add_absolute_path(buf, argv0);
76 return 0;
78 return -1;
81 #ifdef PROCFS_EXECUTABLE_PATH
83 * Resolves the executable path by examining a procfs symlink.
85 * Returns 0 on success, -1 on failure.
87 static int git_get_exec_path_procfs(struct strbuf *buf)
89 if (strbuf_realpath(buf, PROCFS_EXECUTABLE_PATH, 0)) {
90 trace_printf(
91 "trace: resolved executable path from procfs: %s\n",
92 buf->buf);
93 return 0;
95 return -1;
97 #endif /* PROCFS_EXECUTABLE_PATH */
99 #ifdef HAVE_BSD_KERN_PROC_SYSCTL
101 * Resolves the executable path using KERN_PROC_PATHNAME BSD sysctl.
103 * Returns 0 on success, -1 on failure.
105 static int git_get_exec_path_bsd_sysctl(struct strbuf *buf)
107 int mib[4];
108 char path[MAXPATHLEN];
109 size_t cb = sizeof(path);
111 mib[0] = CTL_KERN;
112 mib[1] = KERN_PROC;
113 mib[2] = KERN_PROC_PATHNAME;
114 mib[3] = -1;
115 if (!sysctl(mib, 4, path, &cb, NULL, 0)) {
116 trace_printf(
117 "trace: resolved executable path from sysctl: %s\n",
118 path);
119 strbuf_addstr(buf, path);
120 return 0;
122 return -1;
124 #endif /* HAVE_BSD_KERN_PROC_SYSCTL */
126 #ifdef HAVE_NS_GET_EXECUTABLE_PATH
128 * Resolves the executable path by querying Darwin application stack.
130 * Returns 0 on success, -1 on failure.
132 static int git_get_exec_path_darwin(struct strbuf *buf)
134 char path[PATH_MAX];
135 uint32_t size = sizeof(path);
136 if (!_NSGetExecutablePath(path, &size)) {
137 trace_printf(
138 "trace: resolved executable path from Darwin stack: %s\n",
139 path);
140 strbuf_addstr(buf, path);
141 return 0;
143 return -1;
145 #endif /* HAVE_NS_GET_EXECUTABLE_PATH */
147 #ifdef HAVE_WPGMPTR
149 * Resolves the executable path by using the global variable _wpgmptr.
151 * Returns 0 on success, -1 on failure.
153 static int git_get_exec_path_wpgmptr(struct strbuf *buf)
155 int len = wcslen(_wpgmptr) * 3 + 1;
156 strbuf_grow(buf, len);
157 len = xwcstoutf(buf->buf, _wpgmptr, len);
158 if (len < 0)
159 return -1;
160 buf->len += len;
161 return 0;
163 #endif /* HAVE_WPGMPTR */
166 * Resolves the absolute path of the current executable.
168 * Returns 0 on success, -1 on failure.
170 static int git_get_exec_path(struct strbuf *buf, const char *argv0)
173 * Identifying the executable path is operating system specific.
174 * Selectively employ all available methods in order of preference,
175 * preferring highly-available authoritative methods over
176 * selectively-available or non-authoritative methods.
178 * All cases fall back on resolving against argv[0] if there isn't a
179 * better functional method. However, note that argv[0] can be
180 * used-supplied on many operating systems, and is not authoritative
181 * in those cases.
183 * Each of these functions returns 0 on success, so evaluation will stop
184 * after the first successful method.
186 if (
187 #ifdef HAVE_BSD_KERN_PROC_SYSCTL
188 git_get_exec_path_bsd_sysctl(buf) &&
189 #endif /* HAVE_BSD_KERN_PROC_SYSCTL */
191 #ifdef HAVE_NS_GET_EXECUTABLE_PATH
192 git_get_exec_path_darwin(buf) &&
193 #endif /* HAVE_NS_GET_EXECUTABLE_PATH */
195 #ifdef PROCFS_EXECUTABLE_PATH
196 git_get_exec_path_procfs(buf) &&
197 #endif /* PROCFS_EXECUTABLE_PATH */
199 #ifdef HAVE_WPGMPTR
200 git_get_exec_path_wpgmptr(buf) &&
201 #endif /* HAVE_WPGMPTR */
203 git_get_exec_path_from_argv0(buf, argv0)) {
204 return -1;
207 if (strbuf_normalize_path(buf)) {
208 trace_printf("trace: could not normalize path: %s\n", buf->buf);
209 return -1;
212 trace2_cmd_path(buf->buf);
214 return 0;
217 void git_resolve_executable_dir(const char *argv0)
219 struct strbuf buf = STRBUF_INIT;
220 char *resolved;
221 const char *slash;
223 if (git_get_exec_path(&buf, argv0)) {
224 trace_printf(
225 "trace: could not determine executable path from: %s\n",
226 argv0);
227 strbuf_release(&buf);
228 return;
231 resolved = strbuf_detach(&buf, NULL);
232 slash = find_last_dir_sep(resolved);
233 if (slash)
234 resolved[slash - resolved] = '\0';
236 executable_dirname = resolved;
237 trace_printf("trace: resolved executable dir: %s\n",
238 executable_dirname);
241 #else
244 * When not using a runtime prefix, Git uses a hard-coded path.
246 static const char *system_prefix(void)
248 return FALLBACK_RUNTIME_PREFIX;
252 * This is called during initialization, but No work needs to be done here when
253 * runtime prefix is not being used.
255 void git_resolve_executable_dir(const char *argv0)
259 #endif /* RUNTIME_PREFIX */
261 char *system_path(const char *path)
263 struct strbuf d = STRBUF_INIT;
265 if (is_absolute_path(path))
266 return xstrdup(path);
268 strbuf_addf(&d, "%s/%s", system_prefix(), path);
269 return strbuf_detach(&d, NULL);
272 static const char *exec_path_value;
274 void git_set_exec_path(const char *exec_path)
276 exec_path_value = exec_path;
278 * Propagate this setting to external programs.
280 setenv(EXEC_PATH_ENVIRONMENT, exec_path, 1);
283 /* Returns the highest-priority location to look for git programs. */
284 const char *git_exec_path(void)
286 if (!exec_path_value) {
287 const char *env = getenv(EXEC_PATH_ENVIRONMENT);
288 if (env && *env)
289 exec_path_value = xstrdup(env);
290 else
291 exec_path_value = system_path(GIT_EXEC_PATH);
293 return exec_path_value;
296 static void add_path(struct strbuf *out, const char *path)
298 if (path && *path) {
299 strbuf_add_absolute_path(out, path);
300 strbuf_addch(out, PATH_SEP);
304 void setup_path(void)
306 const char *exec_path = git_exec_path();
307 const char *old_path = getenv("PATH");
308 struct strbuf new_path = STRBUF_INIT;
310 git_set_exec_path(exec_path);
311 add_path(&new_path, exec_path);
313 if (old_path)
314 strbuf_addstr(&new_path, old_path);
315 else
316 strbuf_addstr(&new_path, _PATH_DEFPATH);
318 setenv("PATH", new_path.buf, 1);
320 strbuf_release(&new_path);
323 const char **prepare_git_cmd(struct strvec *out, const char **argv)
325 strvec_push(out, "git");
326 strvec_pushv(out, argv);
327 return out->v;
330 int execv_git_cmd(const char **argv)
332 struct strvec nargv = STRVEC_INIT;
334 prepare_git_cmd(&nargv, argv);
335 trace_argv_printf(nargv.v, "trace: exec:");
337 /* execvp() can only ever return if it fails */
338 sane_execvp("git", (char **)nargv.v);
340 trace_printf("trace: exec failed: %s\n", strerror(errno));
342 strvec_clear(&nargv);
343 return -1;
346 int execl_git_cmd(const char *cmd, ...)
348 int argc;
349 const char *argv[MAX_ARGS + 1];
350 const char *arg;
351 va_list param;
353 va_start(param, cmd);
354 argv[0] = cmd;
355 argc = 1;
356 while (argc < MAX_ARGS) {
357 arg = argv[argc++] = va_arg(param, char *);
358 if (!arg)
359 break;
361 va_end(param);
362 if (MAX_ARGS <= argc)
363 return error(_("too many args to run %s"), cmd);
365 argv[argc] = NULL;
366 return execv_git_cmd(argv);