1 /*
   2  * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 
  25 package org.graalvm.compiler.debug;
  26 
  27 import org.graalvm.compiler.serviceprovider.GraalServices;
  28 
  29 /**
  30  * Tracks memory usage within a scope using {@link com.sun.management.ThreadMXBean}. This facility
  31  * should be employed using the try-with-resources pattern:
  32  *
  33  * <pre>
  34  * try (DebugCloseable a = memUseTracker.start()) {
  35  *     // the code to measure
  36  * }
  37  * </pre>
  38  */
  39 public interface MemUseTrackerKey extends MetricKey {
  40 
  41     /**
  42      * Creates a point from which memory usage will be recorded if memory use tracking is
  43      * {@linkplain DebugContext#isMemUseTrackingEnabled() enabled}.
  44      *
  45      * @return an object that must be closed once the activity has completed to add the memory used
  46      *         since this call to the total for this tracker
  47      */
  48     DebugCloseable start(DebugContext debug);
  49 
  50     /**
  51      * Gets the current value of this tracker.
  52      */
  53     long getCurrentValue(DebugContext debug);
  54 
  55     @Override
  56     MemUseTrackerKey doc(String string);
  57 
  58     static long getCurrentThreadAllocatedBytes() {
  59         return GraalServices.getCurrentThreadAllocatedBytes();
  60     }
  61 }