| 1 | = babeltrace2-query-babeltrace.trace-infos(7) |
| 2 | :manpagetype: query object |
| 3 | :revdate: 14 September 2019 |
| 4 | |
| 5 | |
| 6 | == NAME |
| 7 | |
| 8 | babeltrace2-query-babeltrace.trace-infos - Babeltrace 2's trace infos |
| 9 | query object |
| 10 | |
| 11 | |
| 12 | == DESCRIPTION |
| 13 | |
| 14 | The `babeltrace.trace-infos` Babeltrace~2 query object indicates |
| 15 | time range information about specific traces and their streams, and |
| 16 | which output ports of an eventual source component will serve the |
| 17 | messages for a given stream. |
| 18 | |
| 19 | The man:babeltrace2-convert(1) command queries this object from all the |
| 20 | source component classes to support the |
| 21 | manopt:babeltrace2-convert(1):--stream-intersection feature. |
| 22 | |
| 23 | |
| 24 | == PARAMETERS |
| 25 | |
| 26 | The parameters for this query operation are exactly the same as you |
| 27 | would pass as the initialization parameters of a component created from |
| 28 | the queried component class. |
| 29 | |
| 30 | |
| 31 | == RESULT OBJECT |
| 32 | |
| 33 | The result object is an array of trace info maps (see |
| 34 | <<trace-info-map,``Trace info map''>>). |
| 35 | |
| 36 | |
| 37 | [[trace-info-map]] |
| 38 | === Trace info map |
| 39 | |
| 40 | A trace info map contains: |
| 41 | |
| 42 | nlqres:stream-infos='STREAM-INFOS' vtype:[array of stream info maps]:: |
| 43 | Stream info maps (see <<stream-info-map,``Stream info map''>>) for |
| 44 | this trace. |
| 45 | |
| 46 | |
| 47 | [[stream-info-map]] |
| 48 | === Stream info map |
| 49 | |
| 50 | A stream info map contains: |
| 51 | |
| 52 | nlqres:range-ns='RANGE' vtype:[range map]:: |
| 53 | The time range of this stream, a map containing: |
| 54 | + |
| 55 | -- |
| 56 | nlqres:begin='NS' vtype:[signed integer]:: |
| 57 | Beginning time of this stream (nanoseconds since the stream |
| 58 | class's default clock class's origin). |
| 59 | |
| 60 | nlqres:end='NS' vtype:[signed integer]:: |
| 61 | End time of this stream (nanoseconds since the stream class's |
| 62 | default clock class's origin). |
| 63 | -- |
| 64 | |
| 65 | nlqres:port-name='PORT-NAME' vtype:[string]:: |
| 66 | For an eventual source component initialized with the same |
| 67 | parameters: name of the output port which serves the messages of |
| 68 | this stream. |
| 69 | |
| 70 | |
| 71 | == EXAMPLES |
| 72 | |
| 73 | === Result object |
| 74 | |
| 75 | .Two trace infos: one with three stream infos, one with two stream infos. |
| 76 | ==== |
| 77 | [source,yaml] |
| 78 | ---- |
| 79 | - stream-infos: |
| 80 | - range-ns: |
| 81 | begin: 1509556764975082000 |
| 82 | end: 1509557102181554400 |
| 83 | port-name: trace0-cpu0 |
| 84 | - range-ns: |
| 85 | begin: 1509556764947050800 |
| 86 | end: 1509557102182771000 |
| 87 | port-name: trace0-cpu1 |
| 88 | - range-ns: |
| 89 | begin: 1509556764956409300 |
| 90 | end: 1509557102182770400 |
| 91 | port-name: trace0-cpu2 |
| 92 | - stream-infos: |
| 93 | - range-ns: |
| 94 | begin: 1509556764918082000 |
| 95 | end: 1509557103849928400 |
| 96 | port-name: trace1-cpu0 |
| 97 | - range-ns: |
| 98 | begin: 1509556761888820000 |
| 99 | end: 1509557109928100400 |
| 100 | port-name: trace1-cpu1 |
| 101 | |
| 102 | ---- |
| 103 | ==== |
| 104 | |
| 105 | |
| 106 | include::common-footer.txt[] |
| 107 | |
| 108 | |
| 109 | == SEE ALSO |
| 110 | |
| 111 | man:babeltrace2-intro(7), |
| 112 | man:babeltrace2-query(1), |
| 113 | man:babeltrace2-convert(1) |