/* package-info.java -- package information
* Copyright (C) 2014 Galois, Inc.
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation, either version 3 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 General Public License along with
* this library. If not, see
ppamltracer is a lightweight, portable tracing library designed for * explicit instrumention of generated code. If you're writing a compiler and * need hard data on your optimizer's efficacy, ppamltracer is the library for * you. This Java package provides bindings to the libppamltracer C API. * *
This package's usage can be summed up in a few lines: * *
* // Create report. * Tracer tracer = new ExplicitlyConfiguredTracer("/tmp/my_report"); * * // Register phase 1 and do stuff. * Phase phase = tracer.createPhase("phase 1"); * phase.start(); * doStuff(); * phase.stop(); * phase.close(); * * // Register phase 2 and do different stuff. * phase = tracer.createPhase("phase 2"); * // Other stuff * phase.start(); * doOtherStuff(); * phase.stop(); * // Yet more stuff * phase.start(); * doYetMoreStuff(); * phase.stop(); * * // Clean up. * phase.close(); * tracer.close(); ** *
This creates a report with the total runtime of doStuff
* recorded as "phase 1" and the total runtime of doOtherStuff
and
* doYetMoreStuff
combined as "phase 2".
*
*
com.galois.ppaml.tracer.examples.Simple
, included in the
* distribution, contains a more lengthy example.
*
*
ppamltracer writes trace logs in the * Open Trace Format, a free and * open standard developed by the Zentrum für Informationsdienste und * Hochleistungsrechnen (Center for Information Services and High-Performance * Computing) at the Technical University of Dresden. * *
We developed ppamltracer as part of DARPA's * Probabilistic * Programming for Advancing Machine Learning (PPAML) project. * * @author Galois, Inc. * * @version 0.1.0 */ package com.galois.ppaml.tracer;