X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=73f291466be9368e183d2a856603919b1b67cda1;hp=433d2d804829749b2909b2485213b1c06607377f;hb=b8aa16822f579a6e15b41d2761801a0a65d5f2a5;hpb=0cda4f28041a221757fa2dfa8e91706e7a548090 diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index 433d2d804..73f291466 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -6,8 +6,8 @@ * Copyright (C) 2011 - David Goulet * * This library is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as published by the - * Free Software Foundation; only version 2.1 of the License. + * under the terms of the GNU Lesser General Public License, version 2.1 only, + * as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or @@ -23,13 +23,20 @@ #define _LTTNG_H #include +#include #include #include /* * Event symbol length. Copied from LTTng kernel ABI. */ -#define LTTNG_SYMBOL_NAME_LEN 256 +#define LTTNG_SYMBOL_NAME_LEN 256 + +/* + * Maximum length of a domain name. This is the limit for the total length of a + * domain name specified by the RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) + */ +#define LTTNG_MAX_DNNAME 255 /* * Every lttng_event_* structure both apply to kernel event and user-space @@ -71,8 +78,30 @@ enum lttng_event_type { * Loglevel information. */ enum lttng_loglevel_type { - LTTNG_EVENT_LOGLEVEL = 0, - LTTNG_EVENT_LOGLEVEL_ONLY = 1, + LTTNG_EVENT_LOGLEVEL_ALL = 0, + LTTNG_EVENT_LOGLEVEL_RANGE = 1, + LTTNG_EVENT_LOGLEVEL_SINGLE = 2, +}; + +/* + * Available loglevels. + */ +enum lttng_loglevel { + LTTNG_LOGLEVEL_EMERG = 0, + LTTNG_LOGLEVEL_ALERT = 1, + LTTNG_LOGLEVEL_CRIT = 2, + LTTNG_LOGLEVEL_ERR = 3, + LTTNG_LOGLEVEL_WARNING = 4, + LTTNG_LOGLEVEL_NOTICE = 5, + LTTNG_LOGLEVEL_INFO = 6, + LTTNG_LOGLEVEL_DEBUG_SYSTEM = 7, + LTTNG_LOGLEVEL_DEBUG_PROGRAM = 8, + LTTNG_LOGLEVEL_DEBUG_PROCESS = 9, + LTTNG_LOGLEVEL_DEBUG_MODULE = 10, + LTTNG_LOGLEVEL_DEBUG_UNIT = 11, + LTTNG_LOGLEVEL_DEBUG_FUNCTION = 12, + LTTNG_LOGLEVEL_DEBUG_LINE = 13, + LTTNG_LOGLEVEL_DEBUG = 14, }; /* @@ -102,26 +131,106 @@ enum lttng_calibrate_type { LTTNG_CALIBRATE_FUNCTION = 0, }; +/* Destination type of lttng URI */ +enum lttng_dst_type { + LTTNG_DST_IPV4, /* IPv4 protocol */ + LTTNG_DST_IPV6, /* IPv6 protocol */ + LTTNG_DST_PATH, /* Local file system */ +}; + +/* Type of lttng URI where it is a final destination or a hop */ +enum lttng_uri_type { + LTTNG_URI_DST, /* The URI is a final destination */ + /* + * Hop are not supported yet but planned for a future release. + * + LTTNG_URI_HOP, + */ +}; + +/* Communication stream type of a lttng URI */ +enum lttng_stream_type { + LTTNG_STREAM_CONTROL, + LTTNG_STREAM_DATA, +}; + +/* + * Protocol type of a lttng URI. The value 0 indicate that the proto_type field + * should be ignored. + */ +enum lttng_proto_type { + LTTNG_TCP = 1, + /* + * UDP protocol is not supported for now. + * + LTTNG_UDP = 2, + */ +}; + +/* + * Structure representing an URI supported by lttng. + */ +#define LTTNG_URI_PADDING1_LEN 16 +#define LTTNG_URI_PADDING2_LEN LTTNG_SYMBOL_NAME_LEN + 32 +struct lttng_uri { + enum lttng_dst_type dtype; + enum lttng_uri_type utype; + enum lttng_stream_type stype; + enum lttng_proto_type proto; + in_port_t port; + char padding[LTTNG_URI_PADDING1_LEN]; + union { + char ipv4[INET_ADDRSTRLEN]; + char ipv6[INET6_ADDRSTRLEN]; + char path[PATH_MAX]; + char padding[LTTNG_URI_PADDING2_LEN]; + } dst; +}; + +/* + * The structures should be initialized to zero before use. + */ +#define LTTNG_DOMAIN_PADDING1 16 +#define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_domain { enum lttng_domain_type type; + char padding[LTTNG_DOMAIN_PADDING1]; + union { pid_t pid; char exec_name[NAME_MAX]; + char padding[LTTNG_DOMAIN_PADDING2]; } attr; }; -/* Perf counter attributes */ +/* + * Perf counter attributes + * + * The structures should be initialized to zero before use. + */ +#define LTTNG_PERF_EVENT_PADDING1 16 struct lttng_event_perf_counter_ctx { uint32_t type; uint64_t config; char name[LTTNG_SYMBOL_NAME_LEN]; + + char padding[LTTNG_PERF_EVENT_PADDING1]; }; -/* Event/Channel context */ +/* + * Event/channel context + * + * The structures should be initialized to zero before use. + */ +#define LTTNG_EVENT_CONTEXT_PADDING1 16 +#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_event_context { enum lttng_event_context_type ctx; + char padding[LTTNG_EVENT_CONTEXT_PADDING1]; + union { struct lttng_event_perf_counter_ctx perf_counter; + char padding[LTTNG_EVENT_CONTEXT_PADDING2]; } u; }; @@ -129,44 +238,81 @@ struct lttng_event_context { * Event probe. * * Either addr is used or symbol_name and offset. + * + * The structures should be initialized to zero before use. */ +#define LTTNG_EVENT_PROBE_PADDING1 16 struct lttng_event_probe_attr { uint64_t addr; uint64_t offset; char symbol_name[LTTNG_SYMBOL_NAME_LEN]; + + char padding[LTTNG_EVENT_PROBE_PADDING1]; }; /* * Function tracer + * + * The structures should be initialized to zero before use. */ +#define LTTNG_EVENT_FUNCTION_PADDING1 16 struct lttng_event_function_attr { char symbol_name[LTTNG_SYMBOL_NAME_LEN]; + + char padding[LTTNG_EVENT_FUNCTION_PADDING1]; }; /* * Generic lttng event + * + * The structures should be initialized to zero before use. */ +#define LTTNG_EVENT_PADDING1 16 +#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_event { enum lttng_event_type type; char name[LTTNG_SYMBOL_NAME_LEN]; enum lttng_loglevel_type loglevel_type; - char loglevel[LTTNG_SYMBOL_NAME_LEN]; - int64_t loglevel_value; /* for printing */ + int loglevel; - uint32_t enabled; + int32_t enabled; /* Does not apply: -1 */ pid_t pid; + + char padding[LTTNG_EVENT_PADDING1]; + /* Per event type configuration */ union { struct lttng_event_probe_attr probe; struct lttng_event_function_attr ftrace; + + char padding[LTTNG_EVENT_PADDING2]; } attr; }; +enum lttng_event_field_type { + LTTNG_EVENT_FIELD_OTHER = 0, + LTTNG_EVENT_FIELD_INTEGER = 1, + LTTNG_EVENT_FIELD_ENUM = 2, + LTTNG_EVENT_FIELD_FLOAT = 3, + LTTNG_EVENT_FIELD_STRING = 4, +}; + +#define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32 +struct lttng_event_field { + char field_name[LTTNG_SYMBOL_NAME_LEN]; + enum lttng_event_field_type type; + char padding[LTTNG_EVENT_FIELD_PADDING]; + struct lttng_event event; +}; + /* * Tracer channel attributes. For both kernel and user-space. + * + * The structures should be initialized to zero before use. */ +#define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_channel_attr { int overwrite; /* 1: overwrite, 0: discard */ uint64_t subbuf_size; /* bytes */ @@ -174,19 +320,29 @@ struct lttng_channel_attr { unsigned int switch_timer_interval; /* usec */ unsigned int read_timer_interval; /* usec */ enum lttng_event_output output; /* splice, mmap */ + + char padding[LTTNG_CHANNEL_ATTR_PADDING1]; }; /* * Channel information structure. For both kernel and user-space. + * + * The structures should be initialized to zero before use. */ +#define LTTNG_CHANNEL_PADDING1 16 struct lttng_channel { char name[LTTNG_SYMBOL_NAME_LEN]; uint32_t enabled; struct lttng_channel_attr attr; + + char padding[LTTNG_CHANNEL_PADDING1]; }; +#define LTTNG_CALIBRATE_PADDING1 16 struct lttng_calibrate { enum lttng_calibrate_type type; + + char padding[LTTNG_CALIBRATE_PADDING1]; }; /* @@ -195,20 +351,30 @@ struct lttng_calibrate { * This is an 'output data' meaning that it only comes *from* the session * daemon *to* the lttng client. It's basically a 'human' representation of * tracing entities (here a session). + * + * The structures should be initialized to zero before use. */ +#define LTTNG_SESSION_PADDING1 16 struct lttng_session { char name[NAME_MAX]; /* The path where traces are written */ char path[PATH_MAX]; uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ + + char padding[LTTNG_SESSION_PADDING1]; }; /* * Handle used as a context for commands. + * + * The structures should be initialized to zero before use. */ +#define LTTNG_HANDLE_PADDING1 16 struct lttng_handle { char session_name[NAME_MAX]; struct lttng_domain domain; + + char padding[LTTNG_HANDLE_PADDING1]; }; /* @@ -300,6 +466,15 @@ extern int lttng_list_events(struct lttng_handle *handle, extern int lttng_list_tracepoints(struct lttng_handle *handle, struct lttng_event **events); +/* + * List the available tracepoints fields of a specific lttng domain. + * + * Return the size (number of entries) of the "lttng_event_field" array. + * Caller must free(3). + */ +extern int lttng_list_tracepoint_fields(struct lttng_handle *handle, + struct lttng_event_field **fields); + /* * Check if a session daemon is alive. * @@ -354,7 +529,7 @@ extern int lttng_add_context(struct lttng_handle *handle, const char *channel_name); /* - * Create or enable a kernel event (or events) for a channel. + * Create or enable an event (or events) for a channel. * * If the event you are trying to enable does not exist, it will be created, * else it is enabled. @@ -365,14 +540,14 @@ extern int lttng_enable_event(struct lttng_handle *handle, struct lttng_event *ev, const char *channel_name); /* - * Create or enable a kernel channel. + * Create or enable a channel. * The channel name cannot be NULL. */ extern int lttng_enable_channel(struct lttng_handle *handle, struct lttng_channel *chan); /* - * Disable kernel event(s) of a channel and domain. + * Disable event(s) of a channel and domain. * * If event_name is NULL, all events are disabled. * If channel_name is NULL, the default channel is used (channel0). @@ -381,7 +556,7 @@ extern int lttng_disable_event(struct lttng_handle *handle, const char *name, const char *channel_name); /* - * Disable kernel channel. + * Disable channel. * * The channel name cannot be NULL. */