2 * sar/sadc: Report system activity
3 * (C) 1999-2019 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
113 #define S_F_FDATASYNC 0x08000000
115 #define WANT_SINCE_BOOT(m) (((m) & S_F_SINCE_BOOT) == S_F_SINCE_BOOT)
116 #define WANT_SA_ROTAT(m) (((m) & S_F_SA_ROTAT) == S_F_SA_ROTAT)
117 #define USE_PRETTY_OPTION(m) (((m) & S_F_DEV_PRETTY) == S_F_DEV_PRETTY)
118 #define FORCE_FILE(m) (((m) & S_F_FORCE_FILE) == S_F_FORCE_FILE)
119 #define INTERVAL_SET(m) (((m) & S_F_INTERVAL_SET) == S_F_INTERVAL_SET)
120 #define PRINT_TRUE_TIME(m) (((m) & S_F_TRUE_TIME) == S_F_TRUE_TIME)
121 #define LOCK_FILE(m) (((m) & S_F_LOCK_FILE) == S_F_LOCK_FILE)
122 #define PRINT_SEC_EPOCH(m) (((m) & S_F_SEC_EPOCH) == S_F_SEC_EPOCH)
123 #define DISPLAY_HDR_ONLY(m) (((m) & S_F_HDR_ONLY) == S_F_HDR_ONLY)
124 #define FILE_LOCKED(m) (((m) & S_F_FILE_LOCKED) == S_F_FILE_LOCKED)
125 #define USE_SA_YYYYMMDD(m) (((m) & S_F_SA_YYYYMMDD) == S_F_SA_YYYYMMDD)
126 #define DISPLAY_HORIZONTALLY(m) (((m) & S_F_HORIZONTALLY) == S_F_HORIZONTALLY)
127 #define DISPLAY_COMMENT(m) (((m) & S_F_COMMENT) == S_F_COMMENT)
128 #define DISPLAY_PERSIST_NAME_S(m) (((m) & S_F_PERSIST_NAME) == S_F_PERSIST_NAME)
129 #define PRINT_LOCAL_TIME(m) (((m) & S_F_LOCAL_TIME) == S_F_LOCAL_TIME)
130 #define USE_PREFD_TIME_OUTPUT(m) (((m) & S_F_PREFD_TIME_OUTPUT) == S_F_PREFD_TIME_OUTPUT)
131 #define SKIP_EMPTY_VIEWS(m) (((m) & S_F_SVG_SKIP) == S_F_SVG_SKIP)
132 #define DISPLAY_ZERO_OMIT(m) (((m) & S_F_ZERO_OMIT) == S_F_ZERO_OMIT)
133 #define DISPLAY_DEBUG_MODE(m) (((m) & S_F_RAW_DEBUG_MODE) == S_F_RAW_DEBUG_MODE)
134 #define AUTOSCALE_ON(m) (((m) & S_F_SVG_AUTOSCALE) == S_F_SVG_AUTOSCALE)
135 #define DISPLAY_ONE_DAY(m) (((m) & S_F_SVG_ONE_DAY) == S_F_SVG_ONE_DAY)
136 #define DISPLAY_IDLE(m) (((m) & S_F_SVG_SHOW_IDLE) == S_F_SVG_SHOW_IDLE)
137 #define DISPLAY_INFO(m) (((m) & S_F_SVG_SHOW_INFO) == S_F_SVG_SHOW_INFO)
138 #define DISPLAY_UNIT(m) (((m) & S_F_UNIT) == S_F_UNIT)
139 #define SET_CANVAS_HEIGHT(m) (((m) & S_F_SVG_HEIGHT) == S_F_SVG_HEIGHT)
140 #define PACK_VIEWS(m) (((m) & S_F_SVG_PACKED) == S_F_SVG_PACKED)
141 #define DISPLAY_HUMAN_READ(m) (((m) & S_F_HUMAN_READ) == S_F_HUMAN_READ)
142 #define DISPLAY_TOC(m) (((m) & S_F_SVG_SHOW_TOC) == S_F_SVG_SHOW_TOC)
143 #define FDATASYNC(m) (((m) & S_F_FDATASYNC) == S_F_FDATASYNC)
145 #define AO_F_NULL 0x00000000
147 /* Output flags for options -r / -S */
148 #define AO_F_MEMORY 0x00000001
149 #define AO_F_SWAP 0x00000002
150 /* AO_F_MEM_ALL: See opt_flags in struct activity below */
151 #define AO_F_MEM_ALL (AO_F_MEMORY << 8)
153 #define DISPLAY_MEMORY(m) (((m) & AO_F_MEMORY) == AO_F_MEMORY)
154 #define DISPLAY_SWAP(m) (((m) & AO_F_SWAP) == AO_F_SWAP)
155 #define DISPLAY_MEM_ALL(m) (((m) & AO_F_MEM_ALL) == AO_F_MEM_ALL)
157 /* Output flags for option -u [ ALL ] */
158 #define AO_F_CPU_DEF 0x00000001
159 #define AO_F_CPU_ALL 0x00000002
161 #define DISPLAY_CPU_DEF(m) (((m) & AO_F_CPU_DEF) == AO_F_CPU_DEF)
162 #define DISPLAY_CPU_ALL(m) (((m) & AO_F_CPU_ALL) == AO_F_CPU_ALL)
164 /* Output flags for option -d */
165 #define AO_F_DISK_PART 0x00000001
167 #define COLLECT_PARTITIONS(m) (((m) & AO_F_DISK_PART) == AO_F_DISK_PART)
169 /* Output flags for option -F */
170 #define AO_F_FILESYSTEM 0x00000001
171 #define AO_F_MOUNT 0x00000002
173 #define DISPLAY_MOUNT(m) (((m) & AO_F_MOUNT) == AO_F_MOUNT)
176 ***************************************************************************
177 * Various keywords and constants.
178 ***************************************************************************
182 #define K_A_NULL "A_NULL"
183 #define K_XALL "XALL"
186 #define K_EDEV "EDEV"
188 #define K_NFSD "NFSD"
189 #define K_SOCK "SOCK"
192 #define K_ICMP "ICMP"
193 #define K_EICMP "EICMP"
195 #define K_ETCP "ETCP"
197 #define K_SOCK6 "SOCK6"
199 #define K_EIP6 "EIP6"
200 #define K_ICMP6 "ICMP6"
201 #define K_EICMP6 "EICMP6"
202 #define K_UDP6 "UDP6"
205 #define K_TEMP "TEMP"
207 #define K_FREQ "FREQ"
208 #define K_MOUNT "MOUNT"
210 #define K_SOFT "SOFT"
213 #define K_DISK "DISK"
214 #define K_XDISK "XDISK"
215 #define K_SNMP "SNMP"
216 #define K_IPV6 "IPV6"
217 #define K_POWER "POWER"
220 #define K_SKIP_EMPTY "skipempty"
221 #define K_AUTOSCALE "autoscale"
222 #define K_ONEDAY "oneday"
223 #define K_SHOWIDLE "showidle"
224 #define K_SHOWINFO "showinfo"
225 #define K_DEBUG "debug"
226 #define K_HEIGHT "height="
227 #define K_PACKED "packed"
228 #define K_SHOWTOC "showtoc"
229 #define K_CUSTOMCOL "customcol"
230 #define K_BWCOL "bwcol"
231 #define K_PCPARCHIVE "pcparchive="
233 /* Environment variables */
234 #define ENV_COLORS_PALETTE "S_COLORS_PALETTE"
236 /* Groups of activities */
237 #define G_DEFAULT 0x00
248 /* Time must have the format HH:MM:SS with HH in 24-hour format */
249 #define DEF_TMSTART "08:00:00"
250 #define DEF_TMEND "18:00:00"
252 #define UTSNAME_LEN 65
253 #define HEADER_LINE_LEN 512
256 * Define upper limit for various items.
257 * Made necessary because we have to check the number of
258 * items for each activity when we read a (possibly tainted)
261 #define MAX_NR_SERIAL_LINES 65536
262 #define MAX_NR_DISKS (65536 * 4096)
263 #define MAX_NR_IFACES 65536
264 #define MAX_NR_FANS 4096
265 #define MAX_NR_TEMP_SENSORS 4096
266 #define MAX_NR_IN_SENSORS 4096
267 #define MAX_NR_USB 65536
268 #define MAX_NR_FS (65536 * 4096)
269 #define MAX_NR_FCHOSTS 65536
271 /* NR_MAX is the upper limit used for unknown activities */
272 #define NR_MAX (65536 * 4096)
275 /* Maximum number of args that can be passed to sadc */
276 #define MAX_ARGV_NR 32
278 /* Miscellaneous constants */
280 #define USE_SA_FILE 1
281 #define NO_TM_START 0
288 #define ALL_ACTIVITIES ~0U
289 #define EXIT_IF_NOT_FOUND 1
290 #define RESUME_IF_NOT_FOUND 0
298 #define END_OF_DATA_UNEXPECTED 1
299 #define INCONSISTENT_INPUT_DATA 2
304 #define CLOSE_XML_MARKUP 0
305 #define OPEN_XML_MARKUP 1
307 #define CLOSE_JSON_MARKUP 0
308 #define OPEN_JSON_MARKUP 1
310 #define COUNT_ACTIVITIES 0
311 #define COUNT_OUTPUTS 1
313 /* Type for all functions reading statistics */
314 #define __read_funct_t void
315 /* Type for all functions displaying statistics */
316 #define __print_funct_t void
318 /* Structure containing specific parameters for logic#1 output (XML/JSON/PCP...) */
320 unsigned int flags; /* Common flags */
321 int tab; /* Number of tabulations */
324 /* Structure for SVG specific parameters */
326 unsigned long long dt; /* Interval of time for current sample */
327 unsigned long long ust_time_ref; /* X axis start time in seconds since the epoch */
328 unsigned long long ust_time_end; /* X axis end time in seconds since the epoch */
329 unsigned long long ust_time_first; /* Time (in seconds since the epoch) for first sample */
330 int graph_no; /* Total number of views already displayed */
331 int restart; /* TRUE if we have just met a RESTART record */
332 int nr_act_dispd; /* Number of activities that will be displayed */
333 struct file_header *file_hdr; /* Pointer on file header structure */
336 /* Structure used when displaying SVG header */
337 struct svg_hdr_parm {
338 int graph_nr; /* Number of rows of views to display or canvas height entered on the command line */
339 int views_per_row; /* Maximum number of views on a single row */
340 int nr_act_dispd; /* Number of activities that will be displayed */
344 ***************************************************************************
345 * System activity data files
347 * The rule is: "strict writing, read any", meaning that sar/sadc can
348 * only append data to a datafile whose format is strictly the same as that
349 * of current version (checking FORMAT_MAGIC is not enough), but sar/sadf
350 * can read data from different versions, providing that FORMAT_MAGIC value
351 * has not changed (note that we are talking here of data read from a file,
352 * not data that sar reads from sadc, in which case the "strict" rule applies).
354 * Format of system activity data files:
357 * | file_magic structure
361 * | file_header structure
365 * | file_activity structure | * sa_act_nr
369 * | record_header structure |
375 * | Statistics structure(s) | * <count>
381 * | Statistics structure(s)... |
385 * Note: For activities with varying number of items, a __nr_t value, giving
386 * the number of items, arrives before the statistics structures so that
387 * we know how many of them have to be read.
388 * NB: This value exists for all the activities even if they share the same
389 * count function (e.g. A_NET_DEV and A_NET_EDEV). Indeed, statistics are not
390 * read atomically and the number of items (e.g. network interfaces) may have
393 * If the record header's type is R_COMMENT then we find only a comment
394 * following the record_header structure.
395 * If the record_header's type is R_RESTART then we find only the number of CPU
396 * (of type __nr_t) of the machine following the record_header structure.
397 ***************************************************************************
401 * Sysstat magic number. Should never be modified.
402 * Indicate that the file was created by sysstat.
404 #define SYSSTAT_MAGIC 0xd596
405 #define SYSSTAT_MAGIC_SWAPPED (((SYSSTAT_MAGIC << 8) | (SYSSTAT_MAGIC >> 8)) & 0xffff)
408 * Datafile format magic number.
409 * Modified to indicate that the format of the file is
410 * no longer compatible with that of previous sysstat versions.
412 #define FORMAT_MAGIC 0x2175
413 #define FORMAT_MAGIC_SWAPPED (((FORMAT_MAGIC << 8) | (FORMAT_MAGIC >> 8)) & 0xffff)
415 /* Previous datafile format magic numbers used by older sysstat versions */
416 #define FORMAT_MAGIC_2171 0x2171
417 #define FORMAT_MAGIC_2171_SWAPPED (((FORMAT_MAGIC_2171 << 8) | (FORMAT_MAGIC_2171 >> 8)) & 0xffff)
418 #define FORMAT_MAGIC_2173 0x2173
419 #define FORMAT_MAGIC_2173_SWAPPED (((FORMAT_MAGIC_2173 << 8) | (FORMAT_MAGIC_2173 >> 8)) & 0xffff)
421 /* Padding in file_magic structure. See below. */
422 #define FILE_MAGIC_PADDING 48
424 /* Structure for file magic header data */
427 * This field identifies the file as a file created by sysstat.
429 unsigned short sysstat_magic;
431 * The value of this field varies whenever datafile format changes.
433 unsigned short format_magic;
435 * Sysstat version used to create the file.
437 unsigned char sysstat_version;
438 unsigned char sysstat_patchlevel;
439 unsigned char sysstat_sublevel;
440 unsigned char sysstat_extraversion;
441 #define FILE_MAGIC_ULL_NR 0 /* Nr of unsigned long long below */
442 #define FILE_MAGIC_UL_NR 0 /* Nr of unsigned long below */
443 #define FILE_MAGIC_U_NR 5 /* Nr of [unsigned] int below */
445 * Size of file's header (size of file_header structure used by file).
447 unsigned int header_size;
449 * Set to non zero if data file has been converted with "sadf -c" from
450 * an old format (version x.y.z) to a newest format (version X.Y.Z).
451 * In this case, the value is: Y*256 + Z + 1.
452 * The FORMAT_MAGIC value of the file can be used to determine X.
454 unsigned int upgraded;
456 * Description of the file_header structure
457 * (nr of "long long", nr of "long" and nr of "int").
459 unsigned int hdr_types_nr[3];
461 * Padding. Reserved for future use while avoiding a format change.
462 * sysstat always reads a number of bytes which is that expected for
463 * current sysstat version (FILE_MAGIC_SIZE). We cannot guess if we
464 * are going to read a file from current, an older or a newer version.
466 unsigned char pad[FILE_MAGIC_PADDING];
469 #define FILE_MAGIC_SIZE (sizeof(struct file_magic))
471 /* Header structure for system activity data file */
474 * Timestamp in seconds since the epoch.
476 unsigned long long sa_ust_time;
478 * Number of jiffies per second.
480 unsigned long sa_hz __attribute__ ((aligned (8)));
482 * Number of [online or offline] CPU (1 .. CPU_NR + 1)
483 * when the datafile has been created.
484 * When reading a datafile, this value is updated (in memory)
485 * whenever a RESTART record is found.
486 * When writing or appending data to a file, this field is updated
487 * neither in file nor in memory.
489 unsigned int sa_cpu_nr __attribute__ ((aligned (8)));
491 * Number of activities saved in file.
493 unsigned int sa_act_nr;
499 * Description of the file_activity and record_header structures
500 * (nr of "long long", nr of "long" and nr of "int").
502 unsigned int act_types_nr[3];
503 unsigned int rec_types_nr[3];
505 * Size of file_activity and record_header structures used by file.
507 unsigned int act_size;
508 unsigned int rec_size;
510 * Current day and month.
511 * No need to save DST (Daylight Saving Time) flag, since it is not taken
512 * into account by the strftime() function used to print the timestamp.
514 unsigned char sa_day;
515 unsigned char sa_month;
517 * Size of a long integer. Useful to know the architecture on which
518 * the datafile was created.
522 * Operating system name.
524 char sa_sysname[UTSNAME_LEN];
528 char sa_nodename[UTSNAME_LEN];
530 * Operating system release number.
532 char sa_release[UTSNAME_LEN];
534 * Machine architecture.
536 char sa_machine[UTSNAME_LEN];
539 #define FILE_HEADER_SIZE (sizeof(struct file_header))
540 #define FILE_HEADER_ULL_NR 1 /* Nr of unsigned long long in file_header structure */
541 #define FILE_HEADER_UL_NR 1 /* Nr of unsigned long in file_header structure */
542 #define FILE_HEADER_U_NR 11 /* Nr of [unsigned] int in file_header structure */
543 /* The values below are used for sanity check */
544 #define MIN_FILE_HEADER_SIZE 0
545 #define MAX_FILE_HEADER_SIZE 8192
549 * Base magical number for activities.
551 #define ACTIVITY_MAGIC_BASE 0x8a
553 * Magical value used for activities with
554 * unknown format (used for sadf -H only).
556 #define ACTIVITY_MAGIC_UNKNOWN 0x89
558 /* List of activities saved in file */
559 struct file_activity {
561 * Identification value of activity.
565 * Activity magical number.
569 * Number of items for this activity
570 * when the data file has been created.
574 * Number of sub-items for this activity.
578 * Set to TRUE if statistics are preceded by
579 * a value giving the number of structures to read.
583 * Size of an item structure.
587 * Description of the structure containing statistics for the
588 * given activity (nr of "long long", nr of "long" and nr of "int").
590 unsigned int types_nr[3];
593 #define FILE_ACTIVITY_SIZE (sizeof(struct file_activity))
594 #define MAX_FILE_ACTIVITY_SIZE 1024 /* Used for sanity check */
595 #define FILE_ACTIVITY_ULL_NR 0 /* Nr of unsigned long long in file_activity structure */
596 #define FILE_ACTIVITY_UL_NR 0 /* Nr of unsigned long in file_activity structure */
597 #define FILE_ACTIVITY_U_NR 9 /* Nr of [unsigned] int in file_activity structure */
602 * R_STATS means that this is a record of statistics.
606 * R_RESTART means that this is a special record containing
607 * a LINUX RESTART message.
611 * R_LAST_STATS warns sar that this is the last record to be written
612 * to file before a file rotation, and that the next data to come will
614 * Such a record is tagged R_STATS anyway before being written to file.
616 #define R_LAST_STATS 3
618 * R_COMMENT means that this is a special record containing
623 /* Maximum length of a comment */
624 #define MAX_COMMENT_LEN 64
626 /* Header structure for every record */
627 struct record_header {
629 * Machine uptime in 1/100th of a second.
631 unsigned long long uptime_cs;
633 * Timestamp (number of seconds since the epoch).
635 unsigned long long ust_time;
637 * Record type: R_STATS, R_RESTART,...
639 unsigned char record_type;
641 * Timestamp: Hour (0-23), minute (0-59) and second (0-59).
642 * Used to determine TRUE time (immutable, non locale dependent time).
645 unsigned char minute;
646 unsigned char second;
649 #define RECORD_HEADER_SIZE (sizeof(struct record_header))
650 #define MAX_RECORD_HEADER_SIZE 512 /* Used for sanity check */
651 #define RECORD_HEADER_ULL_NR 2 /* Nr of unsigned long long in record_header structure */
652 #define RECORD_HEADER_UL_NR 0 /* Nr of unsigned long in record_header structure */
653 #define RECORD_HEADER_U_NR 0 /* Nr of unsigned int in record_header structure */
657 ***************************************************************************
658 * Generic description of an activity.
659 ***************************************************************************
662 /* Activity options */
665 * Indicate that corresponding activity should be collected by sadc.
667 #define AO_COLLECTED 0x01
669 * Indicate that corresponding activity should be displayed by sar.
671 #define AO_SELECTED 0x02
673 * Indicate that corresponding activity has items that need to be counted.
674 * This means that its @f_count_index values is >= 0.
675 * (We use AO_COUNTED instead of @f_count_index because @f_count_index
676 * is available (initialized) only for sadc).
678 #define AO_COUNTED 0x04
680 * Indicate that activity's metrics have persistent values when devices
681 * are registered again (this means that when the device is registered again,
682 * the metrics pick the values they had when they had been unregistered).
683 * Exclusively used for CPU related statistics at the present time.
685 #define AO_PERSISTENT 0x08
687 * This flag should be set for every activity closing a markup used
688 * by several activities. Used by sadf f_xml_print() functions to
689 * display XML output.
691 #define AO_CLOSE_MARKUP 0x10
693 * Indicate that corresponding activity has multiple different
694 * output formats. This is the case for example for memory activity
695 * with options -r and -R.
696 * PS: Such an activity should appear in the list of activities that
697 * sar -A is supposed to display.
699 #define AO_MULTIPLE_OUTPUTS 0x20
701 * Indicate that one (SVG) graph will be displayed for each
702 * distinct item for this activity (sadf -g).
704 #define AO_GRAPH_PER_ITEM 0x40
706 * Indicate that this activity may have sub-items.
708 #define AO_MATRIX 0x80
710 * Indicate that a list of devices has been entered on the command
711 * line for this activity (see options --dev=, --iface=, ...)
713 #define AO_LIST_ON_CMDLINE 0x100
715 * Indicate that the number of items for this activity should always
716 * be counted, even if the activity is not collected.
718 #define AO_ALWAYS_COUNTED 0x200
720 #define IS_COLLECTED(m) (((m) & AO_COLLECTED) == AO_COLLECTED)
721 #define IS_SELECTED(m) (((m) & AO_SELECTED) == AO_SELECTED)
722 #define HAS_COUNT_FUNCTION(m) (((m) & AO_COUNTED) == AO_COUNTED)
723 #define HAS_PERSISTENT_VALUES(m) (((m) & AO_PERSISTENT) == AO_PERSISTENT)
724 #define CLOSE_MARKUP(m) (((m) & AO_CLOSE_MARKUP) == AO_CLOSE_MARKUP)
725 #define HAS_MULTIPLE_OUTPUTS(m) (((m) & AO_MULTIPLE_OUTPUTS) == AO_MULTIPLE_OUTPUTS)
726 #define ONE_GRAPH_PER_ITEM(m) (((m) & AO_GRAPH_PER_ITEM) == AO_GRAPH_PER_ITEM)
727 #define IS_MATRIX(m) (((m) & AO_MATRIX) == AO_MATRIX)
728 #define HAS_LIST_ON_CMDLINE(m) (((m) & AO_LIST_ON_CMDLINE) == AO_LIST_ON_CMDLINE)
729 #define ALWAYS_COUNT_ITEMS(m) (((m) & AO_ALWAYS_COUNTED) == AO_ALWAYS_COUNTED)
734 /* Structure used to define a bitmap needed by an activity */
737 * Bitmap for activities that need one. Remember to allocate it
740 unsigned char *b_array;
742 * Size of the bitmap in bits. In fact, bitmap is sized to b_size + 1
743 * to take into account CPU "all"
749 * Structure used to define an activity.
750 * Note: This structure can be modified without changing the format of data files.
754 * This variable contains the identification value (A_...) for this activity.
758 * Activity options (AO_...)
760 unsigned int options;
762 * Activity magical number. This number changes when activity format in file
763 * is no longer compatible with the format of that same activity from
768 * An activity belongs to a group (and only one).
769 * Groups are those selected with option -S of sadc.
773 * Index in f_count[] array to determine function used to count
774 * the number of items (serial lines, network interfaces, etc.) -> @nr
775 * Such a function should _always_ return a value greater than
778 * A value of -1 indicates that the number of items
779 * is a constant (and @nr is set to this value).
781 * These functions are called even if corresponding activities have not
782 * been selected, to make sure that all items have been calculated
783 * (including #CPU, etc.)
787 * The f_count2() function is used to count the number of
789 * Such a function should _always_ return a value greater than
792 * A NULL value for this function pointer indicates that the number of items
793 * is a constant (and @nr2 is set to this value).
795 __nr_t (*f_count2) (struct activity *);
797 * This function reads the relevant file and fill the buffer
798 * with statistics corresponding to given activity.
800 __read_funct_t (*f_read) (struct activity *);
802 * This function displays activity statistics onto the screen.
804 __print_funct_t (*f_print) (struct activity *, int, int, unsigned long long);
806 * This function displays average activity statistics onto the screen.
808 __print_funct_t (*f_print_avg) (struct activity *, int, int, unsigned long long);
810 * This function is used by sadf to display activity in a format that can
811 * easily be ingested by a relational database, or a format that can be
812 * handled by pattern processing commands like "awk".
814 __print_funct_t (*f_render) (struct activity *, int, char *, int, unsigned long long);
816 * This function is used by sadf to display activity statistics in XML.
818 __print_funct_t (*f_xml_print) (struct activity *, int, int, unsigned long long);
820 * This function is used by sadf to display activity statistics in JSON.
822 __print_funct_t (*f_json_print) (struct activity *, int, int, unsigned long long);
824 * This function is used by sadf to display activity statistics in SVG.
826 __print_funct_t (*f_svg_print) (struct activity *, int, int, struct svg_parm *,
827 unsigned long long, struct record_header *);
829 * This function is used by sadf to display activity statistics in raw format.
831 __print_funct_t (*f_raw_print) (struct activity *, char *, int);
833 * This function is used by sadf to display activity statistics in PCP format.
835 __print_funct_t (*f_pcp_print) (struct activity *, int, unsigned long long,
836 struct record_header *);
838 * This function is used by sadf to count the number of new items in current
839 * sample and add them to the linked list @item_list.
841 __nr_t (*f_count_new) (struct activity *, int);
843 * Linked list containing item names. This is either all the different items
844 * found in a file for activities that have a @f_count_function() (used by sadf),
845 * or a list entered on the command line (used by sadf and sar).
847 struct sa_item *item_list;
849 * Number of different items found in file (calculated by sadf).
850 * This is also the number of items in @item_list if this list exists.
854 * Header string displayed by sadf -d.
855 * Header lines for each output (for activities with multiple outputs) are
856 * separated with a '|' character.
857 * For a given output, the first field corresponding to extended statistics
858 * (eg. -r ALL) begins with a '&' character.
862 * Description of activity.
870 * Description of the corresponding structure containing statistics (as defined
871 * in rd_stats.h or rd_sensors.h). Such a structure has 0+ fields of type
872 * "long long", followed by 0+ fields of type "long", followed by 0+ fields of
873 * type "int", followed by 0+ other fields (e.g. of type char). The array below
874 * gives the number of "long long" fields composing the structure, then the number
875 * of "long" fields, then the number of "int" fields.
877 unsigned int gtypes_nr[3];
879 * This array has the same meaning as @gtypes_nr[] above, but the values are those
880 * read from current data file. They may be different from those of @gtypes_nr[]
881 * because we can read data from a different sysstat version (older or newer).
883 unsigned int ftypes_nr[3];
885 * Number of SVG graphs for this activity. The total number of graphs for
886 * the activity can be greater though if flag AO_GRAPH_PER_ITEM is set, in
887 * which case the total number will be @g_nr * @nr.
891 * Number of items on the system, as counted when the system is initialized.
892 * A negative value (-1) is the default value and indicates that this number
893 * has still not been calculated by the f_count() function.
894 * A value of 0 means that this number has been calculated, but no items have
896 * A positive value (>0) has either been calculated or is a constant.
900 * Number of sub-items on the system.
901 * @nr2 is in fact the second dimension of a matrix of items, the first
902 * one being @nr. @nr is the number of lines, and @nr2 the number of columns.
903 * A negative value (-1) is the default value and indicates that this number
904 * has still not been calculated by the f_count2() function.
905 * A value of 0 means that this number has been calculated, but no sub-items have
907 * A positive value (>0) has either been calculated or is a constant.
909 * 1) IF @nr2 = 0 THEN @nr = 0
910 * Note: If @nr = 0, then @nr2 is undetermined (may be -1, 0 or >0).
911 * 2) IF @nr > 0 THEN @nr2 > 0.
912 * Note: If @nr2 > 0 then @nr is undetermined (may be -1, 0 or >0).
913 * 3) IF @nr <= 0 THEN @nr2 = -1 (this is the default value for @nr2,
914 * meaning that it has not been calculated).
918 * Maximum number of elements that sar can handle for this item.
919 * NB: The maximum number of elements that sar can handle for sub-items
924 * Number of items, as read and saved in corresponding buffer (@buf: See below).
925 * The value may be zero for a particular sample if no items have been found.
929 * Number of structures allocated in @buf[*]. This number should be greater
930 * than or equal to @nr[*].
935 * This is the size of the corresponding structure, as read from or written
936 * to a file, or read from or written by the data collector.
941 * This is the size of the corresponding structure as mapped into memory.
942 * @msize can be different from @fsize when data are read from or written to
943 * a data file from a different sysstat version.
947 * Optional flags for activity. This is eg. used when AO_MULTIPLE_OUTPUTS
949 * 0x0001 - 0x0080 : Multiple outputs (eg. AO_F_MEMORY, AO_F_SWAP...)
950 * 0x0100 - 0x8000 : If bit set then display complete header (hdr_line) for
951 * corresponding output
952 * 0x010000+ : Optional flags
954 unsigned int opt_flags;
956 * Buffers that will contain the statistics read. Its size is @nr * @nr2 * @size each.
958 * [0] and [1]: current/previous statistics values (used by sar).
959 * [2]: Used by sar to save first collected stats (used later to
964 * Bitmap for activities that need one. Such a bitmap is needed by activity
965 * if @bitmap is not NULL.
967 struct act_bitmap *bitmap;
972 ***************************************************************************
973 * Generic description of an output format for sadf (and sar).
974 ***************************************************************************
977 /* Type for all functions used by sadf to display stats in various formats */
978 #define __printf_funct_t void
979 #define __tm_funct_t char *
982 * Structure used to define a report.
983 * A XML-like report has the following format:
989 * | | Statistics block
992 * | | | Timestamp block
995 * | | | | Activity #1
1001 * | | | | Activity #n
1006 * | | Restart messages block
1009 * | | Comments block
1013 struct report_format {
1015 * This variable contains the identification value (F_...) for this report format.
1019 * Format options (FO_...).
1021 unsigned int options;
1023 * This function displays the report header
1024 * (data displayed once at the beginning of the report).
1026 __printf_funct_t (*f_header) (void *, int, char *, struct file_magic *, struct file_header *,
1027 struct activity * [], unsigned int [], struct file_activity *);
1029 * This function defines the statistics part of the report.
1030 * Used only with textual (XML-like) reports and PCP archives.
1032 __printf_funct_t (*f_statistics) (int *, int, struct activity * [], unsigned int []);
1034 * This function defines the timestamp part of the report.
1035 * Used only with textual (XML-like) reports.
1037 __tm_funct_t (*f_timestamp) (void *, int, char *, char *, unsigned long long,
1038 struct record_header *, struct file_header *, unsigned int);
1040 * This function displays the restart messages.
1042 __printf_funct_t (*f_restart) (int *, int, char *, char *, int, struct file_header *);
1044 * This function displays the comments.
1046 __printf_funct_t (*f_comment) (int *, int, char *, char *, int, char *, struct file_header *);
1049 /* Possible actions for functions used to display reports */
1050 #define F_BEGIN 0x01
1055 ***************************************************************************
1056 * SVG output definitions
1057 ***************************************************************************
1062 * 1 | General header
1065 * 9 | One line from table of contents (if any)
1068 * | | 4 | Graph title
1078 * | | v |-------------------------------
1080 * | v <---><------------------------------>
1083 * v<---------------------------------------------------------------> Gap
1085 * <--------------------------------------------------------------------->
1090 #define SVG_G_XSIZE 720
1092 #define SVG_M_XSIZE 70
1094 #define SVG_V_XSIZE 1050
1096 #define SVG_T_XSIZE 1060
1099 #define SVG_G_YSIZE 200
1101 #define SVG_H_YSIZE 60
1103 #define SVG_M_YSIZE 50
1105 #define SVG_T_YSIZE 310
1107 #define SVG_V_YSIZE 300
1109 #define SVG_C_YSIZE 20
1111 /* Grid: Nr of horizontal lines */
1112 #define SVG_H_GRIDNR 3
1113 /* Grid: Nr of vertical lines */
1114 #define SVG_V_GRIDNR 10
1116 /* Block size used to allocate arrays for graphs data */
1117 #define CHUNKSIZE 4096
1119 /* Maximum number of views on a single row */
1120 #define MAX_VIEWS_ON_A_ROW 6
1122 #define SVG_LINE_GRAPH 1
1123 #define SVG_BAR_GRAPH 2
1125 /* Maximum number of horizontal lines for the background grid */
1126 #define MAX_HLINES_NR 10
1128 /* Color palette constants */
1129 #define SVG_COLORS_IDX_MASK 0x0f
1130 #define SVG_COL_PALETTE_SIZE 24
1131 #define SVG_COL_PALETTE_NR 3
1132 #define SVG_COL_BCKGRD_IDX 16
1133 #define SVG_COL_AXIS_IDX 17
1134 #define SVG_COL_GRID_IDX 18
1135 #define SVG_COL_TITLE_IDX 19
1136 #define SVG_COL_INFO_IDX 20
1137 #define SVG_COL_DEFAULT_IDX 21
1138 #define SVG_COL_HEADER_IDX 22
1139 #define SVG_COL_ERROR_IDX 23
1141 #define SVG_DEFAULT_COL_PALETTE 0
1142 #define SVG_CUSTOM_COL_PALETTE 1
1143 #define SVG_BW_COL_PALETTE 2
1148 ***************************************************************************
1149 * Macro functions definitions.
1151 * Note: Using 'do ... while' makes the macros safer to use
1152 * (remember that macro use is followed by a semicolon).
1153 ***************************************************************************
1156 /* Close file descriptors */
1157 #define CLOSE_ALL(_fd_) do { \
1162 #define CLOSE(_fd_) if (_fd_ >= 0) \
1167 ***************************************************************************
1168 * Various structure definitions.
1169 ***************************************************************************
1172 /* Structure for timestamps */
1180 /* Structure for items in list */
1183 struct sa_item *next;
1188 ***************************************************************************
1189 * Functions prototypes.
1190 ***************************************************************************
1194 * Prototypes used to count new items
1196 __nr_t count_new_net_dev
1197 (struct activity *, int);
1198 __nr_t count_new_net_edev
1199 (struct activity *, int);
1200 __nr_t count_new_filesystem
1201 (struct activity *, int);
1202 __nr_t count_new_fchost
1203 (struct activity *, int);
1204 __nr_t count_new_disk
1205 (struct activity *, int);
1207 /* Functions used to count number of items */
1208 __nr_t wrap_get_cpu_nr
1209 (struct activity *);
1210 __nr_t wrap_get_irq_nr
1211 (struct activity *);
1212 __nr_t wrap_get_serial_nr
1213 (struct activity *);
1214 __nr_t wrap_get_disk_nr
1215 (struct activity *);
1216 __nr_t wrap_get_iface_nr
1217 (struct activity *);
1218 __nr_t wrap_get_fan_nr
1219 (struct activity *);
1220 __nr_t wrap_get_temp_nr
1221 (struct activity *);
1222 __nr_t wrap_get_in_nr
1223 (struct activity *);
1224 __nr_t wrap_get_freq_nr
1225 (struct activity *);
1226 __nr_t wrap_get_usb_nr
1227 (struct activity *);
1228 __nr_t wrap_get_filesystem_nr
1229 (struct activity *);
1230 __nr_t wrap_get_fchost_nr
1231 (struct activity *);
1233 /* Functions used to read activities statistics */
1234 __read_funct_t wrap_read_stat_cpu
1235 (struct activity *);
1236 __read_funct_t wrap_read_stat_pcsw
1237 (struct activity *);
1238 __read_funct_t wrap_read_stat_irq
1239 (struct activity *);
1240 __read_funct_t wrap_read_swap
1241 (struct activity *);
1242 __read_funct_t wrap_read_paging
1243 (struct activity *);
1244 __read_funct_t wrap_read_io
1245 (struct activity *);
1246 __read_funct_t wrap_read_meminfo
1247 (struct activity *);
1248 __read_funct_t wrap_read_kernel_tables
1249 (struct activity *);
1250 __read_funct_t wrap_read_loadavg
1251 (struct activity *);
1252 __read_funct_t wrap_read_tty_driver_serial
1253 (struct activity *);
1254 __read_funct_t wrap_read_disk
1255 (struct activity *);
1256 __read_funct_t wrap_read_net_dev
1257 (struct activity *);
1258 __read_funct_t wrap_read_net_edev
1259 (struct activity *);
1260 __read_funct_t wrap_read_net_nfs
1261 (struct activity *);
1262 __read_funct_t wrap_read_net_nfsd
1263 (struct activity *);
1264 __read_funct_t wrap_read_net_sock
1265 (struct activity *);
1266 __read_funct_t wrap_read_net_ip
1267 (struct activity *);
1268 __read_funct_t wrap_read_net_eip
1269 (struct activity *);
1270 __read_funct_t wrap_read_net_icmp
1271 (struct activity *);
1272 __read_funct_t wrap_read_net_eicmp
1273 (struct activity *);
1274 __read_funct_t wrap_read_net_tcp
1275 (struct activity *);
1276 __read_funct_t wrap_read_net_etcp
1277 (struct activity *);
1278 __read_funct_t wrap_read_net_udp
1279 (struct activity *);
1280 __read_funct_t wrap_read_net_sock6
1281 (struct activity *);
1282 __read_funct_t wrap_read_net_ip6
1283 (struct activity *);
1284 __read_funct_t wrap_read_net_eip6
1285 (struct activity *);
1286 __read_funct_t wrap_read_net_icmp6
1287 (struct activity *);
1288 __read_funct_t wrap_read_net_eicmp6
1289 (struct activity *);
1290 __read_funct_t wrap_read_net_udp6
1291 (struct activity *);
1292 __read_funct_t wrap_read_cpuinfo
1293 (struct activity *);
1294 __read_funct_t wrap_read_fan
1295 (struct activity *);
1296 __read_funct_t wrap_read_temp
1297 (struct activity *);
1298 __read_funct_t wrap_read_in
1299 (struct activity *);
1300 __read_funct_t wrap_read_meminfo_huge
1301 (struct activity *);
1302 __read_funct_t wrap_read_cpu_wghfreq
1303 (struct activity *);
1304 __read_funct_t wrap_read_bus_usb_dev
1305 (struct activity *);
1306 __read_funct_t wrap_read_filesystem
1307 (struct activity *);
1308 __read_funct_t wrap_read_fchost
1309 (struct activity *);
1310 __read_funct_t wrap_read_softnet
1311 (struct activity *);
1313 /* Other functions */
1314 int check_alt_sa_dir
1316 void enum_version_nr
1317 (struct file_magic *);
1319 (struct activity * [], unsigned int, int);
1320 int get_activity_position
1321 (struct activity * [], unsigned int, int);
1322 void handle_invalid_sa_file
1323 (int, struct file_magic *, char *, int);
1324 void print_collect_error
1326 int set_default_file
1329 (int, const void *, int);
1333 (struct sa_item **, char *, int);
1334 void allocate_bitmaps
1335 (struct activity * []);
1336 void allocate_structures
1337 (struct activity * []);
1339 (struct activity *, int, int, int);
1340 void check_file_actlst
1341 (int *, char *, struct activity * [], unsigned int, struct file_magic *,
1342 struct file_header *, struct file_activity **, unsigned int [], int, int *, int *);
1343 int check_net_dev_reg
1344 (struct activity *, int, int, int);
1345 int check_net_edev_reg
1346 (struct activity *, int, int, int);
1347 double compute_ifutil
1348 (struct stats_net_dev *, double, double);
1349 void copy_structures
1350 (struct activity * [], unsigned int [], struct record_header [], int, int);
1352 (struct tm *, struct tstamp *);
1353 void display_sa_file_version
1354 (FILE *, struct file_magic *);
1356 (struct activity * []);
1357 void free_structures
1358 (struct activity * []);
1360 (unsigned int, unsigned int, int);
1361 char *get_sa_devname
1362 (unsigned int, unsigned int, unsigned int);
1363 void get_file_timestamp_struct
1364 (unsigned int, struct tm *, struct file_header *);
1365 unsigned long long get_global_cpu_statistics
1366 (struct activity *, int, int, unsigned int, unsigned char []);
1367 void get_global_soft_statistics
1368 (struct activity *, int, int, unsigned int, unsigned char []);
1370 (struct record_header *, struct record_header *, unsigned long long *);
1371 void init_custom_color_palette
1374 (unsigned long long, unsigned long long, int, long);
1375 void parse_sa_devices
1376 (char *, struct activity *, int, int *, int);
1378 (char * [], int *, struct activity * [], unsigned int *, int);
1380 (char * [], int *, struct activity * []);
1382 (char * [], int *, unsigned int *, struct activity * []);
1384 (char * [], int *, struct activity * []);
1386 (char * [], int *, struct activity * []);
1388 (char * [], int *, struct tstamp *, const char *);
1389 void print_report_hdr
1390 (unsigned int, struct tm *, struct file_header *);
1391 void print_sar_comment
1392 (int *, int, char *, char *, int, char *, struct file_header *);
1393 __printf_funct_t print_sar_restart
1394 (int *, int, char *, char *, int, struct file_header *);
1395 int print_special_record
1396 (struct record_header *, unsigned int, struct tstamp *, struct tstamp *,
1397 int, int, struct tm *, struct tm *, char *, int, struct file_magic *,
1398 struct file_header *, struct activity * [], struct report_format *, int, int);
1399 int read_file_stat_bunch
1400 (struct activity * [], int, int, int, struct file_activity *, int, int,
1401 char *, struct file_magic *, int);
1402 __nr_t read_nr_value
1403 (int, char *, struct file_magic *, int, int, int);
1405 (int, void *, struct record_header *, struct file_header *, int, int,
1407 void reallocate_all_buffers
1408 (struct activity *, __nr_t);
1409 void replace_nonprintable_char
1412 (int, void *, size_t, int, int);
1413 int sa_get_record_timestamp_struct
1414 (unsigned int, struct record_header *, struct tm *, struct tm *);
1415 int sa_open_read_magic
1416 (int *, char *, struct file_magic *, int, int *, int);
1417 int search_list_item
1418 (struct sa_item *, char *);
1419 void select_all_activities
1420 (struct activity * []);
1421 void select_default_activity
1422 (struct activity * []);
1424 (unsigned char [], unsigned char, unsigned int);
1425 void set_hdr_rectime
1426 (unsigned int, struct tm *, struct file_header *);
1427 void set_record_timestamp_string
1428 (unsigned int, struct record_header *, char *, char *, int, struct tm *);
1430 (unsigned int [], void *, int);
1431 #endif /* SOURCE_SADC undefined */