builtin/submodule--helper: remove stray new line
[git.git] / exec-cmd.c
blob4f81f443105f071e488a0436b7fe0579e22bc816
1 #include "cache.h"
2 #include "exec-cmd.h"
3 #include "quote.h"
4 #include "argv-array.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 return 0;
215 void git_resolve_executable_dir(const char *argv0)
217 struct strbuf buf = STRBUF_INIT;
218 char *resolved;
219 const char *slash;
221 if (git_get_exec_path(&buf, argv0)) {
222 trace_printf(
223 "trace: could not determine executable path from: %s\n",
224 argv0);
225 strbuf_release(&buf);
226 return;
229 resolved = strbuf_detach(&buf, NULL);
230 slash = find_last_dir_sep(resolved);
231 if (slash)
232 resolved[slash - resolved] = '\0';
234 executable_dirname = resolved;
235 trace_printf("trace: resolved executable dir: %s\n",
236 executable_dirname);
239 #else
242 * When not using a runtime prefix, Git uses a hard-coded path.
244 static const char *system_prefix(void)
246 return FALLBACK_RUNTIME_PREFIX;
250 * This is called during initialization, but No work needs to be done here when
251 * runtime prefix is not being used.
253 void git_resolve_executable_dir(const char *argv0)
257 #endif /* RUNTIME_PREFIX */
259 char *system_path(const char *path)
261 struct strbuf d = STRBUF_INIT;
263 if (is_absolute_path(path))
264 return xstrdup(path);
266 strbuf_addf(&d, "%s/%s", system_prefix(), path);
267 return strbuf_detach(&d, NULL);
270 static const char *exec_path_value;
272 void git_set_exec_path(const char *exec_path)
274 exec_path_value = exec_path;
276 * Propagate this setting to external programs.
278 setenv(EXEC_PATH_ENVIRONMENT, exec_path, 1);
281 /* Returns the highest-priority location to look for git programs. */
282 const char *git_exec_path(void)
284 if (!exec_path_value) {
285 const char *env = getenv(EXEC_PATH_ENVIRONMENT);
286 if (env && *env)
287 exec_path_value = xstrdup(env);
288 else
289 exec_path_value = system_path(GIT_EXEC_PATH);
291 return exec_path_value;
294 static void add_path(struct strbuf *out, const char *path)
296 if (path && *path) {
297 strbuf_add_absolute_path(out, path);
298 strbuf_addch(out, PATH_SEP);
302 void setup_path(void)
304 const char *exec_path = git_exec_path();
305 const char *old_path = getenv("PATH");
306 struct strbuf new_path = STRBUF_INIT;
308 git_set_exec_path(exec_path);
309 add_path(&new_path, exec_path);
311 if (old_path)
312 strbuf_addstr(&new_path, old_path);
313 else
314 strbuf_addstr(&new_path, _PATH_DEFPATH);
316 setenv("PATH", new_path.buf, 1);
318 strbuf_release(&new_path);
321 const char **prepare_git_cmd(struct argv_array *out, const char **argv)
323 argv_array_push(out, "git");
324 argv_array_pushv(out, argv);
325 return out->argv;
328 int execv_git_cmd(const char **argv)
330 struct argv_array nargv = ARGV_ARRAY_INIT;
332 prepare_git_cmd(&nargv, argv);
333 trace_argv_printf(nargv.argv, "trace: exec:");
335 /* execvp() can only ever return if it fails */
336 sane_execvp("git", (char **)nargv.argv);
338 trace_printf("trace: exec failed: %s\n", strerror(errno));
340 argv_array_clear(&nargv);
341 return -1;
344 int execl_git_cmd(const char *cmd, ...)
346 int argc;
347 const char *argv[MAX_ARGS + 1];
348 const char *arg;
349 va_list param;
351 va_start(param, cmd);
352 argv[0] = cmd;
353 argc = 1;
354 while (argc < MAX_ARGS) {
355 arg = argv[argc++] = va_arg(param, char *);
356 if (!arg)
357 break;
359 va_end(param);
360 if (MAX_ARGS <= argc)
361 return error(_("too many args to run %s"), cmd);
363 argv[argc] = NULL;
364 return execv_git_cmd(argv);