Skip to content

Commit c30b773

Browse files
committed
Fix Tracepoint_config serialization examples
1 parent 2924f57 commit c30b773

File tree

1 file changed

+59
-25
lines changed

1 file changed

+59
-25
lines changed

documentation/design-docs/ipc-protocol.md

+59-25
Original file line numberDiff line numberDiff line change
@@ -870,29 +870,12 @@ allow=1, event_ids=[1, 2, 3]: Allow only Event IDs 1, 2, and 3.
870870
### Tracepoint_config
871871
Example `tracepoint_config` serialization
872872
```
873-
Output_format = 0, skip tracepoint_config
873+
Output_format=0, DO NOT encode bytes for tracepoint_config
874+
Output_format=1, encode bytes for tracepoint_config
874875
```
875-
<table>
876-
<tr>
877-
<th>1-4</th>
878-
</tr>
879-
<tr>
880-
<tr>
881-
<td colspan="1">string (array&ltwchar&gt)</td>
882-
</tr>
883-
<tr>
884-
<tr>
885-
<td colspan="1">default_tracepoint_name</td>
886-
</tr>
887-
<tr>
888-
<td colspan="1">0</td>
889-
</tr>
890-
</table>
891-
892876

893877
```
894-
Output_format = 1
895-
All allowed Event IDs will be written to "MyTracepoint"
878+
All allowed Event IDs will be written to a default "MyTracepoint" tracepoint
896879
```
897880
<table>
898881
<tr>
@@ -903,7 +886,7 @@ All allowed Event IDs will be written to "MyTracepoint"
903886
<tr>
904887
<tr>
905888
<td colspan="2">string (array&ltwchar&gt)</td>
906-
<td colspan="1">uint</td>
889+
<td colspan="1">array&ltuint&gt</td>
907890
</tr>
908891
<tr>
909892
<td colspan="2">default_tracepoint_name</td>
@@ -916,10 +899,8 @@ All allowed Event IDs will be written to "MyTracepoint"
916899
</tr>
917900
</table>
918901

919-
920902
```
921-
Output_format = 1
922-
Allowed Event IDs 0 - 9 will be written to tracepoint "LowEvents".
903+
Allowed Event IDs 1 - 9 will be written to tracepoint "LowEvents".
923904
All other allowed Event IDs will be written to "MyTracepoint"
924905
```
925906
<table>
@@ -961,9 +942,62 @@ All other allowed Event IDs will be written to "MyTracepoint"
961942
<td colspan="1">1</td>
962943
<td colspan="1">10</td>
963944
<td colspan="1">"LowEvents"</td>
964-
<td colspan="1">10</td>
945+
<td colspan="1">9</td>
946+
<td colspan="1">1</td>
947+
<td colspan="1">2</td>
948+
<td colspan="1">3</td>
949+
<td colspan="1">4</td>
950+
<td colspan="1">5</td>
951+
<td colspan="1">6</td>
952+
<td colspan="1">7</td>
953+
<td colspan="1">8</td>
954+
<td colspan="1">9</td>
955+
</tr>
956+
</table>
957+
958+
```
959+
Allowed Event IDs 1 - 9 will be written to tracepoint "LowEvents".
960+
No default tracepoint needed, don't write any other allowed Event IDs
961+
```
962+
<table>
963+
<tr>
964+
<th>1</th>
965+
<th>5</th>
966+
<th>9</th>
967+
<th>13</th>
968+
<th>33</th>
969+
<th>37</th>
970+
<th>41</th>
971+
<th>45</th>
972+
<th>49</th>
973+
<th>53</th>
974+
<th>57</th>
975+
<th>61</th>
976+
<th>65</th>
977+
<th>69-72</th>
978+
</tr>
979+
<tr>
980+
<tr>
981+
<td colspan="1">string (array&ltwchar&gt)</td>
982+
<td colspan="1">uint</td>
983+
<td colspan="2">string (array&ltwchar&gt)</td>
984+
<td colspan="10">array&lt;uint&gt;</td>
985+
</tr>
986+
</tr>
987+
<tr>
988+
<tr>
989+
<td colspan="1">default_tracepoint_name</td>
990+
<td colspan="1">tracepoints</td>
991+
<td colspan="2">tracepoint_name</td>
992+
<td colspan="10">event_ids</td>
993+
</tr>
994+
<tr>
965995
<td colspan="1">0</td>
966996
<td colspan="1">1</td>
997+
<td colspan="1">10</td>
998+
<td colspan="1">"LowEvents"</td>
999+
<td colspan="1">9</td>
1000+
<td colspan="1">1</td>
9671001
<td colspan="1">2</td>
9681002
<td colspan="1">3</td>
9691003
<td colspan="1">4</td>

0 commit comments

Comments
 (0)