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