io.perfmark.impl.Storage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of perfmark-impl Show documentation
PerfMark Implementation API
The newest version!
/*
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.perfmark.impl;

import java.lang.ref.Reference;
import java.lang.ref.SoftReference;
import java.lang.ref.WeakReference;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

/**
 * Storage is responsible for storing and returning recorded marks. This is a low level class and
 * not intended for use by users. Instead, the {@code TraceEventWriter} and {@code TraceEventViewer}
 * classes provide easier to use APIs for accessing PerfMark data.
 *
 * This code is NOT API stable, and may be removed in the future, or changed
 * without notice.
 */
public final class Storage {
  /*
   * Invariants:
   * 

   *   A Thread may have at most one MarkRecorder at a time.
   *   If a MarkHolder is detached from its Thread, it cannot be written to again.
   * 
   */

  // The order of initialization here matters.  If a logger invokes PerfMark, it will be re-entrant
  // and need to use these static variables.

  private static final ConcurrentMap> allMarkHolders =
      new ConcurrentHashMap>();

  public static long getInitNanoTime() {
    return Generator.INIT_NANO_TIME;
  }

  /**
   * Returns a list of {@link MarkList}s across all reachable threads.  MarkLists with no Marks may be removed.
   *
   * @return all reachable MarkLists.
   */
  public static List read() {
    List markLists = new ArrayList();
    for (Iterator> it = allMarkHolders.values().iterator(); it.hasNext();) {
      Reference ref = it.next();
      MarkHolder markHolder = ref.get();
      if (markHolder == null) {
        it.remove();
        continue;
      }
      markHolder.read(markLists);
    }
    // Avoid doing this in the upper loop to avoid tearing the reads too much.
    Set markRecorderIds = new HashSet(markLists.size());
    for (MarkList list : markLists) {
      if (!markRecorderIds.add(list.getMarkRecorderId())) {
        throw new IllegalStateException("Duplicate MarkRecorder IDs in MarkHolders " + list.getMarkRecorderId());
      }
    }
    return Collections.unmodifiableList(markLists);
  }

  /**
   * Removes all data for the calling Thread.  Other threads may Still have stored data.
   */
  public static void resetForThread() {
    for (Iterator> it = allMarkHolders.values().iterator(); it.hasNext();) {
      Reference ref = it.next();
      MarkHolder holder = ref.get();
      if (holder == null) {
        it.remove();
        continue;
      }
      holder.resetForThread();
    }
  }

  /**
   * Removes the global Read index on all storage, but leaves local storage in place.  Because writer threads may still
   * be writing to the same buffer (which they have a strong ref to), this function only removed data that is truly
   * unwritable anymore.   In addition, it captures a timestamp to which marks to include when reading.  Thus, the data
   * isn't fully removed.  To fully remove all data, each tracing thread must call {@link #resetForThread}.
   */
  public static void resetForAll() {
    for (Iterator>> it = allMarkHolders.entrySet().iterator(); it.hasNext();) {
      Map.Entry> entry = it.next();
      Reference ref = entry.getValue();
      MarkHolder holder = ref.get();
      if (holder == null) {
        it.remove();
        continue;
      }
      if (ref instanceof SoftReference) {
        entry.setValue(new WeakReference(holder));
      }
      holder.resetForAll();
    }
  }

  /**
   * Note: it is the responsibility of the caller to keep a strong reference to the markHolder.
   */
  public static void registerMarkHolder(MarkHolder markHolder) {
    if (markHolder == null) {
      throw new NullPointerException("markHolder");
    }
    allMarkHolders.put(new Object(), new SoftReference(markHolder));
  }

  /**
   * This method is meant to aid in cleanup.  It is not efficient so don't use it in production.
   */
  public static void unregisterMarkHolder(MarkHolder markHolder) {
    if (markHolder == null) {
      throw new NullPointerException("markHolder");
    }
    for (Iterator> it = allMarkHolders.values().iterator(); it.hasNext();) {
      Reference ref = it.next();
      MarkHolder holder = ref.get();
      if (holder == null) {
        it.remove();
        continue;
      }
      if (holder == markHolder) {
        it.remove();
        break;
      }
    }
  }

  /**
   * May Return {@code null}.
   */
  public static MarkList readForTest() {
    List lists = read();
    for (MarkList list : lists) {
      // This is slightly wrong as the thread ID could be reused.
      if (list.getThreadId() == Thread.currentThread().getId()) {
        return list;
      }
    }
    return null;
  }

  private Storage() {}
}