Fix: Clear tracked application contexts upon closing a Java agent
[lttng-ust.git] / liblttng-ust-java-agent / java / lttng-ust-agent-common / org / lttng / ust / agent / AbstractLttngAgent.java
index 4e6d4af011f3e976c7799ec714b8b2130386cfe0..f8ad187bd99ce5e204a1a8d37dc4fb1fbb289936 100644 (file)
@@ -18,9 +18,8 @@
 
 package org.lttng.ust.agent;
 
+import java.util.Collection;
 import java.util.HashSet;
-import java.util.LinkedList;
-import java.util.List;
 import java.util.Map;
 import java.util.NavigableMap;
 import java.util.Set;
@@ -28,7 +27,10 @@ import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentSkipListMap;
 import java.util.concurrent.atomic.AtomicInteger;
 
+import org.lttng.ust.agent.client.ILttngTcpClientListener;
 import org.lttng.ust.agent.client.LttngTcpSessiondClient;
+import org.lttng.ust.agent.filter.FilterChangeNotifier;
+import org.lttng.ust.agent.session.EventRule;
 
 /**
  * Base implementation of a {@link ILttngAgent}.
@@ -37,7 +39,8 @@ import org.lttng.ust.agent.client.LttngTcpSessiondClient;
  * @param <T>
  *            The type of logging handler that should register to this agent
  */
-public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILttngAgent<T> {
+public abstract class AbstractLttngAgent<T extends ILttngHandler>
+               implements ILttngAgent<T>, ILttngTcpClientListener {
 
        private static final String WILDCARD = "*";
        private static final int INIT_TIMEOUT = 3; /* Seconds */
@@ -53,7 +56,7 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
         * falls to 0, this means we can avoid sending log events through JNI
         * because nobody wants them.
         *
-        * It uses a concurrent hash set", so that the {@link #isEventEnabled} and
+        * It uses a concurrent hash map, so that the {@link #isEventEnabled} and
         * read methods do not need to take a synchronization lock.
         */
        private final Map<String, Integer> enabledEvents = new ConcurrentHashMap<String, Integer>();
@@ -72,6 +75,19 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
        /** Number of sessions currently enabling the wildcard "*" event */
        private final AtomicInteger enabledWildcards = new AtomicInteger(0);
 
+       /**
+        * The application contexts currently enabled in the tracing sessions.
+        *
+        * It is first indexed by context retriever, then by context name. This
+        * allows to efficiently query all the contexts for a given retriever.
+        *
+        * Works similarly as {@link #enabledEvents}, but for app contexts (and with
+        * an extra degree of indexing).
+        *
+        * TODO Could be changed to a Guava Table once/if we start using it.
+        */
+       private final Map<String, Map<String, Integer>> enabledAppContexts = new ConcurrentHashMap<String, Map<String, Integer>>();
+
        /** Tracing domain. Defined by the sub-classes via the constructor. */
        private final Domain domain;
 
@@ -134,14 +150,14 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
                }
                String rootClientThreadName = "Root sessiond client started by agent: " + this.getClass().getSimpleName();
 
-               rootSessiondClient = new LttngTcpSessiondClient(this, true);
+               rootSessiondClient = new LttngTcpSessiondClient(this, getDomain().value(), true);
                rootSessiondClientThread = new Thread(rootSessiondClient, rootClientThreadName);
                rootSessiondClientThread.setDaemon(true);
                rootSessiondClientThread.start();
 
                String userClientThreadName = "User sessiond client started by agent: " + this.getClass().getSimpleName();
 
-               userSessiondClient = new LttngTcpSessiondClient(this, false);
+               userSessiondClient = new LttngTcpSessiondClient(this, getDomain().value(), false);
                userSessiondClientThread = new Thread(userSessiondClient, userClientThreadName);
                userSessiondClientThread.setDaemon(true);
                userSessiondClientThread.start();
@@ -182,44 +198,36 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
                enabledEventPrefixes.clear();
                enabledWildcards.set(0);
 
-               initialized = false;
+               enabledAppContexts.clear();
 
+               initialized = false;
        }
 
-       /**
-        * Callback for the TCP clients to notify the agent that a request for
-        * enabling an event was sent from the session daemon.
-        *
-        * @param eventName
-        *            The name of the event that was requested to be enabled.
-        * @return Since we do not track individual sessions, right now this command
-        *         cannot fail. It will always return true.
-        */
-       public boolean eventEnabled(String eventName) {
+       @Override
+       public boolean eventEnabled(EventRule eventRule) {
+               /* Notify the filter change manager of the command */
+               FilterChangeNotifier.getInstance().addEventRule(eventRule);
+
+               String eventName = eventRule.getEventName();
+
                if (eventName.equals(WILDCARD)) {
                        enabledWildcards.incrementAndGet();
                        return true;
                }
-
                if (eventName.endsWith(WILDCARD)) {
                        /* Strip the "*" from the name. */
                        String prefix = eventName.substring(0, eventName.length() - 1);
-                       return incrementEventCount(prefix, enabledEventPrefixes);
+                       return incrementRefCount(prefix, enabledEventPrefixes);
                }
 
-               return incrementEventCount(eventName, enabledEvents);
+               return incrementRefCount(eventName, enabledEvents);
        }
 
-       /**
-        * Callback for the TCP clients to notify the agent that a request for
-        * disabling an event was sent from the session daemon.
-        *
-        * @param eventName
-        *            The name of the event that was requested to be disabled.
-        * @return True if the command completed successfully, false if we should
-        *         report an error (event was not enabled, etc.)
-        */
+       @Override
        public boolean eventDisabled(String eventName) {
+               /* Notify the filter change manager of the command */
+               FilterChangeNotifier.getInstance().removeEventRules(eventName);
+
                if (eventName.equals(WILDCARD)) {
                        int newCount = enabledWildcards.decrementAndGet();
                        if (newCount < 0) {
@@ -227,17 +235,58 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
                                enabledWildcards.incrementAndGet();
                                return false;
                        }
+                       return true;
                }
 
                if (eventName.endsWith(WILDCARD)) {
                        /* Strip the "*" from the name. */
                        String prefix = eventName.substring(0, eventName.length() - 1);
-                       return decrementEventCount(prefix, enabledEventPrefixes);
+                       return decrementRefCount(prefix, enabledEventPrefixes);
+               }
+
+               return decrementRefCount(eventName, enabledEvents);
+       }
+
+       @Override
+       public boolean appContextEnabled(String contextRetrieverName, String contextName) {
+               synchronized (enabledAppContexts) {
+                       Map<String, Integer> retrieverMap = enabledAppContexts.get(contextRetrieverName);
+                       if (retrieverMap == null) {
+                               /* There is no submap for this retriever, let's create one. */
+                               retrieverMap = new ConcurrentHashMap<String, Integer>();
+                               enabledAppContexts.put(contextRetrieverName, retrieverMap);
+                       }
+
+                       return incrementRefCount(contextName, retrieverMap);
                }
+       }
+
+       @Override
+       public boolean appContextDisabled(String contextRetrieverName, String contextName) {
+               synchronized (enabledAppContexts) {
+                       Map<String, Integer> retrieverMap = enabledAppContexts.get(contextRetrieverName);
+                       if (retrieverMap == null) {
+                               /* There was no submap for this retriever, invalid command? */
+                               return false;
+                       }
 
-               return decrementEventCount(eventName, enabledEvents);
+                       boolean ret = decrementRefCount(contextName, retrieverMap);
+
+                       /* If the submap is now empty we can remove it from the main map. */
+                       if (retrieverMap.isEmpty()) {
+                               enabledAppContexts.remove(contextRetrieverName);
+                       }
+
+                       return ret;
+               }
        }
 
+       /*
+        * Implementation of this method is domain-specific.
+        */
+       @Override
+       public abstract Collection<String> listAvailableEvents();
+
        @Override
        public boolean isEventEnabled(String eventName) {
                /* If at least one session enabled the "*" wildcard, send the event */
@@ -260,25 +309,16 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
        }
 
        @Override
-       public Iterable<String> listEnabledEvents() {
-               List<String> events = new LinkedList<String>();
-
-               if (enabledWildcards.get() > 0) {
-                       events.add(WILDCARD);
-               }
-               for (String prefix : enabledEventPrefixes.keySet()) {
-                       events.add(new String(prefix + WILDCARD));
-               }
-               events.addAll(enabledEvents.keySet());
-               return events;
+       public Collection<Map.Entry<String, Map<String, Integer>>> getEnabledAppContexts() {
+               return enabledAppContexts.entrySet();
        }
 
-       private static boolean incrementEventCount(String eventName, Map<String, Integer> eventMap) {
-               synchronized (eventMap) {
-                       Integer count = eventMap.get(eventName);
+       private static boolean incrementRefCount(String key, Map<String, Integer> refCountMap) {
+               synchronized (refCountMap) {
+                       Integer count = refCountMap.get(key);
                        if (count == null) {
                                /* This is the first instance of this event being enabled */
-                               eventMap.put(eventName, Integer.valueOf(1));
+                               refCountMap.put(key, Integer.valueOf(1));
                                return true;
                        }
                        if (count.intValue() <= 0) {
@@ -286,14 +326,14 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
                                throw new IllegalStateException();
                        }
                        /* The event was already enabled, increment its refcount */
-                       eventMap.put(eventName, Integer.valueOf(count.intValue() + 1));
+                       refCountMap.put(key, Integer.valueOf(count.intValue() + 1));
                        return true;
                }
        }
 
-       private static boolean decrementEventCount(String eventName, Map<String, Integer> eventMap) {
-               synchronized (eventMap) {
-                       Integer count = eventMap.get(eventName);
+       private static boolean decrementRefCount(String key, Map<String, Integer> refCountMap) {
+               synchronized (refCountMap) {
+                       Integer count = refCountMap.get(key);
                        if (count == null || count.intValue() <= 0) {
                                /*
                                 * The sessiond asked us to disable an event that was not
@@ -306,14 +346,14 @@ public abstract class AbstractLttngAgent<T extends ILttngHandler> implements ILt
                                 * This is the last instance of this event being disabled,
                                 * remove it from the map so that we stop sending it.
                                 */
-                               eventMap.remove(eventName);
+                               refCountMap.remove(key);
                                return true;
                        }
                        /*
                         * Other sessions are still looking for this event, simply decrement
                         * its refcount.
                         */
-                       eventMap.put(eventName, Integer.valueOf(count.intValue() - 1));
+                       refCountMap.put(key, Integer.valueOf(count.intValue() - 1));
                        return true;
                }
        }
This page took 0.027585 seconds and 4 git commands to generate.