X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fbin%2Flttng-sessiond%2Fust-registry.h;h=b77b1d8ae6f9dd0e4fb30865f4b2b6671ca1eba9;hb=4878de5c7deb512bbdac4fdfc498907efa06fb7c;hp=a8466ebf58c64c9260968e77a8e0573925f9b959;hpb=10b56aefc3e1de5cee607994f64c3b8a7d85c391;p=lttng-tools.git diff --git a/src/bin/lttng-sessiond/ust-registry.h b/src/bin/lttng-sessiond/ust-registry.h index a8466ebf5..b77b1d8ae 100644 --- a/src/bin/lttng-sessiond/ust-registry.h +++ b/src/bin/lttng-sessiond/ust-registry.h @@ -1,18 +1,8 @@ /* - * Copyright (C) 2013 - David Goulet + * Copyright (C) 2013 David Goulet * - * This program is free software; you can redistribute it and/or modify it - * under the terms of the GNU General Public License, version 2 only, as - * published by the Free Software Foundation. + * SPDX-License-Identifier: GPL-2.0-only * - * This program is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for - * more details. - * - * You should have received a copy of the GNU General Public License along with - * this program; if not, write to the Free Software Foundation, Inc., 51 - * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef LTTNG_UST_REGISTRY_H @@ -22,9 +12,9 @@ #include #include -#include +#include -#include "ust-ctl.h" +#include "lttng-ust-ctl.h" #define CTF_SPEC_MAJOR 1 #define CTF_SPEC_MINOR 8 @@ -48,7 +38,7 @@ struct ust_registry_session { /* Next enumeration ID available. */ uint64_t next_enum_id; /* Universal unique identifier used by the tracer. */ - unsigned char uuid[UUID_LEN]; + unsigned char uuid[LTTNG_UUID_LEN]; /* session ABI description */ @@ -68,7 +58,35 @@ struct ust_registry_session { size_t metadata_len, metadata_alloc_len; /* Length of bytes sent to the consumer. */ size_t metadata_len_sent; + /* Current version of the metadata. */ + uint64_t metadata_version; + /* + * Those fields are only used when a session is created with + * the --shm-path option. In this case, the metadata is output + * twice: once to the consumer, as ususal, but a second time + * also in the shm path directly. This is done so that a copy + * of the metadata that is as fresh as possible is available + * on the event of a crash. + * + * root_shm_path contains the shm-path provided by the user, along with + * the session's name and timestamp: + * e.g. /tmp/my_shm/my_session-20180612-135822 + * + * shm_path contains the full path of the memory buffers: + * e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit + * + * metadata_path contains the full path to the metadata file that + * is kept for the "crash buffer" extraction: + * e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit/metadata + * + * Note that this is not the trace's final metadata file. It is + * only meant to be used to read the contents of the ring buffers + * in the event of a crash. + * + * metadata_fd is a file descriptor that points to the file at + * 'metadata_path'. + */ char root_shm_path[PATH_MAX]; char shm_path[PATH_MAX]; char metadata_path[PATH_MAX]; @@ -96,13 +114,25 @@ struct ust_registry_session { /* Enumerations table. */ struct lttng_ht *enums; + + /* + * Copy of the tracer version when the first app is registered. + * It is used if we need to regenerate the metadata. + */ + uint32_t major; + uint32_t minor; + + /* The id of the parent session */ + uint64_t tracing_id; + uid_t tracing_uid; }; struct ust_registry_channel { uint64_t key; + uint64_t consumer_key; /* Id set when replying to a register channel. */ uint32_t chan_id; - enum ustctl_channel_header header_type; + enum lttng_ust_ctl_channel_header header_type; /* * Flag for this channel if the metadata was dumped once during @@ -126,7 +156,7 @@ struct ust_registry_channel { * register channel notification from the UST tracer. */ size_t nr_ctx_fields; - struct ustctl_field *ctx_fields; + struct lttng_ust_ctl_field *ctx_fields; struct lttng_ht_node_u64 node; /* For delayed reclaim */ struct rcu_head rcu_head; @@ -142,11 +172,11 @@ struct ust_registry_event { int session_objd; int channel_objd; /* Name of the event returned by the tracer. */ - char name[LTTNG_UST_SYM_NAME_LEN]; + char name[LTTNG_UST_ABI_SYM_NAME_LEN]; char *signature; int loglevel_value; size_t nr_fields; - struct ustctl_field *fields; + struct lttng_ust_ctl_field *fields; char *model_emf_uri; /* * Flag for this channel if the metadata was dumped once during @@ -161,8 +191,8 @@ struct ust_registry_event { }; struct ust_registry_enum { - char name[LTTNG_UST_SYM_NAME_LEN]; - struct ustctl_enum_entry *entries; + char name[LTTNG_UST_ABI_SYM_NAME_LEN]; + struct lttng_ust_ctl_enum_entry *entries; size_t nr_entries; uint64_t id; /* enum id in session */ /* Enumeration node in session hash table. */ @@ -239,7 +269,7 @@ struct ust_registry_channel *ust_registry_channel_find( int ust_registry_channel_add(struct ust_registry_session *session, uint64_t key); void ust_registry_channel_del_free(struct ust_registry_session *session, - uint64_t key); + uint64_t key, bool notif); int ust_registry_session_init(struct ust_registry_session **sessionp, struct ust_app *app, @@ -255,12 +285,14 @@ int ust_registry_session_init(struct ust_registry_session **sessionp, const char *root_shm_path, const char *shm_path, uid_t euid, - gid_t egid); + gid_t egid, + uint64_t tracing_id, + uid_t tracing_uid); void ust_registry_session_destroy(struct ust_registry_session *session); int ust_registry_create_event(struct ust_registry_session *session, uint64_t chan_key, int session_objd, int channel_objd, char *name, - char *sig, size_t nr_fields, struct ustctl_field *fields, + char *sig, size_t nr_fields, struct lttng_ust_ctl_field *fields, int loglevel_value, char *model_emf_uri, int buffer_type, uint32_t *event_id_p, struct ust_app *app); struct ust_registry_event *ust_registry_find_event( @@ -278,7 +310,7 @@ int ust_metadata_event_statedump(struct ust_registry_session *session, struct ust_registry_event *event); int ust_registry_create_or_find_enum(struct ust_registry_session *session, int session_objd, char *name, - struct ustctl_enum_entry *entries, size_t nr_entries, + struct lttng_ust_ctl_enum_entry *entries, size_t nr_entries, uint64_t *enum_id); struct ust_registry_enum * ust_registry_lookup_enum_by_id(struct ust_registry_session *session, @@ -287,93 +319,140 @@ struct ust_registry_enum * #else /* HAVE_LIBLTTNG_UST_CTL */ static inline -void ust_registry_channel_destroy(struct ust_registry_session *session, - struct ust_registry_channel *chan) +void ust_registry_channel_destroy( + struct ust_registry_session *session __attribute__((unused)), + struct ust_registry_channel *chan __attribute__((unused))) {} + static inline struct ust_registry_channel *ust_registry_channel_find( - struct ust_registry_session *session, uint64_t key) + struct ust_registry_session *session __attribute__((unused)), + uint64_t key __attribute__((unused))) { return NULL; } + static inline -int ust_registry_channel_add(struct ust_registry_session *session, - uint64_t key) +int ust_registry_channel_add( + struct ust_registry_session *session __attribute__((unused)), + uint64_t key __attribute__((unused))) { return 0; } + static inline -void ust_registry_channel_del_free(struct ust_registry_session *session, - uint64_t key) +void ust_registry_channel_del_free( + struct ust_registry_session *session __attribute__((unused)), + uint64_t key __attribute__((unused)), + bool notif __attribute__((unused))) {} + static inline -int ust_registry_session_init(struct ust_registry_session **sessionp, - struct ust_app *app, - uint32_t bits_per_long, - uint32_t uint8_t_alignment, - uint32_t uint16_t_alignment, - uint32_t uint32_t_alignment, - uint32_t uint64_t_alignment, - uint32_t long_alignment, - int byte_order) +int ust_registry_session_init( + struct ust_registry_session **sessionp __attribute__((unused)), + struct ust_app *app __attribute__((unused)), + uint32_t bits_per_long __attribute__((unused)), + uint32_t uint8_t_alignment __attribute__((unused)), + uint32_t uint16_t_alignment __attribute__((unused)), + uint32_t uint32_t_alignment __attribute__((unused)), + uint32_t uint64_t_alignment __attribute__((unused)), + uint32_t long_alignment __attribute__((unused)), + int byte_order __attribute__((unused)), + uint32_t major __attribute__((unused)), + uint32_t minor __attribute__((unused)), + const char *root_shm_path __attribute__((unused)), + const char *shm_path __attribute__((unused)), + uid_t euid __attribute__((unused)), + gid_t egid __attribute__((unused)), + uint64_t tracing_id __attribute__((unused)), + uid_t tracing_uid __attribute__((unused))) { return 0; } + static inline -void ust_registry_session_destroy(struct ust_registry_session *session) +void ust_registry_session_destroy( + struct ust_registry_session *session __attribute__((unused))) {} + static inline -int ust_registry_create_event(struct ust_registry_session *session, - uint64_t chan_key, int session_objd, int channel_objd, char *name, - char *sig, size_t nr_fields, struct ustctl_field *fields, - int loglevel_value, char *model_emf_uri, int buffer_type, - uint32_t *event_id_p) +int ust_registry_create_event( + struct ust_registry_session *session __attribute__((unused)), + uint64_t chan_key __attribute__((unused)), + int session_objd __attribute__((unused)), + int channel_objd __attribute__((unused)), + char *name __attribute__((unused)), + char *sig __attribute__((unused)), + size_t nr_fields __attribute__((unused)), + struct lttng_ust_ctl_field *fields __attribute__((unused)), + int loglevel_value __attribute__((unused)), + char *model_emf_uri __attribute__((unused)), + int buffer_type __attribute__((unused)), + uint32_t *event_id_p __attribute__((unused))) { return 0; } static inline struct ust_registry_event *ust_registry_find_event( - struct ust_registry_channel *chan, char *name, char *sig) + struct ust_registry_channel *chan __attribute__((unused)), + char *name __attribute__((unused)), + char *sig __attribute__((unused))) { return NULL; } + static inline -void ust_registry_destroy_event(struct ust_registry_channel *chan, - struct ust_registry_event *event) +void ust_registry_destroy_event( + struct ust_registry_channel *chan __attribute__((unused)), + struct ust_registry_event *event __attribute__((unused))) {} /* The app object can be NULL for registry shared across applications. */ static inline -int ust_metadata_session_statedump(struct ust_registry_session *session, - struct ust_app *app) +int ust_metadata_session_statedump( + struct ust_registry_session *session __attribute__((unused)), + struct ust_app *app __attribute__((unused)), + uint32_t major __attribute__((unused)), + uint32_t minor __attribute__((unused))) { return 0; } + static inline -int ust_metadata_channel_statedump(struct ust_registry_session *session, - struct ust_registry_channel *chan) +int ust_metadata_channel_statedump( + struct ust_registry_session *session __attribute__((unused)), + struct ust_registry_channel *chan __attribute__((unused))) { return 0; } + static inline -int ust_metadata_event_statedump(struct ust_registry_session *session, - struct ust_registry_channel *chan, - struct ust_registry_event *event) +int ust_metadata_event_statedump( + struct ust_registry_session *session __attribute__((unused)), + struct ust_registry_channel *chan __attribute__((unused)), + struct ust_registry_event *event __attribute__((unused))) { return 0; } + static inline -int ust_registry_create_or_find_enum(struct ust_registry_session *session, - int session_objd, char *name, - struct ustctl_enum_entry *entries, size_t nr_entries, - uint64_t *enum_id) +int ust_registry_create_or_find_enum( + struct ust_registry_session *session __attribute__((unused)), + int session_objd __attribute__((unused)), + char *name __attribute__((unused)), + struct lttng_ust_ctl_enum_entry *entries __attribute__((unused)), + size_t nr_entries __attribute__((unused)), + uint64_t *enum_id __attribute__((unused))) { return 0; } + static inline struct ust_registry_enum * - ust_registry_lookup_enum_by_id(struct ust_registry_session *session, - const char *name, uint64_t id) + ust_registry_lookup_enum_by_id( + struct ust_registry_session *session __attribute__((unused)), + const char *name __attribute__((unused)), + uint64_t id __attribute__((unused))) { return NULL; }