2 * sar/sadc: Report system activity
3 * (C) 1999-2017 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
59 #define A_PWR_CPUFREQ 30
64 #define A_PWR_WGHFREQ 35
66 #define A_FILESYSTEM 37
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_SHOW_HINTS 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
111 #define WANT_SINCE_BOOT(m) (((m) & S_F_SINCE_BOOT) == S_F_SINCE_BOOT)
112 #define WANT_SA_ROTAT(m) (((m) & S_F_SA_ROTAT) == S_F_SA_ROTAT)
113 #define USE_PRETTY_OPTION(m) (((m) & S_F_DEV_PRETTY) == S_F_DEV_PRETTY)
114 #define FORCE_FILE(m) (((m) & S_F_FORCE_FILE) == S_F_FORCE_FILE)
115 #define INTERVAL_SET(m) (((m) & S_F_INTERVAL_SET) == S_F_INTERVAL_SET)
116 #define PRINT_TRUE_TIME(m) (((m) & S_F_TRUE_TIME) == S_F_TRUE_TIME)
117 #define LOCK_FILE(m) (((m) & S_F_LOCK_FILE) == S_F_LOCK_FILE)
118 #define PRINT_SEC_EPOCH(m) (((m) & S_F_SEC_EPOCH) == S_F_SEC_EPOCH)
119 #define DISPLAY_HDR_ONLY(m) (((m) & S_F_HDR_ONLY) == S_F_HDR_ONLY)
120 #define FILE_LOCKED(m) (((m) & S_F_FILE_LOCKED) == S_F_FILE_LOCKED)
121 #define USE_SA_YYYYMMDD(m) (((m) & S_F_SA_YYYYMMDD) == S_F_SA_YYYYMMDD)
122 #define DISPLAY_HORIZONTALLY(m) (((m) & S_F_HORIZONTALLY) == S_F_HORIZONTALLY)
123 #define DISPLAY_COMMENT(m) (((m) & S_F_COMMENT) == S_F_COMMENT)
124 #define DISPLAY_PERSIST_NAME_S(m) (((m) & S_F_PERSIST_NAME) == S_F_PERSIST_NAME)
125 #define PRINT_LOCAL_TIME(m) (((m) & S_F_LOCAL_TIME) == S_F_LOCAL_TIME)
126 #define USE_PREFD_TIME_OUTPUT(m) (((m) & S_F_PREFD_TIME_OUTPUT) == S_F_PREFD_TIME_OUTPUT)
127 #define SKIP_EMPTY_VIEWS(m) (((m) & S_F_SVG_SKIP) == S_F_SVG_SKIP)
128 #define DISPLAY_HINTS(m) (((m) & S_F_RAW_SHOW_HINTS) == S_F_RAW_SHOW_HINTS)
129 #define AUTOSCALE_ON(m) (((m) & S_F_SVG_AUTOSCALE) == S_F_SVG_AUTOSCALE)
130 #define DISPLAY_ONE_DAY(m) (((m) & S_F_SVG_ONE_DAY) == S_F_SVG_ONE_DAY)
131 #define DISPLAY_IDLE(m) (((m) & S_F_SVG_SHOW_IDLE) == S_F_SVG_SHOW_IDLE)
132 #define DISPLAY_INFO(m) (((m) & S_F_SVG_SHOW_INFO) == S_F_SVG_SHOW_INFO)
133 #define DISPLAY_UNIT(m) (((m) & S_F_UNIT) == S_F_UNIT)
134 #define SET_CANVAS_HEIGHT(m) (((m) & S_F_SVG_HEIGHT) == S_F_SVG_HEIGHT)
135 #define PACK_VIEWS(m) (((m) & S_F_SVG_PACKED) == S_F_SVG_PACKED)
137 #define AO_F_NULL 0x00000000
139 /* Output flags for options -r / -S */
140 #define AO_F_MEMORY 0x00000001
141 #define AO_F_SWAP 0x00000002
142 /* AO_F_MEM_ALL: See opt_flags in struct activity below */
143 #define AO_F_MEM_ALL (AO_F_MEMORY << 8)
145 #define DISPLAY_MEMORY(m) (((m) & AO_F_MEMORY) == AO_F_MEMORY)
146 #define DISPLAY_SWAP(m) (((m) & AO_F_SWAP) == AO_F_SWAP)
147 #define DISPLAY_MEM_ALL(m) (((m) & AO_F_MEM_ALL) == AO_F_MEM_ALL)
149 /* Output flags for option -u [ ALL ] */
150 #define AO_F_CPU_DEF 0x00000001
151 #define AO_F_CPU_ALL 0x00000002
153 #define DISPLAY_CPU_DEF(m) (((m) & AO_F_CPU_DEF) == AO_F_CPU_DEF)
154 #define DISPLAY_CPU_ALL(m) (((m) & AO_F_CPU_ALL) == AO_F_CPU_ALL)
156 /* Output flags for option -d */
157 #define AO_F_DISK_PART 0x00000001
159 #define COLLECT_PARTITIONS(m) (((m) & AO_F_DISK_PART) == AO_F_DISK_PART)
161 /* Output flags for option -F */
162 #define AO_F_FILESYSTEM 0x00000001
163 #define AO_F_MOUNT 0x00000002
165 #define DISPLAY_MOUNT(m) (((m) & AO_F_MOUNT) == AO_F_MOUNT)
168 ***************************************************************************
169 * Various keywords and constants.
170 ***************************************************************************
174 #define K_XALL "XALL"
177 #define K_EDEV "EDEV"
179 #define K_NFSD "NFSD"
180 #define K_SOCK "SOCK"
183 #define K_ICMP "ICMP"
184 #define K_EICMP "EICMP"
186 #define K_ETCP "ETCP"
188 #define K_SOCK6 "SOCK6"
190 #define K_EIP6 "EIP6"
191 #define K_ICMP6 "ICMP6"
192 #define K_EICMP6 "EICMP6"
193 #define K_UDP6 "UDP6"
196 #define K_TEMP "TEMP"
198 #define K_FREQ "FREQ"
199 #define K_MOUNT "MOUNT"
201 #define K_SOFT "SOFT"
204 #define K_DISK "DISK"
205 #define K_XDISK "XDISK"
206 #define K_SNMP "SNMP"
207 #define K_IPV6 "IPV6"
208 #define K_POWER "POWER"
211 #define K_SKIP_EMPTY "skipempty"
212 #define K_AUTOSCALE "autoscale"
213 #define K_ONEDAY "oneday"
214 #define K_SHOWIDLE "showidle"
215 #define K_SHOWINFO "showinfo"
216 #define K_SHOWHINTS "showhints"
217 #define K_HEIGHT "height="
218 #define K_PACKED "packed"
220 /* Groups of activities */
221 #define G_DEFAULT 0x00
232 /* Time must have the format HH:MM:SS with HH in 24-hour format */
233 #define DEF_TMSTART "08:00:00"
234 #define DEF_TMEND "18:00:00"
236 #define UTSNAME_LEN 65
237 #define HEADER_LINE_LEN 512
240 * Define upper limit for various items.
241 * Made necessary because we have to check the number of
242 * items for each activity when we read a (possibly tainted)
245 #define MAX_NR_SERIAL_LINES 65536
246 #define MAX_NR_DISKS (65536 * 4096)
247 #define MAX_NR_IFACES 65536
248 #define MAX_NR_FANS 4096
249 #define MAX_NR_TEMP_SENSORS 4096
250 #define MAX_NR_IN_SENSORS 4096
251 #define MAX_NR_USB 65536
252 #define MAX_NR_FS (65536 * 4096)
253 #define MAX_NR_FCHOSTS 65536
255 /* NR_MAX is the upper limit used for unknown activities */
256 #define NR_MAX (65536 * 4096)
259 /* Maximum number of args that can be passed to sadc */
260 #define MAX_ARGV_NR 32
262 /* Miscellaneous constants */
264 #define USE_SA_FILE 1
265 #define NO_TM_START 0
272 #define ALL_ACTIVITIES ~0U
273 #define EXIT_IF_NOT_FOUND 1
274 #define RESUME_IF_NOT_FOUND 0
282 #define END_OF_DATA_UNEXPECTED 1
283 #define INCONSISTENT_INPUT_DATA 2
285 #define CLOSE_XML_MARKUP 0
286 #define OPEN_XML_MARKUP 1
288 #define CLOSE_JSON_MARKUP 0
289 #define OPEN_JSON_MARKUP 1
291 #define COUNT_ACTIVITIES 0
292 #define COUNT_OUTPUTS 1
294 /* Type for all functions counting items */
296 /* Type for all functions reading statistics */
297 #define __read_funct_t void
298 /* Type for all functions displaying statistics */
299 #define __print_funct_t void
301 /* Structure for SVG specific parameters */
303 unsigned long long dt; /* Interval of time for current sample */
304 unsigned long long ust_time_ref; /* X axis start time in seconds since the epoch */
305 unsigned long long ust_time_end; /* X axis end time in seconds since the epoch */
306 unsigned long long ust_time_first; /* Time (in seconds since the epoch) for first sample */
307 int graph_no; /* Total number of views already displayed */
308 int restart; /* TRUE if we have just met a RESTART record */
309 struct file_header *file_hdr; /* Pointer on file header structure */
312 /* Structure used when displaying SVG header */
313 struct svg_hdr_parm {
314 int graph_nr; /* Number of rows of views to display or canvas height entered on the command line */
315 int views_per_row; /* Maximum number of views on a single row */
319 ***************************************************************************
320 * Definitions of header structures.
322 * The rule is: "strict writing, broad reading", meaning that sar/sadc can
323 * only append data to a datafile whose format is strictly the same as that
324 * of current version (checking FORMAT_MAGIC is not enough), but sar/sadf
325 * can read data from different versions, providing that FORMAT_MAGIC value
328 * Format of system activity data files:
331 * | file_magic structure
335 * | file_header structure
339 * | file_activity structure | * sa_act_nr
343 * | record_header structure |
349 * | Statistics structures... |
353 * Note: A record_header structure is followed by 0+ __nr_t values giving
354 * the number of statistics structures for activities whose number of items
355 * may vary (ie. activities having a positive f_count_index value).
356 * If the record header's type is R_COMMENT then we find only a comment
357 * following the record_header structure.
358 * If the record_header's type is R_RESTART then we find only the number of CPU
359 * (of type __nr_t) of the machine following the record_header structure.
360 ***************************************************************************
364 * Sysstat magic number. Should never be modified.
365 * Indicate that the file was created by sysstat.
367 #define SYSSTAT_MAGIC 0xd596
368 #define SYSSTAT_MAGIC_SWAPPED (((SYSSTAT_MAGIC << 8) | (SYSSTAT_MAGIC >> 8)) & 0xffff)
371 * Datafile format magic number.
372 * Modified to indicate that the format of the file is
373 * no longer compatible with that of previous sysstat versions.
375 #define FORMAT_MAGIC 0x2175
376 #define FORMAT_MAGIC_SWAPPED (((FORMAT_MAGIC << 8) | (FORMAT_MAGIC >> 8)) & 0xffff)
378 /* Previous datafile format magic number used by older sysstat versions */
379 #define PREVIOUS_FORMAT_MAGIC 0x2173
381 /* Padding in file_magic structure. See below. */
382 #define FILE_MAGIC_PADDING 48
384 /* Structure for file magic header data */
387 * This field identifies the file as a file created by sysstat.
389 unsigned short sysstat_magic;
391 * The value of this field varies whenever datafile format changes.
393 unsigned short format_magic;
395 * Sysstat version used to create the file.
397 unsigned char sysstat_version;
398 unsigned char sysstat_patchlevel;
399 unsigned char sysstat_sublevel;
400 unsigned char sysstat_extraversion;
401 #define FILE_MAGIC_ULL_NR 0 /* Nr of unsigned long long below */
402 #define FILE_MAGIC_UL_NR 0 /* Nr of unsigned long below */
403 #define FILE_MAGIC_U_NR 5 /* Nr of [unsigned] int below */
405 * Size of file's header (size of file_header structure used by file).
407 unsigned int header_size;
409 * Set to non zero if data file has been converted with "sadf -c" from
410 * an old format (version x.y.z) to a newest format (version X.Y.Z).
411 * In this case, the value is: Y*256 + Z + 1.
412 * The FORMAT_MAGIC value of the file can be used to determine X.
414 unsigned int upgraded;
416 * Description of the file_header structure
417 * (nr of "long long", nr of "long" and nr of "int").
419 unsigned int hdr_types_nr[3];
421 * Padding. Reserved for future use while avoiding a format change.
422 * sysstat always reads a number of bytes which is that expected for
423 * current sysstat version (FILE_MAGIC_SIZE). We cannot guess if we
424 * are going to read a file from current, an older or a newer version.
426 unsigned char pad[FILE_MAGIC_PADDING];
429 #define FILE_MAGIC_SIZE (sizeof(struct file_magic))
431 /* Header structure for system activity data file */
434 * Timestamp in seconds since the epoch.
436 unsigned long long sa_ust_time;
438 * Number of jiffies per second.
440 unsigned long sa_hz __attribute__ ((aligned (8)));
442 * Number of [online or offline] CPU (1 .. CPU_NR + 1)
443 * when the datafile has been created.
444 * When reading a datafile, this value is updated whenever
445 * a RESTART record is found.
447 unsigned int sa_cpu_nr __attribute__ ((aligned (8)));
449 * Number of activities saved in file.
451 unsigned int sa_act_nr;
457 * Description of the file_activity and record_header structures
458 * (nr of "long long", nr of "long" and nr of "int").
460 unsigned int act_types_nr[3];
461 unsigned int rec_types_nr[3];
463 * Size of file_activity and record_header structures used by file.
465 unsigned int act_size;
466 unsigned int rec_size;
468 * Current day and month.
469 * No need to save DST (Daylight Saving Time) flag, since it is not taken
470 * into account by the strftime() function used to print the timestamp.
472 unsigned char sa_day;
473 unsigned char sa_month;
475 * Size of a long integer. Useful to know the architecture on which
476 * the datafile was created.
480 * Operating system name.
482 char sa_sysname[UTSNAME_LEN];
486 char sa_nodename[UTSNAME_LEN];
488 * Operating system release number.
490 char sa_release[UTSNAME_LEN];
492 * Machine architecture.
494 char sa_machine[UTSNAME_LEN];
497 #define FILE_HEADER_SIZE (sizeof(struct file_header))
498 #define FILE_HEADER_ULL_NR 1 /* Nr of unsigned long long in file_header structure */
499 #define FILE_HEADER_UL_NR 1 /* Nr of unsigned long in file_header structure */
500 #define FILE_HEADER_U_NR 11 /* Nr of [unsigned] int in file_header structure */
501 /* The values below are used for sanity check */
502 #define MIN_FILE_HEADER_SIZE 0
503 #define MAX_FILE_HEADER_SIZE 8192
507 * Base magical number for activities.
509 #define ACTIVITY_MAGIC_BASE 0x8a
511 * Magical value used for activities with
512 * unknown format (used for sadf -H only).
514 #define ACTIVITY_MAGIC_UNKNOWN 0x89
516 /* List of activities saved in file */
517 struct file_activity {
519 * Identification value of activity.
523 * Activity magical number.
527 * Number of items for this activity.
531 * Number of sub-items for this activity.
535 * Size of an item structure.
539 * Description of the structure containing statistics for the
540 * given activity (nr of "long long", nr of "long" and nr of "int").
542 unsigned int types_nr[3];
545 #define FILE_ACTIVITY_SIZE (sizeof(struct file_activity))
546 #define MAX_FILE_ACTIVITY_SIZE 1024 /* Used for sanity check */
547 #define FILE_ACTIVITY_ULL_NR 0 /* Nr of unsigned long long in file_activity structure */
548 #define FILE_ACTIVITY_UL_NR 0 /* Nr of unsigned long in file_activity structure */
549 #define FILE_ACTIVITY_U_NR 8 /* Nr of [unsigned] int in file_activity structure */
554 * R_STATS means that this is a record of statistics.
558 * R_RESTART means that this is a special record containing
559 * a LINUX RESTART message.
563 * R_LAST_STATS warns sar that this is the last record to be written
564 * to file before a file rotation, and that the next data to come will
566 * Such a record is tagged R_STATS anyway before being written to file.
568 #define R_LAST_STATS 3
570 * R_COMMENT means that this is a special record containing
575 /* Maximum length of a comment */
576 #define MAX_COMMENT_LEN 64
578 /* Header structure for every record */
579 struct record_header {
581 * Machine uptime in 1/100th of a second.
583 unsigned long long uptime_cs;
585 * Timestamp (number of seconds since the epoch).
587 unsigned long long ust_time;
589 * Record type: R_STATS, R_RESTART,...
591 unsigned char record_type;
593 * Timestamp: Hour (0-23), minute (0-59) and second (0-59).
594 * Used to determine TRUE time (immutable, non locale dependent time).
597 unsigned char minute;
598 unsigned char second;
601 #define RECORD_HEADER_SIZE (sizeof(struct record_header))
602 #define MAX_RECORD_HEADER_SIZE 512 /* Used for sanity check */
603 #define RECORD_HEADER_ULL_NR 2 /* Nr of unsigned long long in record_header structure */
604 #define RECORD_HEADER_UL_NR 0 /* Nr of unsigned long in record_header structure */
605 #define RECORD_HEADER_U_NR 0 /* Nr of unsigned int in record_header structure */
609 ***************************************************************************
610 * Generic description of an activity.
611 ***************************************************************************
614 /* Activity options */
617 * Indicate that corresponding activity should be collected by sadc.
619 #define AO_COLLECTED 0x01
621 * Indicate that corresponding activity should be displayed by sar.
623 #define AO_SELECTED 0x02
629 * This flag should be set for every activity closing a markup used
630 * by several activities. Used by sadf f_xml_print() functions to
631 * display XML output.
633 #define AO_CLOSE_MARKUP 0x10
635 * Indicate that corresponding activity has multiple different
636 * output formats. This is the case for example for memory activity
637 * with options -r and -R.
638 * PS: Such an activity should appear in the list of activities that
639 * sar -A is supposed to display.
641 #define AO_MULTIPLE_OUTPUTS 0x20
643 * Indicate that one (SVG) graph will be displayed for each
644 * distinct item for this activity (sadf -g).
646 #define AO_GRAPH_PER_ITEM 0x40
648 * Indicate that this activity may have sub-items.
650 #define AO_MATRIX 0x80
652 #define IS_COLLECTED(m) (((m) & AO_COLLECTED) == AO_COLLECTED)
653 #define IS_SELECTED(m) (((m) & AO_SELECTED) == AO_SELECTED)
654 #define CLOSE_MARKUP(m) (((m) & AO_CLOSE_MARKUP) == AO_CLOSE_MARKUP)
655 #define HAS_MULTIPLE_OUTPUTS(m) (((m) & AO_MULTIPLE_OUTPUTS) == AO_MULTIPLE_OUTPUTS)
656 #define ONE_GRAPH_PER_ITEM(m) (((m) & AO_GRAPH_PER_ITEM) == AO_GRAPH_PER_ITEM)
657 #define IS_MATRIX(m) (((m) & AO_MATRIX) == AO_MATRIX)
661 /* Structure used to define a bitmap needed by an activity */
664 * Bitmap for activities that need one. Remember to allocate it
667 unsigned char *b_array;
669 * Size of the bitmap in bits. In fact, bitmap is sized to b_size + 1
670 * to take into account CPU "all"
676 * Structure used to define an activity.
677 * Note: This structure can be modified without changing the format of data files.
681 * This variable contains the identification value (A_...) for this activity.
685 * Activity options (AO_...)
687 unsigned int options;
689 * Activity magical number. This number changes when activity format in file
690 * is no longer compatible with the format of that same activity from
695 * An activity belongs to a group (and only one).
696 * Groups are those selected with option -S of sadc.
700 * Index in f_count[] array to determine function used to count
701 * the number of items (serial lines, network interfaces, etc.) -> @nr
702 * Such a function should _always_ return a value greater than
705 * A value of -1 indicates that the number of items
706 * is a constant (and @nr is set to this value).
708 * These functions are called even if corresponding activities have not
709 * been selected, to make sure that all items have been calculated
710 * (including #CPU, etc.)
714 * The f_count2() function is used to count the number of
716 * Such a function should _always_ return a value greater than
719 * A NULL value for this function pointer indicates that the number of items
720 * is a constant (and @nr2 is set to this value).
722 __nr_t (*f_count2) (struct activity *);
724 * This function reads the relevant file and fill the buffer
725 * with statistics corresponding to given activity.
727 __read_funct_t (*f_read) (struct activity *);
729 * This function displays activity statistics onto the screen.
731 __print_funct_t (*f_print) (struct activity *, int, int, unsigned long long);
733 * This function displays average activity statistics onto the screen.
735 __print_funct_t (*f_print_avg) (struct activity *, int, int, unsigned long long);
737 * This function is used by sadf to display activity in a format that can
738 * easily be ingested by a relational database, or a format that can be
739 * handled by pattern processing commands like "awk".
741 __print_funct_t (*f_render) (struct activity *, int, char *, int, unsigned long long);
743 * This function is used by sadf to display activity statistics in XML.
745 __print_funct_t (*f_xml_print) (struct activity *, int, int, unsigned long long);
747 * This function is used by sadf to display activity statistics in JSON.
749 __print_funct_t (*f_json_print) (struct activity *, int, int, unsigned long long);
751 * This function is used by sadf to display activity statistics in SVG.
753 __print_funct_t (*f_svg_print) (struct activity *, int, int, struct svg_parm *,
754 unsigned long long, struct record_header *);
756 * This function is used by sadf to display activity statistics in raw format.
758 __print_funct_t (*f_raw_print) (struct activity *, char *, int);
760 * Header string displayed by sadf -d.
761 * Header lines for each output (for activities with multiple outputs) are
762 * separated with a '|' character.
763 * For a given output, the first field corresponding to extended statistics
764 * (eg. -r ALL) begins with a '&' character.
772 * Description of the corresponding structure containing statistics (as defined
773 * in rd_stats.h or rd_sensors.h). Such a structure has 0+ fields of type
774 * "long long", followed by 0+ fields of type "long", followed by 0+ fields of
775 * type "int", followed by 0+ other fields (e.g. of type char). The array below
776 * gives the number of "long long" fields composing the structure, then the number
777 * of "long" fields, then the number of "int" fields.
779 unsigned int gtypes_nr[3];
781 * This array has the same meaning as @gtypes_nr[] above, but the values are those
782 * read from current data file. They may be different from those of @gtypes_nr[]
783 * because we can read data from a different sysstat version (older or newer).
785 unsigned int ftypes_nr[3];
787 * Number of SVG graphs for this activity. The total number of graphs for
788 * the activity can be greater though if flag AO_GRAPH_PER_ITEM is set, in
789 * which case the total number will be @g_nr * @nr.
793 * Number of items on the system.
794 * A negative value (-1) is the default value and indicates that this number
795 * has still not been calculated by the f_count() function.
796 * A value of 0 means that this number has been calculated, but no items have
798 * A positive value (>0) has either been calculated or is a constant.
802 * Number of sub-items on the system.
803 * @nr2 is in fact the second dimension of a matrix of items, the first
804 * one being @nr. @nr is the number of lines, and @nr2 the number of columns.
805 * A negative value (-1) is the default value and indicates that this number
806 * has still not been calculated by the f_count2() function.
807 * A value of 0 means that this number has been calculated, but no sub-items have
809 * A positive value (>0) has either been calculated or is a constant.
811 * 1) IF @nr2 = 0 THEN @nr = 0
812 * Note: If @nr = 0, then @nr2 is undetermined (may be -1, 0 or >0).
813 * 2) IF @nr > 0 THEN @nr2 > 0.
814 * Note: If @nr2 > 0 then @nr is undetermined (may be -1, 0 or >0).
815 * 3) IF @nr <= 0 THEN @nr2 = -1 (this is the default value for @nr2,
816 * meaning that it has not been calculated).
820 * Maximum number of elements that sar can handle for this item.
821 * NB: The maximum number of elements that sar can handle for sub-items
827 * This is the size of the corresponding structure, as read from or written
828 * to a file, or read from or written by the data collector.
833 * This is the size of the corresponding structure as mapped into memory.
834 * @msize can be different from @fsize when data are read from or written to
835 * a data file from a different sysstat version.
839 * Optional flags for activity. This is eg. used when AO_MULTIPLE_OUTPUTS
841 * 0x0001 - 0x0080 : Multiple outputs (eg. AO_F_MEMORY, AO_F_SWAP...)
842 * 0x0100 - 0x8000 : If bit set then display complete header (hdr_line) for
843 * corresponding output
844 * 0x010000+ : Optional flags
846 unsigned int opt_flags;
848 * Buffers that will contain the statistics read. Its size is @nr * @nr2 * @size each.
850 * [0] and [1]: current/previous statistics values (used by sar).
851 * [2]: Used by sar to save first collected stats (used later to
856 * Bitmap for activities that need one. Such a bitmap is needed by activity
857 * if @bitmap is not NULL.
859 struct act_bitmap *bitmap;
864 ***************************************************************************
865 * Generic description of an output format for sadf (and sar).
866 ***************************************************************************
869 /* Type for all functions used by sadf to display stats in various formats */
870 #define __printf_funct_t void
871 #define __tm_funct_t char *
874 * Structure used to define a report.
875 * A XML-like report has the following format:
881 * | | Statistics block
884 * | | | Timestamp block
887 * | | | | Activity #1
893 * | | | | Activity #n
898 * | | Restart messages block
905 struct report_format {
907 * This variable contains the identification value (F_...) for this report format.
911 * Format options (FO_...).
913 unsigned int options;
915 * This function displays the report header
916 * (data displayed once at the beginning of the report).
918 __printf_funct_t (*f_header) (void *, int, char *, struct file_magic *, struct file_header *,
919 struct activity * [], unsigned int []);
921 * This function defines the statistics part of the report.
922 * Used only with textual (XML-like) reports.
924 __printf_funct_t (*f_statistics) (int *, int);
926 * This function defines the timestamp part of the report.
927 * Used only with textual (XML-like) reports.
929 __tm_funct_t (*f_timestamp) (void *, int, char *, char *, unsigned long long,
930 struct file_header *, unsigned int);
932 * This function displays the restart messages.
934 __printf_funct_t (*f_restart) (int *, int, char *, char *, int, struct file_header *);
936 * This function displays the comments.
938 __printf_funct_t (*f_comment) (int *, int, char *, char *, int, char *, struct file_header *);
941 /* Possible actions for functions used to display reports */
947 ***************************************************************************
948 * SVG output definitions
949 ***************************************************************************
957 * | | 4 | Graph title
967 * | | v |-------------------------------
969 * | v <---><------------------------------>
972 * v<---------------------------------------------------------------> Gap
974 * <--------------------------------------------------------------------->
979 #define SVG_G_XSIZE 720
981 #define SVG_M_XSIZE 70
983 #define SVG_V_XSIZE 1050
985 #define SVG_T_XSIZE 1060
988 #define SVG_G_YSIZE 200
990 #define SVG_H_YSIZE 50
992 #define SVG_M_YSIZE 50
994 #define SVG_T_YSIZE 310
996 #define SVG_V_YSIZE 300
998 /* Grid: Nr of horizontal lines */
999 #define SVG_H_GRIDNR 3
1000 /* Grid: Nr of vertical lines */
1001 #define SVG_V_GRIDNR 10
1003 /* Block size used to allocate arrays for graphs data */
1004 #define CHUNKSIZE 4096
1006 /* Maximum number of views on a single row */
1007 #define MAX_VIEWS_ON_A_ROW 6
1009 #define SVG_LINE_GRAPH 1
1010 #define SVG_BAR_GRAPH 2
1012 /* Maximum number of horizontal lines for the background grid */
1013 #define MAX_HLINES_NR 10
1018 ***************************************************************************
1019 * Macro functions definitions.
1021 * Note: Using 'do ... while' makes the macros safer to use
1022 * (remember that macro use is followed by a semicolon).
1023 ***************************************************************************
1026 /* Close file descriptors */
1027 #define CLOSE_ALL(_fd_) do { \
1032 #define CLOSE(_fd_) if (_fd_ >= 0) \
1037 ***************************************************************************
1038 * Various structure definitions.
1039 ***************************************************************************
1042 /* Structure for timestamps */
1052 ***************************************************************************
1053 * Functions prototypes.
1054 ***************************************************************************
1057 /* Functions used to count number of items */
1058 __nr_t wrap_get_cpu_nr
1059 (struct activity *);
1060 __nr_t wrap_get_irq_nr
1061 (struct activity *);
1062 __nr_t wrap_get_serial_nr
1063 (struct activity *);
1064 __nr_t wrap_get_disk_nr
1065 (struct activity *);
1066 __nr_t wrap_get_iface_nr
1067 (struct activity *);
1068 __nr_t wrap_get_fan_nr
1069 (struct activity *);
1070 __nr_t wrap_get_temp_nr
1071 (struct activity *);
1072 __nr_t wrap_get_in_nr
1073 (struct activity *);
1074 __nr_t wrap_get_freq_nr
1075 (struct activity *);
1076 __nr_t wrap_get_usb_nr
1077 (struct activity *);
1078 __nr_t wrap_get_filesystem_nr
1079 (struct activity *);
1080 __nr_t wrap_get_fchost_nr
1081 (struct activity *);
1083 /* Functions used to read activities statistics */
1084 __read_funct_t wrap_read_stat_cpu
1085 (struct activity *);
1086 __read_funct_t wrap_read_stat_pcsw
1087 (struct activity *);
1088 __read_funct_t wrap_read_stat_irq
1089 (struct activity *);
1090 __read_funct_t wrap_read_swap
1091 (struct activity *);
1092 __read_funct_t wrap_read_paging
1093 (struct activity *);
1094 __read_funct_t wrap_read_io
1095 (struct activity *);
1096 __read_funct_t wrap_read_meminfo
1097 (struct activity *);
1098 __read_funct_t wrap_read_kernel_tables
1099 (struct activity *);
1100 __read_funct_t wrap_read_loadavg
1101 (struct activity *);
1102 __read_funct_t wrap_read_tty_driver_serial
1103 (struct activity *);
1104 __read_funct_t wrap_read_disk
1105 (struct activity *);
1106 __read_funct_t wrap_read_net_dev
1107 (struct activity *);
1108 __read_funct_t wrap_read_net_edev
1109 (struct activity *);
1110 __read_funct_t wrap_read_net_nfs
1111 (struct activity *);
1112 __read_funct_t wrap_read_net_nfsd
1113 (struct activity *);
1114 __read_funct_t wrap_read_net_sock
1115 (struct activity *);
1116 __read_funct_t wrap_read_net_ip
1117 (struct activity *);
1118 __read_funct_t wrap_read_net_eip
1119 (struct activity *);
1120 __read_funct_t wrap_read_net_icmp
1121 (struct activity *);
1122 __read_funct_t wrap_read_net_eicmp
1123 (struct activity *);
1124 __read_funct_t wrap_read_net_tcp
1125 (struct activity *);
1126 __read_funct_t wrap_read_net_etcp
1127 (struct activity *);
1128 __read_funct_t wrap_read_net_udp
1129 (struct activity *);
1130 __read_funct_t wrap_read_net_sock6
1131 (struct activity *);
1132 __read_funct_t wrap_read_net_ip6
1133 (struct activity *);
1134 __read_funct_t wrap_read_net_eip6
1135 (struct activity *);
1136 __read_funct_t wrap_read_net_icmp6
1137 (struct activity *);
1138 __read_funct_t wrap_read_net_eicmp6
1139 (struct activity *);
1140 __read_funct_t wrap_read_net_udp6
1141 (struct activity *);
1142 __read_funct_t wrap_read_cpuinfo
1143 (struct activity *);
1144 __read_funct_t wrap_read_fan
1145 (struct activity *);
1146 __read_funct_t wrap_read_temp
1147 (struct activity *);
1148 __read_funct_t wrap_read_in
1149 (struct activity *);
1150 __read_funct_t wrap_read_meminfo_huge
1151 (struct activity *);
1152 __read_funct_t wrap_read_time_in_state
1153 (struct activity *);
1154 __read_funct_t wrap_read_bus_usb_dev
1155 (struct activity *);
1156 __read_funct_t wrap_read_filesystem
1157 (struct activity *);
1158 __read_funct_t wrap_read_fchost
1159 (struct activity *);
1160 __read_funct_t wrap_read_softnet
1161 (struct activity *);
1163 /* Other functions */
1164 void allocate_bitmaps
1165 (struct activity * []);
1166 void allocate_structures
1167 (struct activity * []);
1168 int check_alt_sa_dir
1171 (struct activity *, int, int, int);
1172 void check_file_actlst
1173 (int *, char *, struct activity * [], struct file_magic *, struct file_header *,
1174 struct file_activity **, unsigned int [], int, int *, int *);
1175 int check_net_dev_reg
1176 (struct activity *, int, int, int);
1177 int check_net_edev_reg
1178 (struct activity *, int, int, int);
1179 double compute_ifutil
1180 (struct stats_net_dev *, double, double);
1181 void copy_structures
1182 (struct activity * [], unsigned int [], struct record_header [], int, int);
1184 (struct tm *, struct tstamp *);
1185 void display_sa_file_version
1186 (FILE *, struct file_magic *);
1187 void enum_version_nr
1188 (struct file_magic *);
1190 (struct activity * []);
1191 void free_structures
1192 (struct activity * []);
1194 (struct activity * [], unsigned int, int);
1195 int get_activity_position
1196 (struct activity * [], unsigned int, int);
1198 (unsigned int, unsigned int, int);
1199 void get_file_timestamp_struct
1200 (unsigned int, struct tm *, struct file_header *);
1202 (struct record_header *, struct record_header *, unsigned long long *);
1203 void handle_invalid_sa_file
1204 (int *, struct file_magic *, char *, int);
1206 (unsigned long long, unsigned long long, int, long);
1208 (char * [], int *, struct activity * [], unsigned int *, int);
1210 (char * [], int *, struct activity * []);
1212 (char * [], int *, unsigned int *, struct activity * []);
1214 (char * [], int *, struct activity * []);
1216 (char * [], int *, struct activity * []);
1218 (char * [], int *, struct tstamp *, const char *);
1219 void print_report_hdr
1220 (unsigned int, struct tm *, struct file_header *);
1221 void print_sar_comment
1222 (int *, int, char *, char *, int, char *, struct file_header *);
1223 __printf_funct_t print_sar_restart
1224 (int *, int, char *, char *, int, struct file_header *);
1225 int print_special_record
1226 (struct record_header *, unsigned int, struct tstamp *, struct tstamp *,
1227 int, int, struct tm *, struct tm *, char *, int, struct file_magic *,
1228 struct file_header *, struct activity * [], struct report_format *, int, int);
1229 void read_file_stat_bunch
1230 (struct activity * [], int, int, int, struct file_activity *, int, int);
1231 __nr_t read_new_cpu_nr
1232 (int, char *, struct file_magic *, int, int);
1234 (int, void *, struct record_header *, struct file_header *, int, int);
1236 (unsigned int [], unsigned int [], void *, unsigned int);
1237 void replace_nonprintable_char
1240 (int, void *, int, int);
1241 int sa_get_record_timestamp_struct
1242 (unsigned int, struct record_header *, struct tm *, struct tm *);
1243 int sa_open_read_magic
1244 (int *, char *, struct file_magic *, int, int *);
1245 void select_all_activities
1246 (struct activity * []);
1247 void select_default_activity
1248 (struct activity * []);
1250 (unsigned char [], unsigned char, unsigned int);
1251 void set_default_file
1253 void set_hdr_rectime
1254 (unsigned int, struct tm *, struct file_header *);
1255 void set_record_timestamp_string
1256 (unsigned int, struct record_header *, char *, char *, int, struct tm *);
1258 (unsigned int [], void *, int);