usr.bin/gprof/PSD.doc/intro.me

   1 .\"     $NetBSD: intro.me,v 1.2 1995/04/19 07:16:42 cgd Exp $
   2 .\"
   3 .\" Copyright (c) 1982, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)intro.me    8.1 (Berkeley) 6/8/93
  31 .\"
  32 .sh 1 "Programs to be Profiled"
  33 .pp
  34 Software research environments
  35 normally include many large programs
  36 both for  production use and for experimental investigation.
  37 These programs are typically modular,
  38 in accordance with generally accepted principles
  39 of good program design.
  40 Often they consist of numerous small routines
  41 that implement various abstractions.
  42 Sometimes such large programs are written
  43 by one programmer
  44 who has understood the requirements for
  45 these abstractions, and has programmed them
  46 appropriately.
  47 More frequently the program has
  48 had multiple authors and has
  49 evolved over time, changing the demands placed
  50 on the implementation of the abstractions without
  51 changing the implementation itself.
  52 Finally, the program may be assembled from a library
  53 of abstraction implementations
  54 unexamined by the programmer.
  55 .pp
  56 Once a large program is executable,
  57 it is often desirable to increase its speed,
  58 especially if small portions of the program
  59 are found to dominate its execution time.
  60 The purpose of the \fBgprof\fP profiling tool is to
  61 help the user evaluate alternative implementations
  62 of abstractions.
  63 We developed this tool in response to our efforts
  64 to improve a code generator we were writing [Graham82].
  65 .pp
  66 The \fBgprof\fP design takes advantage of the fact that the programs
  67 to be measured are large, structured and hierarchical.
  68 We provide a profile in which the execution time
  69 for a set of routines that implement an
  70 abstraction is collected and charged
  71 to that abstraction.
  72 The profile can be used to compare and assess the costs of
  73 various implementations.
  74 .pp
  75 The profiler can be linked into a program without
  76 special planning by the programmer.
  77 The overhead for using \fBgprof\fP is low;
  78 both in terms of added execution time and in the
  79 volume of profiling information recorded.