X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Fmi-lttng.h;h=4b2b035e04a66d1d55c9036103975e3ce90a3612;hp=bdc4a052ae0e8cb99347bedde740719b56606632;hb=acc0921507a42345aa6b032231180c7c6999f55a;hpb=c7e35b037773dbbfe10178c946ba44feefb226e1 diff --git a/src/common/mi-lttng.h b/src/common/mi-lttng.h index bdc4a052a..4b2b035e0 100644 --- a/src/common/mi-lttng.h +++ b/src/common/mi-lttng.h @@ -40,27 +40,107 @@ struct mi_lttng_version { uint32_t version_major; /* LTTng-Tools major version number */ uint32_t version_minor; /* LTTng-Tools minor version number */ uint32_t version_patchlevel; /* LTTng-Tools patchlevel version number */ + char version_commit[NAME_MAX]; /* Commit hash of the current version */ char version_name[NAME_MAX]; char package_url[NAME_MAX]; /* Define to the home page for this package. */ }; /* Strings related to command */ const char * const mi_lttng_element_command; +const char * const mi_lttng_element_command_name; const char * const mi_lttng_element_command_version; const char * const mi_lttng_element_command_list; -const char * const mi_lttng_element_command_name; +const char * const mi_lttng_element_command_save; +const char * const mi_lttng_element_command_load; +const char * const mi_lttng_element_command_stop; +const char * const mi_lttng_element_command_start; +const char * const mi_lttng_element_command_create; +const char * const mi_lttng_element_command_destroy; +const char * const mi_lttng_element_command_calibrate; +const char * const mi_lttng_element_command_add_context; +const char * const mi_lttng_element_command_enable_channels; const char * const mi_lttng_element_command_output; +const char * const mi_lttng_element_command_success; -/* Strings related to command: version */ +/* Strings related to version command */ const char * const mi_lttng_element_version; const char * const mi_lttng_element_version_str; const char * const mi_lttng_element_version_web; const char * const mi_lttng_element_version_major; const char * const mi_lttng_element_version_minor; const char * const mi_lttng_element_version_license; +const char * const mi_lttng_element_version_commit; const char * const mi_lttng_element_version_patch_level; const char * const mi_lttng_element_version_description; +/* String related to a lttng_event_field */ +const char * const mi_lttng_element_event_field; +const char * const mi_lttng_element_event_fields; + +/* String related to lttng_event_context */ +const char * const mi_lttng_context_type_perf_counter; +const char * const mi_lttng_context_type_perf_cpu_counter; +const char * const mi_lttng_context_type_perf_thread_counter; + +/* String related to lttng_event_perf_counter_ctx */ +const char * const mi_lttng_element_perf_counter_context; + +/* Strings related to pid */ +const char * const mi_lttng_element_pids; +const char * const mi_lttng_element_pid; +const char * const mi_lttng_element_pid_id; + +/* Strings related to save command */ +const char * const mi_lttng_element_save; + +/* Strings related to load command */ +const char * const mi_lttng_element_load; + +/* General element of mi_lttng */ +const char * const mi_lttng_element_type_other; +const char * const mi_lttng_element_type_integer; +const char * const mi_lttng_element_type_enum; +const char * const mi_lttng_element_type_float; +const char * const mi_lttng_element_type_string; +const char * const mi_lttng_element_nowrite; +const char * const mi_lttng_element_success; + +/* String related to loglevel */ +const char * const mi_lttng_loglevel_str_alert; +const char * const mi_lttng_loglevel_str_crit; +const char * const mi_lttng_loglevel_str_debug; +const char * const mi_lttng_loglevel_str_debug_function; +const char * const mi_lttng_loglevel_str_debug_line; +const char * const mi_lttng_loglevel_str_debug_module; +const char * const mi_lttng_loglevel_str_debug_process; +const char * const mi_lttng_loglevel_str_debug_program; +const char * const mi_lttng_loglevel_str_debug_system; +const char * const mi_lttng_loglevel_str_debug_unit; +const char * const mi_lttng_loglevel_str_emerg; +const char * const mi_lttng_loglevel_str_err; +const char * const mi_lttng_loglevel_str_info; +const char * const mi_lttng_loglevel_str_notice; +const char * const mi_lttng_loglevel_str_unknown; +const char * const mi_lttng_loglevel_str_warning; + +/* String related to loglevel type */ +const char * const mi_lttng_loglevel_type_all; +const char * const mi_lttng_loglevel_type_range; +const char * const mi_lttng_loglevel_type_single; +const char * const mi_lttng_loglevel_type_unknown; + +/* Sting related to lttng_calibrate */ +const char * const mi_lttng_element_calibrate; +const char * const mi_lttng_element_calibrate_function; + +/* Utility string function */ +const char *mi_lttng_loglevel_string(int value); +const char *mi_lttng_logleveltype_string(enum lttng_loglevel_type value); +const char *mi_lttng_eventfieldtype_string(enum lttng_event_field_type value); +const char *mi_lttng_domaintype_string(enum lttng_domain_type value); +const char *mi_lttng_buffertype_string(enum lttng_buffer_type value); +const char *mi_lttng_calibratetype_string(enum lttng_calibrate_type val); + /* * Create an instance of a machine interface writer. * @@ -86,7 +166,6 @@ int mi_lttng_writer_destroy(struct mi_writer *writer); * Open a command tag and add it's name node. * * writer An instance of a machine interface writer. - * * command The command name. * * Returns zero if the XML document could be closed cleanly. @@ -108,7 +187,6 @@ int mi_lttng_writer_command_close(struct mi_writer *writer); * Open an element tag. * * writer An instance of a machine interface writer. - * * element_name Element tag name. * * Returns zero if the XML document could be closed cleanly. @@ -128,12 +206,22 @@ int mi_lttng_writer_open_element(struct mi_writer *writer, int mi_lttng_writer_close_element(struct mi_writer *writer); /* - * Write an element of type unsigned int. + * Close multiple element. * * writer An instance of a machine interface writer. + * nb_element Number of elements. * - * element_name Element name. + * Returns zero if the XML document could be closed cleanly. + * Negative values indicate an error. + */ +int mi_lttng_close_multi_element(struct mi_writer *writer, + unsigned int nb_element); + +/* + * Write an element of type unsigned int. * + * writer An instance of a machine interface writer. + * element_name Element name. * value Unsigned int value of the element * * Returns zero if the element's value could be written. @@ -146,10 +234,8 @@ int mi_lttng_writer_write_element_unsigned_int(struct mi_writer *writer, * Write an element of type signed int. * * writer An instance of a machine interface writer. - * * element_name Element name. - * - * value Signed int value of the element + * value Signed int value of the element. * * Returns zero if the element's value could be written. * Negative values indicate an error. @@ -161,10 +247,8 @@ int mi_lttng_writer_write_element_signed_int(struct mi_writer *writer, * Write an element of type boolean. * * writer An instance of a machine interface writer. - * * element_name Element name. - * - * value Boolean value of the element + * value Boolean value of the element. * * Returns zero if the element's value could be written. * Negative values indicate an error. @@ -176,10 +260,8 @@ int mi_lttng_writer_write_element_bool(struct mi_writer *writer, * Write an element of type string. * * writer An instance of a machine interface writer. - * * element_name Element name. - * - * value String value of the element + * value String value of the element. * * Returns zero if the element's value could be written. * Negative values indicate an error. @@ -191,11 +273,8 @@ int mi_lttng_writer_write_element_string(struct mi_writer *writer, * Machine interface of struct version. * * writer An instance of a machine interface writer. - * * version Version struct. - * * lttng_description String value of the version description. - * * lttng_license String value of the version license. * * Returns zero if the element's value could be written. @@ -205,24 +284,291 @@ int mi_lttng_version(struct mi_writer *writer, struct mi_lttng_version *version, const char *lttng_description, const char *lttng_license); /* - * Machine interface of struct session. + * Machine interface: open a sessions element. * - * writer An instance of a machine interface writer + * writer An instance of a machine interface writer. * - * session An instance of a session + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_sessions_open(struct mi_writer *writer); + +/* + * Machine interface of struct session. * - * isOpen Define if we close the session element - * This should be use carefully and the client - * need to close the session element. - * Use case: nested addition information on a session + * writer An instance of a machine interface writer. + * session An instance of a session. + * is_open Defines whether or not the session element shall be closed. + * This should be used carefully and the client + * must close the session element. + * Use case: nested addtionnal information on a session * ex: domain,channel event. - * 0-> False - * 1-> True * * Returns zero if the element's value could be written. * Negative values indicate an error. */ int mi_lttng_session(struct mi_writer *writer, - struct lttng_session *session, int isOpen); + struct lttng_session *session, int is_open); + +/* + * Machine interface: open a domains element. + * + * writer An instance of a machine interface writer. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_domains_open(struct mi_writer *writer); + +/* + * Machine interface of struct domain. + * + * writer An instance of a machine interface writer. + * domain An instance of a domain. + * + * is_open Defines whether or not the session element shall be closed. + * This should be used carefully and the client + * must close the domain element. + * Use case: nested addition information on a domain + * ex: channel event. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_domain(struct mi_writer *writer, + struct lttng_domain *domain, int is_open); + +/* + * Machine interface: open a channels element. + * + * writer An instance of a machine interface writer. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_channels_open(struct mi_writer *writer); + +/* + * Machine interface of struct channel. + * + * writer An instance of a machine interface writer. + * channel An instance of a channel. + * + * is_open Defines whether or not the session element shall be closed. + * This should be used carefully and the client + * must close the channel element. + * Use case: nested addition information on a channel. + * ex: channel event. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_channel(struct mi_writer *writer, + struct lttng_channel *channel, int is_open); + +/* + * Machine interface of struct channel_attr. + * + * writer An instance of a machine interface writer. + * attr An instance of a channel_attr struct. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_channel_attr(struct mi_writer *writer, + struct lttng_channel_attr *attr); + +/* +* Machine interface for event common attributes. +* +* writer An instance of a mi writer. +* event single trace event. +* +* The common attribute are: +* - mi event element +* - event name +* - event type +* - enabled tag +* - event filter +* +* Returns zero if the element's value could be written. +* Negative values indicate an error. +*/ +int mi_lttng_event_common_attributes(struct mi_writer *writer, + struct lttng_event *event); + +/* + * Machine interface for kernel tracepoint event with a loglevel. + * + * writer An instance of a mi writer. + * event single trace event. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_event_tracepoint_loglevel(struct mi_writer *writer, + struct lttng_event *event); + +/* + * Machine interface for kernel tracepoint event with no loglevel. + * + * writer An instance of a mi writer. + * event single trace event. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_event_tracepoint_no_loglevel(struct mi_writer *writer, + struct lttng_event *event); + +/* + * Machine interface for kernel function and probe event. + * + * writer An instance of a mi writer. + * event single trace event. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_event_function_probe(struct mi_writer *writer, + struct lttng_event *event); + +/* + * Machine interface for kernel function entry event. + * + * writer An instance of a mi writer. + * event single trace event. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_event_function_entry(struct mi_writer *writer, + struct lttng_event *event); + +/* + * Machine interface: open an events element. + * + * writer An instance of a machine interface writer. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_events_open(struct mi_writer *writer); + +/* + * Machine interface for printing an event. + * The trace event type currently supported are: + * TRACEPOINT, + * PROBE, + * FUNCTION, + * FUNCTION_ENTRY, + * SYSCALL + * + * writer An instance of a mi writer. + * event single trace event. + * is_open Defines whether or not the session element shall be closed. + * This should be used carefully and the client + * must close the event element. + * Use case: nested additional information + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_event(struct mi_writer *writer, struct lttng_event *event, + int is_open); + +/* + * Machine interface for struct lttng_event_field. + * + * writer An instance of a mi writer. + * field An event_field instance. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_event_field(struct mi_writer *writer, + struct lttng_event_field *field); + +/* + * Machine interface: open a event_fields element. + * + * writer An instance of a machine interface writer. + * + * Returns zero if the element could be written. + * Negative values indicate an error. + */ +int mi_lttng_event_fields_open(struct mi_writer *writer); + +/* + * Machine interface: open a PIDs element. + * + * writer An instance of a machine interface writer. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_pids_open(struct mi_writer *writer); + +/* + * Machine interface of a PID. + * + * writer An instance of a machine interface writer. + * pid A PID. + * + * is_open Defines whether or not the session element shall be closed. + * This should be used carefully and the client + * must close the pid element. + * Use case: nested addition information on a domain + * ex: channel event. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_pid(struct mi_writer *writer, pid_t pid , const char *cmdline, + int is_open); + +/* + * Machine interface for struct lttng_calibrate. + * + * writer An instance of a machine interface writer. + * + * calibrate A lttng_calibrate instance. + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_calibrate(struct mi_writer *writer, + struct lttng_calibrate *calibrate); + +/* + * Machine interface of a context. + * + * writer An instance of a machine interface writer + * + * context An instance of a lttng_event_context + * + * is_open Define if we close the context element + * This should be used carefully and the client + * need to close the context element. + * 0-> False + * 1-> True + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_context(struct mi_writer *writer, + struct lttng_event_context *context, int is_open); + +/* + * Machine interface of a perf_counter_context. + * + * writer An instance of a machine interface writer + * + * contest An instance of a lttng_event_perf_counter_ctx + * + * Returns zero if the element's value could be written. + * Negative values indicate an error. + */ +int mi_lttng_perf_counter_context(struct mi_writer *writer, + struct lttng_event_perf_counter_ctx *perf_context); #endif /* _MI_LTTNG_H */