X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Fust-events.h;h=4088157f956e8fe87e89f0aa80fd89e41336d5d3;hb=HEAD;hp=cf1045bb589470d5a1f53f13369b14fb5c5e987c;hpb=3d33ca1d93088e049c36fc0f417d130bc66b2231;p=lttng-ust.git diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h index cf1045bb..4088157f 100644 --- a/include/lttng/ust-events.h +++ b/include/lttng/ust-events.h @@ -1,8 +1,8 @@ +// SPDX-FileCopyrightText: 2010-2012 Mathieu Desnoyers +// +// SPDX-License-Identifier: MIT + /* - * SPDX-License-Identifier: MIT - * - * Copyright (C) 2010-2012 Mathieu Desnoyers - * * Holds LTTng per-session event registry. */ @@ -31,8 +31,13 @@ extern "C" { * Older tracepoint providers can always register to newer lttng-ust * library, but the opposite is rejected: a newer tracepoint provider is * rejected by an older lttng-ust library. + * + * LTTNG_UST_PROVIDER_MAJOR_OLDEST_COMPATIBLE is the floor value of + * oldest provider major version currently allowed, typically increased + * when LTTng-UST has an ABI-breaking soname bump. */ -#define LTTNG_UST_PROVIDER_MAJOR 2 +#define LTTNG_UST_PROVIDER_MAJOR 3 +#define LTTNG_UST_PROVIDER_MAJOR_OLDEST_COMPATIBLE 3 #define LTTNG_UST_PROVIDER_MINOR 0 struct lttng_ust_channel_buffer; @@ -125,7 +130,7 @@ struct lttng_ust_type_integer { .size = sizeof(_type) * CHAR_BIT, \ .alignment = lttng_ust_rb_alignof(_type) * CHAR_BIT, \ .signedness = lttng_ust_is_signed_type(_type), \ - .reverse_byte_order = _byte_order != BYTE_ORDER, \ + .reverse_byte_order = _byte_order != LTTNG_UST_BYTE_ORDER, \ .base = _base, \ })) @@ -157,7 +162,7 @@ struct lttng_ust_type_float { - lttng_ust_float_mant_dig(_type), \ .mant_dig = lttng_ust_float_mant_dig(_type), \ .alignment = lttng_ust_rb_alignof(_type) * CHAR_BIT, \ - .reverse_byte_order = BYTE_ORDER != FLOAT_WORD_ORDER, \ + .reverse_byte_order = LTTNG_UST_BYTE_ORDER != LTTNG_UST_FLOAT_WORD_ORDER, \ })) @@ -193,7 +198,7 @@ struct lttng_ust_type_array { struct lttng_ust_type_sequence { struct lttng_ust_type_common parent; uint32_t struct_size; - const char *length_name; /* Length field name. */ + const char *length_name; /* Length field name. If NULL, use previous field. */ const struct lttng_ust_type_common *elem_type; unsigned int alignment; /* Minimum alignment before elements. */ enum lttng_ust_string_encoding encoding; @@ -225,6 +230,7 @@ struct lttng_ust_enum_desc { const char *name; const struct lttng_ust_enum_entry * const *entries; unsigned int nr_entries; + const struct lttng_ust_probe_desc *probe_desc; /* End of base ABI. Fields below should be used after checking struct_size. */ }; @@ -252,6 +258,29 @@ struct lttng_ust_event_field { /* End of base ABI. Fields below should be used after checking struct_size. */ }; +/* + * Tracepoint class description + * + * IMPORTANT: this structure is part of the ABI between the probe and + * UST. Fields need to be only added at the end, never reordered, never + * removed. + * + * The field @struct_size should be used to determine the size of the + * structure. It should be queried before using additional fields added + * at the end of the structure. + */ + +struct lttng_ust_tracepoint_class { + uint32_t struct_size; + + const struct lttng_ust_event_field * const *fields; + size_t nr_fields; + void (*probe_callback)(void); + const char *signature; /* Argument types/names received */ + const struct lttng_ust_probe_desc *probe_desc; + + /* End of base ABI. Fields below should be used after checking struct_size. */ +}; /* * IMPORTANT: this structure is part of the ABI between the probe and @@ -267,11 +296,8 @@ struct lttng_ust_event_desc { const char *event_name; const struct lttng_ust_probe_desc *probe_desc; - void (*probe_callback)(void); - const struct lttng_ust_event_field * const *fields; /* event payload */ - unsigned int nr_fields; + const struct lttng_ust_tracepoint_class *tp_class; const int **loglevel; - const char *signature; /* Argument types/names received */ const char **model_emf_uri; /* End of base ABI. Fields below should be used after checking struct_size. */ @@ -300,6 +326,26 @@ struct lttng_ust_probe_desc { /* Data structures used by the tracer. */ +/* + * IMPORTANT: this structure is part of the ABI between the probe and + * UST. Fields need to be only added at the end, never reordered, never + * removed. + * + * The field @struct_size should be used to determine the size of the + * structure. It should be queried before using additional fields added + * at the end of the structure. + * + * The probe_ctx is not const because it may be extended to add future + * fields which could be modified by callbacks. + */ +struct lttng_ust_probe_ctx { + uint32_t struct_size; /* Size of this structure. */ + + void *ip; /* caller ip address */ + + /* End of base ABI. Fields below should be used after checking struct_size. */ +}; + /* * lttng_event structure is referred to by the tracing fast path. It * must be kept small. @@ -351,6 +397,7 @@ struct lttng_ust_event_common { int eval_filter; /* Need to evaluate filters */ int (*run_filter)(const struct lttng_ust_event_common *event, const char *stack_data, + struct lttng_ust_probe_ctx *probe_ctx, void *filter_ctx); /* End of base ABI. Fields below should be used after checking struct_size. */ @@ -395,7 +442,6 @@ struct lttng_ust_event_recorder { struct lttng_ust_notification_ctx { uint32_t struct_size; /* Size of this structure. */ int eval_capture; /* Capture evaluation available. */ - /* End of base ABI. Fields below should be used after checking struct_size. */ }; @@ -424,6 +470,7 @@ struct lttng_ust_event_notifier { int eval_capture; /* Need to evaluate capture */ void (*notification_send)(const struct lttng_ust_event_notifier *event_notifier, const char *stack_data, + struct lttng_ust_probe_ctx *probe_ctx, struct lttng_ust_notification_ctx *notif_ctx); /* End of base ABI. Fields below should be used after checking struct_size. */