1 package org.simantics.db.impl.query;
3 import java.io.BufferedOutputStream;
5 import java.io.FileOutputStream;
6 import java.io.IOException;
7 import java.io.PrintStream;
8 import java.util.ArrayList;
9 import java.util.Collection;
10 import java.util.Collections;
11 import java.util.HashMap;
12 import java.util.HashSet;
13 import java.util.LinkedList;
14 import java.util.List;
17 import java.util.concurrent.BlockingQueue;
18 import java.util.concurrent.LinkedBlockingQueue;
19 import java.util.concurrent.Semaphore;
21 import org.simantics.databoard.Bindings;
22 import org.simantics.db.DevelopmentKeys;
23 import org.simantics.db.debug.ListenerReport;
24 import org.simantics.db.exception.DatabaseException;
25 import org.simantics.db.impl.graph.ReadGraphImpl;
26 import org.simantics.db.impl.graph.WriteGraphImpl;
27 import org.simantics.db.procedure.ListenerBase;
28 import org.simantics.utils.Development;
29 import org.simantics.utils.datastructures.Pair;
30 import org.simantics.utils.datastructures.collections.CollectionUtils;
31 import org.slf4j.LoggerFactory;
33 import gnu.trove.map.hash.THashMap;
34 import gnu.trove.set.hash.THashSet;
36 public class QueryListening {
38 private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(QueryListening.class);
40 final private QueryProcessor processor;
41 private THashSet<ListenerEntry> scheduledListeners = new THashSet<ListenerEntry>();
42 private boolean firingListeners = false;
43 final THashMap<CacheEntry, ArrayList<ListenerEntry>> listeners = new THashMap<CacheEntry, ArrayList<ListenerEntry>>(10, 0.75f);
44 private BlockingQueue<Runnable> tasks = new LinkedBlockingQueue<Runnable>();
45 private Map<ListenerBase,ListenerEntry> addedEntries = new HashMap<>();
47 QueryListening(QueryProcessor processor) {
48 this.processor = processor;
49 new DependencyManagementThread(processor, tasks).start();
53 Semaphore s = new Semaphore(0);
59 } catch (Throwable t) {
60 LOGGER.error("Error while waiting for query dependency management", t);
64 static class DependencyManagementThread extends Thread {
66 final private QueryProcessor processor;
67 final BlockingQueue<Runnable> tasks;
69 DependencyManagementThread(QueryProcessor processor, BlockingQueue<Runnable> tasks) {
70 setName("Query Dependency Manager");
71 this.processor = processor;
77 while(processor.isAlive()) {
79 Runnable r = tasks.take();
81 } catch (Throwable t) {
83 LOGGER.error("Error while waiting for query dependency management tasks", t);
90 public boolean hasScheduledUpdates() {
91 return !scheduledListeners.isEmpty();
94 void registerDependencies(ReadGraphImpl graph, CacheEntry child, CacheEntry parent, ListenerBase listener, Object procedure, boolean inferred) {
98 if (parent != null && !inferred) {
100 if(!child.isImmutable(graph))
101 child.addParent(parent);
102 } catch (DatabaseException e) {
103 LOGGER.error("Error while registering query dependencies", e);
105 if (Development.DEVELOPMENT) {
106 if(Development.<Boolean>getProperty(DevelopmentKeys.QUERYPROCESSOR_DEPENDENCIES, Bindings.BOOLEAN)) {
107 System.out.println(child + " -> " + parent);
112 if (listener != null)
113 registerListener(child, listener, procedure);
119 void registerFirstKnown(ListenerBase base, Object result) {
123 ListenerEntry entry = addedEntries.get(base);
124 if(entry != null) entry.setLastKnown(result);
130 public ListenerEntry registerListener(final CacheEntry entry, final ListenerBase base, final Object procedure) {
132 assert (entry != null);
134 if (base.isDisposed())
137 return addListener(entry, base, procedure);
142 * Registers a listener and returns an entry iff the entry was added
144 private ListenerEntry addListener(CacheEntry entry, ListenerBase base, Object procedure) {
146 assert (entry != null);
147 assert (procedure != null);
149 ArrayList<ListenerEntry> list = listeners.get(entry);
151 list = new ArrayList<>(1);
152 listeners.put(entry, list);
155 ListenerEntry result = new ListenerEntry(entry, base, procedure);
156 // Equals is here based on base
157 int currentIndex = list.indexOf(result);
158 // There was already a listener
159 if(currentIndex > -1) {
160 ListenerEntry current = list.get(currentIndex);
161 if(!current.base.isDisposed()) return null;
162 list.set(currentIndex, result);
167 if (Development.DEVELOPMENT) {
168 if(Development.<Boolean>getProperty(DevelopmentKeys.QUERYPROCESSOR_LISTENERS, Bindings.BOOLEAN)) {
169 new Exception().printStackTrace();
170 System.err.println("addListener -> " + list.size() + " " + entry + " " + base + " " + procedure);
174 addedEntries.put(base, result);
180 void scheduleListener(ListenerEntry entry) {
181 assert (entry != null);
182 if (Development.DEVELOPMENT) {
183 if(Development.<Boolean>getProperty(DevelopmentKeys.QUERYPROCESSOR_LISTENERS, Bindings.BOOLEAN)) {
184 System.err.println("Scheduled " + entry.procedure);
187 scheduledListeners.add(entry);
190 private void removeListener(ListenerEntry entry) {
191 assert (entry != null);
192 ArrayList<ListenerEntry> list = listeners.get(entry.entry);
193 if(list == null) return;
194 boolean success = list.remove(entry);
197 listeners.remove(entry.entry);
200 boolean hasListener(CacheEntry entry) {
201 if(listeners.get(entry) != null) return true;
205 boolean hasListenerAfterDisposing(CacheEntry entry) {
206 if(listeners.get(entry) != null) {
207 ArrayList<ListenerEntry> entries = listeners.get(entry);
208 ArrayList<ListenerEntry> list = null;
209 for (ListenerEntry e : entries) {
210 if (e.base.isDisposed()) {
211 if(list == null) list = new ArrayList<ListenerEntry>();
216 for (ListenerEntry e : list) {
220 if (entries.isEmpty()) {
221 listeners.remove(entry);
229 List<ListenerEntry> getListenerEntries(CacheEntry entry) {
230 hasListenerAfterDisposing(entry);
231 if(listeners.get(entry) != null)
232 return listeners.get(entry);
234 return Collections.emptyList();
237 void processListenerReport(CacheEntry<?> entry, Map<CacheEntry, Set<ListenerBase>> workarea) {
239 if(!workarea.containsKey(entry)) {
241 HashSet<ListenerBase> ls = new HashSet<ListenerBase>();
242 for(ListenerEntry e : getListenerEntries(entry))
245 workarea.put(entry, ls);
247 for(CacheEntry parent : entry.getParents(processor)) {
248 processListenerReport(parent, workarea);
249 ls.addAll(workarea.get(parent));
256 public synchronized ListenerReport getListenerReport() throws IOException {
258 class ListenerReportImpl implements ListenerReport {
260 Map<CacheEntry, Set<ListenerBase>> workarea = new HashMap<CacheEntry, Set<ListenerBase>>();
263 public void print(PrintStream b) {
264 Map<ListenerBase, Integer> hist = new HashMap<ListenerBase, Integer>();
265 for(Map.Entry<CacheEntry, Set<ListenerBase>> e : workarea.entrySet()) {
266 for(ListenerBase l : e.getValue()) {
267 Integer i = hist.get(l);
268 hist.put(l, i != null ? i-1 : -1);
272 for(Pair<ListenerBase, Integer> p : CollectionUtils.valueSortedEntries(hist)) {
273 b.print("" + -p.second + " " + p.first + "\n");
281 ListenerReportImpl result = new ListenerReportImpl();
283 Collection<CacheEntryBase> all = processor.allCaches(new CacheCollectionResult()).toCollection();
284 for(CacheEntryBase entry : all) {
285 hasListenerAfterDisposing(entry);
287 for(CacheEntryBase entry : all) {
288 processListenerReport(entry, result.workarea);
295 public synchronized String reportListeners(File file) throws IOException {
297 if (!processor.isAlive())
300 PrintStream b = new PrintStream(new BufferedOutputStream(new FileOutputStream(file)));
301 ListenerReport report = getListenerReport();
304 return "Done reporting listeners.";
308 public void fireListeners(WriteGraphImpl graph) {
310 assert (!processor.updating);
311 assert (!processor.cache.collecting);
312 assert (!firingListeners);
314 firingListeners = true;
318 // Performing may cause further events to be scheduled.
319 while (!scheduledListeners.isEmpty()) {
321 // Clone current events to make new entries possible during
323 THashSet<ListenerEntry> entries = scheduledListeners;
324 scheduledListeners = new THashSet<ListenerEntry>();
326 ArrayList<ListenerEntry> schedule = new ArrayList<ListenerEntry>();
328 for (ListenerEntry listenerEntry : entries) {
330 if (pruneListener(listenerEntry)) {
331 if (Development.DEVELOPMENT) {
332 if(Development.<Boolean>getProperty(DevelopmentKeys.QUERYPROCESSOR_LISTENERS, Bindings.BOOLEAN)) {
333 new Exception().printStackTrace();
334 System.err.println("Pruned " + listenerEntry.procedure);
340 final CacheEntry entry = listenerEntry.entry;
341 assert (entry != null);
343 Object newValue = processor.compareTo(graph, entry, listenerEntry.getLastKnown());
345 if (newValue != ListenerEntry.NOT_CHANGED) {
346 if (Development.DEVELOPMENT) {
347 if(Development.<Boolean>getProperty(DevelopmentKeys.QUERYPROCESSOR_LISTENERS, Bindings.BOOLEAN)) {
348 new Exception().printStackTrace();
349 System.err.println("Add to schedule " + listenerEntry.procedure + " with " + newValue);
352 schedule.add(listenerEntry);
353 listenerEntry.setLastKnown(entry.getResult());
358 for(ListenerEntry listenerEntry : schedule) {
359 final CacheEntry entry = listenerEntry.entry;
360 if (Development.DEVELOPMENT) {
361 if(Development.<Boolean>getProperty(DevelopmentKeys.QUERYPROCESSOR_LISTENERS, Bindings.BOOLEAN)) {
362 System.err.println("Firing " + listenerEntry.procedure);
366 if (Development.DEVELOPMENT) {
367 if(Development.<Boolean>getProperty(DevelopmentKeys.QUERYPROCESSOR_LISTENERS, Bindings.BOOLEAN)) {
368 System.err.println("Firing " + listenerEntry.procedure + " for " + listenerEntry.entry);
371 entry.performFromCache(graph, listenerEntry.procedure);
372 } catch (Throwable t) {
380 firingListeners = false;
385 void updateParents(int indent, CacheEntry entry, LinkedList<UpdateEntry> todo) {
387 Iterable<CacheEntry> oldParents = entry.getParents(processor);
388 for (CacheEntry parent : oldParents) {
389 if(!parent.isDiscarded())
390 todo.push(new UpdateEntry(entry, parent, indent + 2));
395 private boolean pruneListener(ListenerEntry entry) {
396 if (entry.base.isDisposed()) {
397 removeListener(entry);