Commit | Line | Data |
---|---|---|
b35d179d MD |
1 | #ifndef _LTTNG_UST_COMM_H |
2 | #define _LTTNG_UST_COMM_H | |
67c5b804 MD |
3 | |
4 | /* | |
5 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
6 | * Julien Desfossez <julien.desfossez@polymtl.ca> | |
7 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
8 | * | |
15f672f9 MD |
9 | * This library is free software; you can redistribute it and/or |
10 | * modify it under the terms of the GNU Lesser General Public | |
11 | * License as published by the Free Software Foundation; only | |
12 | * version 2.1 of the License. | |
13 | * | |
14 | * This library is distributed in the hope that it will be useful, | |
67c5b804 | 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
15f672f9 MD |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
17 | * Lesser General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU Lesser General Public | |
20 | * License along with this library; if not, write to the Free Software | |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
67c5b804 MD |
22 | */ |
23 | ||
24 | /* | |
25 | * This header is meant for liblttng and libust internal use ONLY. | |
26 | * These declarations should NOT be considered stable API. | |
27 | */ | |
28 | ||
29 | #include <limits.h> | |
57773204 | 30 | #include <unistd.h> |
4318ae1b | 31 | #include <lttng/ust-abi.h> |
7bc53e94 | 32 | #include <lttng/ust-error.h> |
67c5b804 | 33 | |
11ff9c7d | 34 | /* |
cf12a773 MD |
35 | * Default timeout the application waits for the sessiond to send its |
36 | * "register done" command. Can be overridden with the environment | |
69400ac4 | 37 | * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not |
cf12a773 | 38 | * found, the application proceeds directly without any delay. |
11ff9c7d | 39 | */ |
cf12a773 | 40 | #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS 3000 |
11ff9c7d | 41 | |
67c5b804 | 42 | #define LTTNG_RUNDIR "/var/run/lttng" |
6a47c1fb | 43 | #define LTTNG_HOME_RUNDIR "%s/.lttng" |
67c5b804 MD |
44 | |
45 | /* Default unix socket path */ | |
8d1dae7c MD |
46 | #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-lttng-sessiond" |
47 | #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-lttng-sessiond" | |
6a47c1fb DG |
48 | #define DEFAULT_HOME_APPS_UNIX_SOCK LTTNG_HOME_RUNDIR "/apps-lttng-sessiond" |
49 | #define DEFAULT_HOME_CLIENT_UNIX_SOCK LTTNG_HOME_RUNDIR "/client-lttng-sessiond" | |
67c5b804 | 50 | |
7fc90dca | 51 | #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait" |
58d4b2a2 | 52 | #define DEFAULT_HOME_APPS_WAIT_SHM_PATH "/lttng-ust-apps-wait-%u" |
7fc90dca | 53 | |
67c5b804 | 54 | /* Queue size of listen(2) */ |
e41474be | 55 | #define LTTNG_UST_COMM_MAX_LISTEN 10 |
67c5b804 | 56 | |
67c5b804 | 57 | /* |
e7723462 | 58 | * Data structure for the commands sent from sessiond to UST. |
67c5b804 | 59 | */ |
57773204 | 60 | struct ustcomm_ust_msg { |
1ece9766 | 61 | uint32_t handle; |
46050b1a | 62 | uint32_t cmd; |
67c5b804 | 63 | union { |
1ece9766 | 64 | struct lttng_ust_channel channel; |
381c0f1e | 65 | struct lttng_ust_stream stream; |
1ece9766 MD |
66 | struct lttng_ust_event event; |
67 | struct lttng_ust_context context; | |
57773204 | 68 | struct lttng_ust_tracer_version version; |
cbef6901 | 69 | struct lttng_ust_tracepoint_iter tracepoint; |
2d78951a | 70 | struct { |
2734ca65 CB |
71 | uint32_t data_size; /* following filter data */ |
72 | uint32_t reloc_offset; | |
3f6fd224 | 73 | uint64_t seqnum; |
2d78951a | 74 | } filter; |
67c5b804 MD |
75 | } u; |
76 | }; | |
77 | ||
9eb62b9c MD |
78 | /* |
79 | * Data structure for the response from UST to the session daemon. | |
80 | * cmd_type is sent back in the reply for validation. | |
81 | */ | |
57773204 | 82 | struct ustcomm_ust_reply { |
46050b1a MD |
83 | uint32_t handle; |
84 | uint32_t cmd; | |
57773204 | 85 | uint32_t ret_code; /* enum enum ustcomm_return_code */ |
1ece9766 | 86 | uint32_t ret_val; /* return value */ |
9eb62b9c | 87 | union { |
193183fb MD |
88 | struct { |
89 | uint64_t memory_map_size; | |
90 | } channel; | |
381c0f1e MD |
91 | struct { |
92 | uint64_t memory_map_size; | |
93 | } stream; | |
57773204 | 94 | struct lttng_ust_tracer_version version; |
cbef6901 | 95 | struct lttng_ust_tracepoint_iter tracepoint; |
9eb62b9c MD |
96 | } u; |
97 | }; | |
98 | ||
40003310 MD |
99 | /* |
100 | * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a | |
101 | * struct lttng_ust_field_iter field. | |
102 | */ | |
103 | ||
57773204 MD |
104 | extern int ustcomm_create_unix_sock(const char *pathname); |
105 | extern int ustcomm_connect_unix_sock(const char *pathname); | |
106 | extern int ustcomm_accept_unix_sock(int sock); | |
107 | extern int ustcomm_listen_unix_sock(int sock); | |
108 | extern int ustcomm_close_unix_sock(int sock); | |
67c5b804 | 109 | /* Send fd(s) over a unix socket. */ |
57773204 | 110 | extern ssize_t ustcomm_send_fds_unix_sock(int sock, void *buf, int *fds, |
67c5b804 | 111 | size_t nb_fd, size_t len); |
57773204 MD |
112 | extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len); |
113 | extern ssize_t ustcomm_send_unix_sock(int sock, void *buf, size_t len); | |
114 | extern const char *ustcomm_get_readable_code(int code); | |
115 | extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum); | |
116 | extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur, | |
117 | uint32_t expected_handle, uint32_t expected_cmd); | |
118 | extern int ustcomm_send_app_cmd(int sock, | |
119 | struct ustcomm_ust_msg *lum, | |
120 | struct ustcomm_ust_reply *lur); | |
121 | int ustcomm_recv_fd(int sock); | |
67c5b804 | 122 | |
b35d179d | 123 | #endif /* _LTTNG_UST_COMM_H */ |