/
README.html
executable file
·589 lines (509 loc) · 16.9 KB
/
README.html
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
<?xml version="1.0" encoding="utf-8" ?>
<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title>bbpart user manual</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="bbpart-user-manual">
<h1 class="title">bbpart user manual</h1>
<table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="75%" />
</colgroup>
<tbody valign="top">
<tr><td><strong>Title</strong></td>
<td>bbpart (CDFG extraction MachSUIF pass)</td>
</tr>
<tr><td><strong>Author</strong></td>
<td>Nikolaos Kavvadias 2004, 2005, 2006, 2007, 2008, 2009
2010, 2011, 2012, 2013, 2014, 2015, 2016</td>
</tr>
<tr><td><strong>Contact</strong></td>
<td><a class="reference external" href="mailto:nikos@nkavvadias.com">nikos@nkavvadias.com</a></td>
</tr>
<tr><td><strong>Website</strong></td>
<td><a class="reference external" href="http://www.nkavvadias.com">http://www.nkavvadias.com</a></td>
</tr>
<tr><td><strong>Release Date</strong></td>
<td>23 September 2014</td>
</tr>
<tr><td><strong>Version</strong></td>
<td>1.1.2</td>
</tr>
<tr><td><strong>Rev. history</strong></td>
<td> </td>
</tr>
<tr><td><strong>v1.1.2</strong></td>
<td><p class="first">2014-09-23</p>
<p class="last">Updated header comments in all source files. Added File
Listing section in README; added AUTHORS.</p>
</td>
</tr>
<tr><td><strong>v1.1.1</strong></td>
<td><p class="first">2014-08-12</p>
<p class="last">Added VCG file generation for each procedure (was
removed following version <strong>v1.0.1</strong>). Added LICENSE
(modified BSD licensing scheme).</p>
</td>
</tr>
<tr><td><strong>v1.1.0</strong></td>
<td><p class="first">2014-02-24</p>
<p class="last">Changed documentation format to RestructuredText. Added
ChangeLog in separate file.</p>
</td>
</tr>
<tr><td><strong>v1.0.9</strong></td>
<td><p class="first">2006-12-01</p>
<p class="last">Emitter improvements.</p>
</td>
</tr>
<tr><td><strong>v1.0.8</strong></td>
<td><p class="first">2006-11-29</p>
<p class="last">Option for enabling the marking of "false"
dependencies. Not to be used for CFG/SSA SUIFvm.</p>
</td>
</tr>
<tr><td><strong>v1.0.7</strong></td>
<td><p class="first">2006-09-16</p>
<p class="last">Support for operand data type information.</p>
</td>
</tr>
<tr><td><strong>v1.0.6</strong></td>
<td><p class="first">2006-09-15</p>
<p class="last">Cumulative update. Several things fixed. ARM target
support temporarily removed.</p>
</td>
</tr>
<tr><td><strong>v1.0.1</strong></td>
<td><p class="first">2004-10-05</p>
<p class="last">Minor additions to README.</p>
</td>
</tr>
<tr><td><strong>v1.0.0</strong></td>
<td><p class="first">2004-07-17</p>
<p class="last">Initial release.</p>
</td>
</tr>
</tbody>
</table>
<div class="section" id="introduction">
<h1>1. Introduction</h1>
<p><tt class="docutils literal">bbpart</tt> is an analysis pass built to be used with the SUIF2/MachSUIF2
compiler infrastructure. This pass generates a graphical representation for the
data dependence graphs (which come in the form of DAGs) of the basic blocks
found in a given ANSI C source file.</p>
<p>The DAG for each basic block is depicted in the VCG (Visualization and Compiler
Graph) format. A link to VCG can be found here:
<a class="reference external" href="http://rw4.cs.uni-sb.de/~sander/html/gsvcg1.html">http://rw4.cs.uni-sb.de/~sander/html/gsvcg1.html</a></p>
<p>A naming convention has been adopted for each generated file as seen below:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal"><procedure name>_<basic block <span class="pre">number>.vcg</span></tt></div>
</div>
<p>where <tt class="docutils literal"><procedure name></tt> is a C procedure, <tt class="docutils literal"><basic block number></tt> enumerates
the basic blocks in the procedure starting from zero, and vcg is the default
extension for VCG files.</p>
<p>This pass works for the SUIF virtual machine instruction set (SUIFvm) and for
its most common 2 or 3 addressing modes. A more general version of <tt class="docutils literal">bbpart</tt>
applicable to all SUIFvm addressing modes will eventually be released in the
not so distant future. Currently, a new internal version of <tt class="docutils literal">bbpart</tt> is being
developed which is more elegant than the current <tt class="docutils literal">bbpart</tt> since it uses the
<tt class="docutils literal">map_opnds API</tt> function of MachSUIF. The problem is that it is not very stable,
and programs hang right after results have been produced for only a few basic
blocks in the program. I believe this is due to a de-efficiency of the MachSUIF
API.</p>
<p>If nothing is changed in the default <tt class="docutils literal">do_lower</tt> pass of Machine SUIF
(dismantling to simpler objects of several IR objects present in the
corresponding SUIF2 representation), <tt class="docutils literal">bbpart</tt> should not experience any
problems with portable C application codes.</p>
<p>The <tt class="docutils literal">bbpart</tt> pass has been tested with MachSUIF 2.02.07.15.</p>
</div>
<div class="section" id="file-listing">
<h1>2. File listing</h1>
<p>The <tt class="docutils literal">bbpart</tt> distribution includes the following files:</p>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<tbody valign="top">
<tr><td>/bbpart</td>
<td>Top-level directory</td>
</tr>
<tr><td>AUTHORS</td>
<td>List of <tt class="docutils literal">bbpart</tt> authors.</td>
</tr>
<tr><td>LICENSE</td>
<td>The modified BSD license governs <tt class="docutils literal">bbpart</tt>.</td>
</tr>
<tr><td>README.rst</td>
<td>This file.</td>
</tr>
<tr><td>README.html</td>
<td>HTML version of README.</td>
</tr>
<tr><td>README.pdf</td>
<td>PDF version of README.</td>
</tr>
<tr><td>VERSION</td>
<td>Current version of the project sources.</td>
</tr>
<tr><td>bbpart.cpp</td>
<td>Implementation of the <tt class="docutils literal">bbpart</tt> analysis pass.</td>
</tr>
<tr><td>bbpart.h</td>
<td>C++ header file containing declarations and
prototypes for the above.</td>
</tr>
<tr><td>rst2docs.sh</td>
<td>Bash script for generating the HTML and PDF versions
of the documentation (README).</td>
</tr>
<tr><td>suif_main.cpp</td>
<td>Entry point for building the standalone program
<tt class="docutils literal">do_bbpart</tt> that implements the pass.</td>
</tr>
<tr><td>suif_pass.cpp</td>
<td>Define the SUIF pass built as the dynamically
loadable library <tt class="docutils literal">libbbpart.so</tt>.</td>
</tr>
<tr><td>suif_main.h</td>
<td>C++ header file for the above.</td>
</tr>
<tr><td>utils.h</td>
<td>C header file with implementations of auxiliary
functions.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="installation">
<h1>3. Installation</h1>
<p>Unpack the <tt class="docutils literal">bbpart</tt> archive wherever you like, e.g. in <tt class="docutils literal">$MACHSUIFHOME/cfg/bbpart</tt>.
You don't need to modify anything in the Makefile, if you have a working
MachSUIF 2 installation.</p>
<p>The program binary (<tt class="docutils literal">do_bbpart</tt>) will be installed at <tt class="docutils literal">$NCIHOME/bin</tt> and the
shared library (<tt class="docutils literal">libbbpart.so</tt>) at <tt class="docutils literal">$NCIHOME/solib</tt>, where <tt class="docutils literal">NCIHOME</tt> is
the SUIF 2 top-level directory.</p>
</div>
<div class="section" id="usage-details">
<h1>4. Usage details</h1>
<p>The pass accepts an input file in CFG form to operate. You don't have to define
any output files since their naming convention has been hardwired.</p>
<p>As said above, the bbpart pass is applied on the CFG representation of the
input program. Which means that you have to run a sequence of transformation
passes on the C program. These correspond to transformation and optimization
phases of the modular SUIF/MachSUIF compiler. You can prepare something like
the following script (it is just a minimalistic script to get you working),
that can be run e.g. from <tt class="docutils literal">csh</tt>:</p>
<pre class="literal-block">
c2s $1.c $1.suif
do_lower $1.suif $1.lsf
do_s2m $1.lsf $1.svm
do_il2cfg -break_at_call $1.svm $1.afg
do_bbpart $1.afg
echo "Done with $1"
</pre>
<p>Then if this is called <tt class="docutils literal">run_bbpart</tt> you can run it on <tt class="docutils literal">filename.c</tt> as
follows:</p>
<div class="line-block">
<div class="line"><tt class="docutils literal">$ ./run_bbpart filename</tt></div>
</div>
<p>For the C program <tt class="docutils literal">test.c</tt> containing a main procedure with 5 basic blocks and
an abs procedure with 3 basic blocks the following files will be generated:</p>
<pre class="literal-block">
abs_0.vcg
abs_1.vcg
abs_2.vcg
main_0.vcg
main_1.vcg
main_2.vcg
main_3.vcg
main_4.vcg
</pre>
<p>Usage synopsys:</p>
<div class="line-block">
<div class="line">`` do_bbpart [options] test.afg``</div>
</div>
<p>where options can be one or more of the following:</p>
<dl class="docutils">
<dt><strong>-dt</strong></dt>
<dd>enable the production of operand data type information. The
following data types are supported:
{v0, u8, u16, u32, u64, s8, s16, s32, s64, f32, f64, f128, p32, p64}.</dd>
<dt><strong>-mark_false_deps</strong></dt>
<dd>enable the marking of "false" operand dependencies. This option
should not be used for CFG/SSA SUIFvm.</dd>
<dt><strong>-global_symbol_table</strong></dt>
<dd>generation of global symbol table entries.</dd>
</dl>
</div>
<div class="section" id="notes">
<h1>5. Notes</h1>
<p>If you use <tt class="docutils literal">bbpart</tt> in any publication, please give a reference to the
following paper:</p>
<p>Nikolaos Kavvadias and Spiridon Nikolaidis, "Application Analysis with
Integrated Identification of Complex Instructions for Configurable Processors,"
Proc. of the 14th Intl. Workshop on Power and Timing Modeling, Optimization
and Simulation, pp. 633-642, September 15-17, 2004, Santorini, Greece.</p>
<p>This paper discusses a prototype application analysis flow with MachSUIF where
<tt class="docutils literal">bbpart</tt> is used as a CDFG extractor.</p>
</div>
</div>
</body>
</html>