X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=include%2Fust-comm.h;h=775b6bef391bab94b0a06f31cd53a7d02e2b196c;hb=4e48b5d;hp=49a55d2109e31b6ceca45a8fc09002b2f0e45220;hpb=ebabbf580131acd1fe246c4d31fc5c044d36a038;p=lttng-ust.git diff --git a/include/ust-comm.h b/include/ust-comm.h index 49a55d21..775b6bef 100644 --- a/include/ust-comm.h +++ b/include/ust-comm.h @@ -1,24 +1,9 @@ -#ifndef _LTTNG_UST_COMM_H -#define _LTTNG_UST_COMM_H - /* - * Copyright (C) 2011 - David Goulet - * Julien Desfossez - * Mathieu Desnoyers - * - * 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. + * SPDX-License-Identifier: LGPL-2.1-only * - * This library 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * Copyright (C) 2011 David Goulet + * Copyright (C) 2011 Julien Desfossez + * Copyright (C) 2011 Mathieu Desnoyers */ /* @@ -26,6 +11,9 @@ * These declarations should NOT be considered stable API. */ +#ifndef _LTTNG_UST_COMM_H +#define _LTTNG_UST_COMM_H + #include #include #include @@ -34,17 +22,13 @@ #include #include -#ifndef LTTNG_PACKED -#error "LTTNG_PACKED should be defined" -#endif - /* * Default timeout the application waits for the sessiond to send its * "register done" command. Can be overridden with the environment * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not * found, the application proceeds directly without any delay. */ -#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS +#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000 #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng" @@ -53,11 +37,11 @@ #define LTTNG_UST_COMM_MAX_LISTEN 10 #define LTTNG_UST_COMM_REG_MSG_PADDING 64 -struct lttng_event_field; -struct lttng_ctx_field; -struct lttng_enum_entry; +struct lttng_ust_event_field; +struct lttng_ust_ctx_field; +struct lttng_ust_enum_entry; struct lttng_integer_type; -struct lttng_session; +struct lttng_ust_session; struct ustctl_reg_msg { uint32_t magic; @@ -76,7 +60,7 @@ struct ustctl_reg_msg { uint32_t socket_type; /* enum ustctl_socket_type */ char name[LTTNG_UST_ABI_PROCNAME_LEN]; /* process name */ char padding[LTTNG_UST_COMM_REG_MSG_PADDING]; -} LTTNG_PACKED; +} __attribute__((packed)); /* * Data structure for the commands sent from sessiond to UST. @@ -88,32 +72,40 @@ struct ustcomm_ust_msg { uint32_t cmd; char padding[USTCOMM_MSG_PADDING1]; union { - struct lttng_ust_event_notifier event_notifier; - struct lttng_ust_channel channel; - struct lttng_ust_stream stream; - struct lttng_ust_event event; - struct lttng_ust_context context; - struct lttng_ust_tracer_version version; - struct lttng_ust_tracepoint_iter tracepoint; + struct lttng_ust_abi_channel channel; + struct lttng_ust_abi_stream stream; + struct lttng_ust_abi_event event; + struct lttng_ust_abi_context context; + struct lttng_ust_abi_tracer_version version; + struct lttng_ust_abi_tracepoint_iter tracepoint; struct { uint32_t data_size; /* following filter data */ uint32_t reloc_offset; uint64_t seqnum; - } LTTNG_PACKED filter; + } __attribute__((packed)) filter; struct { uint32_t count; /* how many names follow */ - } LTTNG_PACKED exclusion; + } __attribute__((packed)) exclusion; struct { uint32_t data_size; /* following capture data */ uint32_t reloc_offset; uint64_t seqnum; - } LTTNG_PACKED capture; - struct lttng_ust_counter counter; - struct lttng_ust_counter_global counter_global; - struct lttng_ust_counter_cpu counter_cpu; + } __attribute__((packed)) capture; + struct lttng_ust_abi_counter counter; + struct lttng_ust_abi_counter_global counter_global; + struct lttng_ust_abi_counter_cpu counter_cpu; + /* + * For lttng_ust_abi_EVENT_NOTIFIER_CREATE, a struct + * lttng_ust_abi_event_notifier implicitly follows struct + * ustcomm_ust_msg. + */ + struct { + /* Length of struct lttng_ust_abi_event_notifier */ + uint32_t len; + } event_notifier; char padding[USTCOMM_MSG_PADDING2]; } u; -} LTTNG_PACKED; +} __attribute__((packed)); /* * Data structure for the response from UST to the session daemon. @@ -130,55 +122,55 @@ struct ustcomm_ust_reply { union { struct { uint64_t memory_map_size; - } LTTNG_PACKED channel; + } __attribute__((packed)) channel; struct { uint64_t memory_map_size; - } LTTNG_PACKED stream; - struct lttng_ust_tracer_version version; - struct lttng_ust_tracepoint_iter tracepoint; + } __attribute__((packed)) stream; + struct lttng_ust_abi_tracer_version version; + struct lttng_ust_abi_tracepoint_iter tracepoint; char padding[USTCOMM_REPLY_PADDING2]; } u; -} LTTNG_PACKED; +} __attribute__((packed)); struct ustcomm_notify_hdr { uint32_t notify_cmd; -} LTTNG_PACKED; +} __attribute__((packed)); #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32 struct ustcomm_notify_event_msg { uint32_t session_objd; uint32_t channel_objd; - char event_name[LTTNG_UST_SYM_NAME_LEN]; + char event_name[LTTNG_UST_ABI_SYM_NAME_LEN]; int32_t loglevel; uint32_t signature_len; uint32_t fields_len; uint32_t model_emf_uri_len; char padding[USTCOMM_NOTIFY_EVENT_MSG_PADDING]; /* followed by signature, fields, and model_emf_uri */ -} LTTNG_PACKED; +} __attribute__((packed)); #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32 struct ustcomm_notify_event_reply { int32_t ret_code; /* 0: ok, negative: error code */ uint32_t event_id; char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING]; -} LTTNG_PACKED; +} __attribute__((packed)); #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32 struct ustcomm_notify_enum_msg { uint32_t session_objd; - char enum_name[LTTNG_UST_SYM_NAME_LEN]; + char enum_name[LTTNG_UST_ABI_SYM_NAME_LEN]; uint32_t entries_len; char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING]; /* followed by enum entries */ -} LTTNG_PACKED; +} __attribute__((packed)); #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32 struct ustcomm_notify_enum_reply { int32_t ret_code; /* 0: ok, negative: error code */ uint64_t enum_id; char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING]; -} LTTNG_PACKED; +} __attribute__((packed)); #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32 struct ustcomm_notify_channel_msg { @@ -187,7 +179,7 @@ struct ustcomm_notify_channel_msg { uint32_t ctx_fields_len; char padding[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING]; /* followed by context fields */ -} LTTNG_PACKED; +} __attribute__((packed)); #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32 struct ustcomm_notify_channel_reply { @@ -195,46 +187,79 @@ struct ustcomm_notify_channel_reply { uint32_t chan_id; uint32_t header_type; /* enum ustctl_channel_header */ char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING]; -} LTTNG_PACKED; +} __attribute__((packed)); /* * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a * struct lttng_ust_field_iter field. */ -extern int ustcomm_create_unix_sock(const char *pathname); -extern int ustcomm_connect_unix_sock(const char *pathname, - long timeout); -extern int ustcomm_accept_unix_sock(int sock); -extern int ustcomm_listen_unix_sock(int sock); -extern int ustcomm_close_unix_sock(int sock); - -extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len); -extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len); -extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd); -extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd); - -extern const char *ustcomm_get_readable_code(int code); -extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum); -extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur, - uint32_t expected_handle, uint32_t expected_cmd); -extern int ustcomm_send_app_cmd(int sock, +int ustcomm_create_unix_sock(const char *pathname) + __attribute__((visibility("hidden"))); + +int ustcomm_connect_unix_sock(const char *pathname, + long timeout) + __attribute__((visibility("hidden"))); + +int ustcomm_accept_unix_sock(int sock) + __attribute__((visibility("hidden"))); + +int ustcomm_listen_unix_sock(int sock) + __attribute__((visibility("hidden"))); + +int ustcomm_close_unix_sock(int sock) + __attribute__((visibility("hidden"))); + +ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len) + __attribute__((visibility("hidden"))); + +ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len) + __attribute__((visibility("hidden"))); + +ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd) + __attribute__((visibility("hidden"))); + +ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd) + __attribute__((visibility("hidden"))); + +const char *ustcomm_get_readable_code(int code) + __attribute__((visibility("hidden"))); + +int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum) + __attribute__((visibility("hidden"))); + +int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur, + uint32_t expected_handle, uint32_t expected_cmd) + __attribute__((visibility("hidden"))); + +int ustcomm_send_app_cmd(int sock, struct ustcomm_ust_msg *lum, - struct ustcomm_ust_reply *lur); -int ustcomm_recv_fd(int sock); + struct ustcomm_ust_reply *lur) + __attribute__((visibility("hidden"))); + +int ustcomm_recv_fd(int sock) + __attribute__((visibility("hidden"))); ssize_t ustcomm_recv_channel_from_sessiond(int sock, - void **chan_data, uint64_t len, int *wakeup_fd); + void **chan_data, uint64_t len, int *wakeup_fd) + __attribute__((visibility("hidden"))); + int ustcomm_recv_stream_from_sessiond(int sock, uint64_t *memory_map_size, - int *shm_fd, int *wakeup_fd); + int *shm_fd, int *wakeup_fd) + __attribute__((visibility("hidden"))); + ssize_t ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock, - int *event_notifier_notif_fd); + int *event_notifier_notif_fd) + __attribute__((visibility("hidden"))); ssize_t ustcomm_recv_counter_from_sessiond(int sock, - void **counter_data, uint64_t len); + void **counter_data, uint64_t len) + __attribute__((visibility("hidden"))); + int ustcomm_recv_counter_shm_from_sessiond(int sock, - int *shm_fd); + int *shm_fd) + __attribute__((visibility("hidden"))); /* * Returns 0 on success, negative error value on error. @@ -247,23 +272,25 @@ int ustcomm_send_reg_msg(int sock, uint32_t uint16_t_alignment, uint32_t uint32_t_alignment, uint32_t uint64_t_alignment, - uint32_t long_alignment); + uint32_t long_alignment) + __attribute__((visibility("hidden"))); /* * Returns 0 on success, negative error value on error. * Returns -EPIPE or -ECONNRESET if other end has hung up. */ int ustcomm_register_event(int sock, - struct lttng_session *session, + struct lttng_ust_session *session, int session_objd, /* session descriptor */ int channel_objd, /* channel descriptor */ const char *event_name, /* event name (input) */ int loglevel, const char *signature, /* event signature (input) */ size_t nr_fields, /* fields */ - const struct lttng_event_field *fields, + const struct lttng_ust_event_field **fields, const char *model_emf_uri, - uint32_t *id); /* event id (output) */ + uint32_t *id) /* event id (output) */ + __attribute__((visibility("hidden"))); /* * Returns 0 on success, negative error value on error. @@ -273,23 +300,28 @@ int ustcomm_register_enum(int sock, int session_objd, /* session descriptor */ const char *enum_name, /* enum name (input) */ size_t nr_entries, /* entries */ - const struct lttng_enum_entry *entries, - uint64_t *id); /* enum id (output) */ + const struct lttng_ust_enum_entry **entries, + uint64_t *id) /* enum id (output) */ + __attribute__((visibility("hidden"))); /* * Returns 0 on success, negative error value on error. * Returns -EPIPE or -ECONNRESET if other end has hung up. */ int ustcomm_register_channel(int sock, - struct lttng_session *session, + struct lttng_ust_session *session, int session_objd, /* session descriptor */ int channel_objd, /* channel descriptor */ size_t nr_ctx_fields, - const struct lttng_ctx_field *ctx_fields, + struct lttng_ust_ctx_field *ctx_fields, uint32_t *chan_id, /* channel id (output) */ - int *header_type); /* header type (output) */ + int *header_type) /* header type (output) */ + __attribute__((visibility("hidden"))); + +int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec) + __attribute__((visibility("hidden"))); -int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec); -int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec); +int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec) + __attribute__((visibility("hidden"))); #endif /* _LTTNG_UST_COMM_H */