home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / binutils-2.7-src.tgz / tar.out / fsf / binutils / gprof / fsf_callg_bl.c < prev    next >
C/C++ Source or Header  |  1996-09-28  |  5KB  |  94 lines
  1. /* ==> Do not modify this file!!  It is created automatically
  2.    from fsf_callg_bl.m using the gen-c-prog.awk script.  <== */
  3.  
  4. #include <stdio.h>
  5.  
  6. void
  7. fsf_callg_blurb (file)
  8.      FILE *file;
  9. {
  10.   fputs ("\n", file);
  11.   fputs (" This table describes the call tree of the program, and was sorted by\n", file);
  12.   fputs (" the total amount of time spent in each function and its children.\n", file);
  13.   fputs ("\n", file);
  14.   fputs (" Each entry in this table consists of several lines.  The line with the\n", file);
  15.   fputs (" index number at the left hand margin lists the current function.\n", file);
  16.   fputs (" The lines above it list the functions that called this function,\n", file);
  17.   fputs (" and the lines below it list the functions this one called.\n", file);
  18.   fputs (" This line lists:\n", file);
  19.   fputs ("     index    A unique number given to each element of the table.\n", file);
  20.   fputs ("        Index numbers are sorted numerically.\n", file);
  21.   fputs ("        The index number is printed next to every function name so\n", file);
  22.   fputs ("        it is easier to look up where the function in the table.\n", file);
  23.   fputs ("\n", file);
  24.   fputs ("     % time    This is the percentage of the `total' time that was spent\n", file);
  25.   fputs ("        in this function and its children.  Note that due to\n", file);
  26.   fputs ("        different viewpoints, functions excluded by options, etc,\n", file);
  27.   fputs ("        these numbers will NOT add up to 100%.\n", file);
  28.   fputs ("\n", file);
  29.   fputs ("     self    This is the total amount of time spent in this function.\n", file);
  30.   fputs ("\n", file);
  31.   fputs ("     children    This is the total amount of time propagated into this\n", file);
  32.   fputs ("        function by its children.\n", file);
  33.   fputs ("\n", file);
  34.   fputs ("     called    This is the number of times the function was called.\n", file);
  35.   fputs ("        If the function called itself recursively, the number\n", file);
  36.   fputs ("        only includes non-recursive calls, and is followed by\n", file);
  37.   fputs ("        a `+' and the number of recursive calls.\n", file);
  38.   fputs ("\n", file);
  39.   fputs ("     name    The name of the current function.  The index number is\n", file);
  40.   fputs ("        printed after it.  If the function is a member of a\n", file);
  41.   fputs ("        cycle, the cycle number is printed between the\n", file);
  42.   fputs ("        function's name and the index number.\n", file);
  43.   fputs ("\n", file);
  44.   fputs ("\n", file);
  45.   fputs (" For the function's parents, the fields have the following meanings:\n", file);
  46.   fputs ("\n", file);
  47.   fputs ("     self    This is the amount of time that was propagated directly\n", file);
  48.   fputs ("        from the function into this parent.\n", file);
  49.   fputs ("\n", file);
  50.   fputs ("     children    This is the amount of time that was propagated from\n", file);
  51.   fputs ("        the function's children into this parent.\n", file);
  52.   fputs ("\n", file);
  53.   fputs ("     called    This is the number of times this parent called the\n", file);
  54.   fputs ("        function `/' the total number of times the function\n", file);
  55.   fputs ("        was called.  Recursive calls to the function are not\n", file);
  56.   fputs ("        included in the number after the `/'.\n", file);
  57.   fputs ("\n", file);
  58.   fputs ("     name    This is the name of the parent.  The parent's index\n", file);
  59.   fputs ("        number is printed after it.  If the parent is a\n", file);
  60.   fputs ("        member of a cycle, the cycle number is printed between\n", file);
  61.   fputs ("        the name and the index number.\n", file);
  62.   fputs ("\n", file);
  63.   fputs (" If the parents of the function cannot be determined, the word\n", file);
  64.   fputs (" `<spontaneous>' is printed in the `name' field, and all the other\n", file);
  65.   fputs (" fields are blank.\n", file);
  66.   fputs ("\n", file);
  67.   fputs (" For the function's children, the fields have the following meanings:\n", file);
  68.   fputs ("\n", file);
  69.   fputs ("     self    This is the amount of time that was propagated directly\n", file);
  70.   fputs ("        from the child into the function.\n", file);
  71.   fputs ("\n", file);
  72.   fputs ("     children    This is the amount of time that was propagated from the\n", file);
  73.   fputs ("        child's children to the function.\n", file);
  74.   fputs ("\n", file);
  75.   fputs ("     called    This is the number of times the function called\n", file);
  76.   fputs ("        this child `/' the total number of times the child\n", file);
  77.   fputs ("        was called.  Recursive calls by the child are not\n", file);
  78.   fputs ("        listed in the number after the `/'.\n", file);
  79.   fputs ("\n", file);
  80.   fputs ("     name    This is the name of the child.  The child's index\n", file);
  81.   fputs ("        number is printed after it.  If the child is a\n", file);
  82.   fputs ("        member of a cycle, the cycle number is printed\n", file);
  83.   fputs ("        between the name and the index number.\n", file);
  84.   fputs ("\n", file);
  85.   fputs (" If there are any cycles (circles) in the call graph, there is an\n", file);
  86.   fputs (" entry for the cycle-as-a-whole.  This entry shows who called the\n", file);
  87.   fputs (" cycle (as parents) and the members of the cycle (as children.)\n", file);
  88.   fputs (" The `+' recursive calls entry shows the number of function calls that\n", file);
  89.   fputs (" were internal to the cycle, and the calls entry for each member shows,\n", file);
  90.   fputs (" for that member, how many times it was called from other members of\n", file);
  91.   fputs (" the cycle.\n", file);
  92.   fputs ("\n", file);
  93. }
  94.