Autogenerated HTML docs for v1.7.6-472-g4bfe7
[git/jnareb-git.git] / technical / api-lockfile.html
blob62b798114167da9f1800e758d6e50edd76ef0fd3
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>lockfile API</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Workarounds for IE6's broken and incomplete CSS2. */
344 div.sidebar-content {
345 background: #ffffee;
346 border: 1px solid silver;
347 padding: 0.5em;
349 div.sidebar-title, div.image-title {
350 color: #527bbd;
351 font-family: sans-serif;
352 font-weight: bold;
353 margin-top: 0.0em;
354 margin-bottom: 0.5em;
357 div.listingblock div.content {
358 border: 1px solid silver;
359 background: #f4f4f4;
360 padding: 0.5em;
363 div.quoteblock-attribution {
364 padding-top: 0.5em;
365 text-align: right;
368 div.verseblock-content {
369 white-space: pre;
371 div.verseblock-attribution {
372 padding-top: 0.75em;
373 text-align: left;
376 div.exampleblock-content {
377 border-left: 2px solid silver;
378 padding-left: 0.5em;
381 /* IE6 sets dynamically generated links as visited. */
382 div#toc a:visited { color: blue; }
383 </style>
384 </head>
385 <body>
386 <div id="header">
387 <h1>lockfile API</h1>
388 </div>
389 <div id="preamble">
390 <div class="sectionbody">
391 <div class="paragraph"><p>The lockfile API serves two purposes:</p></div>
392 <div class="ulist"><ul>
393 <li>
395 Mutual exclusion. When we write out a new index file, first
396 we create a new file <tt>$GIT_DIR/index.lock</tt>, write the new
397 contents into it, and rename it to the final destination
398 <tt>$GIT_DIR/index</tt>. We try to create the <tt>$GIT_DIR/index.lock</tt>
399 file with O_EXCL so that we can notice and fail when somebody
400 else is already trying to update the index file.
401 </p>
402 </li>
403 <li>
405 Automatic cruft removal. After we create the "lock" file, we
406 may decide to <tt>die()</tt>, and we would want to make sure that we
407 remove the file that has not been committed to its final
408 destination. This is done by remembering the lockfiles we
409 created in a linked list and cleaning them up from an
410 <tt>atexit(3)</tt> handler. Outstanding lockfiles are also removed
411 when the program dies on a signal.
412 </p>
413 </li>
414 </ul></div>
415 </div>
416 </div>
417 <h2 id="_the_functions">The functions</h2>
418 <div class="sectionbody">
419 <div class="dlist"><dl>
420 <dt class="hdlist1">
421 hold_lock_file_for_update
422 </dt>
423 <dd>
425 Take a pointer to <tt>struct lock_file</tt>, the filename of
426 the final destination (e.g. <tt>$GIT_DIR/index</tt>) and a flag
427 <tt>die_on_error</tt>. Attempt to create a lockfile for the
428 destination and return the file descriptor for writing
429 to the file. If <tt>die_on_error</tt> flag is true, it dies if
430 a lock is already taken for the file; otherwise it
431 returns a negative integer to the caller on failure.
432 </p>
433 </dd>
434 <dt class="hdlist1">
435 commit_lock_file
436 </dt>
437 <dd>
439 Take a pointer to the <tt>struct lock_file</tt> initialized
440 with an earlier call to <tt>hold_lock_file_for_update()</tt>,
441 close the file descriptor and rename the lockfile to its
442 final destination. Returns 0 upon success, a negative
443 value on failure to close(2) or rename(2).
444 </p>
445 </dd>
446 <dt class="hdlist1">
447 rollback_lock_file
448 </dt>
449 <dd>
451 Take a pointer to the <tt>struct lock_file</tt> initialized
452 with an earlier call to <tt>hold_lock_file_for_update()</tt>,
453 close the file descriptor and remove the lockfile.
454 </p>
455 </dd>
456 <dt class="hdlist1">
457 close_lock_file
458 </dt>
459 <dd>
461 Take a pointer to the <tt>struct lock_file</tt> initialized
462 with an earlier call to <tt>hold_lock_file_for_update()</tt>,
463 and close the file descriptor. Returns 0 upon success,
464 a negative value on failure to close(2).
465 </p>
466 </dd>
467 </dl></div>
468 <div class="paragraph"><p>Because the structure is used in an <tt>atexit(3)</tt> handler, its
469 storage has to stay throughout the life of the program. It
470 cannot be an auto variable allocated on the stack.</p></div>
471 <div class="paragraph"><p>Call <tt>commit_lock_file()</tt> or <tt>rollback_lock_file()</tt> when you are
472 done writing to the file descriptor. If you do not call either
473 and simply <tt>exit(3)</tt> from the program, an <tt>atexit(3)</tt> handler
474 will close and remove the lockfile.</p></div>
475 <div class="paragraph"><p>If you need to close the file descriptor you obtained from
476 <tt>hold_lock_file_for_update</tt> function yourself, do so by calling
477 <tt>close_lock_file()</tt>. You should never call <tt>close(2)</tt> yourself!
478 Otherwise the <tt>struct
479 lock_file</tt> structure still remembers that the file descriptor
480 needs to be closed, and a later call to <tt>commit_lock_file()</tt> or
481 <tt>rollback_lock_file()</tt> will result in duplicate calls to
482 <tt>close(2)</tt>. Worse yet, if you <tt>close(2)</tt>, open another file
483 descriptor for completely different purpose, and then call
484 <tt>commit_lock_file()</tt> or <tt>rollback_lock_file()</tt>, they may close
485 that unrelated file descriptor.</p></div>
486 </div>
487 <div id="footer">
488 <div id="footer-text">
489 Last updated 2008-09-19 06:28:28 UTC
490 </div>
491 </div>
492 </body>
493 </html>