1. Common constants

Important

The bindings documented here are the ones of Babeltrace 2, which is not yet released. If you're using a Babeltrace 1.x release, all the names are in the same module named babeltrace.

In this case, the names found in the babeltrace.common module documented here can be found in the babeltrace module directly.

For example, instead of:

import babeltrace.common

scope = babeltrace.common.CTFScope.EVENT_CONTEXT

do:

import babeltrace

scope = babeltrace.CTFScope.EVENT_CONTEXT

The following constants are used as arguments and return values in several methods of both the reader and CTF writer APIs.

1.1. CTFStringEncoding

class babeltrace.common.CTFStringEncoding

CTF string encodings.

ASCII = 2

ASCII

NONE = 0

None

UNKNOWN = 3

Unknown

UTF8 = 1

UTF-8

1.2. ByteOrder

class babeltrace.common.ByteOrder

Byte orders.

BYTE_ORDER_BIG_ENDIAN = 2

Big-endian

BYTE_ORDER_LITTLE_ENDIAN = 1

Little-endian

BYTE_ORDER_NATIVE = 0

Native byte order

BYTE_ORDER_NETWORK = 3

Network byte order (big-endian)

BYTE_ORDER_UNKNOWN = 4

Unknown byte order

1.3. CTFTypeId

class babeltrace.common.CTFTypeId

CTF numeric type identifiers.

ARRAY = 8

Array

ENUM = 3

Enumeration

FLOAT = 2

Floating point number

INTEGER = 1

Integer

SEQUENCE = 9

Sequence

STRING = 4

String

STRUCT = 5

Structure

UNKNOWN = 0

Unknown type

UNTAGGED_VARIANT = 6

Untagged variant

VARIANT = 7

Variant

type_name(id)

Returns the name of the CTF numeric type identifier id.

1.4. CTFScope

class babeltrace.common.CTFScope

CTF scopes.

EVENT_CONTEXT = 4

Event context

EVENT_FIELDS = 5

Event fields

STREAM_EVENT_CONTEXT = 3

Stream event context

STREAM_EVENT_HEADER = 2

Event header

STREAM_PACKET_CONTEXT = 1

Packet context

TRACE_PACKET_HEADER = 0

Packet header

scope_name(scope)

Returns the name of the CTF scope scope.