org.cip4.jdflib.util.CPUTimer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of JDFLibJ Show documentation
Show all versions of JDFLibJ Show documentation
CIP4 JDF Library for JDF 1.x
/*
*
* The CIP4 Software License, Version 1.0
*
*
* Copyright (c) 2001-2015 The International Cooperation for the Integration of
* Processes in Prepress, Press and Postpress (CIP4). All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* The International Cooperation for the Integration of
* Processes in Prepress, Press and Postpress (www.cip4.org)"
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "CIP4" and "The International Cooperation for the Integration of
* Processes in Prepress, Press and Postpress" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "CIP4",
* nor may "CIP4" appear in their name, without prior written
* permission of the CIP4 organization
*
* Usage of this software in commercial products is subject to restrictions. For
* details please consult [email protected].
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE INTERNATIONAL COOPERATION FOR
* THE INTEGRATION OF PROCESSES IN PREPRESS, PRESS AND POSTPRESS OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the The International Cooperation for the Integration
* of Processes in Prepress, Press and Postpress and was
* originally based on software
* copyright (c) 1999-2001, Heidelberger Druckmaschinen AG
* copyright (c) 1999-2001, Agfa-Gevaert N.V.
*
* For more information on The International Cooperation for the
* Integration of Processes in Prepress, Press and Postpress , please see
* ();
}
/**
*
* @author Rainer Prosi, Heidelberger Druckmaschinen *
*/
protected class ThreadIdentifier
{
protected Thread theThread;
protected String id;
/**
* @param id a unique Identifier, may be null
*
*/
public ThreadIdentifier(String id)
{
this.id = id;
theThread = Thread.currentThread();
}
/**
* @see java.lang.Object#equals(java.lang.Object)
* @param obj
* @return
*/
@Override
public boolean equals(Object obj)
{
if (!(obj instanceof ThreadIdentifier))
return false;
ThreadIdentifier ti = (ThreadIdentifier) obj;
return ContainerUtil.equals(id, ti.id) && ContainerUtil.equals(theThread, ti.theThread);
}
/**
* @see java.lang.Object#hashCode()
* @return
*/
@Override
public int hashCode()
{
return HashUtil.hashCode(HashUtil.hashCode(0, id), theThread);
}
/**
* @see java.lang.Object#toString()
* @return
*/
@Override
public String toString()
{
return "ThreadIdentified Thread=" + theThread.getName() + "_" + theThread.getId() + " ID: " + id;
}
}
private final Map globalMap;
protected static CPUTimerFactory theFactory = null;
/**
*
* get the CPUTimer for a given ID for this thread
* the timer is in paused mode
* @param id the id for the timer
* @return the timer
*/
public CPUTimer getCurrentTimer(String id)
{
return globalMap.get(new ThreadIdentifier(id));
}
/**
* get the summary of all matching timers over all threads
*
* @param id if null get all
* @return a disposable summary timer
*/
public CPUTimer getGlobalTimer(String id)
{
CPUTimer timer = new CPUTimer(false);
timer.setName(id);
Vector v = getTimers(id);
for (CPUTimer ti : v)
timer.add(ti);
return timer;
}
/**
* get all timers for all threads for a given id
*
* @param id if null get all
* @return
*/
public Vector getTimers(String id)
{
Vector v = new Vector();
synchronized (globalMap)
{
Set s = globalMap.keySet();
Iterator it = s.iterator();
while (it.hasNext())
{
ThreadIdentifier ti = it.next();
if (id == null || id.equals(ti.id))
{
v.add(globalMap.get(ti));
}
}
}
return v;
}
/**
* get the CPUTimer for a given ID for this thread, create it if it does not yet exist
* the timer is in paused mode
* @param id the id for the timer
* @return the timer
*/
public CPUTimer getCreateCurrentTimer(String id)
{
synchronized (globalMap)
{
CPUTimer ct = globalMap.get(new ThreadIdentifier(id));
if (ct == null)
{
ct = new CPUTimer(false);
ct.setName(id);
globalMap.put(new ThreadIdentifier(id), ct);
}
return ct;
}
}
/**
* @see java.lang.Object#toString()
* @return
*/
@Override
public String toString()
{
return "CPUTimerFactory;\n" + globalMap;
}
}
/** ----------- end of private classes ----------- **/
private long createT0;
private long realT0;
private long cpuT0;
private long currentCPU;
private long currentReal;
private long totalReal;
private long toatalCPU;
private final ThreadMXBean bean;
private final boolean threadCpuTimeEnabled;
private int nStartStop;
private String name = null;
/**
* @return the name
*/
public String getName()
{
return name;
}
/**
* add a timer to this
* @param timer
*/
public void add(CPUTimer timer)
{
totalReal += timer.totalReal;
toatalCPU += timer.toatalCPU;
nStartStop += timer.getNumStarts();
createT0 = Math.min(createT0, timer.getCreationTime());
long currentRealTime = timer.getCurrentRealTime();
if (currentRealTime > 0)
{
currentReal += currentRealTime;
}
long currentCPUTime = timer.getCurrentCPUTime();
if (currentCPUTime > 0)
{
currentCPU += currentCPUTime;
}
}
/**
* @param name the name to set
*/
public void setName(String name)
{
this.name = name;
}
/**
* @param bStart if true, start measuring now
*
*/
public CPUTimer(boolean bStart)
{
super();
bean = ManagementFactory.getThreadMXBean();
threadCpuTimeEnabled = bean.isThreadCpuTimeEnabled();
realT0 = -1;
currentCPU = 0;
currentReal = 0;
cpuT0 = -1;
toatalCPU = 0;
totalReal = 0;
nStartStop = 0;
createT0 = System.currentTimeMillis();
if (bStart)
start();
}
/**
* method to get the amount of cpu time since construction
* @return amount of cpu time in nano seconds
*
*
*/
public long getTotalCPUTime()
{
if (!threadCpuTimeEnabled)
return -1;
return toatalCPU + getCurrentCPUTime();
}
/**
* @return
*/
public long getCurrentCPUTime()
{
if (!threadCpuTimeEnabled)
return -1;
else if (cpuT0 > 0)
return currentCPU + bean.getCurrentThreadCpuTime() - cpuT0;
else
return currentCPU;
}
/**
*
* @return creation time in milliseconds (see System.currentTimeMillis());
*
*
*/
public long getCreationTime()
{
return createT0;
}
/**
* method to get the amount of real time since construction in milliseconds
* @return amount of real in milliseconds
*
*/
public long getTotalRealTime()
{
return totalReal + getCurrentRealTime();
}
/**
* @return the current realtime im milliseconds
*/
public long getCurrentRealTime()
{
if (realT0 > 0)
return currentReal + System.currentTimeMillis() - realT0;
else
return currentReal;
}
/**
* start measuring times
*
*
*/
public void start()
{
if (realT0 > 0)
return;
if (threadCpuTimeEnabled)
cpuT0 = bean.getCurrentThreadCpuTime();
realT0 = System.currentTimeMillis();
nStartStop++;
}
/**
* stop/pause measuring times
*
*
*/
public void stop()
{
if (realT0 <= 0)
return;
if (threadCpuTimeEnabled)
toatalCPU = getTotalCPUTime();
totalReal = getTotalRealTime();
cpuT0 = -1;
realT0 = -1;
}
/**
* stop/pause measuring times - decrement the number of start/stop so that we don't recount the next start
*
*
*/
public void pause()
{
if (realT0 <= 0)
return;
stop();
nStartStop--;
}
/**
* @return
*/
public long getNumStarts()
{
return nStartStop;
}
/**
* @return
*/
public long getAverageRealTime()
{
return nStartStop == 0 ? 0 : getTotalRealTime() / nStartStop;
}
/**
* @return
*/
public long getAverageCPUTime()
{
return nStartStop == 0 ? 0 : getTotalCPUTime() / nStartStop;
}
/**
* @see java.lang.Object#toString()
* @return
*/
@Override
public String toString()
{
String label = "CPUTimer: ";
if (name != null)
label += getName();
return label + " totalCPU=" + getTotalCPUTime() / 1000000000. + " currentCPU=" + getCurrentCPUTime() / 1000000000. + " totalT=" + getTotalRealTime() / 1000. + " currentT="
+ getCurrentRealTime() / 1000. + " starts=" + nStartStop + " active=" + (realT0 > 0);
}
/**
* get a summary for a single run
* @return
*/
public String getSingleSummary()
{
String label = "CPUTimer: ";
if (name != null)
label += getName();
return label + " CPU=" + getTotalCPUTime() / 1000000000. + " RealTime=" + getTotalRealTime() / 1000.;
}
/**
*
* @return the XML representation of this
*/
public KElement toXML()
{
KElement root = new XMLDoc("CPUTimer", null).getRoot();
root.setAttribute("Name", getName(), null);
root.setAttribute("TotalRealTime", getTotalRealTime() / 1000., null);
root.setAttribute("CurrentRealTime", getCurrentRealTime() / 1000., null);
root.setAttribute("AverageRealTime", getAverageRealTime() / 1000., null);
root.setAttribute("TotalCPUTime", getTotalCPUTime() / 1000000000., null);
root.setAttribute("CurrentCPUTime", getCurrentCPUTime() / 1000000000., null);
root.setAttribute("AverageCPUTime", getAverageCPUTime() / 1000000000., null);
root.setAttribute("CreationTime", new JDFDate(getCreationTime()).getFormattedDateTime("dd MMM, HH:mm:ss.sss"), null);
root.setAttribute("StartStop", getNumStarts(), null);
return root;
}
/**
* @return the one and only CPUTimerFactory
*/
public static CPUTimerFactory getFactory()
{
if (CPUTimerFactory.theFactory == null)
CPUTimerFactory.theFactory = new CPUTimerFactory();
return CPUTimerFactory.theFactory;
}
/**
* simple print utility for lazy folks
*/
public void println()
{
System.out.println(toString());
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy