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>
28 * Hash table that contains the agent app created upon registration indexed by
31 struct lttng_ht
*agent_apps_ht_by_sock
;
39 * Registration message payload from an agent application. The PID is used to
40 * find back the corresponding UST app object so both socket can be linked.
42 struct agent_register_msg
{
43 /* This maps to a lttng_domain_type. */
49 * Agent application object created after a successful registration. This
50 * object is linked to its associated UST app by their PID through hash table
55 * PID sent during registration of a AGENT application.
59 /* Domain of the application. */
60 enum lttng_domain_type domain
;
63 * AGENT TCP socket that was created upon registration.
65 struct lttcomm_sock
*sock
;
67 /* Initialized with the AGENT sock value. */
68 struct lttng_ht_node_ulong node
;
72 * Agent event representation.
75 /* Name of the event. */
76 char name
[LTTNG_SYMBOL_NAME_LEN
];
78 enum lttng_loglevel_type loglevel_type
;
81 * Tells if the event is enabled or not on the agent.
83 unsigned int enabled
:1;
85 /* Hash table node of the agent domain object. */
86 struct lttng_ht_node_str node
;
88 /* Bytecode filter associated with the event . NULL if none. */
89 struct lttng_filter_bytecode
*filter
;
93 * Agent object containing events enabled/disabled for it.
97 * This indicates if that domain is being used meaning if at least one
98 * event has been at some point in time added to it. This is used so when
99 * listing domains for a session, we can tell or not if the agent is
102 unsigned int being_used
:1;
104 /* What domain this agent is. */
105 enum lttng_domain_type domain
;
107 /* Contains event indexed by name. */
108 struct lttng_ht
*events
;
110 /* Node used for the hash table indexed by domain type. */
111 struct lttng_ht_node_u64 node
;
114 /* Setup agent subsystem. */
115 int agent_setup(void);
117 /* Initialize an already allocated agent domain. */
118 int agent_init(struct agent
*agt
);
119 struct agent
*agent_create(enum lttng_domain_type domain
);
120 void agent_destroy(struct agent
*agt
);
121 void agent_add(struct agent
*agt
, struct lttng_ht
*ht
);
123 /* Agent event API. */
124 struct agent_event
*agent_create_event(const char *name
,
125 struct lttng_filter_bytecode
*filter
);
126 void agent_add_event(struct agent_event
*event
, struct agent
*agt
);
128 struct agent_event
*agent_find_event(const char *name
, int loglevel
,
130 struct agent_event
*agent_find_event_by_name(const char *name
,
132 void agent_delete_event(struct agent_event
*event
, struct agent
*agt
);
133 void agent_destroy_event(struct agent_event
*event
);
136 struct agent_app
*agent_create_app(pid_t pid
, enum lttng_domain_type domain
,
137 struct lttcomm_sock
*sock
);
138 void agent_add_app(struct agent_app
*app
);
139 void agent_delete_app(struct agent_app
*app
);
140 struct agent_app
*agent_find_app_by_sock(int sock
);
141 void agent_destroy_app(struct agent_app
*app
);
142 int agent_send_registration_done(struct agent_app
*app
);
144 /* Agent action API */
145 int agent_enable_event(struct agent_event
*event
,
146 enum lttng_domain_type domain
);
147 int agent_disable_event(struct agent_event
*event
,
148 enum lttng_domain_type domain
);
149 void agent_update(struct agent
*agt
, int sock
);
150 int agent_list_events(struct lttng_event
**events
,
151 enum lttng_domain_type domain
);
153 #endif /* LTTNG_SESSIOND_AGENT_H */