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;
30 * @author Tuukka Lehtonen
32 public class SessionGarbageCollection {
34 * collect everything possible, default target is 0 queries.
36 private static int DEFAULT_ALLOWED_TIME = 300;
37 public static int getDefaultQueryTarget() {
38 return DEFAULT_ALLOWED_TIME;
40 public static void setDefaultAllowedTime(int a) {
41 DEFAULT_ALLOWED_TIME = a;
44 * Default maximum cluster memory consumption target is 32MB.
46 private static int DEFAULT_CLUSTER_TARGET = -1;
47 public static int getDefaultClusterTarget() {
48 return DEFAULT_CLUSTER_TARGET;
50 public static void setDefaultClusterTarget(int a) {
51 DEFAULT_CLUSTER_TARGET = a;
54 * @param monitor <code>null</code> if progress monitor not available
55 * @param session the session to GC
56 * @param sync <code>true</code> to block until gc is completed
57 * @param errorCallback callback for any errors occuring during the
58 * operation or <code>null</code> to ignore errors
60 public static boolean gc(IProgressMonitor monitor, Session session, boolean sync,
61 final Consumer<DatabaseException> errorCallback) {
62 long took = gc(monitor, session, sync, errorCallback, DEFAULT_ALLOWED_TIME, DEFAULT_CLUSTER_TARGET);
63 return ((16*took) / DEFAULT_ALLOWED_TIME) > 15;
66 public static void gc(ReadGraph graph, final int allowedTimeInMs, final int clusterTarget) throws DatabaseException {
67 doIt(null, graph, allowedTimeInMs, clusterTarget);
70 public static void gc(IProgressMonitor monitor, ReadGraph graph, final int allowedTimeInMs, final int clusterTarget) throws DatabaseException {
71 doIt(monitor, graph, allowedTimeInMs, clusterTarget);
74 private static void doIt(IProgressMonitor _monitor, ReadGraph graph, final int allowedTimeInMs, final int clusterTarget) {
75 if(_monitor == null) _monitor = new NullProgressMonitor();
76 QueryControl qc = graph.getService(QueryControl.class);
77 ClusterControl cc = graph.getService(ClusterControl.class);
78 _monitor.beginTask("Collect clusters", IProgressMonitor.UNKNOWN);
79 //cc.gc(graph, clusterTarget);
80 if(clusterTarget == -1) {
82 //System.err.println("session gc, cluster use = " + used);
83 int baseline = 32*(1<<20);
85 int dynamicTarget = (int)(0.95 * (used-baseline)) + baseline;
86 cc.gc(graph, dynamicTarget);
89 cc.gc(graph, clusterTarget);
91 _monitor.beginTask("Collect queries", IProgressMonitor.UNKNOWN);
92 qc.gc(graph, allowedTimeInMs);
99 * @param errorCallback
102 * @param monitor <code>null</code> if progress monitor not available
103 * @param session the session to GC
104 * @param sync <code>true</code> to block until gc is completed
105 * @param errorCallback callback for any errors occuring during the
106 * operation or <code>null</code> to ignore errors
107 * @param allowedTimeInMs the time allowed for query collection in ms
108 * @param clusterTarget target for the maximum amount of memory in bytes to
109 * be consumed by cluster caches after collection.
111 public static long gc(IProgressMonitor monitor, Session session, boolean sync,
112 final Consumer<DatabaseException> errorCallback, final int allowedTimeInMs, final int clusterTarget) {
114 monitor = new NullProgressMonitor();
115 final IProgressMonitor _monitor = monitor;
117 throw new NullPointerException("null session");
119 final DataContainer<Long> took = new DataContainer<Long>(0L);
121 WriteRequest request = new WriteRequest() {
123 public void perform(WriteGraph graph) throws DatabaseException {
124 long start = System.nanoTime();
125 doIt(_monitor, graph, allowedTimeInMs, clusterTarget);
126 long duration = System.nanoTime()-start;
127 took.set((long)(duration*1e-6));
131 LifecycleSupport lfs = session.peekService(LifecycleSupport.class);
132 if (lfs == null || lfs.isClosed() || lfs.isClosing())
137 session.syncRequest(request);
138 } catch (DatabaseException e) {
139 if (errorCallback != null)
140 errorCallback.accept(e);
142 Logger.defaultLogError(e);
145 session.asyncRequest(request, e -> {
147 if (errorCallback != null)
148 errorCallback.accept(e);
150 Logger.defaultLogError(e);