1 /*******************************************************************************
2 * Copyright (c) 2007, 2011 Association for Decentralized Information Management
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.db.layer0.util;
14 import java.util.function.Consumer;
16 import org.eclipse.core.runtime.IProgressMonitor;
17 import org.eclipse.core.runtime.NullProgressMonitor;
18 import org.simantics.db.ReadGraph;
19 import org.simantics.db.Session;
20 import org.simantics.db.WriteGraph;
21 import org.simantics.db.common.request.WriteRequest;
22 import org.simantics.db.common.utils.Logger;
23 import org.simantics.db.exception.DatabaseException;
24 import org.simantics.db.service.ClusterControl;
25 import org.simantics.db.service.LifecycleSupport;
26 import org.simantics.db.service.QueryControl;
27 import org.simantics.utils.DataContainer;
28 import org.simantics.utils.datastructures.Callback;
31 * @author Tuukka Lehtonen
33 public class SessionGarbageCollection {
35 * collect everything possible, default target is 0 queries.
37 private static int DEFAULT_ALLOWED_TIME = 300;
38 public static int getDefaultQueryTarget() {
39 return DEFAULT_ALLOWED_TIME;
41 public static void setDefaultAllowedTime(int a) {
42 DEFAULT_ALLOWED_TIME = a;
45 * Default maximum cluster memory consumption target is 32MB.
47 private static int DEFAULT_CLUSTER_TARGET = -1;
48 public static int getDefaultClusterTarget() {
49 return DEFAULT_CLUSTER_TARGET;
51 public static void setDefaultClusterTarget(int a) {
52 DEFAULT_CLUSTER_TARGET = a;
55 * @param monitor <code>null</code> if progress monitor not available
56 * @param session the session to GC
57 * @param sync <code>true</code> to block until gc is completed
58 * @param errorCallback callback for any errors occuring during the
59 * operation or <code>null</code> to ignore errors
61 public static boolean gc(IProgressMonitor monitor, Session session, boolean sync,
62 final Consumer<DatabaseException> errorCallback) {
63 long took = gc(monitor, session, sync, errorCallback, DEFAULT_ALLOWED_TIME, DEFAULT_CLUSTER_TARGET);
64 return ((16*took) / DEFAULT_ALLOWED_TIME) > 15;
67 public static void gc(ReadGraph graph, final int allowedTimeInMs, final int clusterTarget) throws DatabaseException {
68 doIt(null, graph, allowedTimeInMs, clusterTarget);
71 private static void doIt(IProgressMonitor _monitor, ReadGraph graph, final int allowedTimeInMs, final int clusterTarget) {
72 if(_monitor == null) _monitor = new NullProgressMonitor();
73 QueryControl qc = graph.getService(QueryControl.class);
74 ClusterControl cc = graph.getService(ClusterControl.class);
75 _monitor.beginTask("Collect clusters", IProgressMonitor.UNKNOWN);
76 cc.gc(graph, clusterTarget);
77 _monitor.beginTask("Collect queries", IProgressMonitor.UNKNOWN);
78 qc.gc(graph, allowedTimeInMs);
85 * @param errorCallback
88 * @param monitor <code>null</code> if progress monitor not available
89 * @param session the session to GC
90 * @param sync <code>true</code> to block until gc is completed
91 * @param errorCallback callback for any errors occuring during the
92 * operation or <code>null</code> to ignore errors
93 * @param allowedTimeInMs the time allowed for query collection in ms
94 * @param clusterTarget target for the maximum amount of memory in bytes to
95 * be consumed by cluster caches after collection.
97 public static long gc(IProgressMonitor monitor, Session session, boolean sync,
98 final Consumer<DatabaseException> errorCallback, final int allowedTimeInMs, final int clusterTarget) {
100 monitor = new NullProgressMonitor();
101 final IProgressMonitor _monitor = monitor;
103 throw new NullPointerException("null session");
105 final DataContainer<Long> took = new DataContainer<Long>(0L);
107 WriteRequest request = new WriteRequest() {
109 public void perform(WriteGraph graph) throws DatabaseException {
110 long start = System.nanoTime();
111 doIt(_monitor, graph, allowedTimeInMs, clusterTarget);
112 long duration = System.nanoTime()-start;
113 took.set((long)(duration*1e-6));
117 LifecycleSupport lfs = session.peekService(LifecycleSupport.class);
118 if (lfs == null || lfs.isClosed() || lfs.isClosing())
123 session.syncRequest(request);
124 } catch (DatabaseException e) {
125 if (errorCallback != null)
126 errorCallback.accept(e);
128 Logger.defaultLogError(e);
131 session.asyncRequest(request, new Callback<DatabaseException>() {
133 public void run(DatabaseException e) {
135 if (errorCallback != null)
136 errorCallback.accept(e);
138 Logger.defaultLogError(e);