1 -----------------------------------------------------------------------------
2 -- $Id: Main.hs,v 1.10 2005/06/07 10:58:31 simonmar Exp $
4 -- (c) Simon Marlow 1997-2005
5 -----------------------------------------------------------------------------
14 import Text.Html hiding ((!))
15 import qualified Text.Html as Html ((!))
16 import qualified Data.Map as Map
18 import System.Console.GetOpt
19 import System.Exit ( exitWith, ExitCode(..) )
21 import Numeric ( showFloat, showFFloat, showSigned )
22 import Data.Maybe ( isNothing )
29 -----------------------------------------------------------------------------
33 die s = hPutStr stderr s >> exitWith (ExitFailure 1)
35 usageHeader = "usage: nofib-analyse [OPTION...] <logfile1> <logfile2> ..."
39 if not (null cmdline_errors) || OptHelp `elem` flags
40 then die (concat cmdline_errors ++ usageInfo usageHeader argInfo)
43 let { html = OptHTMLOutput `elem` flags;
44 latex = OptLaTeXOutput `elem` flags;
45 ascii = OptASCIIOutput `elem` flags
49 then die "Can't produce both ASCII and HTML"
53 then die "Can't both display and hide deviations"
56 results <- parse_logs other_args
58 summary_spec <- case [ cols | OptColumns cols <- flags ] of
59 [] -> return (pickSummary results)
60 (cols:_) -> namedColumns (split ',' cols)
62 let summary_rows = case [ rows | OptRows rows <- flags ] of
64 rows -> Just (split ',' (last rows))
66 let column_headings = map (reverse . takeWhile (/= '/') . reverse) other_args
69 sequence_ [ checkTimes prog res | table <- results,
70 (prog,res) <- Map.toList table ]
74 putStr (renderHtml (htmlPage results column_headings))
76 putStr (latexOutput results column_headings summary_spec summary_rows)
78 putStr (asciiPage results column_headings summary_spec summary_rows)
81 parse_logs :: [String] -> IO [ResultTable]
83 f <- hGetContents stdin
85 parse_logs log_files =
86 mapM (\f -> do h <- openFile f ReadMode
88 return (parse_log c)) log_files
90 -----------------------------------------------------------------------------
91 -- List of tables we're going to generate
93 data PerProgTableSpec =
94 forall a . Result a =>
96 String -- Name of the table
97 String -- Short name (for column heading)
98 String -- HTML tag for the table
99 (Results -> Maybe a) -- How to get the result
100 (Results -> Status) -- How to get the status of this result
101 (a -> Bool) -- Result within reasonable limits?
103 data PerModuleTableSpec =
104 forall a . Result a =>
106 String -- Name of the table
107 String -- HTML tag for the table
108 (Results -> Map String a) -- get the module map
109 (a -> Bool) -- Result within reasonable limits?
111 -- The various per-program aspects of execution that we can generate results for.
112 size_spec = SpecP "Binary Sizes" "Size" "binary-sizes" binary_size compile_status always_ok
113 alloc_spec = SpecP "Allocations" "Allocs" "allocations" allocs run_status always_ok
114 runtime_spec = SpecP "Run Time" "Runtime" "run-times" (mean run_time) run_status time_ok
115 muttime_spec = SpecP "Mutator Time" "MutTime" "mutator-time" (mean mut_time) run_status time_ok
116 gctime_spec = SpecP "GC Time" "GCTime" "gc-time" (mean gc_time) run_status time_ok
117 gcwork_spec = SpecP "GC Work" "GCWork" "gc-work" gc_work run_status always_ok
118 instrs_spec = SpecP "Instructions" "Instrs" "instrs" instrs run_status always_ok
119 mreads_spec = SpecP "Memory Reads" "Reads" "mem-reads" mem_reads run_status always_ok
120 mwrite_spec = SpecP "Memory Writes" "Writes" "mem-writes" mem_writes run_status always_ok
121 cmiss_spec = SpecP "Cache Misses" "Misses" "cache-misses" cache_misses run_status always_ok
136 namedColumns :: [String] -> IO [PerProgTableSpec]
137 namedColumns ss = mapM findSpec ss
139 case [ spec | spec@(SpecP _ short_name _ _ _ _) <- all_specs,
141 [] -> die ("unknown column: " ++ s)
142 (spec:_) -> return spec
144 mean :: (Results -> [Float]) -> Results -> Maybe Float
145 mean f results = go (f results)
146 where go [] = Nothing
147 go fs = Just (foldl' (+) 0 fs / fromIntegral (length fs))
149 -- Look for bogus-looking times: On Linux we occasionally get timing results
150 -- that are bizarrely low, and skew the average.
151 checkTimes :: String -> Results -> IO ()
152 checkTimes prog results = do
153 check "run time" (run_time results)
154 check "mut time" (mut_time results)
155 check "GC time" (gc_time results)
159 hPutStrLn stderr ("warning: dubious " ++ kind
160 ++ " results for " ++ prog
162 | otherwise = return ()
163 where strange t = any (\r -> time_ok r && r / t > 1.4) ts
164 -- looks for times that are >40% smaller than
168 -- These are the per-prog tables we want to generate
169 per_prog_result_tab =
170 [ size_spec, alloc_spec, runtime_spec, muttime_spec, gctime_spec,
171 gcwork_spec, instrs_spec, mreads_spec, mwrite_spec, cmiss_spec ]
173 -- A single summary table, giving comparison figures for a number of
174 -- aspects, each in its own column. Only works when comparing two runs.
175 normal_summary_specs =
176 [ size_spec, alloc_spec, runtime_spec ]
178 cachegrind_summary_specs =
179 [ size_spec, alloc_spec, instrs_spec, mreads_spec, mwrite_spec ]
181 -- Pick an appropriate summary table: if we're cachegrinding, then
182 -- we're probably not interested in the runtime, but we are interested
183 -- in instructions, mem reads and mem writes (and vice-versa).
184 pickSummary :: [ResultTable] -> [PerProgTableSpec]
186 | isNothing (instrs (head (Map.elems (head rs)))) = normal_summary_specs
187 | otherwise = cachegrind_summary_specs
189 per_module_result_tab =
190 [ SpecM "Module Sizes" "mod-sizes" module_size always_ok
191 , SpecM "Compile Times" "compile-time" compile_time time_ok
194 always_ok :: a -> Bool
195 always_ok = const True
197 time_ok :: Float -> Bool
198 time_ok t = t > tooquick_threshold
200 -----------------------------------------------------------------------------
201 -- HTML page generation
203 --htmlPage :: Results -> [String] -> Html
204 htmlPage results args
205 = header << thetitle << reportTitle
207 +++ h1 << reportTitle
210 +++ body (gen_tables results args)
212 gen_menu = unordList (map (prog_menu_item) per_prog_result_tab
213 ++ map (module_menu_item) per_module_result_tab)
215 prog_menu_item (SpecP name _ anc _ _ _) = anchor <! [href ('#':anc)] << name
216 module_menu_item (SpecM name anc _ _) = anchor <! [href ('#':anc)] << name
218 gen_tables results args =
219 foldr1 (+++) (map (htmlGenProgTable results args) per_prog_result_tab)
220 +++ foldr1 (+++) (map (htmlGenModTable results args) per_module_result_tab)
222 htmlGenProgTable results args (SpecP title _ anc get_result get_status result_ok)
223 = sectHeading title anc
224 +++ font <! [size "1"]
225 << mkTable (htmlShowResults results args get_result get_status result_ok)
228 htmlGenModTable results args (SpecM title anc get_result result_ok)
229 = sectHeading title anc
230 +++ font <![size "1"]
231 << mkTable (htmlShowMultiResults results args get_result result_ok)
234 sectHeading :: String -> String -> Html
235 sectHeading s nm = h2 << anchor <! [name nm] << s
241 -> (Results -> Maybe a)
242 -> (Results -> Status)
246 htmlShowResults (r:rs) ss f stat result_ok
248 </> aboves (zipWith tableRow [1..] results_per_prog)
249 </> aboves ((if nodevs then []
250 else [tableRow (-1) ("-1 s.d.", lows),
251 tableRow (-1) ("+1 s.d.", highs)])
252 ++ [tableRow (-1) ("Average", gms)])
254 -- results_per_prog :: [ (String,[BoxValue a]) ]
255 results_per_prog = map (calc_result rs f stat result_ok) (Map.toList r)
257 results_per_run = transpose (map snd results_per_prog)
258 (lows,gms,highs) = unzip3 (map calc_gmsd results_per_run)
264 -> (Results -> Map String a)
268 htmlShowMultiResults (r:rs) ss f result_ok =
270 </> aboves (map show_results_for_prog results_per_prog_mod_run)
271 </> aboves ((if nodevs then []
272 else [td << bold << "-1 s.d."
273 <-> tableRow (-1) ("", lows),
274 td << bold << "+1 s.d."
275 <-> tableRow (-1) ("", highs)])
276 ++ [td << bold << "Average"
277 <-> tableRow (-1) ("", gms)])
280 base_results = Map.toList r :: [(String,Results)]
282 -- results_per_prog_mod_run :: [(String,[(String,[BoxValue a])])]
283 results_per_prog_mod_run = map get_results_for_prog base_results
285 -- get_results_for_prog :: (String,Results) -> (String,[BoxValue a])
286 get_results_for_prog (prog,r) = (prog, map get_results_for_mod (Map.toList (f r)))
288 where fms = map get_run_results rs
290 get_run_results fm = case Map.lookup prog fm of
294 get_results_for_mod (id,attr) = calc_result fms Just (const Success)
297 show_results_for_prog (prog,mrs) =
298 td <! [valign "top"] << bold << prog
299 <-> (if null mrs then
300 td << "(no modules compiled)"
302 toHtml (aboves (map (tableRow 0) mrs)))
304 results_per_run = transpose [xs | (_,mods) <- results_per_prog_mod_run,
306 (lows,gms,highs) = unzip3 (map calc_gmsd results_per_run)
308 tableRow :: Int -> (String, [BoxValue]) -> HtmlTable
309 tableRow row_no (prog, results)
310 = td <! [bgcolor left_column_color] << prog
311 <-> besides (map (\s -> td <! [align "right", clr] << showBox s)
313 where clr | row_no < 0 = bgcolor average_row_color
314 | even row_no = bgcolor even_row_color
315 | otherwise = bgcolor odd_row_color
317 left_column_color = "#d0d0ff" -- light blue
318 odd_row_color = "#d0d0ff" -- light blue
319 even_row_color = "#f0f0ff" -- v. light blue
320 average_row_color = "#ffd0d0" -- light red
323 findBest :: Result a => [BoxValue a] -> [(Bool,BoxValue a)]
324 findBest stuff@(Result base : rest)
325 = map (\a -> (a==base, a))
327 best = snd (minimumBy (\a b -> fst a < fst b) no_pcnt_stuff
329 no_pcnt_stuff = map unPcnt stuff
331 unPcnt (r@(Percentage f) : rest) = (base * f/100, r) : unPcnt rest
332 unPcnt (r@(Result a) : rest) = (a, r) : unPcnt rest
333 unPcnt (_ : rest) = unPcnt rest
337 = besides (map (\s -> (td <! [align "right", width "100"] << bold << s)) ss)
339 mkTable t = table <! [cellspacing 0, cellpadding 0, border 0] << t
342 = (td <! [align "left", width "100"] << bold << "Program")
346 = (td <! [align "left", width "100"] << bold << "Program")
347 <-> (td <! [align "left", width "100"] << bold << "Module")
350 -- Calculate a color ranging from bright blue for -100% to bright red for +100%.
352 calcColor :: Int -> String
353 calcColor p | p >= 0 = "#" ++ (showHex red 2 "0000")
354 | otherwise = "#0000" ++ (showHex blue 2 "")
355 where red = p * 255 `div` 100
356 blue = (-p) * 255 `div` 100
358 showHex 0 f s = if f > 0 then take f (repeat '0') ++ s else s
359 showHex i f s = showHex (i `div` 16) (f-1) (hexDig (i `mod` 16) : s)
361 hexDig i | i > 10 = chr (i-10 + ord 'a')
362 | otherwise = chr (i + ord '0')
364 -----------------------------------------------------------------------------
365 -- LaTeX table generation (just the summary for now)
367 latexOutput results args summary_spec summary_rows =
368 (if (length results == 2)
369 then ascii_summary_table True results summary_spec summary_rows
374 -----------------------------------------------------------------------------
375 -- ASCII page generation
377 asciiPage results args summary_spec summary_rows =
380 -- only show the summary table if we're comparing two runs
381 . (if (length results == 2)
382 then ascii_summary_table False results summary_spec summary_rows . str "\n\n"
384 . interleave "\n\n" (map (asciiGenProgTable results args) per_prog_result_tab)
386 . interleave "\n\n" (map (asciiGenModTable results args) per_module_result_tab)
389 asciiGenProgTable results args (SpecP title _ anc get_result get_status result_ok)
392 . ascii_show_results results args get_result get_status result_ok
394 asciiGenModTable results args (SpecM title anc get_result result_ok)
397 . ascii_show_multi_results results args get_result result_ok
399 ascii_header width ss
400 = str "\n-------------------------------------------------------------------------------\n"
401 . str (rjustify 15 "Program")
403 . foldr (.) id (map (str . rjustify width) ss)
404 . str "\n-------------------------------------------------------------------------------\n"
410 -> (Results -> Maybe a)
411 -> (Results -> Status)
415 ascii_show_results (r:rs) ss f stat result_ok
416 = ascii_header fIELD_WIDTH ss
417 . interleave "\n" (map show_per_prog_results results_per_prog)
420 . show_per_prog_results ("-1 s.d.",lows)
422 . show_per_prog_results ("+1 s.d.",highs)
424 . show_per_prog_results ("Average",gms)
426 -- results_per_prog :: [ (String,[BoxValue a]) ]
427 results_per_prog = map (calc_result rs f stat result_ok) (Map.toList r)
429 results_per_run = transpose (map snd results_per_prog)
430 (lows,gms,highs) = unzip3 (map calc_gmsd results_per_run)
432 -- A summary table, useful only when we are comparing two runs. This table
433 -- shows a number of different result categories, one per column.
435 :: Bool -- generate a LaTeX table?
437 -> [PerProgTableSpec]
440 ascii_summary_table latex (r1:r2:_) specs mb_restrict
441 | latex = makeLatexTable (rows ++ TableLine : av_rows)
443 makeTable (table_layout (length specs) width)
444 (TableLine : TableRow header : TableLine : rows ++ TableLine : av_rows)
446 header = BoxString "Program" : map BoxString headings
448 (headings, columns, av_cols) = unzip3 (map calc_col specs)
449 av_heads = [BoxString "Min", BoxString "Max", BoxString "Geometric Mean"]
450 baseline = Map.toList r1
451 progs = map BoxString (Map.keys r1)
452 rows0 = map TableRow (zipWith (:) progs (transpose columns))
454 rows1 = restrictRows mb_restrict rows0
456 rows | latex = mungeForLaTeX rows1
459 av_rows = map TableRow (zipWith (:) av_heads (transpose av_cols))
462 calc_col (SpecP _ heading _ getr gets ok)
463 = (heading, column, [min,max,mean]) -- throw away the baseline result
464 where (_, boxes) = unzip (map calc_one_result baseline)
465 calc_one_result = calc_result [r2] getr gets ok
466 column = map (\(_:b:_) -> b) boxes
467 (_,mean,_) = calc_gmsd column
468 (min,max) = calc_minmax column
470 restrictRows :: Maybe [String] -> [TableRow] -> [TableRow]
471 restrictRows Nothing rows = rows
472 restrictRows (Just these) rows = filter keep_it rows
473 where keep_it (TableRow (BoxString s: _)) = s `elem` these
474 keep_it TableLine = True
477 mungeForLaTeX :: [TableRow] -> [TableRow]
478 mungeForLaTeX = map transrow
480 transrow (TableRow boxes) = TableRow (map transbox boxes)
483 transbox (BoxString s) = BoxString (foldr transchar "" s)
486 transchar '_' s = '\\':'_':s
489 table_layout n width =
490 (str . rjustify 15) :
491 (\s -> str (space 5) . str (rjustify width s)) :
492 replicate (n-1) (str . rjustify width)
494 ascii_show_multi_results
498 -> (Results -> Map String a)
502 ascii_show_multi_results (r:rs) ss f result_ok
503 = ascii_header fIELD_WIDTH ss
504 . interleave "\n" (map show_results_for_prog results_per_prog_mod_run)
508 . show_per_prog_results ("-1 s.d.",lows)
510 . show_per_prog_results ("+1 s.d.",highs)
512 . show_per_prog_results ("Average",gms)
514 base_results = Map.toList r :: [(String,Results)]
516 -- results_per_prog_mod_run :: [(String,[(String,[BoxValue a])])]
517 results_per_prog_mod_run = map get_results_for_prog base_results
519 -- get_results_for_prog :: (String,Results) -> (String,[BoxValue a])
520 get_results_for_prog (prog,r) = (prog, map get_results_for_mod (Map.toList (f r)))
522 where fms = map get_run_results rs
524 get_run_results fm = case Map.lookup prog fm of
528 get_results_for_mod (id,attr) = calc_result fms Just (const Success)
531 show_results_for_prog (prog,mrs) =
532 str ("\n"++prog++"\n")
534 str "(no modules compiled)\n"
536 interleave "\n" (map show_per_prog_results mrs))
538 results_per_run = transpose [xs | (_,mods) <- results_per_prog_mod_run,
540 (lows,gms,highs) = unzip3 (map calc_gmsd results_per_run)
543 show_per_prog_results :: (String, [BoxValue]) -> ShowS
544 show_per_prog_results = show_per_prog_results_width fIELD_WIDTH
546 show_per_prog_results_width width (prog,results)
547 = str (rjustify 15 prog)
549 . foldr (.) id (map (str . rjustify width . showBox) results)
551 -- ---------------------------------------------------------------------------
552 -- Generic stuff for results generation
554 -- calc_result is a nice exercise in higher-order programming...
557 => [Map String b] -- accumulated results
558 -> (b -> Maybe a) -- get a result from the b
559 -> (b -> Status) -- get a status from the b
560 -> (a -> Bool) -- is this result ok?
561 -> (String,b) -- the baseline result
562 -> (String,[BoxValue])
564 calc_result rts get_maybe_a get_stat result_ok (prog,base_r) =
565 (prog, (just_result baseline base_stat :
568 rts' = map (\rt -> get_stuff (Map.lookup prog rt)) rts
570 get_stuff Nothing = (Nothing, NotDone)
571 get_stuff (Just r) = (get_maybe_a r, get_stat r)
575 Just base | result_ok base
576 -> map (\(r,s) -> percentage r s base) rts'
578 -> map (\(r,s) -> just_result r s) rts'
581 baseline = get_maybe_a base_r
582 base_stat = get_stat base_r
584 just_result Nothing s = RunFailed s
585 just_result (Just a) s = toBox a
587 percentage Nothing s base = RunFailed s
588 percentage (Just a) s base = Percentage
589 (convert_to_percentage base a)
590 -----------------------------------------------------------------------------
591 -- Calculating geometric means and standard deviations
594 This is done using the log method, to avoid needing really large
595 intermediate results. The formula for a geometric mean is
597 (a1 * .... * an) ^ 1/n
599 which is equivalent to
601 e ^ ( (log a1 + ... + log an) / n )
603 where log is the natural logarithm function.
605 Similarly, to compute the geometric standard deviation we compute the
606 deviation of each log, take the root-mean-square, and take the
609 e ^ sqrt( ( sqr(log a1 - lbar) + ... + sqr(log an - lbar) ) / n )
611 where lbar is the mean log,
613 (log a1 + ... + log an) / n
615 This is a *factor*: i.e., the 1 s.d. points are (gm/sdf,gm*sdf); do
616 not subtract 100 from gm before performing this calculation.
618 We therefore return a (low, mean, high) triple.
622 calc_gmsd :: [BoxValue] -> (BoxValue, BoxValue, BoxValue)
624 | null percentages = (RunFailed NotDone, RunFailed NotDone, RunFailed NotDone)
625 | otherwise = let sqr x = x * x
626 len = fromIntegral (length percentages)
627 logs = map log percentages
628 lbar = sum logs / len
629 devs = map (sqr . (lbar-)) logs
630 dbar = sum devs / len
632 sdf = exp (sqrt dbar)
634 (Percentage (gm/sdf),
638 percentages = [ if f < 5 then 5 else f | Percentage f <- xs ]
639 -- can't do log(0.0), so exclude zeros
640 -- small values have inordinate effects so cap at -95%.
642 calc_minmax :: [BoxValue] -> (BoxValue, BoxValue)
644 | null percentages = (RunFailed NotDone, RunFailed NotDone)
645 | otherwise = (Percentage (minimum percentages),
646 Percentage (maximum percentages))
648 percentages = [ if f < 5 then 5 else f | Percentage f <- xs ]
651 -----------------------------------------------------------------------------
654 class Num a => Result a where
655 toBox :: a -> BoxValue
656 convert_to_percentage :: a -> a -> Float
658 -- We assume an Int is a size, and print it in kilobytes.
660 instance Result Int where
661 convert_to_percentage 0 size = 100
662 convert_to_percentage base size = (fromIntegral size / fromIntegral base) * 100
666 instance Result Integer where
667 convert_to_percentage 0 size = 100
668 convert_to_percentage base size = (fromInteger size / fromInteger base) * 100
672 instance Result Float where
673 convert_to_percentage 0.0 size = 100.0
674 convert_to_percentage base size = size / base * 100
678 -- -----------------------------------------------------------------------------
681 -- The contents of a box in a table
690 showBox :: BoxValue -> String
691 showBox (RunFailed stat) = show_stat stat
692 showBox (Percentage f) = show_pcntage f
693 showBox (BoxFloat f) = printf "%.2f" f
694 showBox (BoxInt n) = show (n `div` 1024) ++ "k"
695 showBox (BoxInteger n) = show (n `div` 1024) ++ "k"
696 showBox (BoxString s) = s
698 instance Show BoxValue where { show = showBox }
700 show_pcntage n = show_float_signed (n-100) ++ "%"
703 | n >= 0 = printf "+%.1f" n
704 | otherwise = printf "%.1f" n
706 show_stat Success = "(no result)"
707 show_stat WrongStdout = "(stdout)"
708 show_stat WrongStderr = "(stderr)"
709 show_stat (Exit x) = "exit(" ++ show x ++")"
710 show_stat OutOfHeap = "(heap)"
711 show_stat OutOfStack = "(stack)"
712 show_stat NotDone = "-----"
714 -- -----------------------------------------------------------------------------
718 = TableRow [BoxValue]
721 type Layout = [String -> ShowS]
723 makeTable :: Layout -> [TableRow] -> ShowS
724 makeTable p = interleave "\n" . map do_row
725 where do_row (TableRow boxes) = applyLayout p boxes
726 do_row TableLine = str (take 80 (repeat '-'))
728 makeLatexTable :: [TableRow] -> ShowS
729 makeLatexTable = foldr (.) id . map do_row
730 where do_row (TableRow boxes)
731 = applyLayout latexTableLayout boxes . str "\\\\\n"
735 latexTableLayout :: Layout
736 latexTableLayout = box : repeat (box . (" & "++))
737 where box s = str (foldr transchar "" s)
739 transchar '%' s = s -- leave out the percentage signs
740 transchar c s = c : s
742 applyLayout :: Layout -> [BoxValue] -> ShowS
743 applyLayout layout values =
744 foldr (.) id [ f (show val) | (val,f) <- zip values layout ]
746 -- -----------------------------------------------------------------------------
749 split :: Char -> String -> [String]
750 split c s = case rest of
752 _:rest -> chunk : split c rest
753 where (chunk, rest) = break (==c) s
757 interleave s = foldr1 (\a b -> a . str s . b)
759 fIELD_WIDTH = 16 :: Int
761 -----------------------------------------------------------------------------