2 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 #ifndef LTTNG_SESSIOND_AGENT_H
19 #define LTTNG_SESSIOND_AGENT_H
24 #include <common/hashtable/hashtable.h>
25 #include <lttng/lttng.h>
27 /* Agent protocol version that is verified during the agent registration. */
28 #define AGENT_MAJOR_VERSION 1
29 #define AGENT_MINOR_VERSION 0
32 * Hash table that contains the agent app created upon registration indexed by
33 * socket. Global to the session daemon.
35 extern struct lttng_ht
*agent_apps_ht_by_sock
;
43 * Registration message payload from an agent application. The PID is used to
44 * find back the corresponding UST app object so both socket can be linked.
46 struct agent_register_msg
{
47 /* This maps to a lttng_domain_type. */
50 uint32_t major_version
;
51 uint32_t minor_version
;
55 * Agent application object created after a successful registration. This
56 * object is linked to its associated UST app by their PID through hash table
61 * PID sent during registration of an agent application.
65 /* Domain of the application. */
66 enum lttng_domain_type domain
;
69 * AGENT TCP socket that was created upon registration.
71 struct lttcomm_sock
*sock
;
73 /* Initialized with the AGENT sock value. */
74 struct lttng_ht_node_ulong node
;
78 * Agent event representation.
81 /* Name of the event. */
82 char name
[LTTNG_SYMBOL_NAME_LEN
];
84 enum lttng_loglevel_type loglevel_type
;
87 * Tells if the event is enabled or not on the agent.
89 unsigned int enabled
:1;
91 /* Hash table node of the agent domain object. */
92 struct lttng_ht_node_str node
;
94 /* Filter associated with the event. NULL if none. */
95 struct lttng_filter_bytecode
*filter
;
96 char *filter_expression
;
97 struct lttng_event_exclusion
*exclusion
;
101 * Agent object containing events enabled/disabled for it.
105 * This indicates if that domain is being used meaning if at least one
106 * event has been at some point in time added to it. This is used so when
107 * listing domains for a session, we can tell or not if the agent is
110 unsigned int being_used
:1;
112 /* What domain this agent is. */
113 enum lttng_domain_type domain
;
115 /* Contains event indexed by name. */
116 struct lttng_ht
*events
;
118 /* Node used for the hash table indexed by domain type. */
119 struct lttng_ht_node_u64 node
;
122 /* Allocate agent apps hash table */
123 int agent_app_ht_alloc(void);
124 /* Clean-up agent apps hash table */
125 void agent_app_ht_clean(void);
127 /* Initialize an already allocated agent domain. */
128 int agent_init(struct agent
*agt
);
129 struct agent
*agent_create(enum lttng_domain_type domain
);
130 void agent_destroy(struct agent
*agt
);
131 void agent_add(struct agent
*agt
, struct lttng_ht
*ht
);
133 /* Agent event API. */
134 struct agent_event
*agent_create_event(const char *name
, int loglevel
,
135 enum lttng_loglevel_type loglevel_type
,
136 struct lttng_filter_bytecode
*filter
,
137 char *filter_expression
);
138 void agent_add_event(struct agent_event
*event
, struct agent
*agt
);
140 struct agent_event
*agent_find_event(const char *name
, int loglevel
,
142 struct agent_event
*agent_find_event_by_name(const char *name
,
144 void agent_delete_event(struct agent_event
*event
, struct agent
*agt
);
145 void agent_destroy_event(struct agent_event
*event
);
148 struct agent_app
*agent_create_app(pid_t pid
, enum lttng_domain_type domain
,
149 struct lttcomm_sock
*sock
);
150 void agent_add_app(struct agent_app
*app
);
151 void agent_delete_app(struct agent_app
*app
);
152 struct agent_app
*agent_find_app_by_sock(int sock
);
153 void agent_destroy_app(struct agent_app
*app
);
154 void agent_destroy_app_by_sock(int sock
);
155 int agent_send_registration_done(struct agent_app
*app
);
157 /* Agent action API */
158 int agent_enable_event(struct agent_event
*event
,
159 enum lttng_domain_type domain
);
160 int agent_disable_event(struct agent_event
*event
,
161 enum lttng_domain_type domain
);
162 void agent_update(struct agent
*agt
, int sock
);
163 int agent_list_events(struct lttng_event
**events
,
164 enum lttng_domain_type domain
);
166 #endif /* LTTNG_SESSIOND_AGENT_H */