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         /*
  58          * Associated UST app. socket. To get a reference to the ust application
  59          * object corresponding to that socket, a lookup MUST be done each time
  60          * since there is important synchronization issue for the lockless hash
  61          * table shared accross multiple threads.
  62          */
  63         int ust_app_sock;
  64
  65         /* Initialized with the JUL sock value. */
  66         struct lttng_ht_node_ulong node;
  67 };
  68
  69 /*
  70  * Java Util Logging event representation.
  71  */
  72 struct jul_event {
  73         /*
  74          * Name of the event which is directly mapped to a Logger object name in
  75          * the JUL API.
  76          */
  77         char name[LTTNG_SYMBOL_NAME_LEN];
  78
  79         /*
  80          * Tells if the event is enabled or not on the JUL Agent.
  81          */
  82         unsigned int enabled:1;
  83
  84         /*
  85          * Hash table nodes of the JUL domain. Indexed by name string.
  86          */
  87         struct lttng_ht_node_str node;
  88 };
  89
  90 /*
  91  * Top level data structure in a UST session containing JUL event name created
  92  * for it.
  93  */
  94 struct jul_domain {
  95         /*
  96          * This indicates if that domain is being used meaning if at least one
  97          * event has been at some point in time added to it. This is used so when
  98          * listing domains for a session, we can tell or not if the JUL is actually
  99          * enabled.
 100          */
 101         unsigned int being_used:1;
 102         /*
 103          * Contains JUL event indexed by name.
 104          */
 105         struct lttng_ht *events;
 106 };
 107
 108 /* Initialize JUL domain subsystem. */
 109 int jul_init(void);
 110
 111 /* Initialize an already allocated JUL domain. */
 112 int jul_init_domain(struct jul_domain *dom);
 113 void jul_destroy_domain(struct jul_domain *dom);
 114
 115 /* JUL event API. */
 116 struct jul_event *jul_create_event(const char *name);
 117 void jul_add_event(struct jul_event *event, struct jul_domain *dom);
 118 struct jul_event *jul_find_by_name(const char *name, struct jul_domain *dom);
 119 void jul_delete_event(struct jul_event *event, struct jul_domain *dom);
 120 void jul_destroy_event(struct jul_event *event);
 121
 122 /* JUL app API. */
 123 struct jul_app *jul_create_app(pid_t pid, struct lttcomm_sock *sock);
 124 void jul_add_app(struct jul_app *app);
 125 void jul_delete_app(struct jul_app *app);
 126 struct jul_app *jul_find_app_by_sock(int sock);
 127 void jul_attach_app(struct jul_app *japp);
 128 void jul_detach_app(struct jul_app *app);
 129 void jul_destroy_app(struct jul_app *app);
 130
 131 /* JUL action API */
 132 int jul_enable_event(struct jul_event *event);
 133 int jul_disable_event(struct jul_event *event);
 134 void jul_update(struct jul_domain *domain, int sock);
 135 int jul_list_events(struct lttng_event **events);
 136
 137 #endif /* LTTNG_SESSIOND_JUL_H */