Tests: kernel wildcards
[lttng-tools.git] / src / bin / lttng-sessiond / agent.h
CommitLineData
022d91ba
DG
1/*
2 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
3 *
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.
7 *
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
11 * more details.
12 *
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.
16 */
17
18#ifndef LTTNG_SESSIOND_AGENT_H
19#define LTTNG_SESSIOND_AGENT_H
20
21#define _GNU_SOURCE
22#include <inttypes.h>
23
24#include <common/hashtable/hashtable.h>
25#include <lttng/lttng.h>
26
9474416f
DG
27/* Agent protocol version that is verified during the agent registration. */
28#define AGENT_MAJOR_VERSION 1
29#define AGENT_MINOR_VERSION 0
30
022d91ba
DG
31/*
32 * Hash table that contains the agent app created upon registration indexed by
7c1d2758 33 * socket. Global to the session daemon.
022d91ba 34 */
7c1d2758 35extern struct lttng_ht *agent_apps_ht_by_sock;
022d91ba
DG
36
37struct agent_ht_key {
38 const char *name;
39 int loglevel;
40};
41
42/*
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.
45 */
46struct agent_register_msg {
fefd409b
DG
47 /* This maps to a lttng_domain_type. */
48 uint32_t domain;
022d91ba 49 uint32_t pid;
9474416f
DG
50 uint32_t major_version;
51 uint32_t minor_version;
022d91ba
DG
52};
53
54/*
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
57 * lookups.
58 */
59struct agent_app {
60 /*
d53e2992 61 * PID sent during registration of an agent application.
022d91ba
DG
62 */
63 pid_t pid;
64
fefd409b
DG
65 /* Domain of the application. */
66 enum lttng_domain_type domain;
67
022d91ba
DG
68 /*
69 * AGENT TCP socket that was created upon registration.
70 */
71 struct lttcomm_sock *sock;
72
73 /* Initialized with the AGENT sock value. */
74 struct lttng_ht_node_ulong node;
75};
76
77/*
78 * Agent event representation.
79 */
80struct agent_event {
81 /* Name of the event. */
82 char name[LTTNG_SYMBOL_NAME_LEN];
83 int loglevel;
84 enum lttng_loglevel_type loglevel_type;
85
86 /*
87 * Tells if the event is enabled or not on the agent.
88 */
89 unsigned int enabled:1;
90
91 /* Hash table node of the agent domain object. */
92 struct lttng_ht_node_str node;
93
51755dc8 94 /* Filter associated with the event. NULL if none. */
022d91ba 95 struct lttng_filter_bytecode *filter;
51755dc8
JG
96 char *filter_expression;
97 struct lttng_event_exclusion *exclusion;
022d91ba
DG
98};
99
100/*
101 * Agent object containing events enabled/disabled for it.
102 */
103struct agent {
104 /*
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
108 * actually enabled.
109 */
110 unsigned int being_used:1;
fefd409b
DG
111
112 /* What domain this agent is. */
113 enum lttng_domain_type domain;
114
022d91ba
DG
115 /* Contains event indexed by name. */
116 struct lttng_ht *events;
fefd409b
DG
117
118 /* Node used for the hash table indexed by domain type. */
119 struct lttng_ht_node_u64 node;
022d91ba
DG
120};
121
6a4e4039
JG
122/* Allocate agent apps hash table */
123int agent_app_ht_alloc(void);
124/* Clean-up agent apps hash table */
125void agent_app_ht_clean(void);
022d91ba
DG
126
127/* Initialize an already allocated agent domain. */
128int agent_init(struct agent *agt);
fefd409b 129struct agent *agent_create(enum lttng_domain_type domain);
022d91ba 130void agent_destroy(struct agent *agt);
fefd409b 131void agent_add(struct agent *agt, struct lttng_ht *ht);
022d91ba
DG
132
133/* Agent event API. */
51755dc8
JG
134struct 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);
022d91ba
DG
138void agent_add_event(struct agent_event *event, struct agent *agt);
139
140struct agent_event *agent_find_event(const char *name, int loglevel,
141 struct agent *agt);
142struct agent_event *agent_find_event_by_name(const char *name,
143 struct agent *agt);
144void agent_delete_event(struct agent_event *event, struct agent *agt);
145void agent_destroy_event(struct agent_event *event);
146
147/* Agent app API. */
fefd409b
DG
148struct agent_app *agent_create_app(pid_t pid, enum lttng_domain_type domain,
149 struct lttcomm_sock *sock);
022d91ba
DG
150void agent_add_app(struct agent_app *app);
151void agent_delete_app(struct agent_app *app);
152struct agent_app *agent_find_app_by_sock(int sock);
153void agent_destroy_app(struct agent_app *app);
6a4e4039 154void agent_destroy_app_by_sock(int sock);
022d91ba
DG
155int agent_send_registration_done(struct agent_app *app);
156
157/* Agent action API */
fefd409b
DG
158int agent_enable_event(struct agent_event *event,
159 enum lttng_domain_type domain);
160int agent_disable_event(struct agent_event *event,
161 enum lttng_domain_type domain);
022d91ba 162void agent_update(struct agent *agt, int sock);
f60140a1
DG
163int agent_list_events(struct lttng_event **events,
164 enum lttng_domain_type domain);
022d91ba
DG
165
166#endif /* LTTNG_SESSIOND_AGENT_H */
This page took 0.048964 seconds and 4 git commands to generate.