aboutsummaryrefslogtreecommitdiff
path: root/modules/profile
diff options
context:
space:
mode:
authorStuart Sierra <mail@stuartsierra.com>2010-08-07 16:41:53 -0400
committerStuart Sierra <mail@stuartsierra.com>2010-08-07 16:41:53 -0400
commita6a92b9b3d2bfd9a56e1e5e9cfba706d1aeeaae5 (patch)
treef1f3da9887dc2dc557df3282b0bcbd4d701ec593 /modules/profile
parente7930c85290f77815cdb00a60604feedfa2d0194 (diff)
Split all namespaces into sub-modules.
* Examples and tests have not been copied over. * Clojure test/compile phases are commented out in parent POM. * May require installing parent POM before full build.
Diffstat (limited to 'modules/profile')
-rw-r--r--modules/profile/pom.xml16
-rw-r--r--modules/profile/src/main/clojure/clojure/contrib/profile.clj110
2 files changed, 126 insertions, 0 deletions
diff --git a/modules/profile/pom.xml b/modules/profile/pom.xml
new file mode 100644
index 00000000..9882c99a
--- /dev/null
+++ b/modules/profile/pom.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http//www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+ http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.clojure.contrib</groupId>
+ <artifactId>parent</artifactId>
+ <version>1.3.0-SNAPSHOT</version>
+ <relativePath>../parent</relativePath>
+ </parent>
+ <artifactId>profile</artifactId>
+ <dependencies>
+ </dependencies>
+</project> \ No newline at end of file
diff --git a/modules/profile/src/main/clojure/clojure/contrib/profile.clj b/modules/profile/src/main/clojure/clojure/contrib/profile.clj
new file mode 100644
index 00000000..19b61a47
--- /dev/null
+++ b/modules/profile/src/main/clojure/clojure/contrib/profile.clj
@@ -0,0 +1,110 @@
+;;; profile.clj: simple code profiling & timing
+
+;; by Stuart Sierra, http://stuartsierra.com/
+;; May 9, 2009
+
+;; Copyright (c) Stuart Sierra, 2009. All rights reserved. The use
+;; and distribution terms for this software are covered by the Eclipse
+;; Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
+;; which can be found in the file epl-v10.html at the root of this
+;; distribution. By using this software in any fashion, you are
+;; agreeing to be bound by the terms of this license. You must not
+;; remove this notice, or any other, from this software.
+
+
+(ns ^{:author "Stuart Sierra"
+ :doc "Simple code profiling & timing measurement.
+
+Wrap any section of code in the prof macro, giving it a name, like this:
+
+ (defn my-function [x y]
+ (let [sum (prof :addition (+ x y))
+ product (prof :multiplication (* x y))]
+ [sum product]))
+
+The run your code in the profile macro, like this:
+
+ (profile (dotimes [i 10000] (my-function 3 4)))
+
+Which prints a report for each named section of code:
+
+ Name mean min max count sum
+ addition 265 0 37000 10000 2655000
+multiplication 274 0 53000 10000 2747000
+
+Times are measured in nanoseconds, to the maximum precision available
+under the JVM. See the function documentation for more details.
+"}
+ clojure.contrib.profile)
+
+(def *profile-data* nil)
+
+(def ^{:doc "Set this to false before loading/compiling to omit
+profiling code."} *enable-profiling* true)
+
+(defmacro prof
+ "If *enable-profiling* is true, wraps body in profiling code.
+ Returns the result of body. Profile timings will be stored in
+ *profile-data* using name, which must be a keyword, as the key.
+ Timings are measured with System/nanoTime."
+ [name & body]
+ (assert (keyword? name))
+ (if *enable-profiling*
+ `(if *profile-data*
+ (let [start-time# (System/nanoTime)
+ value# (do ~@body)
+ elapsed# (- (System/nanoTime) start-time#)]
+ (swap! *profile-data* assoc ~name
+ (conj (get @*profile-data* ~name) elapsed#))
+ value#)
+ ~@body)
+ `(do ~@body)))
+
+(defmacro with-profile-data
+ "Executes body with *profile-data* bound to an atom of a new map.
+ Returns the raw profile data as a map. Keys in the map are profile
+ names (keywords), and values are lists of elapsed time, in
+ nanoseconds."
+ [& body]
+ `(binding [*profile-data* (atom {})]
+ ~@body
+ @*profile-data*))
+
+(defn summarize
+ "Takes the raw data returned by with-profile-data and returns a map
+ from names to summary statistics. Each value in the map will look
+ like:
+
+ {:mean ..., :min ..., :max ..., :count ..., :sum ...}
+
+ :mean, :min, and :max are how long the profiled section took to run,
+ in nanoseconds. :count is the total number of times the profiled
+ section was executed. :sum is the total amount of time spent in the
+ profiled section, in nanoseconds."
+ [profile-data]
+ (reduce (fn [m [k v]]
+ (let [cnt (count v)
+ sum (reduce + v)]
+ (assoc m k {:mean (int (/ sum cnt))
+ :min (apply min v)
+ :max (apply max v)
+ :count cnt
+ :sum sum})))
+ {} profile-data))
+
+(defn print-summary
+ "Prints a table of the results returned by summarize."
+ [profile-summary]
+ (let [name-width (apply max 1 (map (comp count name) (keys profile-summary)))
+ fmt-string (str "%" name-width "s %8d %8d %8d %8d %8d%n")]
+ (printf (.replace fmt-string \d \s)
+ "Name" "mean" "min" "max" "count" "sum")
+ (doseq [k (sort (keys profile-summary))]
+ (let [v (get profile-summary k)]
+ (printf fmt-string (name k) (:mean v) (:min v) (:max v) (:count v) (:sum v))))))
+
+(defmacro profile
+ "Runs body with profiling enabled, then prints a summary of
+ results. Returns nil."
+ [& body]
+ `(print-summary (summarize (with-profile-data (do ~@body)))))