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
|
llvm-remarkutil - Remark utility
================================
.. program:: llvm-remarkutil
SYNOPSIS
--------
:program:`llvm-remarkutil` [*subcommmand*] [*options*]
DESCRIPTION
-----------
Utility for displaying information from, and converting between different
`remark <https://llvm.org/docs/Remarks.html>`_ formats.
Subcommands
-----------
* :ref:`bitstream2yaml_subcommand` - Reserialize bitstream remarks to YAML.
* :ref:`yaml2bitstream_subcommand` - Reserialize YAML remarks to bitstream.
* :ref:`instruction-count_subcommand` - Output function instruction counts.
* :ref:`annotation-count_subcommand` - Output remark type count from annotation remarks.
.. _bitstream2yaml_subcommand:
bitstream2yaml
~~~~~~~~~~~~~~
.. program:: llvm-remarkutil bitstream2yaml
USAGE: :program:`llvm-remarkutil` bitstream2yaml <input file> -o <output file>
Summary
^^^^^^^
Takes a bitstream remark file as input, and reserializes that file as YAML.
.. _yaml2bitstream_subcommand:
yaml2bitstream
~~~~~~~~~~~~~~
.. program:: llvm-remarkutil yaml2bitstream
USAGE: :program:`llvm-remarkutil` yaml2bitstream <input file> -o <output file>
Summary
^^^^^^^
Takes a YAML remark file as input, and reserializes that file in the bitstream
format.
.. _instruction-count_subcommand:
instruction-count
~~~~~~~~~~~~~~~~~
.. program:: llvm-remarkutil instruction-count
USAGE: :program:`llvm-remarkutil` instruction-count <input file> --parser=<bitstream|yaml> [--use-debug-loc] -o <output file>
Summary
^^^^^^^
Outputs instruction count remarks for every function. Instruction count remarks
encode the number of instructions in a function at assembly printing time.
Instruction count remarks require asm-printer remarks.
CSV format is as follows:
::
Function,InstructionCount
foo,123
if `--use-debug-loc` is passed then the CSV will include the source path, line number and column.
::
Source,Function,InstructionCount
path:line:column,foo,3
.. _annotation-count_subcommand:
annotation-count
~~~~~~~~~~~~~~~~~
.. program:: llvm-remarkutil annotation-count
USAGE: :program:`llvm-remarkutil` annotation-count <input file> --parser=<bitstream|yaml> --annotation-type=<type> [--use-debug-loc] -o <output file>
Summary
^^^^^^^
Outputs a count for annotation-type `<type>` remark for every function. The count expresses
the number of remark checks inserted at the function.
Annotation count remarks require AnnotationRemarksPass remarks.
CSV format is as follows:
::
Function,Count
foo,123
if `--use-debug-loc` is passed then the CSV will include the source path, line number and column.
::
Source,Function,Count
path:line:column,foo,3
|
