liblzma-doc 5.1.1alpha+20120614-2ubuntu2 / usr / share / doc / liblzma-doc / html / signals_8c.html

This file is indexed.

/usr/share/doc/liblzma-doc/html/signals_8c.html is in liblzma-doc 5.1.1alpha+20120614-2ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>XZ Utils: xz/signals.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">XZ Utils
   &#160;<span id="projectnumber">5.1.0alpha</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_53e01eec41348db90f08d9ee7e6793af.html">xz</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">signals.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Handling signals to abort operation.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="private_8h.html">private.h</a>&quot;</code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae710b6e1e3475f05843032f73a4dd7a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae710b6e1e3475f05843032f73a4dd7a7"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>signal_handler</b> (int sig)</td></tr>
<tr class="separator:ae710b6e1e3475f05843032f73a4dd7a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3719a1754f6e317bbb96770b973d453c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#a3719a1754f6e317bbb96770b973d453c">signals_init</a> (void)</td></tr>
<tr class="separator:a3719a1754f6e317bbb96770b973d453c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c7cbcd4595590670a3784d393770693"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#a6c7cbcd4595590670a3784d393770693">signals_block</a> (void)</td></tr>
<tr class="separator:a6c7cbcd4595590670a3784d393770693"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55ea2250ff5153a3a4daf1f5a75ea921"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#a55ea2250ff5153a3a4daf1f5a75ea921">signals_unblock</a> (void)</td></tr>
<tr class="memdesc:a55ea2250ff5153a3a4daf1f5a75ea921"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unblock the signals blocked by <a class="el" href="signals_8h.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a>.  <a href="#a55ea2250ff5153a3a4daf1f5a75ea921">More...</a><br/></td></tr>
<tr class="separator:a55ea2250ff5153a3a4daf1f5a75ea921"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb960c3705a055f596b288b0961e135a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#abb960c3705a055f596b288b0961e135a">signals_exit</a> (void)</td></tr>
<tr class="separator:abb960c3705a055f596b288b0961e135a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a190aaf6ae9eaa75671718e1ceed999e6"><td class="memItemLeft" align="right" valign="top">volatile sig_atomic_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#a190aaf6ae9eaa75671718e1ceed999e6">user_abort</a> = false</td></tr>
<tr class="separator:a190aaf6ae9eaa75671718e1ceed999e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32f31d825b75591d947a03750cdedda1"><td class="memItemLeft" align="right" valign="top">static volatile sig_atomic_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#a32f31d825b75591d947a03750cdedda1">exit_signal</a> = 0</td></tr>
<tr class="separator:a32f31d825b75591d947a03750cdedda1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad26b98f4795fd915cf1a761dc572f590"><td class="memItemLeft" align="right" valign="top">static sigset_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#ad26b98f4795fd915cf1a761dc572f590">hooked_signals</a></td></tr>
<tr class="separator:ad26b98f4795fd915cf1a761dc572f590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43e552d0c019958f2cab258d14d99a09"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#a43e552d0c019958f2cab258d14d99a09">signals_are_initialized</a> = false</td></tr>
<tr class="separator:a43e552d0c019958f2cab258d14d99a09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31d411d04c87eedc3fb64f7c4478d1d3"><td class="memItemLeft" align="right" valign="top">static size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="signals_8c.html#a31d411d04c87eedc3fb64f7c4478d1d3">signals_block_count</a> = 0</td></tr>
<tr class="memdesc:a31d411d04c87eedc3fb64f7c4478d1d3"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="signals_8c.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a> and <a class="el" href="signals_8c.html#a55ea2250ff5153a3a4daf1f5a75ea921" title="Unblock the signals blocked by signals_block(). ">signals_unblock()</a> can be called recursively.  <a href="#a31d411d04c87eedc3fb64f7c4478d1d3">More...</a><br/></td></tr>
<tr class="separator:a31d411d04c87eedc3fb64f7c4478d1d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Handling signals to abort operation. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3719a1754f6e317bbb96770b973d453c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void signals_init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the signal handler, which will set user_abort to true when user e.g. presses C-c. </p>

<p>References <a class="el" href="signals_8c.html#ad26b98f4795fd915cf1a761dc572f590">hooked_signals</a>, <a class="el" href="message_8h.html#a05228efdeb6c4e4814fa906d6f2381d6">message_progress_sigs</a>, <a class="el" href="message_8c.html#a8d931845255d94bfbcfacfd99f82b46d">message_signal_handler()</a>, and <a class="el" href="signals_8c.html#a43e552d0c019958f2cab258d14d99a09">signals_are_initialized</a>.</p>

</div>
</div>
<a class="anchor" id="a6c7cbcd4595590670a3784d393770693"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void signals_block </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Block the signals which don't have SA_RESTART and which would just set user_abort to true. This is handy when we don't want to handle EINTR and don't want SA_RESTART either. </p>

<p>References <a class="el" href="signals_8c.html#ad26b98f4795fd915cf1a761dc572f590">hooked_signals</a>, <a class="el" href="signals_8c.html#a43e552d0c019958f2cab258d14d99a09">signals_are_initialized</a>, and <a class="el" href="signals_8c.html#a31d411d04c87eedc3fb64f7c4478d1d3">signals_block_count</a>.</p>

<p>Referenced by <a class="el" href="file__io_8h.html#a8dcc56461111f392398385820ad9c1d9">io_close()</a>, <a class="el" href="file__io_8h.html#a51c7b0ad8b7829773a69972565b7d08d">io_open_dest()</a>, <a class="el" href="file__io_8h.html#ac4fb03f340ee03676cbde913682a3719">io_open_src()</a>, <a class="el" href="file__io_8c.html#af0470bc137d3ae386126db2ca94b5e65">io_open_src_real()</a>, <a class="el" href="message_8h.html#abc7b1a649494177507246554d2d6d6ef">message_progress_update()</a>, and <a class="el" href="message_8c.html#acbbb9eea316e38b0df1bf050d5a2feb6">print_filename()</a>.</p>

</div>
</div>
<a class="anchor" id="a55ea2250ff5153a3a4daf1f5a75ea921"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void signals_unblock </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unblock the signals blocked by <a class="el" href="signals_8h.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a>. </p>

<p>References <a class="el" href="signals_8c.html#ad26b98f4795fd915cf1a761dc572f590">hooked_signals</a>, <a class="el" href="signals_8c.html#a43e552d0c019958f2cab258d14d99a09">signals_are_initialized</a>, and <a class="el" href="signals_8c.html#a31d411d04c87eedc3fb64f7c4478d1d3">signals_block_count</a>.</p>

<p>Referenced by <a class="el" href="file__io_8h.html#a8dcc56461111f392398385820ad9c1d9">io_close()</a>, <a class="el" href="file__io_8h.html#a51c7b0ad8b7829773a69972565b7d08d">io_open_dest()</a>, <a class="el" href="file__io_8h.html#ac4fb03f340ee03676cbde913682a3719">io_open_src()</a>, <a class="el" href="file__io_8c.html#af0470bc137d3ae386126db2ca94b5e65">io_open_src_real()</a>, <a class="el" href="message_8h.html#abc7b1a649494177507246554d2d6d6ef">message_progress_update()</a>, and <a class="el" href="message_8c.html#acbbb9eea316e38b0df1bf050d5a2feb6">print_filename()</a>.</p>

</div>
</div>
<a class="anchor" id="abb960c3705a055f596b288b0961e135a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void signals_exit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>If user has sent us a signal earlier to terminate the process, re-raise that signal to actually terminate the process. </p>

<p>References <a class="el" href="signals_8c.html#a32f31d825b75591d947a03750cdedda1">exit_signal</a>, and <a class="el" href="main_8c.html#aa5da9e106c96aef50fcb212123d5e906">set_exit_status()</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a190aaf6ae9eaa75671718e1ceed999e6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">volatile sig_atomic_t user_abort = false</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>If this is true, we will clean up the possibly incomplete output file, return to main() as soon as practical. That is, the code needs to poll this variable in various places. </p>

<p>Referenced by <a class="el" href="coder_8c.html#a1dc9a6813d9158c93ad48053549825b0">coder_normal()</a>, <a class="el" href="coder_8c.html#ae31acd560ee4d35b7bd0d1bdc94fde0a">coder_passthru()</a>, <a class="el" href="coder_8h.html#acbe7065d22ed54ab19a1a9bb0cb808de">coder_run()</a>, <a class="el" href="file__io_8c.html#af0470bc137d3ae386126db2ca94b5e65">io_open_src_real()</a>, and <a class="el" href="file__io_8h.html#aeda6fa2567b1b96603abbae64217e2f8">io_read()</a>.</p>

</div>
</div>
<a class="anchor" id="a32f31d825b75591d947a03750cdedda1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">volatile sig_atomic_t exit_signal = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>If we were interrupted by a signal, we store the signal number so that we can raise that signal to kill the program when all cleanups have been done. </p>

<p>Referenced by <a class="el" href="signals_8h.html#abb960c3705a055f596b288b0961e135a">signals_exit()</a>.</p>

</div>
</div>
<a class="anchor" id="ad26b98f4795fd915cf1a761dc572f590"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">sigset_t hooked_signals</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Mask of signals for which have have established a signal handler to set user_abort to true. </p>

<p>Referenced by <a class="el" href="signals_8h.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a>, <a class="el" href="signals_8h.html#a3719a1754f6e317bbb96770b973d453c">signals_init()</a>, and <a class="el" href="signals_8h.html#a55ea2250ff5153a3a4daf1f5a75ea921">signals_unblock()</a>.</p>

</div>
</div>
<a class="anchor" id="a43e552d0c019958f2cab258d14d99a09"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool signals_are_initialized = false</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>True once <a class="el" href="signals_8c.html#a3719a1754f6e317bbb96770b973d453c">signals_init()</a> has finished. This is used to skip blocking signals (with uninitialized hooked_signals) if <a class="el" href="signals_8c.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a> and <a class="el" href="signals_8c.html#a55ea2250ff5153a3a4daf1f5a75ea921" title="Unblock the signals blocked by signals_block(). ">signals_unblock()</a> are called before <a class="el" href="signals_8c.html#a3719a1754f6e317bbb96770b973d453c">signals_init()</a> has been called. </p>

<p>Referenced by <a class="el" href="signals_8h.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a>, <a class="el" href="signals_8h.html#a3719a1754f6e317bbb96770b973d453c">signals_init()</a>, and <a class="el" href="signals_8h.html#a55ea2250ff5153a3a4daf1f5a75ea921">signals_unblock()</a>.</p>

</div>
</div>
<a class="anchor" id="a31d411d04c87eedc3fb64f7c4478d1d3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">size_t signals_block_count = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p><a class="el" href="signals_8c.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a> and <a class="el" href="signals_8c.html#a55ea2250ff5153a3a4daf1f5a75ea921" title="Unblock the signals blocked by signals_block(). ">signals_unblock()</a> can be called recursively. </p>

<p>Referenced by <a class="el" href="signals_8h.html#a6c7cbcd4595590670a3784d393770693">signals_block()</a>, and <a class="el" href="signals_8h.html#a55ea2250ff5153a3a4daf1f5a75ea921">signals_unblock()</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 12 2014 15:12:37 for XZ Utils by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.