Use common functions for module loading and unloading
[lttng-tools.git] / src / bin / lttng-sessiond / jul.h
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_JUL_H
19 #define LTTNG_SESSIOND_JUL_H
20
21 #define _GNU_SOURCE
22 #include <inttypes.h>
23
24 #include <common/hashtable/hashtable.h>
25 #include <lttng/lttng.h>
26
27 /*
28 * Hash table that contains the JUL app created upon registration indexed by
29 * socket.
30 */
31 struct lttng_ht *jul_apps_ht_by_sock;
32
33 struct jul_ht_key {
34 const char *name;
35 enum lttng_loglevel_jul loglevel;
36 };
37
38 /*
39 * Registration message payload from a JUL application. The PID is used to find
40 * back the corresponding UST app object so both socket can be linked.
41 */
42 struct jul_register_msg {
43 uint32_t pid;
44 };
45
46 /*
47 * JUL application object created after a successful registration. This
48 * object is linked to its associated UST app by their PID through hash
49 * table lookups.
50 */
51 struct jul_app {
52 /*
53 * PID sent during registration of a JUL application.
54 */
55 pid_t pid;
56
57 /*
58 * JUL TCP socket that was created upon registration.
59 */
60 struct lttcomm_sock *sock;
61
62 /* Initialized with the JUL sock value. */
63 struct lttng_ht_node_ulong node;
64 };
65
66 /*
67 * Java Util Logging event representation.
68 */
69 struct jul_event {
70 /*
71 * Name of the event which is directly mapped to a Logger object name in
72 * the JUL API.
73 */
74 char name[LTTNG_SYMBOL_NAME_LEN];
75 enum lttng_loglevel_jul loglevel;
76 enum lttng_loglevel_type loglevel_type;
77
78 /*
79 * Tells if the event is enabled or not on the JUL Agent.
80 */
81 unsigned int enabled:1;
82
83 /*
84 * Hash table nodes of the JUL domain. Indexed by name string.
85 */
86 struct lttng_ht_node_str node;
87 };
88
89 /*
90 * Top level data structure in a UST session containing JUL event name created
91 * for it.
92 */
93 struct jul_domain {
94 /*
95 * This indicates if that domain is being used meaning if at least one
96 * event has been at some point in time added to it. This is used so when
97 * listing domains for a session, we can tell or not if the JUL is actually
98 * enabled.
99 */
100 unsigned int being_used:1;
101 /*
102 * Contains JUL event indexed by name.
103 */
104 struct lttng_ht *events;
105 };
106
107 /* Initialize JUL domain subsystem. */
108 int jul_init(void);
109
110 /* Initialize an already allocated JUL domain. */
111 int jul_init_domain(struct jul_domain *dom);
112 void jul_destroy_domain(struct jul_domain *dom);
113
114 /* JUL event API. */
115 struct jul_event *jul_create_event(const char *name);
116 void jul_add_event(struct jul_event *event, struct jul_domain *dom);
117 struct jul_event *jul_find_event(const char *name,
118 enum lttng_loglevel_jul loglevel, struct jul_domain *dom);
119 struct jul_event *jul_find_event_by_name(const char *name,
120 struct jul_domain *dom);
121 void jul_delete_event(struct jul_event *event, struct jul_domain *dom);
122 void jul_destroy_event(struct jul_event *event);
123
124 /* JUL app API. */
125 struct jul_app *jul_create_app(pid_t pid, struct lttcomm_sock *sock);
126 void jul_add_app(struct jul_app *app);
127 void jul_delete_app(struct jul_app *app);
128 struct jul_app *jul_find_app_by_sock(int sock);
129 void jul_destroy_app(struct jul_app *app);
130 int jul_send_registration_done(struct jul_app *app);
131
132 /* JUL action API */
133 int jul_enable_event(struct jul_event *event);
134 int jul_disable_event(struct jul_event *event);
135 void jul_update(struct jul_domain *domain, int sock);
136 int jul_list_events(struct lttng_event **events);
137
138 #endif /* LTTNG_SESSIOND_JUL_H */
This page took 0.032371 seconds and 5 git commands to generate.