X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng-sessiond%2Fust-registry.h;h=a0a4a17f43b8ba0edd8ecd3f9d29798ffe421c01;hp=04bbaa0e9f3c94b385ffa4248d5882bc021761e2;hb=16ea9370e1b1d553c795d888cef0c900079a1ae2;hpb=45893984238b2e2c12fc0d84b90336c98a6d98c9 diff --git a/src/bin/lttng-sessiond/ust-registry.h b/src/bin/lttng-sessiond/ust-registry.h index 04bbaa0e9..a0a4a17f4 100644 --- a/src/bin/lttng-sessiond/ust-registry.h +++ b/src/bin/lttng-sessiond/ust-registry.h @@ -20,11 +20,12 @@ #include #include -#include #include #include +#include "ust-ctl.h" + #define CTF_SPEC_MAJOR 1 #define CTF_SPEC_MINOR 8 @@ -33,14 +34,19 @@ struct ust_app; struct ust_registry_session { /* * With multiple writers and readers, use this lock to access - * the registry. Use defined macros above to lock it. - * Can nest within the ust app session lock. + * the registry. Can nest within the ust app session lock. + * Also acts as a registry serialization lock. Used by registry + * readers to serialize the registry information sent from the + * sessiond to the consumerd. + * The consumer socket lock nests within this lock. */ pthread_mutex_t lock; /* Next channel ID available for a newly registered channel. */ uint32_t next_channel_id; /* Once this value reaches UINT32_MAX, no more id can be allocated. */ uint32_t used_channel_id; + /* Next enumeration ID available. */ + uint64_t next_enum_id; /* Universal unique identifier used by the tracer. */ unsigned char uuid[UUID_LEN]; @@ -62,19 +68,90 @@ 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; + /* - * Hash table containing channels sent by the UST tracer. MUST be accessed - * with a RCU read side lock acquired. + * 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]; + int metadata_fd; /* file-backed metadata FD */ + + /* + * Hash table containing channels sent by the UST tracer. MUST + * be accessed with a RCU read side lock acquired. */ struct lttng_ht *channels; + /* + * Unique key to identify the metadata on the consumer side. + */ + uint64_t metadata_key; + /* + * Indicates if the metadata is closed on the consumer side. This is to + * avoid double close of metadata when an application unregisters AND + * deletes its sessions. + */ + unsigned int metadata_closed; + + /* User and group owning the session. */ + uid_t uid; + gid_t gid; + + /* 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; + /* + * Flag for this channel if the metadata was dumped once during + * registration. 0 means no, 1 yes. + */ + unsigned int metadata_dumped; + /* Indicates if this channel registry has already been registered. */ + unsigned int register_done; + /* * Hash table containing events sent by the UST tracer. MUST be accessed * with a RCU read side lock acquired. @@ -90,8 +167,9 @@ struct ust_registry_channel { */ size_t nr_ctx_fields; struct ustctl_field *ctx_fields; - /* Hash table node for the session ht indexed by key. */ struct lttng_ht_node_u64 node; + /* For delayed reclaim */ + struct rcu_head rcu_head; }; /* @@ -106,15 +184,31 @@ struct ust_registry_event { /* Name of the event returned by the tracer. */ char name[LTTNG_UST_SYM_NAME_LEN]; char *signature; - int loglevel; + int loglevel_value; size_t nr_fields; struct ustctl_field *fields; char *model_emf_uri; + /* + * Flag for this channel if the metadata was dumped once during + * registration. 0 means no, 1 yes. + */ + unsigned int metadata_dumped; /* * Node in the ust-registry hash table. The event name is used to * initialize the node and the event_name/signature for the match function. */ + struct lttng_ht_node_u64 node; +}; + +struct ust_registry_enum { + char name[LTTNG_UST_SYM_NAME_LEN]; + struct ustctl_enum_entry *entries; + size_t nr_entries; + uint64_t id; /* enum id in session */ + /* Enumeration node in session hash table. */ struct lttng_ht_node_str node; + /* For delayed reclaim. */ + struct rcu_head rcu_head; }; /* @@ -176,6 +270,8 @@ static inline uint32_t ust_registry_get_event_count( return (uint32_t) uatomic_read(&r->used_event_id); } +#ifdef HAVE_LIBLTTNG_UST_CTL + void ust_registry_channel_destroy(struct ust_registry_session *session, struct ust_registry_channel *chan); struct ust_registry_channel *ust_registry_channel_find( @@ -183,7 +279,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, @@ -193,13 +289,22 @@ int ust_registry_session_init(struct ust_registry_session **sessionp, uint32_t uint32_t_alignment, uint32_t uint64_t_alignment, uint32_t long_alignment, - int byte_order); + int byte_order, + uint32_t major, + uint32_t minor, + const char *root_shm_path, + const char *shm_path, + uid_t euid, + 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, int loglevel, - char *model_emf_uri, uint32_t *event_id); + 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, struct ust_app *app); struct ust_registry_event *ust_registry_find_event( struct ust_registry_channel *chan, char *name, char *sig); void ust_registry_destroy_event(struct ust_registry_channel *chan, @@ -207,11 +312,122 @@ void ust_registry_destroy_event(struct ust_registry_channel *chan, /* app can be NULL for registry shared across applications. */ int ust_metadata_session_statedump(struct ust_registry_session *session, - struct ust_app *app); + struct ust_app *app, uint32_t major, uint32_t minor); int ust_metadata_channel_statedump(struct ust_registry_session *session, struct ust_registry_channel *chan); int ust_metadata_event_statedump(struct ust_registry_session *session, struct ust_registry_channel *chan, 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, + uint64_t *enum_id); +struct ust_registry_enum * + ust_registry_lookup_enum_by_id(struct ust_registry_session *session, + const char *name, uint64_t id); + +#else /* HAVE_LIBLTTNG_UST_CTL */ + +static inline +void ust_registry_channel_destroy(struct ust_registry_session *session, + struct ust_registry_channel *chan) +{} +static inline +struct ust_registry_channel *ust_registry_channel_find( + struct ust_registry_session *session, uint64_t key) +{ + return NULL; +} +static inline +int ust_registry_channel_add(struct ust_registry_session *session, + uint64_t key) +{ + return 0; +} +static inline +void ust_registry_channel_del_free(struct ust_registry_session *session, + uint64_t key, bool notif) +{} +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, + uint32_t major, + uint32_t minor, + const char *root_shm_path, + const char *shm_path, + uid_t euid, + gid_t egid, + uint64_t tracing_id, + uid_t tracing_uid) +{ + return 0; +} +static inline +void ust_registry_session_destroy(struct ust_registry_session *session) +{} +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) +{ + return 0; +} +static inline +struct ust_registry_event *ust_registry_find_event( + struct ust_registry_channel *chan, char *name, char *sig) +{ + return NULL; +} +static inline +void ust_registry_destroy_event(struct ust_registry_channel *chan, + struct ust_registry_event *event) +{} + +/* 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, uint32_t major, uint32_t minor) +{ + return 0; +} +static inline +int ust_metadata_channel_statedump(struct ust_registry_session *session, + struct ust_registry_channel *chan) +{ + return 0; +} +static inline +int ust_metadata_event_statedump(struct ust_registry_session *session, + struct ust_registry_channel *chan, + struct ust_registry_event *event) +{ + 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) +{ + 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) +{ + return NULL; +} + +#endif /* HAVE_LIBLTTNG_UST_CTL */ #endif /* LTTNG_UST_REGISTRY_H */