1LLVM-REMARKUTIL(1)                   LLVM                   LLVM-REMARKUTIL(1)
2
3
4

NAME

6       llvm-remarkutil - Remark utility
7

SYNOPSIS

9       llvm-remarkutil [subcommmand] [options]
10

DESCRIPTION

12       Utility for displaying information from, and converting between differ‐
13       ent remark formats.
14

SUBCOMMANDS

16          • bitstream2yaml - Reserialize bitstream remarks to YAML.
17
18          • yaml2bitstream - Reserialize YAML remarks to bitstream.
19
20          • instruction-count - Output function instruction counts.
21
22          • annotation-count - Output remark type count  from  annotation  re‐
23            marks.
24
25   bitstream2yaml
26       USAGE: llvm-remarkutil bitstream2yaml <input file> -o <output file>
27
28   Summary
29       Takes  a  bitstream remark file as input, and reserializes that file as
30       YAML.
31
32   yaml2bitstream
33       USAGE: llvm-remarkutil yaml2bitstream <input file> -o <output file>
34
35   Summary
36       Takes a YAML remark file as input, and reserializes that  file  in  the
37       bitstream format.
38
39   instruction-count
40       USAGE:  llvm-remarkutil  instruction-count  <input file> --parser=<bit‐
41       stream|yaml> [--use-debug-loc] -o <output file>
42
43   Summary
44       Outputs instruction count remarks for every function. Instruction count
45       remarks  encode  the  number  of instructions in a function at assembly
46       printing time.
47
48       Instruction count remarks require asm-printer remarks.
49
50       CSV format is as follows:
51
52       ::     Function,InstructionCount foo,123
53
54       if --use-debug-loc is passed then the CSV will include the source path,
55       line number and column.
56
57       ::     Source,Function,InstructionCount path:line:column,foo,3
58
59   annotation-count
60       USAGE:  llvm-remarkutil  annotation-count  <input  file> --parser=<bit‐
61       stream|yaml>  --annotation-type=<type>   [--use-debug-loc]  -o  <output
62       file>
63
64   Summary
65       Outputs  a  count for annotation-type <type> remark for every function.
66       The count expresses the number of remark checks inserted at  the  func‐
67       tion.
68
69       Annotation count remarks require AnnotationRemarksPass remarks.
70
71       CSV format is as follows:
72
73       ::     Function,Count foo,123
74
75       if --use-debug-loc is passed then the CSV will include the source path,
76       line number and column.
77
78       ::     Source,Function,Count path:line:column,foo,3
79

AUTHOR

81       Maintained by the LLVM Team (https://llvm.org/).
82

84       2003-2023, LLVM Project
85
86
87
88
8917                                2023-11-28                LLVM-REMARKUTIL(1)
Impressum