1 /* Copyright (C) 2009 Pierre-Marc Fournier
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #include <sys/types.h>
23 #include <urcu/list.h>
25 #include <ust/kcompat/kcompat.h>
27 #define SOCK_DIR "/tmp/ust-app-socks"
28 #define USER_TMP_DIR "/tmp"
29 #define USER_SOCK_DIR_BASE "ust-socks-"
30 #define USER_SOCK_DIR USER_TMP_DIR "/" USER_SOCK_DIR_BASE
33 struct cds_list_head list
;
38 struct ustcomm_header
{
45 #define USTCOMM_BUFFER_SIZE ((1 << 12) - sizeof(struct ustcomm_header))
47 /* Specify a sata size that leaves margin at the end of a buffer
48 * in order to make sure that we never have more data than
49 * will fit in the buffer AND that the last chars (due to a
50 * pre-receive memset) will always be 0, terminating any string
52 #define USTCOMM_DATA_SIZE (USTCOMM_BUFFER_SIZE - 20 * sizeof(void *))
54 enum tracectl_commands
{
63 GET_BUF_SHMID_PIPE_FD
,
84 struct ustcomm_single_field
{
86 char data
[USTCOMM_DATA_SIZE
];
89 struct ustcomm_channel_info
{
92 unsigned int subbuf_size
;
93 unsigned int subbuf_num
;
94 char data
[USTCOMM_DATA_SIZE
];
97 struct ustcomm_buffer_info
{
103 int buf_struct_shmid
;
105 char data
[USTCOMM_DATA_SIZE
];
108 struct ustcomm_ust_marker_info
{
112 char data
[USTCOMM_DATA_SIZE
];
115 struct ustcomm_pidunique
{
119 struct ustcomm_notify_buf_mapped
{
120 char data
[USTCOMM_DATA_SIZE
];
123 /* Ensure directory existence, usefull for unix sockets */
124 extern int ensure_dir_exists(const char *dir
, mode_t mode
);
126 /* Create and delete sockets */
127 extern struct ustcomm_sock
* ustcomm_init_sock(int fd
, int epoll_fd
,
128 struct cds_list_head
*list
);
129 extern void ustcomm_del_sock(struct ustcomm_sock
*sock
, int keep_in_epoll
);
131 /* Create and delete named sockets */
132 extern struct ustcomm_sock
* ustcomm_init_named_socket(const char *name
,
134 extern void ustcomm_del_named_sock(struct ustcomm_sock
*sock
,
135 int keep_socket_file
);
137 /* Send and receive functions for file descriptors */
138 extern int ustcomm_send_fd(int sock
, const struct ustcomm_header
*header
,
139 const char *data
, int *fd
);
140 extern int ustcomm_recv_fd(int sock
, struct ustcomm_header
*header
,
141 char *data
, int *fd
);
143 /* Normal send and receive functions */
144 extern int ustcomm_send(int sock
, const struct ustcomm_header
*header
,
146 extern int ustcomm_recv(int sock
, struct ustcomm_header
*header
,
149 /* Receive and allocate data, not to be used inside libust */
150 extern int ustcomm_recv_alloc(int sock
,
151 struct ustcomm_header
*header
,
154 /* Request function, send and receive */
155 extern int ustcomm_req(int sock
,
156 const struct ustcomm_header
*req_header
,
157 const char *req_data
,
158 struct ustcomm_header
*res_header
,
161 extern int ustcomm_request_consumer(pid_t pid
, const char *channel
);
163 /* Returns the current users socket directory, must be freed */
164 extern char *ustcomm_user_sock_dir(void);
166 /* Get the st_m_time from proc*/
167 extern time_t ustcomm_pid_st_mtime(pid_t pid
);
169 /* Check that a socket is live */
170 extern int ustcomm_is_socket_live(char *sock_name
, pid_t
*read_pid
);
172 extern int ustcomm_connect_app(pid_t pid
, int *app_fd
);
173 extern int ustcomm_connect_path(const char *path
, int *connection_fd
);
175 extern int nth_token_is(const char *str
, const char *token
, int tok_no
);
177 extern char *nth_token(const char *str
, int tok_no
);
179 /* String serialising functions, printf straight into a buffer */
180 #define USTCOMM_POISON_PTR (void *)0x19831018
182 extern char * ustcomm_print_data(char *data_field
, int field_size
,
183 int *offset
, const char *format
, ...);
184 extern char * ustcomm_restore_ptr(char *ptr
, char *data_field
,
185 int data_field_size
);
187 #define COMPUTE_MSG_SIZE(struct_ptr, offset) \
188 (size_t) (long)(struct_ptr)->data - (long)(struct_ptr) + (offset)
190 /* Packing and unpacking functions, making life easier */
191 extern int ustcomm_pack_single_field(struct ustcomm_header
*header
,
192 struct ustcomm_single_field
*sf
,
195 extern int ustcomm_unpack_single_field(struct ustcomm_single_field
*sf
);
197 extern int ustcomm_pack_channel_info(struct ustcomm_header
*header
,
198 struct ustcomm_channel_info
*ch_inf
,
200 const char *channel
);
202 extern int ustcomm_unpack_channel_info(struct ustcomm_channel_info
*ch_inf
);
204 extern int ustcomm_pack_buffer_info(struct ustcomm_header
*header
,
205 struct ustcomm_buffer_info
*buf_inf
,
210 extern int ustcomm_unpack_buffer_info(struct ustcomm_buffer_info
*buf_inf
);
212 extern int ustcomm_pack_ust_marker_info(struct ustcomm_header
*header
,
213 struct ustcomm_ust_marker_info
*ust_marker_inf
,
216 const char *ust_marker
);
218 extern int ustcomm_unpack_ust_marker_info(struct ustcomm_ust_marker_info
*ust_marker_inf
);
220 #endif /* USTCOMM_H */