org.spf4j.base.Timing Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spf4j-core Show documentation
A continuously growing collection of utilities to measure performance, get better diagnostics, improve performance, or do things more reliably, faster that other open source libraries...
The newest version!
/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * 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 org.spf4j.base;

import com.google.common.annotations.Beta;
import java.time.Instant;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.spf4j.concurrent.DefaultScheduler;
import org.spf4j.jmx.JmxExport;

/**
 * A Utility class that allows for quick conversion between nanotime and epoch relative time.
 * @author Zoltan Farkas
 */
@Beta
public final class Timing {

  public static final long MAX_MS_SPAN = TimeUnit.NANOSECONDS.toMillis(Long.MAX_VALUE);

  private static final long TIMING_UPDATE_INTERVAL_MINUTES = Long.getLong("spf4j.timing.updateIntervalMinutes", 60);

  private static volatile Timing latestTiming;

  static {
    updateTiming(); // run twice to reduce timing discrepancies introduced by class-loading
    updateTiming();
  }

  private static final ScheduledFuture UPDATER =  startScheduledUpdater();

  public static ScheduledFuture startScheduledUpdater() {
    final ScheduledFuture fut = DefaultScheduler.get().scheduleWithFixedDelay(Timing::updateTiming,
            TIMING_UPDATE_INTERVAL_MINUTES, TIMING_UPDATE_INTERVAL_MINUTES, TimeUnit.MINUTES);
    if (!ShutdownThread.get().queueHookAtBeginning(() -> fut.cancel(true))) {
      fut.cancel(true);
    }
    return fut;
  }

  @JmxExport
  public static void updateTiming() {
    latestTiming = new Timing();
  }


  private final long nanoTimeRef;
  private final long currentTimeMillisRef;

  private Timing() {
    nanoTimeRef = TimeSource.nanoTime();
    currentTimeMillisRef = System.currentTimeMillis();
  }

  public long fromNanoTimeToEpochMillis(final long nanoTime) {
    return currentTimeMillisRef + TimeUnit.NANOSECONDS.toMillis(nanoTime - nanoTimeRef);
  }

  public Instant fromNanoTimeToInstant(final long nanoTime) {
    long relNanos = nanoTime - nanoTimeRef;
    return Instant.ofEpochSecond(currentTimeMillisRef / 1000
            + relNanos / 1000000000, (currentTimeMillisRef % 1000) * 1000000 + relNanos %  1000000000);
  }

  public long fromEpochMillisToNanoTime(final long epochTimeMillis) {
    long msSinceLast = epochTimeMillis - currentTimeMillisRef;
    if (Math.abs(msSinceLast) > MAX_MS_SPAN) {
      return TimeSource.nanoTime() + Long.MAX_VALUE;
    }
    return nanoTimeRef + TimeUnit.MILLISECONDS.toNanos(msSinceLast);
  }

  public static Timing getCurrentTiming() {
    return latestTiming;
  }

  @JmxExport
  public static void stopUpdate() {
    if (UPDATER != null) {
      if (UPDATER.isCancelled() || UPDATER.isDone()) {
        return;
      }
      UPDATER.cancel(false);
    }
  }

  @Override
  public String toString() {
    return "Timing{" + "nanoTimeRef=" + nanoTimeRef + ", currentTimeMillisRef=" + currentTimeMillisRef + '}';
  }


}