Add support for auto session creation
[lttng-tools.git] / liblttsessiondcomm / liblttsessiondcomm.h
CommitLineData
fac6795d
DG
1/* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
2 *
3 * This program is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU General Public License
5 * as published by the Free Software Foundation; either version 2
6 * of the License, or (at your option) any later version.
7 *
8 * This program 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
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
16 *
17 */
18
19#ifndef _LIBLTTSESSIONDCOMM_H
20#define _LIBLTTSESSIONDCOMM_H
21
22#include <limits.h>
23#include <uuid/uuid.h>
24
25/* Default unix socket path */
26#define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK "/tmp/client-ltt-sessiond"
27#define DEFAULT_GLOBAL_APPS_UNIX_SOCK "/tmp/apps-ltt-sessiond"
28#define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
29#define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
30
31/* Queue size of listen(2) */
32#define MAX_LISTEN 10
33
fac6795d
DG
34/* Get the error code index from 0 since
35 * LTTCOMM_OK start at 1000
36 */
686204ab 37#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d
DG
38
39enum lttcomm_command_type {
40 LTTNG_CREATE_SESSION,
41 LTTNG_DESTROY_SESSION,
42 LTTNG_FORCE_SUBBUF_SWITCH,
43 LTTNG_GET_ALL_SESSION,
44 LTTNG_GET_SOCK_PATH,
45 LTTNG_GET_SUBBUF_NUM_SIZE,
46 LTTNG_LIST_MARKERS,
47 LTTNG_LIST_SESSIONS,
1657e9bb 48 LTTNG_LIST_TRACES,
fac6795d
DG
49 LTTNG_LIST_TRACE_EVENTS,
50 LTTNG_SETUP_TRACE,
51 LTTNG_SET_SOCK_PATH,
52 LTTNG_SET_SUBBUF_NUM,
53 LTTNG_SET_SUBBUF_SIZE,
54 UST_ALLOC_TRACE,
55 UST_CREATE_TRACE,
56 UST_DESTROY_TRACE,
57 UST_DISABLE_MARKER,
58 UST_ENABLE_MARKER,
59 UST_LIST_APPS,
60 UST_START_TRACE,
61 UST_STOP_TRACE,
62};
63
64/*
65 * lttcomm error code.
66 */
67enum lttcomm_return_code {
68 LTTCOMM_OK = 1000, /* Ok */
69 LTTCOMM_ERR, /* Unknown Error */
70 LTTCOMM_UND, /* Undefine command */
71 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
72 LTTCOMM_NO_SESSION, /* No session found */
73 LTTCOMM_CREATE_FAIL, /* Create trace fail */
74 LTTCOMM_SESSION_FAIL, /* Create session fail */
75 LTTCOMM_START_FAIL, /* Start tracing fail */
520ff687 76 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
fac6795d 77 LTTCOMM_LIST_FAIL, /* Listing apps fail */
e065084a 78 LTTCOMM_NO_APPS, /* No traceable application */
57167058 79 LTTCOMM_NO_SESS, /* No sessions available */
ce3d728c 80 LTTCOMM_NO_TRACE, /* No trace exist */
ca95a216 81 LTTCOMM_FATAL, /* Session daemon had a fatal error */
379473d2
DG
82 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
83 LTTCOMM_SELECT_SESS, /* Must select a session */
27673bb6 84 LTTCOMM_EXIST_SESS, /* Session name already exist */
fac6795d
DG
85 LTTCOMM_NR, /* Last element */
86};
87
88/*
89 * Data structure for ltt-session received message
90 */
91struct lttcomm_session_msg {
92 /* Common data to almost all command */
93 enum lttcomm_command_type cmd_type;
8028d920 94 uuid_t session_id;
fac6795d
DG
95 char trace_name[NAME_MAX];
96 char session_name[NAME_MAX];
97 pid_t pid;
98 union {
99 struct {
100 int auto_session;
101 } create_session;
102 /* Marker data */
103 struct {
104 char channel[NAME_MAX];
105 char marker[NAME_MAX];
106 } marker;
107 /* SET_SOCK_PATH */
108 struct {
109 char sock_path[PATH_MAX];
110 } sock_path;
111 /* SET_SUBBUF_NUM */
112 struct {
113 unsigned int subbuf_num;
114 char channel[NAME_MAX];
115 } subbuf_num;
116 /* SET_SUBBUF_SIZE */
117 struct {
118 unsigned int subbuf_size;
119 char channel[NAME_MAX];
120 } subbuf_size;
121 } u;
122};
123
124/*
ca95a216
DG
125 * Data structure for the lttng client response.
126 *
127 * This data structure is the control struct use in
128 * the header of the transmission. NEVER put variable
129 * size data in here.
fac6795d
DG
130 */
131struct lttcomm_lttng_msg {
132 enum lttcomm_command_type cmd_type;
133 enum lttcomm_return_code ret_code;
8028d920 134 uuid_t session_id;
fac6795d
DG
135 pid_t pid;
136 char trace_name[NAME_MAX];
ca95a216 137 unsigned int size_payload;
fac6795d
DG
138};
139
140extern int lttcomm_create_unix_sock(const char *pathname);
141extern int lttcomm_connect_unix_sock(const char *pathname);
142extern int lttcomm_accept_unix_sock(int sock);
143extern int lttcomm_listen_unix_sock(int sock);
87378cf5 144extern int lttcomm_close_unix_sock(int sock);
fac6795d
DG
145extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
146extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
147extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
148
149#endif /* _LIBLTTSESSIONDCOMM_H */
This page took 0.045951 seconds and 4 git commands to generate.