usr.sbin/pmcstat/pmcstat.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2005-2007, Joseph Koshy
   5  * Copyright (c) 2007 The FreeBSD Foundation
   6  * All rights reserved.
   7  *
   8  * Portions of this software were developed by A. Joseph Koshy under
   9  * sponsorship from the FreeBSD Foundation and Google, Inc.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _PMCSTAT_H_
  36 #define _PMCSTAT_H_
  37
  38 #include <libpmcstat.h>
  39
  40 #define DEFAULT_WAIT_INTERVAL           5.0
  41 #define DEFAULT_DISPLAY_HEIGHT          256             /* file virtual height */
  42 #define DEFAULT_DISPLAY_WIDTH           1024            /* file virtual width */
  43 #define DEFAULT_BUFFER_SIZE             4096
  44 #define DEFAULT_CALLGRAPH_DEPTH         16
  45
  46 #define PRINT_HEADER_PREFIX             "# "
  47
  48 #define PMCSTAT_DEFAULT_NW_HOST         "localhost"
  49 #define PMCSTAT_DEFAULT_NW_PORT         "9000"
  50
  51 #define PMCSTAT_LDD_COMMAND             "/usr/bin/ldd"
  52
  53 #define PMCSTAT_PRINT_ENTRY(T,...) do {                                 \
  54                 (void) fprintf(args.pa_printfile, "%-9s", T);           \
  55                 (void) fprintf(args.pa_printfile, " "  __VA_ARGS__);    \
  56                 (void) fprintf(args.pa_printfile, "\n");                \
  57         } while (0)
  58
  59 #define PMCSTAT_PL_NONE         0
  60 #define PMCSTAT_PL_CALLGRAPH    1
  61 #define PMCSTAT_PL_GPROF        2
  62 #define PMCSTAT_PL_ANNOTATE     3
  63 #define PMCSTAT_PL_CALLTREE     4
  64 #define PMCSTAT_PL_ANNOTATE_CG  5
  65
  66 #define PMCSTAT_TOP_DELTA       0
  67 #define PMCSTAT_TOP_ACCUM       1
  68
  69 extern int pmcstat_displayheight;       /* current terminal height */
  70 extern int pmcstat_displaywidth;        /* current terminal width */
  71 extern struct pmcstat_args args;        /* command line args */
  72
  73 /* Function prototypes */
  74 void    pmcstat_cleanup(void);
  75 void    pmcstat_find_targets(const char *_arg);
  76 void    pmcstat_kill_process(void);
  77 void    pmcstat_print_counters(void);
  78 void    pmcstat_print_headers(void);
  79 void    pmcstat_print_pmcs(void);
  80 void    pmcstat_show_usage(void);
  81 void    pmcstat_start_pmcs(void);
  82 int     pmcstat_process_log(void);
  83 int     pmcstat_keypress_log(void);
  84 void    pmcstat_display_log(void);
  85 void    pmcstat_pluginconfigure_log(char *_opt);
  86 void    pmcstat_topexit(void);
  87
  88 void pmcstat_log_shutdown_logging(void);
  89 void pmcstat_log_initialize_logging(void);
  90 #endif  /* _PMCSTAT_H_ */