2 * sar/sadc: Report system activity
3 * (C) 1999-2018 by Sebastien Godard (sysstat <at> orange.fr)
13 #include "rd_sensors.h"
16 ***************************************************************************
17 * Activity identification values.
18 ***************************************************************************
21 /* Number of activities */
23 /* The value below is used for sanity check */
24 #define MAX_NR_ACT 256
26 /* Number of functions used to count items */
49 #define A_NET_EICMP 20
53 #define A_NET_SOCK6 24
56 #define A_NET_ICMP6 27
57 #define A_NET_EICMP6 28
71 /* Macro used to flag an activity that should be collected */
72 #define COLLECT_ACTIVITY(m) act[get_activity_position(act, m, EXIT_IF_NOT_FOUND)]->options |= AO_COLLECTED
74 /* Macro used to flag an activity that should be selected */
75 #define SELECT_ACTIVITY(m) act[get_activity_position(act, m, EXIT_IF_NOT_FOUND)]->options |= AO_SELECTED
79 ***************************************************************************
81 ***************************************************************************
84 #define S_F_SINCE_BOOT 0x00000001
85 #define S_F_SA_ROTAT 0x00000002
86 #define S_F_DEV_PRETTY 0x00000004
87 #define S_F_FORCE_FILE 0x00000008
88 #define S_F_INTERVAL_SET 0x00000010
89 #define S_F_TRUE_TIME 0x00000020
90 #define S_F_LOCK_FILE 0x00000040
91 #define S_F_SEC_EPOCH 0x00000080
92 #define S_F_HDR_ONLY 0x00000100
93 #define S_F_FILE_LOCKED 0x00000200
94 #define S_F_SA_YYYYMMDD 0x00000400
95 #define S_F_HORIZONTALLY 0x00000800
96 #define S_F_COMMENT 0x00001000
97 #define S_F_PERSIST_NAME 0x00002000
98 #define S_F_LOCAL_TIME 0x00004000
99 #define S_F_PREFD_TIME_OUTPUT 0x00008000
100 #define S_F_SVG_SKIP 0x00010000
101 /* Same value as S_F_SVG_SKIP above. Used for a different output format */
102 #define S_F_RAW_DEBUG_MODE 0x00010000
103 #define S_F_SVG_AUTOSCALE 0x00020000
104 #define S_F_SVG_ONE_DAY 0x00040000
105 #define S_F_SVG_SHOW_IDLE 0x00080000
106 #define S_F_UNIT 0x00100000
107 #define S_F_SVG_HEIGHT 0x00200000
108 #define S_F_SVG_PACKED 0x00400000
109 #define S_F_SVG_SHOW_INFO 0x00800000
110 #define S_F_HUMAN_READ 0x01000000
111 #define S_F_ZERO_OMIT 0x02000000
112 #define S_F_SVG_SHOW_TOC 0x04000000
114 #define WANT_SINCE_BOOT(m) (((m) & S_F_SINCE_BOOT) == S_F_SINCE_BOOT)
115 #define WANT_SA_ROTAT(m) (((m) & S_F_SA_ROTAT) == S_F_SA_ROTAT)
116 #define USE_PRETTY_OPTION(m) (((m) & S_F_DEV_PRETTY) == S_F_DEV_PRETTY)
117 #define FORCE_FILE(m) (((m) & S_F_FORCE_FILE) == S_F_FORCE_FILE)
118 #define INTERVAL_SET(m) (((m) & S_F_INTERVAL_SET) == S_F_INTERVAL_SET)
119 #define PRINT_TRUE_TIME(m) (((m) & S_F_TRUE_TIME) == S_F_TRUE_TIME)
120 #define LOCK_FILE(m) (((m) & S_F_LOCK_FILE) == S_F_LOCK_FILE)
121 #define PRINT_SEC_EPOCH(m) (((m) & S_F_SEC_EPOCH) == S_F_SEC_EPOCH)
122 #define DISPLAY_HDR_ONLY(m) (((m) & S_F_HDR_ONLY) == S_F_HDR_ONLY)
123 #define FILE_LOCKED(m) (((m) & S_F_FILE_LOCKED) == S_F_FILE_LOCKED)
124 #define USE_SA_YYYYMMDD(m) (((m) & S_F_SA_YYYYMMDD) == S_F_SA_YYYYMMDD)
125 #define DISPLAY_HORIZONTALLY(m) (((m) & S_F_HORIZONTALLY) == S_F_HORIZONTALLY)
126 #define DISPLAY_COMMENT(m) (((m) & S_F_COMMENT) == S_F_COMMENT)
127 #define DISPLAY_PERSIST_NAME_S(m) (((m) & S_F_PERSIST_NAME) == S_F_PERSIST_NAME)
128 #define PRINT_LOCAL_TIME(m) (((m) & S_F_LOCAL_TIME) == S_F_LOCAL_TIME)
129 #define USE_PREFD_TIME_OUTPUT(m) (((m) & S_F_PREFD_TIME_OUTPUT) == S_F_PREFD_TIME_OUTPUT)
130 #define SKIP_EMPTY_VIEWS(m) (((m) & S_F_SVG_SKIP) == S_F_SVG_SKIP)
131 #define DISPLAY_ZERO_OMIT(m) (((m) & S_F_ZERO_OMIT) == S_F_ZERO_OMIT)
132 #define DISPLAY_DEBUG_MODE(m) (((m) & S_F_RAW_DEBUG_MODE) == S_F_RAW_DEBUG_MODE)
133 #define AUTOSCALE_ON(m) (((m) & S_F_SVG_AUTOSCALE) == S_F_SVG_AUTOSCALE)
134 #define DISPLAY_ONE_DAY(m) (((m) & S_F_SVG_ONE_DAY) == S_F_SVG_ONE_DAY)
135 #define DISPLAY_IDLE(m) (((m) & S_F_SVG_SHOW_IDLE) == S_F_SVG_SHOW_IDLE)
136 #define DISPLAY_INFO(m) (((m) & S_F_SVG_SHOW_INFO) == S_F_SVG_SHOW_INFO)
137 #define DISPLAY_UNIT(m) (((m) & S_F_UNIT) == S_F_UNIT)
138 #define SET_CANVAS_HEIGHT(m) (((m) & S_F_SVG_HEIGHT) == S_F_SVG_HEIGHT)
139 #define PACK_VIEWS(m) (((m) & S_F_SVG_PACKED) == S_F_SVG_PACKED)
140 #define DISPLAY_HUMAN_READ(m) (((m) & S_F_HUMAN_READ) == S_F_HUMAN_READ)
141 #define DISPLAY_TOC(m) (((m) & S_F_SVG_SHOW_TOC) == S_F_SVG_SHOW_TOC)
143 #define AO_F_NULL 0x00000000
145 /* Output flags for options -r / -S */
146 #define AO_F_MEMORY 0x00000001
147 #define AO_F_SWAP 0x00000002
148 /* AO_F_MEM_ALL: See opt_flags in struct activity below */
149 #define AO_F_MEM_ALL (AO_F_MEMORY << 8)
151 #define DISPLAY_MEMORY(m) (((m) & AO_F_MEMORY) == AO_F_MEMORY)
152 #define DISPLAY_SWAP(m) (((m) & AO_F_SWAP) == AO_F_SWAP)
153 #define DISPLAY_MEM_ALL(m) (((m) & AO_F_MEM_ALL) == AO_F_MEM_ALL)
155 /* Output flags for option -u [ ALL ] */
156 #define AO_F_CPU_DEF 0x00000001
157 #define AO_F_CPU_ALL 0x00000002
159 #define DISPLAY_CPU_DEF(m) (((m) & AO_F_CPU_DEF) == AO_F_CPU_DEF)
160 #define DISPLAY_CPU_ALL(m) (((m) & AO_F_CPU_ALL) == AO_F_CPU_ALL)
162 /* Output flags for option -d */
163 #define AO_F_DISK_PART 0x00000001
165 #define COLLECT_PARTITIONS(m) (((m) & AO_F_DISK_PART) == AO_F_DISK_PART)
167 /* Output flags for option -F */
168 #define AO_F_FILESYSTEM 0x00000001
169 #define AO_F_MOUNT 0x00000002
171 #define DISPLAY_MOUNT(m) (((m) & AO_F_MOUNT) == AO_F_MOUNT)
174 ***************************************************************************
175 * Various keywords and constants.
176 ***************************************************************************
180 #define K_A_NULL "A_NULL"
181 #define K_XALL "XALL"
184 #define K_EDEV "EDEV"
186 #define K_NFSD "NFSD"
187 #define K_SOCK "SOCK"
190 #define K_ICMP "ICMP"
191 #define K_EICMP "EICMP"
193 #define K_ETCP "ETCP"
195 #define K_SOCK6 "SOCK6"
197 #define K_EIP6 "EIP6"
198 #define K_ICMP6 "ICMP6"
199 #define K_EICMP6 "EICMP6"
200 #define K_UDP6 "UDP6"
203 #define K_TEMP "TEMP"
205 #define K_FREQ "FREQ"
206 #define K_MOUNT "MOUNT"
208 #define K_SOFT "SOFT"
211 #define K_DISK "DISK"
212 #define K_XDISK "XDISK"
213 #define K_SNMP "SNMP"
214 #define K_IPV6 "IPV6"
215 #define K_POWER "POWER"
218 #define K_SKIP_EMPTY "skipempty"
219 #define K_AUTOSCALE "autoscale"
220 #define K_ONEDAY "oneday"
221 #define K_SHOWIDLE "showidle"
222 #define K_SHOWINFO "showinfo"
223 #define K_DEBUG "debug"
224 #define K_HEIGHT "height="
225 #define K_PACKED "packed"
226 #define K_SHOWTOC "showtoc"
228 /* Groups of activities */
229 #define G_DEFAULT 0x00
240 /* Time must have the format HH:MM:SS with HH in 24-hour format */
241 #define DEF_TMSTART "08:00:00"
242 #define DEF_TMEND "18:00:00"
244 #define UTSNAME_LEN 65
245 #define HEADER_LINE_LEN 512
248 * Define upper limit for various items.
249 * Made necessary because we have to check the number of
250 * items for each activity when we read a (possibly tainted)
253 #define MAX_NR_SERIAL_LINES 65536
254 #define MAX_NR_DISKS (65536 * 4096)
255 #define MAX_NR_IFACES 65536
256 #define MAX_NR_FANS 4096
257 #define MAX_NR_TEMP_SENSORS 4096
258 #define MAX_NR_IN_SENSORS 4096
259 #define MAX_NR_USB 65536
260 #define MAX_NR_FS (65536 * 4096)
261 #define MAX_NR_FCHOSTS 65536
263 /* NR_MAX is the upper limit used for unknown activities */
264 #define NR_MAX (65536 * 4096)
267 /* Maximum number of args that can be passed to sadc */
268 #define MAX_ARGV_NR 32
270 /* Miscellaneous constants */
272 #define USE_SA_FILE 1
273 #define NO_TM_START 0
280 #define ALL_ACTIVITIES ~0U
281 #define EXIT_IF_NOT_FOUND 1
282 #define RESUME_IF_NOT_FOUND 0
290 #define END_OF_DATA_UNEXPECTED 1
291 #define INCONSISTENT_INPUT_DATA 2
293 #define CLOSE_XML_MARKUP 0
294 #define OPEN_XML_MARKUP 1
296 #define CLOSE_JSON_MARKUP 0
297 #define OPEN_JSON_MARKUP 1
299 #define COUNT_ACTIVITIES 0
300 #define COUNT_OUTPUTS 1
302 /* Type for all functions reading statistics */
303 #define __read_funct_t void
304 /* Type for all functions displaying statistics */
305 #define __print_funct_t void
307 /* Structure for SVG specific parameters */
309 unsigned long long dt; /* Interval of time for current sample */
310 unsigned long long ust_time_ref; /* X axis start time in seconds since the epoch */
311 unsigned long long ust_time_end; /* X axis end time in seconds since the epoch */
312 unsigned long long ust_time_first; /* Time (in seconds since the epoch) for first sample */
313 int graph_no; /* Total number of views already displayed */
314 int restart; /* TRUE if we have just met a RESTART record */
315 int nr_act_dispd; /* Number of activities that will be displayed */
316 struct file_header *file_hdr; /* Pointer on file header structure */
319 /* Structure used when displaying SVG header */
320 struct svg_hdr_parm {
321 int graph_nr; /* Number of rows of views to display or canvas height entered on the command line */
322 int views_per_row; /* Maximum number of views on a single row */
323 int nr_act_dispd; /* Number of activities that will be displayed */
327 ***************************************************************************
328 * System activity data files
330 * The rule is: "strict writing, read any", meaning that sar/sadc can
331 * only append data to a datafile whose format is strictly the same as that
332 * of current version (checking FORMAT_MAGIC is not enough), but sar/sadf
333 * can read data from different versions, providing that FORMAT_MAGIC value
334 * has not changed (note that we are talking here of data read from a file,
335 * not data that sar reads from sadc, in which case the "strict" rule applies).
337 * Format of system activity data files:
340 * | file_magic structure
344 * | file_header structure
348 * | file_activity structure | * sa_act_nr
352 * | record_header structure |
358 * | Statistics structure(s) | * <count>
364 * | Statistics structure(s)... |
368 * Note: For activities with varying number of items, a __nr_t value, giving
369 * the number of items, arrives before the statistics structures so that
370 * we know how many of them have to be read.
371 * NB: This value exists for all the activities even if they share the same
372 * count function (e.g. A_NET_DEV and A_NET_EDEV). Indeed, statistics are not
373 * read atomically and the number of items (e.g. network interfaces) may have
376 * If the record header's type is R_COMMENT then we find only a comment
377 * following the record_header structure.
378 * If the record_header's type is R_RESTART then we find only the number of CPU
379 * (of type __nr_t) of the machine following the record_header structure.
380 ***************************************************************************
384 * Sysstat magic number. Should never be modified.
385 * Indicate that the file was created by sysstat.
387 #define SYSSTAT_MAGIC 0xd596
388 #define SYSSTAT_MAGIC_SWAPPED (((SYSSTAT_MAGIC << 8) | (SYSSTAT_MAGIC >> 8)) & 0xffff)
391 * Datafile format magic number.
392 * Modified to indicate that the format of the file is
393 * no longer compatible with that of previous sysstat versions.
395 #define FORMAT_MAGIC 0x2175
396 #define FORMAT_MAGIC_SWAPPED (((FORMAT_MAGIC << 8) | (FORMAT_MAGIC >> 8)) & 0xffff)
398 /* Previous datafile format magic numbers used by older sysstat versions */
399 #define FORMAT_MAGIC_2171 0x2171
400 #define FORMAT_MAGIC_2171_SWAPPED (((FORMAT_MAGIC_2171 << 8) | (FORMAT_MAGIC_2171 >> 8)) & 0xffff)
401 #define FORMAT_MAGIC_2173 0x2173
402 #define FORMAT_MAGIC_2173_SWAPPED (((FORMAT_MAGIC_2173 << 8) | (FORMAT_MAGIC_2173 >> 8)) & 0xffff)
404 /* Padding in file_magic structure. See below. */
405 #define FILE_MAGIC_PADDING 48
407 /* Structure for file magic header data */
410 * This field identifies the file as a file created by sysstat.
412 unsigned short sysstat_magic;
414 * The value of this field varies whenever datafile format changes.
416 unsigned short format_magic;
418 * Sysstat version used to create the file.
420 unsigned char sysstat_version;
421 unsigned char sysstat_patchlevel;
422 unsigned char sysstat_sublevel;
423 unsigned char sysstat_extraversion;
424 #define FILE_MAGIC_ULL_NR 0 /* Nr of unsigned long long below */
425 #define FILE_MAGIC_UL_NR 0 /* Nr of unsigned long below */
426 #define FILE_MAGIC_U_NR 5 /* Nr of [unsigned] int below */
428 * Size of file's header (size of file_header structure used by file).
430 unsigned int header_size;
432 * Set to non zero if data file has been converted with "sadf -c" from
433 * an old format (version x.y.z) to a newest format (version X.Y.Z).
434 * In this case, the value is: Y*256 + Z + 1.
435 * The FORMAT_MAGIC value of the file can be used to determine X.
437 unsigned int upgraded;
439 * Description of the file_header structure
440 * (nr of "long long", nr of "long" and nr of "int").
442 unsigned int hdr_types_nr[3];
444 * Padding. Reserved for future use while avoiding a format change.
445 * sysstat always reads a number of bytes which is that expected for
446 * current sysstat version (FILE_MAGIC_SIZE). We cannot guess if we
447 * are going to read a file from current, an older or a newer version.
449 unsigned char pad[FILE_MAGIC_PADDING];
452 #define FILE_MAGIC_SIZE (sizeof(struct file_magic))
454 /* Header structure for system activity data file */
457 * Timestamp in seconds since the epoch.
459 unsigned long long sa_ust_time;
461 * Number of jiffies per second.
463 unsigned long sa_hz __attribute__ ((aligned (8)));
465 * Number of [online or offline] CPU (1 .. CPU_NR + 1)
466 * when the datafile has been created.
467 * When reading a datafile, this value is updated (in memory)
468 * whenever a RESTART record is found.
469 * When writing or appending data to a file, this field is updated
470 * neither in file nor in memory.
472 unsigned int sa_cpu_nr __attribute__ ((aligned (8)));
474 * Number of activities saved in file.
476 unsigned int sa_act_nr;
482 * Description of the file_activity and record_header structures
483 * (nr of "long long", nr of "long" and nr of "int").
485 unsigned int act_types_nr[3];
486 unsigned int rec_types_nr[3];
488 * Size of file_activity and record_header structures used by file.
490 unsigned int act_size;
491 unsigned int rec_size;
493 * Current day and month.
494 * No need to save DST (Daylight Saving Time) flag, since it is not taken
495 * into account by the strftime() function used to print the timestamp.
497 unsigned char sa_day;
498 unsigned char sa_month;
500 * Size of a long integer. Useful to know the architecture on which
501 * the datafile was created.
505 * Operating system name.
507 char sa_sysname[UTSNAME_LEN];
511 char sa_nodename[UTSNAME_LEN];
513 * Operating system release number.
515 char sa_release[UTSNAME_LEN];
517 * Machine architecture.
519 char sa_machine[UTSNAME_LEN];
522 #define FILE_HEADER_SIZE (sizeof(struct file_header))
523 #define FILE_HEADER_ULL_NR 1 /* Nr of unsigned long long in file_header structure */
524 #define FILE_HEADER_UL_NR 1 /* Nr of unsigned long in file_header structure */
525 #define FILE_HEADER_U_NR 11 /* Nr of [unsigned] int in file_header structure */
526 /* The values below are used for sanity check */
527 #define MIN_FILE_HEADER_SIZE 0
528 #define MAX_FILE_HEADER_SIZE 8192
532 * Base magical number for activities.
534 #define ACTIVITY_MAGIC_BASE 0x8a
536 * Magical value used for activities with
537 * unknown format (used for sadf -H only).
539 #define ACTIVITY_MAGIC_UNKNOWN 0x89
541 /* List of activities saved in file */
542 struct file_activity {
544 * Identification value of activity.
548 * Activity magical number.
552 * Number of items for this activity
553 * when the data file has been created.
557 * Number of sub-items for this activity.
561 * Set to TRUE if statistics are preceded by
562 * a value giving the number of structures to read.
566 * Size of an item structure.
570 * Description of the structure containing statistics for the
571 * given activity (nr of "long long", nr of "long" and nr of "int").
573 unsigned int types_nr[3];
576 #define FILE_ACTIVITY_SIZE (sizeof(struct file_activity))
577 #define MAX_FILE_ACTIVITY_SIZE 1024 /* Used for sanity check */
578 #define FILE_ACTIVITY_ULL_NR 0 /* Nr of unsigned long long in file_activity structure */
579 #define FILE_ACTIVITY_UL_NR 0 /* Nr of unsigned long in file_activity structure */
580 #define FILE_ACTIVITY_U_NR 9 /* Nr of [unsigned] int in file_activity structure */
585 * R_STATS means that this is a record of statistics.
589 * R_RESTART means that this is a special record containing
590 * a LINUX RESTART message.
594 * R_LAST_STATS warns sar that this is the last record to be written
595 * to file before a file rotation, and that the next data to come will
597 * Such a record is tagged R_STATS anyway before being written to file.
599 #define R_LAST_STATS 3
601 * R_COMMENT means that this is a special record containing
606 /* Maximum length of a comment */
607 #define MAX_COMMENT_LEN 64
609 /* Header structure for every record */
610 struct record_header {
612 * Machine uptime in 1/100th of a second.
614 unsigned long long uptime_cs;
616 * Timestamp (number of seconds since the epoch).
618 unsigned long long ust_time;
620 * Record type: R_STATS, R_RESTART,...
622 unsigned char record_type;
624 * Timestamp: Hour (0-23), minute (0-59) and second (0-59).
625 * Used to determine TRUE time (immutable, non locale dependent time).
628 unsigned char minute;
629 unsigned char second;
632 #define RECORD_HEADER_SIZE (sizeof(struct record_header))
633 #define MAX_RECORD_HEADER_SIZE 512 /* Used for sanity check */
634 #define RECORD_HEADER_ULL_NR 2 /* Nr of unsigned long long in record_header structure */
635 #define RECORD_HEADER_UL_NR 0 /* Nr of unsigned long in record_header structure */
636 #define RECORD_HEADER_U_NR 0 /* Nr of unsigned int in record_header structure */
640 ***************************************************************************
641 * Generic description of an activity.
642 ***************************************************************************
645 /* Activity options */
648 * Indicate that corresponding activity should be collected by sadc.
650 #define AO_COLLECTED 0x01
652 * Indicate that corresponding activity should be displayed by sar.
654 #define AO_SELECTED 0x02
656 * Indicate that corresponding activity has items that need to be counted.
657 * This means that its @f_count_index values is >= 0.
658 * (We use AO_COUNTED instead of @f_count_index because @f_count_index
659 * is available (initialized) only for sadc).
661 #define AO_COUNTED 0x04
663 * Indicate that activity's metrics have persistent values when devices
664 * are registered again (this means that when the device is registered again,
665 * the metrics pick the values they had when they had been unregistered).
666 * Exclusively used for CPU related statistics at the present time.
668 #define AO_PERSISTENT 0x08
670 * This flag should be set for every activity closing a markup used
671 * by several activities. Used by sadf f_xml_print() functions to
672 * display XML output.
674 #define AO_CLOSE_MARKUP 0x10
676 * Indicate that corresponding activity has multiple different
677 * output formats. This is the case for example for memory activity
678 * with options -r and -R.
679 * PS: Such an activity should appear in the list of activities that
680 * sar -A is supposed to display.
682 #define AO_MULTIPLE_OUTPUTS 0x20
684 * Indicate that one (SVG) graph will be displayed for each
685 * distinct item for this activity (sadf -g).
687 #define AO_GRAPH_PER_ITEM 0x40
689 * Indicate that this activity may have sub-items.
691 #define AO_MATRIX 0x80
693 * Indicate that a list of devices has been entered on the command
694 * line for this activity (see options --dev=, --iface=, ...)
696 #define AO_LIST_ON_CMDLINE 0x100
698 #define IS_COLLECTED(m) (((m) & AO_COLLECTED) == AO_COLLECTED)
699 #define IS_SELECTED(m) (((m) & AO_SELECTED) == AO_SELECTED)
700 #define HAS_COUNT_FUNCTION(m) (((m) & AO_COUNTED) == AO_COUNTED)
701 #define HAS_PERSISTENT_VALUES(m) (((m) & AO_PERSISTENT) == AO_PERSISTENT)
702 #define CLOSE_MARKUP(m) (((m) & AO_CLOSE_MARKUP) == AO_CLOSE_MARKUP)
703 #define HAS_MULTIPLE_OUTPUTS(m) (((m) & AO_MULTIPLE_OUTPUTS) == AO_MULTIPLE_OUTPUTS)
704 #define ONE_GRAPH_PER_ITEM(m) (((m) & AO_GRAPH_PER_ITEM) == AO_GRAPH_PER_ITEM)
705 #define IS_MATRIX(m) (((m) & AO_MATRIX) == AO_MATRIX)
706 #define HAS_LIST_ON_CMDLINE(m) (((m) & AO_LIST_ON_CMDLINE) == AO_LIST_ON_CMDLINE)
711 /* Structure used to define a bitmap needed by an activity */
714 * Bitmap for activities that need one. Remember to allocate it
717 unsigned char *b_array;
719 * Size of the bitmap in bits. In fact, bitmap is sized to b_size + 1
720 * to take into account CPU "all"
726 * Structure used to define an activity.
727 * Note: This structure can be modified without changing the format of data files.
731 * This variable contains the identification value (A_...) for this activity.
735 * Activity options (AO_...)
737 unsigned int options;
739 * Activity magical number. This number changes when activity format in file
740 * is no longer compatible with the format of that same activity from
745 * An activity belongs to a group (and only one).
746 * Groups are those selected with option -S of sadc.
750 * Index in f_count[] array to determine function used to count
751 * the number of items (serial lines, network interfaces, etc.) -> @nr
752 * Such a function should _always_ return a value greater than
755 * A value of -1 indicates that the number of items
756 * is a constant (and @nr is set to this value).
758 * These functions are called even if corresponding activities have not
759 * been selected, to make sure that all items have been calculated
760 * (including #CPU, etc.)
764 * The f_count2() function is used to count the number of
766 * Such a function should _always_ return a value greater than
769 * A NULL value for this function pointer indicates that the number of items
770 * is a constant (and @nr2 is set to this value).
772 __nr_t (*f_count2) (struct activity *);
774 * This function reads the relevant file and fill the buffer
775 * with statistics corresponding to given activity.
777 __read_funct_t (*f_read) (struct activity *);
779 * This function displays activity statistics onto the screen.
781 __print_funct_t (*f_print) (struct activity *, int, int, unsigned long long);
783 * This function displays average activity statistics onto the screen.
785 __print_funct_t (*f_print_avg) (struct activity *, int, int, unsigned long long);
787 * This function is used by sadf to display activity in a format that can
788 * easily be ingested by a relational database, or a format that can be
789 * handled by pattern processing commands like "awk".
791 __print_funct_t (*f_render) (struct activity *, int, char *, int, unsigned long long);
793 * This function is used by sadf to display activity statistics in XML.
795 __print_funct_t (*f_xml_print) (struct activity *, int, int, unsigned long long);
797 * This function is used by sadf to display activity statistics in JSON.
799 __print_funct_t (*f_json_print) (struct activity *, int, int, unsigned long long);
801 * This function is used by sadf to display activity statistics in SVG.
803 __print_funct_t (*f_svg_print) (struct activity *, int, int, struct svg_parm *,
804 unsigned long long, struct record_header *);
806 * This function is used by sadf to display activity statistics in raw format.
808 __print_funct_t (*f_raw_print) (struct activity *, char *, int);
810 * This function is used by sadf to count the number of new items in current
811 * sample and add them to the linked list @item_list.
813 __nr_t (*f_count_new) (struct activity *, int);
815 * Linked list containing item names. This is either all the different items
816 * found in a file for activities that have a @f_count_function() (used by sadf),
817 * or a list entered on the command line (used by sadf and sar).
819 struct sa_item *item_list;
821 * Number of different items found in file (calculated by sadf).
822 * This is also the number of items in @item_list if this list exists.
826 * Header string displayed by sadf -d.
827 * Header lines for each output (for activities with multiple outputs) are
828 * separated with a '|' character.
829 * For a given output, the first field corresponding to extended statistics
830 * (eg. -r ALL) begins with a '&' character.
834 * Description of activity.
842 * Description of the corresponding structure containing statistics (as defined
843 * in rd_stats.h or rd_sensors.h). Such a structure has 0+ fields of type
844 * "long long", followed by 0+ fields of type "long", followed by 0+ fields of
845 * type "int", followed by 0+ other fields (e.g. of type char). The array below
846 * gives the number of "long long" fields composing the structure, then the number
847 * of "long" fields, then the number of "int" fields.
849 unsigned int gtypes_nr[3];
851 * This array has the same meaning as @gtypes_nr[] above, but the values are those
852 * read from current data file. They may be different from those of @gtypes_nr[]
853 * because we can read data from a different sysstat version (older or newer).
855 unsigned int ftypes_nr[3];
857 * Number of SVG graphs for this activity. The total number of graphs for
858 * the activity can be greater though if flag AO_GRAPH_PER_ITEM is set, in
859 * which case the total number will be @g_nr * @nr.
863 * Number of items on the system, as counted when the system is initialized.
864 * A negative value (-1) is the default value and indicates that this number
865 * has still not been calculated by the f_count() function.
866 * A value of 0 means that this number has been calculated, but no items have
868 * A positive value (>0) has either been calculated or is a constant.
872 * Number of sub-items on the system.
873 * @nr2 is in fact the second dimension of a matrix of items, the first
874 * one being @nr. @nr is the number of lines, and @nr2 the number of columns.
875 * A negative value (-1) is the default value and indicates that this number
876 * has still not been calculated by the f_count2() function.
877 * A value of 0 means that this number has been calculated, but no sub-items have
879 * A positive value (>0) has either been calculated or is a constant.
881 * 1) IF @nr2 = 0 THEN @nr = 0
882 * Note: If @nr = 0, then @nr2 is undetermined (may be -1, 0 or >0).
883 * 2) IF @nr > 0 THEN @nr2 > 0.
884 * Note: If @nr2 > 0 then @nr is undetermined (may be -1, 0 or >0).
885 * 3) IF @nr <= 0 THEN @nr2 = -1 (this is the default value for @nr2,
886 * meaning that it has not been calculated).
890 * Maximum number of elements that sar can handle for this item.
891 * NB: The maximum number of elements that sar can handle for sub-items
896 * Number of items, as read and saved in corresponding buffer (@buf: See below).
897 * The value may be zero for a particular sample if no items have been found.
901 * Number of structures allocated in @buf[*]. This number should be greater
902 * than or equal to @nr[*].
907 * This is the size of the corresponding structure, as read from or written
908 * to a file, or read from or written by the data collector.
913 * This is the size of the corresponding structure as mapped into memory.
914 * @msize can be different from @fsize when data are read from or written to
915 * a data file from a different sysstat version.
919 * Optional flags for activity. This is eg. used when AO_MULTIPLE_OUTPUTS
921 * 0x0001 - 0x0080 : Multiple outputs (eg. AO_F_MEMORY, AO_F_SWAP...)
922 * 0x0100 - 0x8000 : If bit set then display complete header (hdr_line) for
923 * corresponding output
924 * 0x010000+ : Optional flags
926 unsigned int opt_flags;
928 * Buffers that will contain the statistics read. Its size is @nr * @nr2 * @size each.
930 * [0] and [1]: current/previous statistics values (used by sar).
931 * [2]: Used by sar to save first collected stats (used later to
936 * Bitmap for activities that need one. Such a bitmap is needed by activity
937 * if @bitmap is not NULL.
939 struct act_bitmap *bitmap;
944 ***************************************************************************
945 * Generic description of an output format for sadf (and sar).
946 ***************************************************************************
949 /* Type for all functions used by sadf to display stats in various formats */
950 #define __printf_funct_t void
951 #define __tm_funct_t char *
954 * Structure used to define a report.
955 * A XML-like report has the following format:
961 * | | Statistics block
964 * | | | Timestamp block
967 * | | | | Activity #1
973 * | | | | Activity #n
978 * | | Restart messages block
985 struct report_format {
987 * This variable contains the identification value (F_...) for this report format.
991 * Format options (FO_...).
993 unsigned int options;
995 * This function displays the report header
996 * (data displayed once at the beginning of the report).
998 __printf_funct_t (*f_header) (void *, int, char *, struct file_magic *, struct file_header *,
999 struct activity * [], unsigned int [], struct file_activity *);
1001 * This function defines the statistics part of the report.
1002 * Used only with textual (XML-like) reports.
1004 __printf_funct_t (*f_statistics) (int *, int);
1006 * This function defines the timestamp part of the report.
1007 * Used only with textual (XML-like) reports.
1009 __tm_funct_t (*f_timestamp) (void *, int, char *, char *, unsigned long long,
1010 struct file_header *, unsigned int);
1012 * This function displays the restart messages.
1014 __printf_funct_t (*f_restart) (int *, int, char *, char *, int, struct file_header *);
1016 * This function displays the comments.
1018 __printf_funct_t (*f_comment) (int *, int, char *, char *, int, char *, struct file_header *);
1021 /* Possible actions for functions used to display reports */
1022 #define F_BEGIN 0x01
1027 ***************************************************************************
1028 * SVG output definitions
1029 ***************************************************************************
1034 * 1 | General header
1037 * 9 | One line from table of contents (if any)
1040 * | | 4 | Graph title
1050 * | | v |-------------------------------
1052 * | v <---><------------------------------>
1055 * v<---------------------------------------------------------------> Gap
1057 * <--------------------------------------------------------------------->
1062 #define SVG_G_XSIZE 720
1064 #define SVG_M_XSIZE 70
1066 #define SVG_V_XSIZE 1050
1068 #define SVG_T_XSIZE 1060
1071 #define SVG_G_YSIZE 200
1073 #define SVG_H_YSIZE 60
1075 #define SVG_M_YSIZE 50
1077 #define SVG_T_YSIZE 310
1079 #define SVG_V_YSIZE 300
1081 #define SVG_C_YSIZE 20
1083 /* Grid: Nr of horizontal lines */
1084 #define SVG_H_GRIDNR 3
1085 /* Grid: Nr of vertical lines */
1086 #define SVG_V_GRIDNR 10
1088 /* Block size used to allocate arrays for graphs data */
1089 #define CHUNKSIZE 4096
1091 /* Maximum number of views on a single row */
1092 #define MAX_VIEWS_ON_A_ROW 6
1094 #define SVG_LINE_GRAPH 1
1095 #define SVG_BAR_GRAPH 2
1097 /* Maximum number of horizontal lines for the background grid */
1098 #define MAX_HLINES_NR 10
1103 ***************************************************************************
1104 * Macro functions definitions.
1106 * Note: Using 'do ... while' makes the macros safer to use
1107 * (remember that macro use is followed by a semicolon).
1108 ***************************************************************************
1111 /* Close file descriptors */
1112 #define CLOSE_ALL(_fd_) do { \
1117 #define CLOSE(_fd_) if (_fd_ >= 0) \
1122 ***************************************************************************
1123 * Various structure definitions.
1124 ***************************************************************************
1127 /* Structure for timestamps */
1135 /* Structure for items in list */
1138 struct sa_item *next;
1143 ***************************************************************************
1144 * Functions prototypes.
1145 ***************************************************************************
1149 * Prototypes used to count new items
1151 __nr_t count_new_net_dev
1152 (struct activity *, int);
1153 __nr_t count_new_net_edev
1154 (struct activity *, int);
1155 __nr_t count_new_filesystem
1156 (struct activity *, int);
1157 __nr_t count_new_fchost
1158 (struct activity *, int);
1159 __nr_t count_new_disk
1160 (struct activity *, int);
1162 /* Functions used to count number of items */
1163 __nr_t wrap_get_cpu_nr
1164 (struct activity *);
1165 __nr_t wrap_get_irq_nr
1166 (struct activity *);
1167 __nr_t wrap_get_serial_nr
1168 (struct activity *);
1169 __nr_t wrap_get_disk_nr
1170 (struct activity *);
1171 __nr_t wrap_get_iface_nr
1172 (struct activity *);
1173 __nr_t wrap_get_fan_nr
1174 (struct activity *);
1175 __nr_t wrap_get_temp_nr
1176 (struct activity *);
1177 __nr_t wrap_get_in_nr
1178 (struct activity *);
1179 __nr_t wrap_get_freq_nr
1180 (struct activity *);
1181 __nr_t wrap_get_usb_nr
1182 (struct activity *);
1183 __nr_t wrap_get_filesystem_nr
1184 (struct activity *);
1185 __nr_t wrap_get_fchost_nr
1186 (struct activity *);
1188 /* Functions used to read activities statistics */
1189 __read_funct_t wrap_read_stat_cpu
1190 (struct activity *);
1191 __read_funct_t wrap_read_stat_pcsw
1192 (struct activity *);
1193 __read_funct_t wrap_read_stat_irq
1194 (struct activity *);
1195 __read_funct_t wrap_read_swap
1196 (struct activity *);
1197 __read_funct_t wrap_read_paging
1198 (struct activity *);
1199 __read_funct_t wrap_read_io
1200 (struct activity *);
1201 __read_funct_t wrap_read_meminfo
1202 (struct activity *);
1203 __read_funct_t wrap_read_kernel_tables
1204 (struct activity *);
1205 __read_funct_t wrap_read_loadavg
1206 (struct activity *);
1207 __read_funct_t wrap_read_tty_driver_serial
1208 (struct activity *);
1209 __read_funct_t wrap_read_disk
1210 (struct activity *);
1211 __read_funct_t wrap_read_net_dev
1212 (struct activity *);
1213 __read_funct_t wrap_read_net_edev
1214 (struct activity *);
1215 __read_funct_t wrap_read_net_nfs
1216 (struct activity *);
1217 __read_funct_t wrap_read_net_nfsd
1218 (struct activity *);
1219 __read_funct_t wrap_read_net_sock
1220 (struct activity *);
1221 __read_funct_t wrap_read_net_ip
1222 (struct activity *);
1223 __read_funct_t wrap_read_net_eip
1224 (struct activity *);
1225 __read_funct_t wrap_read_net_icmp
1226 (struct activity *);
1227 __read_funct_t wrap_read_net_eicmp
1228 (struct activity *);
1229 __read_funct_t wrap_read_net_tcp
1230 (struct activity *);
1231 __read_funct_t wrap_read_net_etcp
1232 (struct activity *);
1233 __read_funct_t wrap_read_net_udp
1234 (struct activity *);
1235 __read_funct_t wrap_read_net_sock6
1236 (struct activity *);
1237 __read_funct_t wrap_read_net_ip6
1238 (struct activity *);
1239 __read_funct_t wrap_read_net_eip6
1240 (struct activity *);
1241 __read_funct_t wrap_read_net_icmp6
1242 (struct activity *);
1243 __read_funct_t wrap_read_net_eicmp6
1244 (struct activity *);
1245 __read_funct_t wrap_read_net_udp6
1246 (struct activity *);
1247 __read_funct_t wrap_read_cpuinfo
1248 (struct activity *);
1249 __read_funct_t wrap_read_fan
1250 (struct activity *);
1251 __read_funct_t wrap_read_temp
1252 (struct activity *);
1253 __read_funct_t wrap_read_in
1254 (struct activity *);
1255 __read_funct_t wrap_read_meminfo_huge
1256 (struct activity *);
1257 __read_funct_t wrap_read_cpu_wghfreq
1258 (struct activity *);
1259 __read_funct_t wrap_read_bus_usb_dev
1260 (struct activity *);
1261 __read_funct_t wrap_read_filesystem
1262 (struct activity *);
1263 __read_funct_t wrap_read_fchost
1264 (struct activity *);
1265 __read_funct_t wrap_read_softnet
1266 (struct activity *);
1268 /* Other functions */
1269 int check_alt_sa_dir
1271 void enum_version_nr
1272 (struct file_magic *);
1274 (struct activity * [], unsigned int, int);
1275 int get_activity_position
1276 (struct activity * [], unsigned int, int);
1277 void handle_invalid_sa_file
1278 (int, struct file_magic *, char *, int);
1279 void print_collect_error
1281 int set_default_file
1284 (int, const void *, int);
1288 (struct sa_item **, char *, int);
1289 void allocate_bitmaps
1290 (struct activity * []);
1291 void allocate_structures
1292 (struct activity * []);
1294 (struct activity *, int, int, int);
1295 void check_file_actlst
1296 (int *, char *, struct activity * [], struct file_magic *, struct file_header *,
1297 struct file_activity **, unsigned int [], int, int *, int *);
1298 int check_net_dev_reg
1299 (struct activity *, int, int, int);
1300 int check_net_edev_reg
1301 (struct activity *, int, int, int);
1302 double compute_ifutil
1303 (struct stats_net_dev *, double, double);
1304 void copy_structures
1305 (struct activity * [], unsigned int [], struct record_header [], int, int);
1307 (struct tm *, struct tstamp *);
1308 void display_sa_file_version
1309 (FILE *, struct file_magic *);
1311 (struct activity * []);
1312 void free_structures
1313 (struct activity * []);
1315 (unsigned int, unsigned int, int);
1316 char *get_sa_devname
1317 (unsigned int, unsigned int, unsigned int);
1318 void get_file_timestamp_struct
1319 (unsigned int, struct tm *, struct file_header *);
1320 unsigned long long get_global_cpu_statistics
1321 (struct activity *, int, int, unsigned int, unsigned char []);
1322 void get_global_soft_statistics
1323 (struct activity *, int, int, unsigned int, unsigned char []);
1325 (struct record_header *, struct record_header *, unsigned long long *);
1327 (unsigned long long, unsigned long long, int, long);
1328 void parse_sa_devices
1329 (char *, struct activity *, int, int *, int);
1331 (char * [], int *, struct activity * [], unsigned int *, int);
1333 (char * [], int *, struct activity * []);
1335 (char * [], int *, unsigned int *, struct activity * []);
1337 (char * [], int *, struct activity * []);
1339 (char * [], int *, struct activity * []);
1341 (char * [], int *, struct tstamp *, const char *);
1342 void print_report_hdr
1343 (unsigned int, struct tm *, struct file_header *);
1344 void print_sar_comment
1345 (int *, int, char *, char *, int, char *, struct file_header *);
1346 __printf_funct_t print_sar_restart
1347 (int *, int, char *, char *, int, struct file_header *);
1348 int print_special_record
1349 (struct record_header *, unsigned int, struct tstamp *, struct tstamp *,
1350 int, int, struct tm *, struct tm *, char *, int, struct file_magic *,
1351 struct file_header *, struct activity * [], struct report_format *, int, int);
1352 void read_file_stat_bunch
1353 (struct activity * [], int, int, int, struct file_activity *, int, int,
1354 char *, struct file_magic *);
1355 __nr_t read_nr_value
1356 (int, char *, struct file_magic *, int, int, int);
1358 (int, void *, struct record_header *, struct file_header *, int, int);
1359 void reallocate_all_buffers
1360 (struct activity *, __nr_t);
1362 (unsigned int [], unsigned int [], void *, unsigned int);
1363 void replace_nonprintable_char
1366 (int, void *, size_t, int);
1367 int sa_get_record_timestamp_struct
1368 (unsigned int, struct record_header *, struct tm *, struct tm *);
1369 int sa_open_read_magic
1370 (int *, char *, struct file_magic *, int, int *, int);
1371 int search_list_item
1372 (struct sa_item *, char *);
1373 void select_all_activities
1374 (struct activity * []);
1375 void select_default_activity
1376 (struct activity * []);
1378 (unsigned char [], unsigned char, unsigned int);
1379 void set_hdr_rectime
1380 (unsigned int, struct tm *, struct file_header *);
1381 void set_record_timestamp_string
1382 (unsigned int, struct record_header *, char *, char *, int, struct tm *);
1384 (unsigned int [], void *, int);
1385 #endif /* SOURCE_SADC undefined */