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"
227 #define K_CUSTOMCOL "customcol"
228 #define K_BWCOL "bwcol"
230 /* Environment variables */
231 #define ENV_COLORS_PALETTE "S_COLORS_PALETTE"
233 /* Groups of activities */
234 #define G_DEFAULT 0x00
245 /* Time must have the format HH:MM:SS with HH in 24-hour format */
246 #define DEF_TMSTART "08:00:00"
247 #define DEF_TMEND "18:00:00"
249 #define UTSNAME_LEN 65
250 #define HEADER_LINE_LEN 512
253 * Define upper limit for various items.
254 * Made necessary because we have to check the number of
255 * items for each activity when we read a (possibly tainted)
258 #define MAX_NR_SERIAL_LINES 65536
259 #define MAX_NR_DISKS (65536 * 4096)
260 #define MAX_NR_IFACES 65536
261 #define MAX_NR_FANS 4096
262 #define MAX_NR_TEMP_SENSORS 4096
263 #define MAX_NR_IN_SENSORS 4096
264 #define MAX_NR_USB 65536
265 #define MAX_NR_FS (65536 * 4096)
266 #define MAX_NR_FCHOSTS 65536
268 /* NR_MAX is the upper limit used for unknown activities */
269 #define NR_MAX (65536 * 4096)
272 /* Maximum number of args that can be passed to sadc */
273 #define MAX_ARGV_NR 32
275 /* Miscellaneous constants */
277 #define USE_SA_FILE 1
278 #define NO_TM_START 0
285 #define ALL_ACTIVITIES ~0U
286 #define EXIT_IF_NOT_FOUND 1
287 #define RESUME_IF_NOT_FOUND 0
295 #define END_OF_DATA_UNEXPECTED 1
296 #define INCONSISTENT_INPUT_DATA 2
301 #define CLOSE_XML_MARKUP 0
302 #define OPEN_XML_MARKUP 1
304 #define CLOSE_JSON_MARKUP 0
305 #define OPEN_JSON_MARKUP 1
307 #define COUNT_ACTIVITIES 0
308 #define COUNT_OUTPUTS 1
310 /* Type for all functions reading statistics */
311 #define __read_funct_t void
312 /* Type for all functions displaying statistics */
313 #define __print_funct_t void
315 /* Structure for SVG specific parameters */
317 unsigned long long dt; /* Interval of time for current sample */
318 unsigned long long ust_time_ref; /* X axis start time in seconds since the epoch */
319 unsigned long long ust_time_end; /* X axis end time in seconds since the epoch */
320 unsigned long long ust_time_first; /* Time (in seconds since the epoch) for first sample */
321 int graph_no; /* Total number of views already displayed */
322 int restart; /* TRUE if we have just met a RESTART record */
323 int nr_act_dispd; /* Number of activities that will be displayed */
324 struct file_header *file_hdr; /* Pointer on file header structure */
327 /* Structure used when displaying SVG header */
328 struct svg_hdr_parm {
329 int graph_nr; /* Number of rows of views to display or canvas height entered on the command line */
330 int views_per_row; /* Maximum number of views on a single row */
331 int nr_act_dispd; /* Number of activities that will be displayed */
335 ***************************************************************************
336 * System activity data files
338 * The rule is: "strict writing, read any", meaning that sar/sadc can
339 * only append data to a datafile whose format is strictly the same as that
340 * of current version (checking FORMAT_MAGIC is not enough), but sar/sadf
341 * can read data from different versions, providing that FORMAT_MAGIC value
342 * has not changed (note that we are talking here of data read from a file,
343 * not data that sar reads from sadc, in which case the "strict" rule applies).
345 * Format of system activity data files:
348 * | file_magic structure
352 * | file_header structure
356 * | file_activity structure | * sa_act_nr
360 * | record_header structure |
366 * | Statistics structure(s) | * <count>
372 * | Statistics structure(s)... |
376 * Note: For activities with varying number of items, a __nr_t value, giving
377 * the number of items, arrives before the statistics structures so that
378 * we know how many of them have to be read.
379 * NB: This value exists for all the activities even if they share the same
380 * count function (e.g. A_NET_DEV and A_NET_EDEV). Indeed, statistics are not
381 * read atomically and the number of items (e.g. network interfaces) may have
384 * If the record header's type is R_COMMENT then we find only a comment
385 * following the record_header structure.
386 * If the record_header's type is R_RESTART then we find only the number of CPU
387 * (of type __nr_t) of the machine following the record_header structure.
388 ***************************************************************************
392 * Sysstat magic number. Should never be modified.
393 * Indicate that the file was created by sysstat.
395 #define SYSSTAT_MAGIC 0xd596
396 #define SYSSTAT_MAGIC_SWAPPED (((SYSSTAT_MAGIC << 8) | (SYSSTAT_MAGIC >> 8)) & 0xffff)
399 * Datafile format magic number.
400 * Modified to indicate that the format of the file is
401 * no longer compatible with that of previous sysstat versions.
403 #define FORMAT_MAGIC 0x2175
404 #define FORMAT_MAGIC_SWAPPED (((FORMAT_MAGIC << 8) | (FORMAT_MAGIC >> 8)) & 0xffff)
406 /* Previous datafile format magic numbers used by older sysstat versions */
407 #define FORMAT_MAGIC_2171 0x2171
408 #define FORMAT_MAGIC_2171_SWAPPED (((FORMAT_MAGIC_2171 << 8) | (FORMAT_MAGIC_2171 >> 8)) & 0xffff)
409 #define FORMAT_MAGIC_2173 0x2173
410 #define FORMAT_MAGIC_2173_SWAPPED (((FORMAT_MAGIC_2173 << 8) | (FORMAT_MAGIC_2173 >> 8)) & 0xffff)
412 /* Padding in file_magic structure. See below. */
413 #define FILE_MAGIC_PADDING 48
415 /* Structure for file magic header data */
418 * This field identifies the file as a file created by sysstat.
420 unsigned short sysstat_magic;
422 * The value of this field varies whenever datafile format changes.
424 unsigned short format_magic;
426 * Sysstat version used to create the file.
428 unsigned char sysstat_version;
429 unsigned char sysstat_patchlevel;
430 unsigned char sysstat_sublevel;
431 unsigned char sysstat_extraversion;
432 #define FILE_MAGIC_ULL_NR 0 /* Nr of unsigned long long below */
433 #define FILE_MAGIC_UL_NR 0 /* Nr of unsigned long below */
434 #define FILE_MAGIC_U_NR 5 /* Nr of [unsigned] int below */
436 * Size of file's header (size of file_header structure used by file).
438 unsigned int header_size;
440 * Set to non zero if data file has been converted with "sadf -c" from
441 * an old format (version x.y.z) to a newest format (version X.Y.Z).
442 * In this case, the value is: Y*256 + Z + 1.
443 * The FORMAT_MAGIC value of the file can be used to determine X.
445 unsigned int upgraded;
447 * Description of the file_header structure
448 * (nr of "long long", nr of "long" and nr of "int").
450 unsigned int hdr_types_nr[3];
452 * Padding. Reserved for future use while avoiding a format change.
453 * sysstat always reads a number of bytes which is that expected for
454 * current sysstat version (FILE_MAGIC_SIZE). We cannot guess if we
455 * are going to read a file from current, an older or a newer version.
457 unsigned char pad[FILE_MAGIC_PADDING];
460 #define FILE_MAGIC_SIZE (sizeof(struct file_magic))
462 /* Header structure for system activity data file */
465 * Timestamp in seconds since the epoch.
467 unsigned long long sa_ust_time;
469 * Number of jiffies per second.
471 unsigned long sa_hz __attribute__ ((aligned (8)));
473 * Number of [online or offline] CPU (1 .. CPU_NR + 1)
474 * when the datafile has been created.
475 * When reading a datafile, this value is updated (in memory)
476 * whenever a RESTART record is found.
477 * When writing or appending data to a file, this field is updated
478 * neither in file nor in memory.
480 unsigned int sa_cpu_nr __attribute__ ((aligned (8)));
482 * Number of activities saved in file.
484 unsigned int sa_act_nr;
490 * Description of the file_activity and record_header structures
491 * (nr of "long long", nr of "long" and nr of "int").
493 unsigned int act_types_nr[3];
494 unsigned int rec_types_nr[3];
496 * Size of file_activity and record_header structures used by file.
498 unsigned int act_size;
499 unsigned int rec_size;
501 * Current day and month.
502 * No need to save DST (Daylight Saving Time) flag, since it is not taken
503 * into account by the strftime() function used to print the timestamp.
505 unsigned char sa_day;
506 unsigned char sa_month;
508 * Size of a long integer. Useful to know the architecture on which
509 * the datafile was created.
513 * Operating system name.
515 char sa_sysname[UTSNAME_LEN];
519 char sa_nodename[UTSNAME_LEN];
521 * Operating system release number.
523 char sa_release[UTSNAME_LEN];
525 * Machine architecture.
527 char sa_machine[UTSNAME_LEN];
530 #define FILE_HEADER_SIZE (sizeof(struct file_header))
531 #define FILE_HEADER_ULL_NR 1 /* Nr of unsigned long long in file_header structure */
532 #define FILE_HEADER_UL_NR 1 /* Nr of unsigned long in file_header structure */
533 #define FILE_HEADER_U_NR 11 /* Nr of [unsigned] int in file_header structure */
534 /* The values below are used for sanity check */
535 #define MIN_FILE_HEADER_SIZE 0
536 #define MAX_FILE_HEADER_SIZE 8192
540 * Base magical number for activities.
542 #define ACTIVITY_MAGIC_BASE 0x8a
544 * Magical value used for activities with
545 * unknown format (used for sadf -H only).
547 #define ACTIVITY_MAGIC_UNKNOWN 0x89
549 /* List of activities saved in file */
550 struct file_activity {
552 * Identification value of activity.
556 * Activity magical number.
560 * Number of items for this activity
561 * when the data file has been created.
565 * Number of sub-items for this activity.
569 * Set to TRUE if statistics are preceded by
570 * a value giving the number of structures to read.
574 * Size of an item structure.
578 * Description of the structure containing statistics for the
579 * given activity (nr of "long long", nr of "long" and nr of "int").
581 unsigned int types_nr[3];
584 #define FILE_ACTIVITY_SIZE (sizeof(struct file_activity))
585 #define MAX_FILE_ACTIVITY_SIZE 1024 /* Used for sanity check */
586 #define FILE_ACTIVITY_ULL_NR 0 /* Nr of unsigned long long in file_activity structure */
587 #define FILE_ACTIVITY_UL_NR 0 /* Nr of unsigned long in file_activity structure */
588 #define FILE_ACTIVITY_U_NR 9 /* Nr of [unsigned] int in file_activity structure */
593 * R_STATS means that this is a record of statistics.
597 * R_RESTART means that this is a special record containing
598 * a LINUX RESTART message.
602 * R_LAST_STATS warns sar that this is the last record to be written
603 * to file before a file rotation, and that the next data to come will
605 * Such a record is tagged R_STATS anyway before being written to file.
607 #define R_LAST_STATS 3
609 * R_COMMENT means that this is a special record containing
614 /* Maximum length of a comment */
615 #define MAX_COMMENT_LEN 64
617 /* Header structure for every record */
618 struct record_header {
620 * Machine uptime in 1/100th of a second.
622 unsigned long long uptime_cs;
624 * Timestamp (number of seconds since the epoch).
626 unsigned long long ust_time;
628 * Record type: R_STATS, R_RESTART,...
630 unsigned char record_type;
632 * Timestamp: Hour (0-23), minute (0-59) and second (0-59).
633 * Used to determine TRUE time (immutable, non locale dependent time).
636 unsigned char minute;
637 unsigned char second;
640 #define RECORD_HEADER_SIZE (sizeof(struct record_header))
641 #define MAX_RECORD_HEADER_SIZE 512 /* Used for sanity check */
642 #define RECORD_HEADER_ULL_NR 2 /* Nr of unsigned long long in record_header structure */
643 #define RECORD_HEADER_UL_NR 0 /* Nr of unsigned long in record_header structure */
644 #define RECORD_HEADER_U_NR 0 /* Nr of unsigned int in record_header structure */
648 ***************************************************************************
649 * Generic description of an activity.
650 ***************************************************************************
653 /* Activity options */
656 * Indicate that corresponding activity should be collected by sadc.
658 #define AO_COLLECTED 0x01
660 * Indicate that corresponding activity should be displayed by sar.
662 #define AO_SELECTED 0x02
664 * Indicate that corresponding activity has items that need to be counted.
665 * This means that its @f_count_index values is >= 0.
666 * (We use AO_COUNTED instead of @f_count_index because @f_count_index
667 * is available (initialized) only for sadc).
669 #define AO_COUNTED 0x04
671 * Indicate that activity's metrics have persistent values when devices
672 * are registered again (this means that when the device is registered again,
673 * the metrics pick the values they had when they had been unregistered).
674 * Exclusively used for CPU related statistics at the present time.
676 #define AO_PERSISTENT 0x08
678 * This flag should be set for every activity closing a markup used
679 * by several activities. Used by sadf f_xml_print() functions to
680 * display XML output.
682 #define AO_CLOSE_MARKUP 0x10
684 * Indicate that corresponding activity has multiple different
685 * output formats. This is the case for example for memory activity
686 * with options -r and -R.
687 * PS: Such an activity should appear in the list of activities that
688 * sar -A is supposed to display.
690 #define AO_MULTIPLE_OUTPUTS 0x20
692 * Indicate that one (SVG) graph will be displayed for each
693 * distinct item for this activity (sadf -g).
695 #define AO_GRAPH_PER_ITEM 0x40
697 * Indicate that this activity may have sub-items.
699 #define AO_MATRIX 0x80
701 * Indicate that a list of devices has been entered on the command
702 * line for this activity (see options --dev=, --iface=, ...)
704 #define AO_LIST_ON_CMDLINE 0x100
706 #define IS_COLLECTED(m) (((m) & AO_COLLECTED) == AO_COLLECTED)
707 #define IS_SELECTED(m) (((m) & AO_SELECTED) == AO_SELECTED)
708 #define HAS_COUNT_FUNCTION(m) (((m) & AO_COUNTED) == AO_COUNTED)
709 #define HAS_PERSISTENT_VALUES(m) (((m) & AO_PERSISTENT) == AO_PERSISTENT)
710 #define CLOSE_MARKUP(m) (((m) & AO_CLOSE_MARKUP) == AO_CLOSE_MARKUP)
711 #define HAS_MULTIPLE_OUTPUTS(m) (((m) & AO_MULTIPLE_OUTPUTS) == AO_MULTIPLE_OUTPUTS)
712 #define ONE_GRAPH_PER_ITEM(m) (((m) & AO_GRAPH_PER_ITEM) == AO_GRAPH_PER_ITEM)
713 #define IS_MATRIX(m) (((m) & AO_MATRIX) == AO_MATRIX)
714 #define HAS_LIST_ON_CMDLINE(m) (((m) & AO_LIST_ON_CMDLINE) == AO_LIST_ON_CMDLINE)
719 /* Structure used to define a bitmap needed by an activity */
722 * Bitmap for activities that need one. Remember to allocate it
725 unsigned char *b_array;
727 * Size of the bitmap in bits. In fact, bitmap is sized to b_size + 1
728 * to take into account CPU "all"
734 * Structure used to define an activity.
735 * Note: This structure can be modified without changing the format of data files.
739 * This variable contains the identification value (A_...) for this activity.
743 * Activity options (AO_...)
745 unsigned int options;
747 * Activity magical number. This number changes when activity format in file
748 * is no longer compatible with the format of that same activity from
753 * An activity belongs to a group (and only one).
754 * Groups are those selected with option -S of sadc.
758 * Index in f_count[] array to determine function used to count
759 * the number of items (serial lines, network interfaces, etc.) -> @nr
760 * Such a function should _always_ return a value greater than
763 * A value of -1 indicates that the number of items
764 * is a constant (and @nr is set to this value).
766 * These functions are called even if corresponding activities have not
767 * been selected, to make sure that all items have been calculated
768 * (including #CPU, etc.)
772 * The f_count2() function is used to count the number of
774 * Such a function should _always_ return a value greater than
777 * A NULL value for this function pointer indicates that the number of items
778 * is a constant (and @nr2 is set to this value).
780 __nr_t (*f_count2) (struct activity *);
782 * This function reads the relevant file and fill the buffer
783 * with statistics corresponding to given activity.
785 __read_funct_t (*f_read) (struct activity *);
787 * This function displays activity statistics onto the screen.
789 __print_funct_t (*f_print) (struct activity *, int, int, unsigned long long);
791 * This function displays average activity statistics onto the screen.
793 __print_funct_t (*f_print_avg) (struct activity *, int, int, unsigned long long);
795 * This function is used by sadf to display activity in a format that can
796 * easily be ingested by a relational database, or a format that can be
797 * handled by pattern processing commands like "awk".
799 __print_funct_t (*f_render) (struct activity *, int, char *, int, unsigned long long);
801 * This function is used by sadf to display activity statistics in XML.
803 __print_funct_t (*f_xml_print) (struct activity *, int, int, unsigned long long);
805 * This function is used by sadf to display activity statistics in JSON.
807 __print_funct_t (*f_json_print) (struct activity *, int, int, unsigned long long);
809 * This function is used by sadf to display activity statistics in SVG.
811 __print_funct_t (*f_svg_print) (struct activity *, int, int, struct svg_parm *,
812 unsigned long long, struct record_header *);
814 * This function is used by sadf to display activity statistics in raw format.
816 __print_funct_t (*f_raw_print) (struct activity *, char *, int);
818 * This function is used by sadf to count the number of new items in current
819 * sample and add them to the linked list @item_list.
821 __nr_t (*f_count_new) (struct activity *, int);
823 * Linked list containing item names. This is either all the different items
824 * found in a file for activities that have a @f_count_function() (used by sadf),
825 * or a list entered on the command line (used by sadf and sar).
827 struct sa_item *item_list;
829 * Number of different items found in file (calculated by sadf).
830 * This is also the number of items in @item_list if this list exists.
834 * Header string displayed by sadf -d.
835 * Header lines for each output (for activities with multiple outputs) are
836 * separated with a '|' character.
837 * For a given output, the first field corresponding to extended statistics
838 * (eg. -r ALL) begins with a '&' character.
842 * Description of activity.
850 * Description of the corresponding structure containing statistics (as defined
851 * in rd_stats.h or rd_sensors.h). Such a structure has 0+ fields of type
852 * "long long", followed by 0+ fields of type "long", followed by 0+ fields of
853 * type "int", followed by 0+ other fields (e.g. of type char). The array below
854 * gives the number of "long long" fields composing the structure, then the number
855 * of "long" fields, then the number of "int" fields.
857 unsigned int gtypes_nr[3];
859 * This array has the same meaning as @gtypes_nr[] above, but the values are those
860 * read from current data file. They may be different from those of @gtypes_nr[]
861 * because we can read data from a different sysstat version (older or newer).
863 unsigned int ftypes_nr[3];
865 * Number of SVG graphs for this activity. The total number of graphs for
866 * the activity can be greater though if flag AO_GRAPH_PER_ITEM is set, in
867 * which case the total number will be @g_nr * @nr.
871 * Number of items on the system, as counted when the system is initialized.
872 * A negative value (-1) is the default value and indicates that this number
873 * has still not been calculated by the f_count() function.
874 * A value of 0 means that this number has been calculated, but no items have
876 * A positive value (>0) has either been calculated or is a constant.
880 * Number of sub-items on the system.
881 * @nr2 is in fact the second dimension of a matrix of items, the first
882 * one being @nr. @nr is the number of lines, and @nr2 the number of columns.
883 * A negative value (-1) is the default value and indicates that this number
884 * has still not been calculated by the f_count2() function.
885 * A value of 0 means that this number has been calculated, but no sub-items have
887 * A positive value (>0) has either been calculated or is a constant.
889 * 1) IF @nr2 = 0 THEN @nr = 0
890 * Note: If @nr = 0, then @nr2 is undetermined (may be -1, 0 or >0).
891 * 2) IF @nr > 0 THEN @nr2 > 0.
892 * Note: If @nr2 > 0 then @nr is undetermined (may be -1, 0 or >0).
893 * 3) IF @nr <= 0 THEN @nr2 = -1 (this is the default value for @nr2,
894 * meaning that it has not been calculated).
898 * Maximum number of elements that sar can handle for this item.
899 * NB: The maximum number of elements that sar can handle for sub-items
904 * Number of items, as read and saved in corresponding buffer (@buf: See below).
905 * The value may be zero for a particular sample if no items have been found.
909 * Number of structures allocated in @buf[*]. This number should be greater
910 * than or equal to @nr[*].
915 * This is the size of the corresponding structure, as read from or written
916 * to a file, or read from or written by the data collector.
921 * This is the size of the corresponding structure as mapped into memory.
922 * @msize can be different from @fsize when data are read from or written to
923 * a data file from a different sysstat version.
927 * Optional flags for activity. This is eg. used when AO_MULTIPLE_OUTPUTS
929 * 0x0001 - 0x0080 : Multiple outputs (eg. AO_F_MEMORY, AO_F_SWAP...)
930 * 0x0100 - 0x8000 : If bit set then display complete header (hdr_line) for
931 * corresponding output
932 * 0x010000+ : Optional flags
934 unsigned int opt_flags;
936 * Buffers that will contain the statistics read. Its size is @nr * @nr2 * @size each.
938 * [0] and [1]: current/previous statistics values (used by sar).
939 * [2]: Used by sar to save first collected stats (used later to
944 * Bitmap for activities that need one. Such a bitmap is needed by activity
945 * if @bitmap is not NULL.
947 struct act_bitmap *bitmap;
952 ***************************************************************************
953 * Generic description of an output format for sadf (and sar).
954 ***************************************************************************
957 /* Type for all functions used by sadf to display stats in various formats */
958 #define __printf_funct_t void
959 #define __tm_funct_t char *
962 * Structure used to define a report.
963 * A XML-like report has the following format:
969 * | | Statistics block
972 * | | | Timestamp block
975 * | | | | Activity #1
981 * | | | | Activity #n
986 * | | Restart messages block
993 struct report_format {
995 * This variable contains the identification value (F_...) for this report format.
999 * Format options (FO_...).
1001 unsigned int options;
1003 * This function displays the report header
1004 * (data displayed once at the beginning of the report).
1006 __printf_funct_t (*f_header) (void *, int, char *, struct file_magic *, struct file_header *,
1007 struct activity * [], unsigned int [], struct file_activity *);
1009 * This function defines the statistics part of the report.
1010 * Used only with textual (XML-like) reports.
1012 __printf_funct_t (*f_statistics) (int *, int);
1014 * This function defines the timestamp part of the report.
1015 * Used only with textual (XML-like) reports.
1017 __tm_funct_t (*f_timestamp) (void *, int, char *, char *, unsigned long long,
1018 struct file_header *, unsigned int);
1020 * This function displays the restart messages.
1022 __printf_funct_t (*f_restart) (int *, int, char *, char *, int, struct file_header *);
1024 * This function displays the comments.
1026 __printf_funct_t (*f_comment) (int *, int, char *, char *, int, char *, struct file_header *);
1029 /* Possible actions for functions used to display reports */
1030 #define F_BEGIN 0x01
1035 ***************************************************************************
1036 * SVG output definitions
1037 ***************************************************************************
1042 * 1 | General header
1045 * 9 | One line from table of contents (if any)
1048 * | | 4 | Graph title
1058 * | | v |-------------------------------
1060 * | v <---><------------------------------>
1063 * v<---------------------------------------------------------------> Gap
1065 * <--------------------------------------------------------------------->
1070 #define SVG_G_XSIZE 720
1072 #define SVG_M_XSIZE 70
1074 #define SVG_V_XSIZE 1050
1076 #define SVG_T_XSIZE 1060
1079 #define SVG_G_YSIZE 200
1081 #define SVG_H_YSIZE 60
1083 #define SVG_M_YSIZE 50
1085 #define SVG_T_YSIZE 310
1087 #define SVG_V_YSIZE 300
1089 #define SVG_C_YSIZE 20
1091 /* Grid: Nr of horizontal lines */
1092 #define SVG_H_GRIDNR 3
1093 /* Grid: Nr of vertical lines */
1094 #define SVG_V_GRIDNR 10
1096 /* Block size used to allocate arrays for graphs data */
1097 #define CHUNKSIZE 4096
1099 /* Maximum number of views on a single row */
1100 #define MAX_VIEWS_ON_A_ROW 6
1102 #define SVG_LINE_GRAPH 1
1103 #define SVG_BAR_GRAPH 2
1105 /* Maximum number of horizontal lines for the background grid */
1106 #define MAX_HLINES_NR 10
1108 /* Color palette constants */
1109 #define SVG_COLORS_IDX_MASK 0x0f
1110 #define SVG_COL_PALETTE_SIZE 24
1111 #define SVG_COL_PALETTE_NR 3
1112 #define SVG_COL_BCKGRD_IDX 16
1113 #define SVG_COL_AXIS_IDX 17
1114 #define SVG_COL_GRID_IDX 18
1115 #define SVG_COL_TITLE_IDX 19
1116 #define SVG_COL_INFO_IDX 20
1117 #define SVG_COL_DEFAULT_IDX 21
1118 #define SVG_COL_HEADER_IDX 22
1119 #define SVG_COL_ERROR_IDX 23
1121 #define SVG_DEFAULT_COL_PALETTE 0
1122 #define SVG_CUSTOM_COL_PALETTE 1
1123 #define SVG_BW_COL_PALETTE 2
1128 ***************************************************************************
1129 * Macro functions definitions.
1131 * Note: Using 'do ... while' makes the macros safer to use
1132 * (remember that macro use is followed by a semicolon).
1133 ***************************************************************************
1136 /* Close file descriptors */
1137 #define CLOSE_ALL(_fd_) do { \
1142 #define CLOSE(_fd_) if (_fd_ >= 0) \
1147 ***************************************************************************
1148 * Various structure definitions.
1149 ***************************************************************************
1152 /* Structure for timestamps */
1160 /* Structure for items in list */
1163 struct sa_item *next;
1168 ***************************************************************************
1169 * Functions prototypes.
1170 ***************************************************************************
1174 * Prototypes used to count new items
1176 __nr_t count_new_net_dev
1177 (struct activity *, int);
1178 __nr_t count_new_net_edev
1179 (struct activity *, int);
1180 __nr_t count_new_filesystem
1181 (struct activity *, int);
1182 __nr_t count_new_fchost
1183 (struct activity *, int);
1184 __nr_t count_new_disk
1185 (struct activity *, int);
1187 /* Functions used to count number of items */
1188 __nr_t wrap_get_cpu_nr
1189 (struct activity *);
1190 __nr_t wrap_get_irq_nr
1191 (struct activity *);
1192 __nr_t wrap_get_serial_nr
1193 (struct activity *);
1194 __nr_t wrap_get_disk_nr
1195 (struct activity *);
1196 __nr_t wrap_get_iface_nr
1197 (struct activity *);
1198 __nr_t wrap_get_fan_nr
1199 (struct activity *);
1200 __nr_t wrap_get_temp_nr
1201 (struct activity *);
1202 __nr_t wrap_get_in_nr
1203 (struct activity *);
1204 __nr_t wrap_get_freq_nr
1205 (struct activity *);
1206 __nr_t wrap_get_usb_nr
1207 (struct activity *);
1208 __nr_t wrap_get_filesystem_nr
1209 (struct activity *);
1210 __nr_t wrap_get_fchost_nr
1211 (struct activity *);
1213 /* Functions used to read activities statistics */
1214 __read_funct_t wrap_read_stat_cpu
1215 (struct activity *);
1216 __read_funct_t wrap_read_stat_pcsw
1217 (struct activity *);
1218 __read_funct_t wrap_read_stat_irq
1219 (struct activity *);
1220 __read_funct_t wrap_read_swap
1221 (struct activity *);
1222 __read_funct_t wrap_read_paging
1223 (struct activity *);
1224 __read_funct_t wrap_read_io
1225 (struct activity *);
1226 __read_funct_t wrap_read_meminfo
1227 (struct activity *);
1228 __read_funct_t wrap_read_kernel_tables
1229 (struct activity *);
1230 __read_funct_t wrap_read_loadavg
1231 (struct activity *);
1232 __read_funct_t wrap_read_tty_driver_serial
1233 (struct activity *);
1234 __read_funct_t wrap_read_disk
1235 (struct activity *);
1236 __read_funct_t wrap_read_net_dev
1237 (struct activity *);
1238 __read_funct_t wrap_read_net_edev
1239 (struct activity *);
1240 __read_funct_t wrap_read_net_nfs
1241 (struct activity *);
1242 __read_funct_t wrap_read_net_nfsd
1243 (struct activity *);
1244 __read_funct_t wrap_read_net_sock
1245 (struct activity *);
1246 __read_funct_t wrap_read_net_ip
1247 (struct activity *);
1248 __read_funct_t wrap_read_net_eip
1249 (struct activity *);
1250 __read_funct_t wrap_read_net_icmp
1251 (struct activity *);
1252 __read_funct_t wrap_read_net_eicmp
1253 (struct activity *);
1254 __read_funct_t wrap_read_net_tcp
1255 (struct activity *);
1256 __read_funct_t wrap_read_net_etcp
1257 (struct activity *);
1258 __read_funct_t wrap_read_net_udp
1259 (struct activity *);
1260 __read_funct_t wrap_read_net_sock6
1261 (struct activity *);
1262 __read_funct_t wrap_read_net_ip6
1263 (struct activity *);
1264 __read_funct_t wrap_read_net_eip6
1265 (struct activity *);
1266 __read_funct_t wrap_read_net_icmp6
1267 (struct activity *);
1268 __read_funct_t wrap_read_net_eicmp6
1269 (struct activity *);
1270 __read_funct_t wrap_read_net_udp6
1271 (struct activity *);
1272 __read_funct_t wrap_read_cpuinfo
1273 (struct activity *);
1274 __read_funct_t wrap_read_fan
1275 (struct activity *);
1276 __read_funct_t wrap_read_temp
1277 (struct activity *);
1278 __read_funct_t wrap_read_in
1279 (struct activity *);
1280 __read_funct_t wrap_read_meminfo_huge
1281 (struct activity *);
1282 __read_funct_t wrap_read_cpu_wghfreq
1283 (struct activity *);
1284 __read_funct_t wrap_read_bus_usb_dev
1285 (struct activity *);
1286 __read_funct_t wrap_read_filesystem
1287 (struct activity *);
1288 __read_funct_t wrap_read_fchost
1289 (struct activity *);
1290 __read_funct_t wrap_read_softnet
1291 (struct activity *);
1293 /* Other functions */
1294 int check_alt_sa_dir
1296 void enum_version_nr
1297 (struct file_magic *);
1299 (struct activity * [], unsigned int, int);
1300 int get_activity_position
1301 (struct activity * [], unsigned int, int);
1302 void handle_invalid_sa_file
1303 (int, struct file_magic *, char *, int);
1304 void print_collect_error
1306 int set_default_file
1309 (int, const void *, int);
1313 (struct sa_item **, char *, int);
1314 void allocate_bitmaps
1315 (struct activity * []);
1316 void allocate_structures
1317 (struct activity * []);
1319 (struct activity *, int, int, int);
1320 void check_file_actlst
1321 (int *, char *, struct activity * [], struct file_magic *, struct file_header *,
1322 struct file_activity **, unsigned int [], int, int *, int *);
1323 int check_net_dev_reg
1324 (struct activity *, int, int, int);
1325 int check_net_edev_reg
1326 (struct activity *, int, int, int);
1327 double compute_ifutil
1328 (struct stats_net_dev *, double, double);
1329 void copy_structures
1330 (struct activity * [], unsigned int [], struct record_header [], int, int);
1332 (struct tm *, struct tstamp *);
1333 void display_sa_file_version
1334 (FILE *, struct file_magic *);
1336 (struct activity * []);
1337 void free_structures
1338 (struct activity * []);
1340 (unsigned int, unsigned int, int);
1341 char *get_sa_devname
1342 (unsigned int, unsigned int, unsigned int);
1343 void get_file_timestamp_struct
1344 (unsigned int, struct tm *, struct file_header *);
1345 unsigned long long get_global_cpu_statistics
1346 (struct activity *, int, int, unsigned int, unsigned char []);
1347 void get_global_soft_statistics
1348 (struct activity *, int, int, unsigned int, unsigned char []);
1350 (struct record_header *, struct record_header *, unsigned long long *);
1351 void init_custom_color_palette
1354 (unsigned long long, unsigned long long, int, long);
1355 void parse_sa_devices
1356 (char *, struct activity *, int, int *, int);
1358 (char * [], int *, struct activity * [], unsigned int *, int);
1360 (char * [], int *, struct activity * []);
1362 (char * [], int *, unsigned int *, struct activity * []);
1364 (char * [], int *, struct activity * []);
1366 (char * [], int *, struct activity * []);
1368 (char * [], int *, struct tstamp *, const char *);
1369 void print_report_hdr
1370 (unsigned int, struct tm *, struct file_header *);
1371 void print_sar_comment
1372 (int *, int, char *, char *, int, char *, struct file_header *);
1373 __printf_funct_t print_sar_restart
1374 (int *, int, char *, char *, int, struct file_header *);
1375 int print_special_record
1376 (struct record_header *, unsigned int, struct tstamp *, struct tstamp *,
1377 int, int, struct tm *, struct tm *, char *, int, struct file_magic *,
1378 struct file_header *, struct activity * [], struct report_format *, int, int);
1379 int read_file_stat_bunch
1380 (struct activity * [], int, int, int, struct file_activity *, int, int,
1381 char *, struct file_magic *, int);
1382 __nr_t read_nr_value
1383 (int, char *, struct file_magic *, int, int, int);
1385 (int, void *, struct record_header *, struct file_header *, int, int,
1387 void reallocate_all_buffers
1388 (struct activity *, __nr_t);
1389 void replace_nonprintable_char
1392 (int, void *, size_t, int, int);
1393 int sa_get_record_timestamp_struct
1394 (unsigned int, struct record_header *, struct tm *, struct tm *);
1395 int sa_open_read_magic
1396 (int *, char *, struct file_magic *, int, int *, int);
1397 int search_list_item
1398 (struct sa_item *, char *);
1399 void select_all_activities
1400 (struct activity * []);
1401 void select_default_activity
1402 (struct activity * []);
1404 (unsigned char [], unsigned char, unsigned int);
1405 void set_hdr_rectime
1406 (unsigned int, struct tm *, struct file_header *);
1407 void set_record_timestamp_string
1408 (unsigned int, struct record_header *, char *, char *, int, struct tm *);
1410 (unsigned int [], void *, int);
1411 #endif /* SOURCE_SADC undefined */