aboutsummaryrefslogtreecommitdiff
blob: 9c2790ba3c3197dbd2b30f43e9f3ebc3115d45e6 (plain)
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
<!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/html; charset=utf-8" />
    
    <title>Introduction &mdash; Autodep documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="Autodep documentation" href="index.html" />
    <link rel="next" title="Internals" href="architecture.html" />
    <link rel="prev" title="Autodep’s documentation" href="index.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="architecture.html" title="Internals"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Autodep’s documentation"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Autodep</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline"></a></h1>
<div class="section" id="overview">
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h2>
<p>Auto dependency (autodep) builder is a tool for the analysis of accessed files during
the build of a package. It also can be used for runtime dependencies analysis.</p>
<p>The tool can trace, log and block access to files of given packages.</p>
<p>It is released under GNU GPL license.</p>
</div>
<div class="section" id="status">
<h2>Status<a class="headerlink" href="#status" title="Permalink to this headline"></a></h2>
<p>Autodep is in active developing.</p>
</div>
<div class="section" id="installing">
<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline"></a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">TODO: make an overlay and ebuild</p>
</div>
</div>
<div class="section" id="running">
<h2>Running<a class="headerlink" href="#running" title="Permalink to this headline"></a></h2>
<div class="highlight-none"><div class="highlight"><pre>autodep [options] &lt;command&gt;
</pre></div>
</div>
<dl class="cmdoption">
<dt id="cmdoption-autodep--help">
<tt class="descname">--help</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">-h</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep--help" title="Permalink to this definition"></a></dt>
<dd><p>Show this help message and exit.</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-autodep-b">
<tt class="descname">-b</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--block</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep-b" title="Permalink to this definition"></a></dt>
<dd><p>strict mode: Deny all access to files from non-dependency packages.</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-autodep--blockpkgs">
<tt class="descname">--blockpkgs</tt><tt class="descclassname">=PACKAGES</tt><a class="headerlink" href="#cmdoption-autodep--blockpkgs" title="Permalink to this definition"></a></dt>
<dd><p>Block access to files from this packages.</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-autodep-f">
<tt class="descname">-f</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--files</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep-f" title="Permalink to this definition"></a></dt>
<dd><p>Show all files, accessed and missing (not found).</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-autodep-v">
<tt class="descname">-v</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--verbose</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep-v" title="Permalink to this definition"></a></dt>
<dd><p>Show non-important packages, unknown packages and unknown building stages.</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-autodep--nocolor">
<tt class="descname">--nocolor</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">-C</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep--nocolor" title="Permalink to this definition"></a></dt>
<dd><p>Don&#8217;t colorize output</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-autodep--hooklib">
<tt class="descname">--hooklib</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep--hooklib" title="Permalink to this definition"></a></dt>
<dd><p>Use LD_PRELOAD logging approach (default).</p>
</dd></dl>

<dl class="cmdoption">
<dt id="cmdoption-autodep--fusefs">
<tt class="descname">--fusefs</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-autodep--fusefs" title="Permalink to this definition"></a></dt>
<dd><p>Use FUSE logging approach (slow, but reliable).</p>
</dd></dl>

<p>Example: showfsevents.py -b lsof,cowsay emerge bash</p>
</div>
<div class="section" id="hooklib-vs-fusefs">
<h2>Hooklib vs Fusefs<a class="headerlink" href="#hooklib-vs-fusefs" title="Permalink to this headline"></a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="63%" />
<col width="17%" />
<col width="20%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">&nbsp;</th>
<th class="head">Hooklib</th>
<th class="head">FuseFS</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>Who can use this approach?</td>
<td><strong>Any user</strong></td>
<td>Only root</td>
</tr>
<tr><td>Does approach allows to block access to files?</td>
<td><strong>YES</strong></td>
<td><strong>YES</strong></td>
</tr>
<tr><td>Is the overhead in performance noticeable?</td>
<td><strong>NO</strong></td>
<td>YES <a class="footnote-reference" href="#f1" id="id1">[1]</a></td>
</tr>
<tr><td>What events are logged?</td>
<td>Most <a class="footnote-reference" href="#f2" id="id2">[2]</a></td>
<td><strong>ALL</strong></td>
</tr>
<tr><td>When is it recomended to use an approach?</td>
<td>Analysis
of
<em>buildtime</em>
dependencies</td>
<td>Analysis
of <em>runtime</em>
dependencies</td>
</tr>
<tr><td>Are there any pre-requirements
for using an approach?</td>
<td><strong>NO</strong></td>
<td>FUSE must be
enabled in
kernel</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<table class="docutils footnote" frame="void" id="f1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>FUSE filesystems are slower than a normal one. A Program accesses many files
while launching, so this will take more time than usual.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="f2" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Loading of Dynamic libraries and direct syscalls will not be logged.</td></tr>
</tbody>
</table>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p class="rubric">1. Get the potential dependencies for net-irc/xchat:</p>
<div class="highlight-none"><div class="highlight"><pre>autodep emerge net-irc/xchat
</pre></div>
</div>
<p class="rubric">2. Get the potential dependencies for net-irc/xchat, blocking
x11-misc/util-macros package:</p>
<div class="highlight-none"><div class="highlight"><pre>autodep emerge --blockpkgs x11-misc/util-macros emerge net-irc/xchat
</pre></div>
</div>
<p class="rubric">3. Get the potential dependencies for net-irc/xchat, and show files
accessed:</p>
<div class="highlight-none"><div class="highlight"><pre>autodep --files emerge net-irc/xchat
</pre></div>
</div>
<p class="rubric">4. Get the runtime dependencies of a xchat and show accessed files:</p>
<div class="highlight-none"><div class="highlight"><pre>autodep --fusefs --files xchat
</pre></div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Introduction</a><ul>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#status">Status</a></li>
<li><a class="reference internal" href="#installing">Installing</a></li>
<li><a class="reference internal" href="#running">Running</a></li>
<li><a class="reference internal" href="#hooklib-vs-fusefs">Hooklib vs Fusefs</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="index.html"
                        title="previous chapter">Autodep&#8217;s documentation</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="architecture.html"
                        title="next chapter">Internals</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/intro.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="architecture.html" title="Internals"
             >next</a> |</li>
        <li class="right" >
          <a href="index.html" title="Autodep’s documentation"
             >previous</a> |</li>
        <li><a href="index.html">Autodep</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, Alexander Bersenev.
      Last updated on Aug 21, 2011.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
  </body>
</html>