forked from git/git
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathapi-run-command.html
More file actions
727 lines (690 loc) · 17.1 KB
/
api-run-command.html
File metadata and controls
727 lines (690 loc) · 17.1 KB
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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.5" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
div.olist2 ol {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>run-command API</title>
</head>
<body>
<div id="header">
<h1>run-command API</h1>
</div>
<div id="preamble">
<div class="sectionbody">
<div class="para"><p>The run-command API offers a versatile tool to run sub-processes with
redirected input and output as well as with a modified environment
and an alternate current directory.</p></div>
<div class="para"><p>A similar API offers the capability to run a function asynchronously,
which is primarily used to capture the output that the function
produces in the caller in order to process it.</p></div>
</div>
</div>
<h2 id="_functions">Functions</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
<tt>start_command</tt>
</dt>
<dd>
<p>
Start a sub-process. Takes a pointer to a <tt>struct child_process</tt>
that specifies the details and returns pipe FDs (if requested).
See below for details.
</p>
</dd>
<dt>
<tt>finish_command</tt>
</dt>
<dd>
<p>
Wait for the completion of a sub-process that was started with
start_command().
</p>
</dd>
<dt>
<tt>run_command</tt>
</dt>
<dd>
<p>
A convenience function that encapsulates a sequence of
start_command() followed by finish_command(). Takes a pointer
to a <tt>struct child_process</tt> that specifies the details.
</p>
</dd>
<dt>
<tt>run_command_v_opt</tt>, <tt>run_command_v_opt_cd_env</tt>
</dt>
<dd>
<p>
Convenience functions that encapsulate a sequence of
start_command() followed by finish_command(). The argument argv
specifies the program and its arguments. The argument opt is zero
or more of the flags <tt>RUN_COMMAND_NO_STDIN</tt>, <tt>RUN_GIT_CMD</tt>,
<tt>RUN_COMMAND_STDOUT_TO_STDERR</tt>, or <tt>RUN_SILENT_EXEC_FAILURE</tt>
that correspond to the members .no_stdin, .git_cmd,
.stdout_to_stderr, .silent_exec_failure of <tt>struct child_process</tt>.
The argument dir corresponds the member .dir. The argument env
corresponds to the member .env.
</p>
</dd>
</dl></div>
<div class="para"><p>The functions above do the following:</p></div>
<div class="olist"><ol>
<li>
<p>
If a system call failed, errno is set and -1 is returned. A diagnostic
is printed.
</p>
</li>
<li>
<p>
If the program was not found, then -1 is returned and errno is set to
ENOENT; a diagnostic is printed only if .silent_exec_failure is 0.
</p>
</li>
<li>
<p>
Otherwise, the program is run. If it terminates regularly, its exit
code is returned. No diagnostic is printed, even if the exit code is
non-zero.
</p>
</li>
<li>
<p>
If the program terminated due to a signal, then the return value is the
signal number - 128, ie. it is negative and so indicates an unusual
condition; a diagnostic is printed. This return value can be passed to
exit(2), which will report the same code to the parent process that a
POSIX shell's $? would report for a program that died from the signal.
</p>
<div class="vlist"><dl>
<dt>
<tt>start_async</tt>
</dt>
<dd>
<p>
Run a function asynchronously. Takes a pointer to a <tt>struct
async</tt> that specifies the details and returns a set of pipe FDs
for communication with the function. See below for details.
</p>
</dd>
<dt>
<tt>finish_async</tt>
</dt>
<dd>
<p>
Wait for the completion of an asynchronous function that was
started with start_async().
</p>
</dd>
<dt>
<tt>run_hook</tt>
</dt>
<dd>
<p>
Run a hook.
The first argument is a pathname to an index file, or NULL
if the hook uses the default index file or no index is needed.
The second argument is the name of the hook.
The further arguments correspond to the hook arguments.
The last argument has to be NULL to terminate the arguments list.
If the hook does not exist or is not executable, the return
value will be zero.
If it is executable, the hook will be executed and the exit
status of the hook is returned.
On execution, .stdout_to_stderr and .no_stdin will be set.
(See below.)
</p>
</dd>
</dl></div>
</li>
</ol></div>
</div>
<h2 id="_data_structures">Data structures</h2>
<div class="sectionbody">
<div class="ilist"><ul>
<li>
<p>
<tt>struct child_process</tt>
</p>
</li>
</ul></div>
<div class="para"><p>This describes the arguments, redirections, and environment of a
command to run in a sub-process.</p></div>
<div class="para"><p>The caller:</p></div>
<div class="olist"><ol>
<li>
<p>
allocates and clears (memset(&chld, 0, sizeof(chld));) a
struct child_process variable;
</p>
</li>
<li>
<p>
initializes the members;
</p>
</li>
<li>
<p>
calls start_command();
</p>
</li>
<li>
<p>
processes the data;
</p>
</li>
<li>
<p>
closes file descriptors (if necessary; see below);
</p>
</li>
<li>
<p>
calls finish_command().
</p>
</li>
</ol></div>
<div class="para"><p>The .argv member is set up as an array of string pointers (NULL
terminated), of which .argv[0] is the program name to run (usually
without a path). If the command to run is a git command, set argv[0] to
the command name without the <em>git-</em> prefix and set .git_cmd = 1.</p></div>
<div class="para"><p>The members .in, .out, .err are used to redirect stdin, stdout,
stderr as follows:</p></div>
<div class="olist"><ol>
<li>
<p>
Specify 0 to request no special redirection. No new file descriptor
is allocated. The child process simply inherits the channel from the
parent.
</p>
</li>
<li>
<p>
Specify -1 to have a pipe allocated; start_command() replaces -1
by the pipe FD in the following way:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>.in: Returns the writable pipe end into which the caller writes;
the readable end of the pipe becomes the child's stdin.</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>.out, .err: Returns the readable pipe end from which the caller
reads; the writable end of the pipe end becomes child's
stdout/stderr.</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>The caller of start_command() must close the so returned FDs
after it has completed reading from/writing to it!</tt></pre>
</div></div>
</li>
<li>
<p>
Specify a file descriptor > 0 to be used by the child:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>.in: The FD must be readable; it becomes child's stdin.
.out: The FD must be writable; it becomes child's stdout.
.err: The FD must be writable; it becomes child's stderr.</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>The specified FD is closed by start_command(), even if it fails to
run the sub-process!</tt></pre>
</div></div>
</li>
<li>
<p>
Special forms of redirection are available by setting these members
to 1:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>.no_stdin, .no_stdout, .no_stderr: The respective channel is
redirected to /dev/null.</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>.stdout_to_stderr: stdout of the child is redirected to its
stderr. This happens after stderr is itself redirected.
So stdout will follow stderr to wherever it is
redirected.</tt></pre>
</div></div>
</li>
</ol></div>
<div class="para"><p>To modify the environment of the sub-process, specify an array of
string pointers (NULL terminated) in .env:</p></div>
<div class="olist"><ol>
<li>
<p>
If the string is of the form "VAR=value", i.e. it contains <em>=</em>
the variable is added to the child process's environment.
</p>
</li>
<li>
<p>
If the string does not contain <em>=</em>, it names an environment
variable that will be removed from the child process's environment.
</p>
</li>
</ol></div>
<div class="para"><p>To specify a new initial working directory for the sub-process,
specify it in the .dir member.</p></div>
<div class="para"><p>If the program cannot be found, the functions return -1 and set
errno to ENOENT. Normally, an error message is printed, but if
.silent_exec_failure is set to 1, no message is printed for this
special error condition.</p></div>
<div class="ilist"><ul>
<li>
<p>
<tt>struct async</tt>
</p>
</li>
</ul></div>
<div class="para"><p>This describes a function to run asynchronously, whose purpose is
to produce output that the caller reads.</p></div>
<div class="para"><p>The caller:</p></div>
<div class="olist"><ol>
<li>
<p>
allocates and clears (memset(&asy, 0, sizeof(asy));) a
struct async variable;
</p>
</li>
<li>
<p>
initializes .proc and .data;
</p>
</li>
<li>
<p>
calls start_async();
</p>
</li>
<li>
<p>
processes communicates with proc through .in and .out;
</p>
</li>
<li>
<p>
closes .in and .out;
</p>
</li>
<li>
<p>
calls finish_async().
</p>
</li>
</ol></div>
<div class="para"><p>The members .in, .out are used to provide a set of fd's for
communication between the caller and the callee as follows:</p></div>
<div class="olist"><ol>
<li>
<p>
Specify 0 to have no file descriptor passed. The callee will
receive -1 in the corresponding argument.
</p>
</li>
<li>
<p>
Specify < 0 to have a pipe allocated; start_async() replaces
with the pipe FD in the following way:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>.in: Returns the writable pipe end into which the caller
writes; the readable end of the pipe becomes the function's
in argument.</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>.out: Returns the readable pipe end from which the caller
reads; the writable end of the pipe becomes the function's
out argument.</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>The caller of start_async() must close the returned FDs after it
has completed reading from/writing from them.</tt></pre>
</div></div>
</li>
<li>
<p>
Specify a file descriptor > 0 to be used by the function:
</p>
<div class="literalblock">
<div class="content">
<pre><tt>.in: The FD must be readable; it becomes the function's in.
.out: The FD must be writable; it becomes the function's out.</tt></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><tt>The specified FD is closed by start_async(), even if it fails to
run the function.</tt></pre>
</div></div>
</li>
</ol></div>
<div class="para"><p>The function pointer in .proc has the following signature:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>int proc(int in, int out, void *data);</tt></pre>
</div></div>
<div class="olist"><ol>
<li>
<p>
in, out specifies a set of file descriptors to which the function
must read/write the data that it needs/produces. The function
<strong>must</strong> close these descriptors before it returns. A descriptor
may be -1 if the caller did not configure a descriptor for that
direction.
</p>
</li>
<li>
<p>
data is the value that the caller has specified in the .data member
of struct async.
</p>
</li>
<li>
<p>
The return value of the function is 0 on success and non-zero
on failure. If the function indicates failure, finish_async() will
report failure as well.
</p>
</li>
</ol></div>
<div class="para"><p>There are serious restrictions on what the asynchronous function can do
because this facility is implemented by a thread in the same address
space on most platforms (when pthreads is available), but by a pipe to
a forked process otherwise:</p></div>
<div class="olist"><ol>
<li>
<p>
It cannot change the program's state (global variables, environment,
etc.) in a way that the caller notices; in other words, .in and .out
are the only communication channels to the caller.
</p>
</li>
<li>
<p>
It must not change the program's state that the caller of the
facility also uses.
</p>
</li>
</ol></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2010-09-18 23:57:15 UTC
</div>
</div>
</body>
</html>