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
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
110 #define S_F_HUMAN_READ 0x01000000
112 #define WANT_SINCE_BOOT(m) (((m) & S_F_SINCE_BOOT) == S_F_SINCE_BOOT)
113 #define WANT_SA_ROTAT(m) (((m) & S_F_SA_ROTAT) == S_F_SA_ROTAT)
114 #define USE_PRETTY_OPTION(m) (((m) & S_F_DEV_PRETTY) == S_F_DEV_PRETTY)
115 #define FORCE_FILE(m) (((m) & S_F_FORCE_FILE) == S_F_FORCE_FILE)
116 #define INTERVAL_SET(m) (((m) & S_F_INTERVAL_SET) == S_F_INTERVAL_SET)
117 #define PRINT_TRUE_TIME(m) (((m) & S_F_TRUE_TIME) == S_F_TRUE_TIME)
118 #define LOCK_FILE(m) (((m) & S_F_LOCK_FILE) == S_F_LOCK_FILE)
119 #define PRINT_SEC_EPOCH(m) (((m) & S_F_SEC_EPOCH) == S_F_SEC_EPOCH)
120 #define DISPLAY_HDR_ONLY(m) (((m) & S_F_HDR_ONLY) == S_F_HDR_ONLY)
121 #define FILE_LOCKED(m) (((m) & S_F_FILE_LOCKED) == S_F_FILE_LOCKED)
122 #define USE_SA_YYYYMMDD(m) (((m) & S_F_SA_YYYYMMDD) == S_F_SA_YYYYMMDD)
123 #define DISPLAY_HORIZONTALLY(m) (((m) & S_F_HORIZONTALLY) == S_F_HORIZONTALLY)
124 #define DISPLAY_COMMENT(m) (((m) & S_F_COMMENT) == S_F_COMMENT)
125 #define DISPLAY_PERSIST_NAME_S(m) (((m) & S_F_PERSIST_NAME) == S_F_PERSIST_NAME)
126 #define PRINT_LOCAL_TIME(m) (((m) & S_F_LOCAL_TIME) == S_F_LOCAL_TIME)
127 #define USE_PREFD_TIME_OUTPUT(m) (((m) & S_F_PREFD_TIME_OUTPUT) == S_F_PREFD_TIME_OUTPUT)
128 #define SKIP_EMPTY_VIEWS(m) (((m) & S_F_SVG_SKIP) == S_F_SVG_SKIP)
129 #define DISPLAY_HINTS(m) (((m) & S_F_RAW_SHOW_HINTS) == S_F_RAW_SHOW_HINTS)
130 #define AUTOSCALE_ON(m) (((m) & S_F_SVG_AUTOSCALE) == S_F_SVG_AUTOSCALE)
131 #define DISPLAY_ONE_DAY(m) (((m) & S_F_SVG_ONE_DAY) == S_F_SVG_ONE_DAY)
132 #define DISPLAY_IDLE(m) (((m) & S_F_SVG_SHOW_IDLE) == S_F_SVG_SHOW_IDLE)
133 #define DISPLAY_INFO(m) (((m) & S_F_SVG_SHOW_INFO) == S_F_SVG_SHOW_INFO)
134 #define DISPLAY_UNIT(m) (((m) & S_F_UNIT) == S_F_UNIT)
135 #define SET_CANVAS_HEIGHT(m) (((m) & S_F_SVG_HEIGHT) == S_F_SVG_HEIGHT)
136 #define PACK_VIEWS(m) (((m) & S_F_SVG_PACKED) == S_F_SVG_PACKED)
137 #define DISPLAY_HUMAN_READ(m) (((m) & S_F_HUMAN_READ) == S_F_HUMAN_READ)
139 #define AO_F_NULL 0x00000000
141 /* Output flags for options -r / -S */
142 #define AO_F_MEMORY 0x00000001
143 #define AO_F_SWAP 0x00000002
144 /* AO_F_MEM_ALL: See opt_flags in struct activity below */
145 #define AO_F_MEM_ALL (AO_F_MEMORY << 8)
147 #define DISPLAY_MEMORY(m) (((m) & AO_F_MEMORY) == AO_F_MEMORY)
148 #define DISPLAY_SWAP(m) (((m) & AO_F_SWAP) == AO_F_SWAP)
149 #define DISPLAY_MEM_ALL(m) (((m) & AO_F_MEM_ALL) == AO_F_MEM_ALL)
151 /* Output flags for option -u [ ALL ] */
152 #define AO_F_CPU_DEF 0x00000001
153 #define AO_F_CPU_ALL 0x00000002
155 #define DISPLAY_CPU_DEF(m) (((m) & AO_F_CPU_DEF) == AO_F_CPU_DEF)
156 #define DISPLAY_CPU_ALL(m) (((m) & AO_F_CPU_ALL) == AO_F_CPU_ALL)
158 /* Output flags for option -d */
159 #define AO_F_DISK_PART 0x00000001
161 #define COLLECT_PARTITIONS(m) (((m) & AO_F_DISK_PART) == AO_F_DISK_PART)
163 /* Output flags for option -F */
164 #define AO_F_FILESYSTEM 0x00000001
165 #define AO_F_MOUNT 0x00000002
167 #define DISPLAY_MOUNT(m) (((m) & AO_F_MOUNT) == AO_F_MOUNT)
170 ***************************************************************************
171 * Various keywords and constants.
172 ***************************************************************************
176 #define K_XALL "XALL"
179 #define K_EDEV "EDEV"
181 #define K_NFSD "NFSD"
182 #define K_SOCK "SOCK"
185 #define K_ICMP "ICMP"
186 #define K_EICMP "EICMP"
188 #define K_ETCP "ETCP"
190 #define K_SOCK6 "SOCK6"
192 #define K_EIP6 "EIP6"
193 #define K_ICMP6 "ICMP6"
194 #define K_EICMP6 "EICMP6"
195 #define K_UDP6 "UDP6"
198 #define K_TEMP "TEMP"
200 #define K_FREQ "FREQ"
201 #define K_MOUNT "MOUNT"
203 #define K_SOFT "SOFT"
206 #define K_DISK "DISK"
207 #define K_XDISK "XDISK"
208 #define K_SNMP "SNMP"
209 #define K_IPV6 "IPV6"
210 #define K_POWER "POWER"
213 #define K_SKIP_EMPTY "skipempty"
214 #define K_AUTOSCALE "autoscale"
215 #define K_ONEDAY "oneday"
216 #define K_SHOWIDLE "showidle"
217 #define K_SHOWINFO "showinfo"
218 #define K_SHOWHINTS "showhints"
219 #define K_HEIGHT "height="
220 #define K_PACKED "packed"
222 /* Groups of activities */
223 #define G_DEFAULT 0x00
234 /* Time must have the format HH:MM:SS with HH in 24-hour format */
235 #define DEF_TMSTART "08:00:00"
236 #define DEF_TMEND "18:00:00"
238 #define UTSNAME_LEN 65
239 #define HEADER_LINE_LEN 512
242 * Define upper limit for various items.
243 * Made necessary because we have to check the number of
244 * items for each activity when we read a (possibly tainted)
247 #define MAX_NR_SERIAL_LINES 65536
248 #define MAX_NR_DISKS (65536 * 4096)
249 #define MAX_NR_IFACES 65536
250 #define MAX_NR_FANS 4096
251 #define MAX_NR_TEMP_SENSORS 4096
252 #define MAX_NR_IN_SENSORS 4096
253 #define MAX_NR_USB 65536
254 #define MAX_NR_FS (65536 * 4096)
255 #define MAX_NR_FCHOSTS 65536
257 /* NR_MAX is the upper limit used for unknown activities */
258 #define NR_MAX (65536 * 4096)
261 /* Maximum number of args that can be passed to sadc */
262 #define MAX_ARGV_NR 32
264 /* Miscellaneous constants */
266 #define USE_SA_FILE 1
267 #define NO_TM_START 0
274 #define ALL_ACTIVITIES ~0U
275 #define EXIT_IF_NOT_FOUND 1
276 #define RESUME_IF_NOT_FOUND 0
284 #define END_OF_DATA_UNEXPECTED 1
285 #define INCONSISTENT_INPUT_DATA 2
287 #define CLOSE_XML_MARKUP 0
288 #define OPEN_XML_MARKUP 1
290 #define CLOSE_JSON_MARKUP 0
291 #define OPEN_JSON_MARKUP 1
293 #define COUNT_ACTIVITIES 0
294 #define COUNT_OUTPUTS 1
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 __nr_t nr_max; /* Maximum number of items for this activity */
310 struct file_header *file_hdr; /* Pointer on file header structure */
313 /* Structure used when displaying SVG header */
314 struct svg_hdr_parm {
315 int graph_nr; /* Number of rows of views to display or canvas height entered on the command line */
316 int views_per_row; /* Maximum number of views on a single row */
320 ***************************************************************************
321 * System activity data files
323 * The rule is: "strict writing, read any", meaning that sar/sadc can
324 * only append data to a datafile whose format is strictly the same as that
325 * of current version (checking FORMAT_MAGIC is not enough), but sar/sadf
326 * can read data from different versions, providing that FORMAT_MAGIC value
327 * has not changed (note that we are talking here of data read from a file,
328 * not data that sar reads from sadc, in which case the "strict" rule applies).
330 * Format of system activity data files:
333 * | file_magic structure
337 * | file_header structure
341 * | file_activity structure | * sa_act_nr
345 * | record_header structure |
351 * | Statistics structure(s) | * <count>
357 * | Statistics structure(s)... |
361 * Note: For activities with varying number of items, a __nr_t value, giving
362 * the number of items, arrives before the statistics structures so that
363 * we know how many of them have to be read.
364 * NB: This value exists for all the activities even if they share the same
365 * count function (e.g. A_NET_DEV and A_NET_EDEV). Indeed, statistics are not
366 * read atomically and the number of items (e.g. network interfaces) may have
369 * If the record header's type is R_COMMENT then we find only a comment
370 * following the record_header structure.
371 * If the record_header's type is R_RESTART then we find only the number of CPU
372 * (of type __nr_t) of the machine following the record_header structure.
373 ***************************************************************************
377 * Sysstat magic number. Should never be modified.
378 * Indicate that the file was created by sysstat.
380 #define SYSSTAT_MAGIC 0xd596
381 #define SYSSTAT_MAGIC_SWAPPED (((SYSSTAT_MAGIC << 8) | (SYSSTAT_MAGIC >> 8)) & 0xffff)
384 * Datafile format magic number.
385 * Modified to indicate that the format of the file is
386 * no longer compatible with that of previous sysstat versions.
388 #define FORMAT_MAGIC 0x2175
389 #define FORMAT_MAGIC_SWAPPED (((FORMAT_MAGIC << 8) | (FORMAT_MAGIC >> 8)) & 0xffff)
391 /* Previous datafile format magic number used by older sysstat versions */
392 #define PREVIOUS_FORMAT_MAGIC 0x2173
394 /* Padding in file_magic structure. See below. */
395 #define FILE_MAGIC_PADDING 48
397 /* Structure for file magic header data */
400 * This field identifies the file as a file created by sysstat.
402 unsigned short sysstat_magic;
404 * The value of this field varies whenever datafile format changes.
406 unsigned short format_magic;
408 * Sysstat version used to create the file.
410 unsigned char sysstat_version;
411 unsigned char sysstat_patchlevel;
412 unsigned char sysstat_sublevel;
413 unsigned char sysstat_extraversion;
414 #define FILE_MAGIC_ULL_NR 0 /* Nr of unsigned long long below */
415 #define FILE_MAGIC_UL_NR 0 /* Nr of unsigned long below */
416 #define FILE_MAGIC_U_NR 5 /* Nr of [unsigned] int below */
418 * Size of file's header (size of file_header structure used by file).
420 unsigned int header_size;
422 * Set to non zero if data file has been converted with "sadf -c" from
423 * an old format (version x.y.z) to a newest format (version X.Y.Z).
424 * In this case, the value is: Y*256 + Z + 1.
425 * The FORMAT_MAGIC value of the file can be used to determine X.
427 unsigned int upgraded;
429 * Description of the file_header structure
430 * (nr of "long long", nr of "long" and nr of "int").
432 unsigned int hdr_types_nr[3];
434 * Padding. Reserved for future use while avoiding a format change.
435 * sysstat always reads a number of bytes which is that expected for
436 * current sysstat version (FILE_MAGIC_SIZE). We cannot guess if we
437 * are going to read a file from current, an older or a newer version.
439 unsigned char pad[FILE_MAGIC_PADDING];
442 #define FILE_MAGIC_SIZE (sizeof(struct file_magic))
444 /* Header structure for system activity data file */
447 * Timestamp in seconds since the epoch.
449 unsigned long long sa_ust_time;
451 * Number of jiffies per second.
453 unsigned long sa_hz __attribute__ ((aligned (8)));
455 * Number of [online or offline] CPU (1 .. CPU_NR + 1)
456 * when the datafile has been created.
457 * When reading a datafile, this value is updated (in memory)
458 * whenever a RESTART record is found.
459 * When writing or appending data to a file, this field is updated
460 * neither in file nor in memory.
462 unsigned int sa_cpu_nr __attribute__ ((aligned (8)));
464 * Number of activities saved in file.
466 unsigned int sa_act_nr;
472 * Description of the file_activity and record_header structures
473 * (nr of "long long", nr of "long" and nr of "int").
475 unsigned int act_types_nr[3];
476 unsigned int rec_types_nr[3];
478 * Size of file_activity and record_header structures used by file.
480 unsigned int act_size;
481 unsigned int rec_size;
483 * Current day and month.
484 * No need to save DST (Daylight Saving Time) flag, since it is not taken
485 * into account by the strftime() function used to print the timestamp.
487 unsigned char sa_day;
488 unsigned char sa_month;
490 * Size of a long integer. Useful to know the architecture on which
491 * the datafile was created.
495 * Operating system name.
497 char sa_sysname[UTSNAME_LEN];
501 char sa_nodename[UTSNAME_LEN];
503 * Operating system release number.
505 char sa_release[UTSNAME_LEN];
507 * Machine architecture.
509 char sa_machine[UTSNAME_LEN];
512 #define FILE_HEADER_SIZE (sizeof(struct file_header))
513 #define FILE_HEADER_ULL_NR 1 /* Nr of unsigned long long in file_header structure */
514 #define FILE_HEADER_UL_NR 1 /* Nr of unsigned long in file_header structure */
515 #define FILE_HEADER_U_NR 11 /* Nr of [unsigned] int in file_header structure */
516 /* The values below are used for sanity check */
517 #define MIN_FILE_HEADER_SIZE 0
518 #define MAX_FILE_HEADER_SIZE 8192
522 * Base magical number for activities.
524 #define ACTIVITY_MAGIC_BASE 0x8a
526 * Magical value used for activities with
527 * unknown format (used for sadf -H only).
529 #define ACTIVITY_MAGIC_UNKNOWN 0x89
531 /* List of activities saved in file */
532 struct file_activity {
534 * Identification value of activity.
538 * Activity magical number.
542 * Number of items for this activity
543 * when the data file has been created.
547 * Number of sub-items for this activity.
551 * Set to TRUE if statistics are preceded by
552 * a value giving the number of structures to read.
556 * Size of an item structure.
560 * Description of the structure containing statistics for the
561 * given activity (nr of "long long", nr of "long" and nr of "int").
563 unsigned int types_nr[3];
566 #define FILE_ACTIVITY_SIZE (sizeof(struct file_activity))
567 #define MAX_FILE_ACTIVITY_SIZE 1024 /* Used for sanity check */
568 #define FILE_ACTIVITY_ULL_NR 0 /* Nr of unsigned long long in file_activity structure */
569 #define FILE_ACTIVITY_UL_NR 0 /* Nr of unsigned long in file_activity structure */
570 #define FILE_ACTIVITY_U_NR 9 /* Nr of [unsigned] int in file_activity structure */
575 * R_STATS means that this is a record of statistics.
579 * R_RESTART means that this is a special record containing
580 * a LINUX RESTART message.
584 * R_LAST_STATS warns sar that this is the last record to be written
585 * to file before a file rotation, and that the next data to come will
587 * Such a record is tagged R_STATS anyway before being written to file.
589 #define R_LAST_STATS 3
591 * R_COMMENT means that this is a special record containing
596 /* Maximum length of a comment */
597 #define MAX_COMMENT_LEN 64
599 /* Header structure for every record */
600 struct record_header {
602 * Machine uptime in 1/100th of a second.
604 unsigned long long uptime_cs;
606 * Timestamp (number of seconds since the epoch).
608 unsigned long long ust_time;
610 * Record type: R_STATS, R_RESTART,...
612 unsigned char record_type;
614 * Timestamp: Hour (0-23), minute (0-59) and second (0-59).
615 * Used to determine TRUE time (immutable, non locale dependent time).
618 unsigned char minute;
619 unsigned char second;
622 #define RECORD_HEADER_SIZE (sizeof(struct record_header))
623 #define MAX_RECORD_HEADER_SIZE 512 /* Used for sanity check */
624 #define RECORD_HEADER_ULL_NR 2 /* Nr of unsigned long long in record_header structure */
625 #define RECORD_HEADER_UL_NR 0 /* Nr of unsigned long in record_header structure */
626 #define RECORD_HEADER_U_NR 0 /* Nr of unsigned int in record_header structure */
630 ***************************************************************************
631 * Generic description of an activity.
632 ***************************************************************************
635 /* Activity options */
638 * Indicate that corresponding activity should be collected by sadc.
640 #define AO_COLLECTED 0x01
642 * Indicate that corresponding activity should be displayed by sar.
644 #define AO_SELECTED 0x02
646 * Indicate that corresponding activity has items that need to be counted.
647 * This means that its @f_count_index values is >= 0.
648 * (We use AO_COUNTED instead of @f_count_index because @f_count_index
649 * is available (initialized) only for sadc).
651 #define AO_COUNTED 0x04
653 * Indicate that activity's metrics have persistent values when devices
654 * are registered again (this means that when the device is registered again,
655 * the metrics pick the values they had when they had been unregistered).
657 #define AO_PERSISTENT 0x08
659 * This flag should be set for every activity closing a markup used
660 * by several activities. Used by sadf f_xml_print() functions to
661 * display XML output.
663 #define AO_CLOSE_MARKUP 0x10
665 * Indicate that corresponding activity has multiple different
666 * output formats. This is the case for example for memory activity
667 * with options -r and -R.
668 * PS: Such an activity should appear in the list of activities that
669 * sar -A is supposed to display.
671 #define AO_MULTIPLE_OUTPUTS 0x20
673 * Indicate that one (SVG) graph will be displayed for each
674 * distinct item for this activity (sadf -g).
676 #define AO_GRAPH_PER_ITEM 0x40
678 * Indicate that this activity may have sub-items.
680 #define AO_MATRIX 0x80
682 #define IS_COLLECTED(m) (((m) & AO_COLLECTED) == AO_COLLECTED)
683 #define IS_SELECTED(m) (((m) & AO_SELECTED) == AO_SELECTED)
684 #define HAS_COUNT_FUNCTION(m) (((m) & AO_COUNTED) == AO_COUNTED)
685 #define HAS_PERSISTENT_VALUES(m) (((m) & AO_PERSISTENT) == AO_PERSISTENT)
686 #define CLOSE_MARKUP(m) (((m) & AO_CLOSE_MARKUP) == AO_CLOSE_MARKUP)
687 #define HAS_MULTIPLE_OUTPUTS(m) (((m) & AO_MULTIPLE_OUTPUTS) == AO_MULTIPLE_OUTPUTS)
688 #define ONE_GRAPH_PER_ITEM(m) (((m) & AO_GRAPH_PER_ITEM) == AO_GRAPH_PER_ITEM)
689 #define IS_MATRIX(m) (((m) & AO_MATRIX) == AO_MATRIX)
694 /* Structure used to define a bitmap needed by an activity */
697 * Bitmap for activities that need one. Remember to allocate it
700 unsigned char *b_array;
702 * Size of the bitmap in bits. In fact, bitmap is sized to b_size + 1
703 * to take into account CPU "all"
709 * Structure used to define an activity.
710 * Note: This structure can be modified without changing the format of data files.
714 * This variable contains the identification value (A_...) for this activity.
718 * Activity options (AO_...)
720 unsigned int options;
722 * Activity magical number. This number changes when activity format in file
723 * is no longer compatible with the format of that same activity from
728 * An activity belongs to a group (and only one).
729 * Groups are those selected with option -S of sadc.
733 * Index in f_count[] array to determine function used to count
734 * the number of items (serial lines, network interfaces, etc.) -> @nr
735 * Such a function should _always_ return a value greater than
738 * A value of -1 indicates that the number of items
739 * is a constant (and @nr is set to this value).
741 * These functions are called even if corresponding activities have not
742 * been selected, to make sure that all items have been calculated
743 * (including #CPU, etc.)
747 * The f_count2() function is used to count the number of
749 * Such a function should _always_ return a value greater than
752 * A NULL value for this function pointer indicates that the number of items
753 * is a constant (and @nr2 is set to this value).
755 __nr_t (*f_count2) (struct activity *);
757 * This function reads the relevant file and fill the buffer
758 * with statistics corresponding to given activity.
760 __read_funct_t (*f_read) (struct activity *);
762 * This function displays activity statistics onto the screen.
764 __print_funct_t (*f_print) (struct activity *, int, int, unsigned long long);
766 * This function displays average activity statistics onto the screen.
768 __print_funct_t (*f_print_avg) (struct activity *, int, int, unsigned long long);
770 * This function is used by sadf to display activity in a format that can
771 * easily be ingested by a relational database, or a format that can be
772 * handled by pattern processing commands like "awk".
774 __print_funct_t (*f_render) (struct activity *, int, char *, int, unsigned long long);
776 * This function is used by sadf to display activity statistics in XML.
778 __print_funct_t (*f_xml_print) (struct activity *, int, int, unsigned long long);
780 * This function is used by sadf to display activity statistics in JSON.
782 __print_funct_t (*f_json_print) (struct activity *, int, int, unsigned long long);
784 * This function is used by sadf to display activity statistics in SVG.
786 __print_funct_t (*f_svg_print) (struct activity *, int, int, struct svg_parm *,
787 unsigned long long, struct record_header *);
789 * This function is used by sadf to display activity statistics in raw format.
791 __print_funct_t (*f_raw_print) (struct activity *, char *, int);
793 * Header string displayed by sadf -d.
794 * Header lines for each output (for activities with multiple outputs) are
795 * separated with a '|' character.
796 * For a given output, the first field corresponding to extended statistics
797 * (eg. -r ALL) begins with a '&' character.
805 * Description of the corresponding structure containing statistics (as defined
806 * in rd_stats.h or rd_sensors.h). Such a structure has 0+ fields of type
807 * "long long", followed by 0+ fields of type "long", followed by 0+ fields of
808 * type "int", followed by 0+ other fields (e.g. of type char). The array below
809 * gives the number of "long long" fields composing the structure, then the number
810 * of "long" fields, then the number of "int" fields.
812 unsigned int gtypes_nr[3];
814 * This array has the same meaning as @gtypes_nr[] above, but the values are those
815 * read from current data file. They may be different from those of @gtypes_nr[]
816 * because we can read data from a different sysstat version (older or newer).
818 unsigned int ftypes_nr[3];
820 * Number of SVG graphs for this activity. The total number of graphs for
821 * the activity can be greater though if flag AO_GRAPH_PER_ITEM is set, in
822 * which case the total number will be @g_nr * @nr.
826 * Number of items on the system, as counted when the system is initialized.
827 * A negative value (-1) is the default value and indicates that this number
828 * has still not been calculated by the f_count() function.
829 * A value of 0 means that this number has been calculated, but no items have
831 * A positive value (>0) has either been calculated or is a constant.
835 * Number of sub-items on the system.
836 * @nr2 is in fact the second dimension of a matrix of items, the first
837 * one being @nr. @nr is the number of lines, and @nr2 the number of columns.
838 * A negative value (-1) is the default value and indicates that this number
839 * has still not been calculated by the f_count2() function.
840 * A value of 0 means that this number has been calculated, but no sub-items have
842 * A positive value (>0) has either been calculated or is a constant.
844 * 1) IF @nr2 = 0 THEN @nr = 0
845 * Note: If @nr = 0, then @nr2 is undetermined (may be -1, 0 or >0).
846 * 2) IF @nr > 0 THEN @nr2 > 0.
847 * Note: If @nr2 > 0 then @nr is undetermined (may be -1, 0 or >0).
848 * 3) IF @nr <= 0 THEN @nr2 = -1 (this is the default value for @nr2,
849 * meaning that it has not been calculated).
853 * Maximum number of elements that sar can handle for this item.
854 * NB: The maximum number of elements that sar can handle for sub-items
859 * Number of items, as read and saved in corresponding buffer (@buf: See below).
860 * The value may be zero for a particular sample if no items have been found.
864 * Number of structures allocated in @buf[*]. This number should be greater
865 * than or equal to @nr[*].
870 * This is the size of the corresponding structure, as read from or written
871 * to a file, or read from or written by the data collector.
876 * This is the size of the corresponding structure as mapped into memory.
877 * @msize can be different from @fsize when data are read from or written to
878 * a data file from a different sysstat version.
882 * Optional flags for activity. This is eg. used when AO_MULTIPLE_OUTPUTS
884 * 0x0001 - 0x0080 : Multiple outputs (eg. AO_F_MEMORY, AO_F_SWAP...)
885 * 0x0100 - 0x8000 : If bit set then display complete header (hdr_line) for
886 * corresponding output
887 * 0x010000+ : Optional flags
889 unsigned int opt_flags;
891 * Buffers that will contain the statistics read. Its size is @nr * @nr2 * @size each.
893 * [0] and [1]: current/previous statistics values (used by sar).
894 * [2]: Used by sar to save first collected stats (used later to
899 * Bitmap for activities that need one. Such a bitmap is needed by activity
900 * if @bitmap is not NULL.
902 struct act_bitmap *bitmap;
907 ***************************************************************************
908 * Generic description of an output format for sadf (and sar).
909 ***************************************************************************
912 /* Type for all functions used by sadf to display stats in various formats */
913 #define __printf_funct_t void
914 #define __tm_funct_t char *
917 * Structure used to define a report.
918 * A XML-like report has the following format:
924 * | | Statistics block
927 * | | | Timestamp block
930 * | | | | Activity #1
936 * | | | | Activity #n
941 * | | Restart messages block
948 struct report_format {
950 * This variable contains the identification value (F_...) for this report format.
954 * Format options (FO_...).
956 unsigned int options;
958 * This function displays the report header
959 * (data displayed once at the beginning of the report).
961 __printf_funct_t (*f_header) (void *, int, char *, struct file_magic *, struct file_header *,
962 struct activity * [], unsigned int [], struct file_activity *);
964 * This function defines the statistics part of the report.
965 * Used only with textual (XML-like) reports.
967 __printf_funct_t (*f_statistics) (int *, int);
969 * This function defines the timestamp part of the report.
970 * Used only with textual (XML-like) reports.
972 __tm_funct_t (*f_timestamp) (void *, int, char *, char *, unsigned long long,
973 struct file_header *, unsigned int);
975 * This function displays the restart messages.
977 __printf_funct_t (*f_restart) (int *, int, char *, char *, int, struct file_header *);
979 * This function displays the comments.
981 __printf_funct_t (*f_comment) (int *, int, char *, char *, int, char *, struct file_header *);
984 /* Possible actions for functions used to display reports */
990 ***************************************************************************
991 * SVG output definitions
992 ***************************************************************************
1000 * | | 4 | Graph title
1010 * | | v |-------------------------------
1012 * | v <---><------------------------------>
1015 * v<---------------------------------------------------------------> Gap
1017 * <--------------------------------------------------------------------->
1022 #define SVG_G_XSIZE 720
1024 #define SVG_M_XSIZE 70
1026 #define SVG_V_XSIZE 1050
1028 #define SVG_T_XSIZE 1060
1031 #define SVG_G_YSIZE 200
1033 #define SVG_H_YSIZE 50
1035 #define SVG_M_YSIZE 50
1037 #define SVG_T_YSIZE 310
1039 #define SVG_V_YSIZE 300
1041 /* Grid: Nr of horizontal lines */
1042 #define SVG_H_GRIDNR 3
1043 /* Grid: Nr of vertical lines */
1044 #define SVG_V_GRIDNR 10
1046 /* Block size used to allocate arrays for graphs data */
1047 #define CHUNKSIZE 4096
1049 /* Maximum number of views on a single row */
1050 #define MAX_VIEWS_ON_A_ROW 6
1052 #define SVG_LINE_GRAPH 1
1053 #define SVG_BAR_GRAPH 2
1055 /* Maximum number of horizontal lines for the background grid */
1056 #define MAX_HLINES_NR 10
1061 ***************************************************************************
1062 * Macro functions definitions.
1064 * Note: Using 'do ... while' makes the macros safer to use
1065 * (remember that macro use is followed by a semicolon).
1066 ***************************************************************************
1069 /* Close file descriptors */
1070 #define CLOSE_ALL(_fd_) do { \
1075 #define CLOSE(_fd_) if (_fd_ >= 0) \
1080 ***************************************************************************
1081 * Various structure definitions.
1082 ***************************************************************************
1085 /* Structure for timestamps */
1095 ***************************************************************************
1096 * Functions prototypes.
1097 ***************************************************************************
1100 /* Functions used to count number of items */
1101 __nr_t wrap_get_cpu_nr
1102 (struct activity *);
1103 __nr_t wrap_get_irq_nr
1104 (struct activity *);
1105 __nr_t wrap_get_serial_nr
1106 (struct activity *);
1107 __nr_t wrap_get_disk_nr
1108 (struct activity *);
1109 __nr_t wrap_get_iface_nr
1110 (struct activity *);
1111 __nr_t wrap_get_fan_nr
1112 (struct activity *);
1113 __nr_t wrap_get_temp_nr
1114 (struct activity *);
1115 __nr_t wrap_get_in_nr
1116 (struct activity *);
1117 __nr_t wrap_get_freq_nr
1118 (struct activity *);
1119 __nr_t wrap_get_usb_nr
1120 (struct activity *);
1121 __nr_t wrap_get_filesystem_nr
1122 (struct activity *);
1123 __nr_t wrap_get_fchost_nr
1124 (struct activity *);
1126 /* Functions used to read activities statistics */
1127 __read_funct_t wrap_read_stat_cpu
1128 (struct activity *);
1129 __read_funct_t wrap_read_stat_pcsw
1130 (struct activity *);
1131 __read_funct_t wrap_read_stat_irq
1132 (struct activity *);
1133 __read_funct_t wrap_read_swap
1134 (struct activity *);
1135 __read_funct_t wrap_read_paging
1136 (struct activity *);
1137 __read_funct_t wrap_read_io
1138 (struct activity *);
1139 __read_funct_t wrap_read_meminfo
1140 (struct activity *);
1141 __read_funct_t wrap_read_kernel_tables
1142 (struct activity *);
1143 __read_funct_t wrap_read_loadavg
1144 (struct activity *);
1145 __read_funct_t wrap_read_tty_driver_serial
1146 (struct activity *);
1147 __read_funct_t wrap_read_disk
1148 (struct activity *);
1149 __read_funct_t wrap_read_net_dev
1150 (struct activity *);
1151 __read_funct_t wrap_read_net_edev
1152 (struct activity *);
1153 __read_funct_t wrap_read_net_nfs
1154 (struct activity *);
1155 __read_funct_t wrap_read_net_nfsd
1156 (struct activity *);
1157 __read_funct_t wrap_read_net_sock
1158 (struct activity *);
1159 __read_funct_t wrap_read_net_ip
1160 (struct activity *);
1161 __read_funct_t wrap_read_net_eip
1162 (struct activity *);
1163 __read_funct_t wrap_read_net_icmp
1164 (struct activity *);
1165 __read_funct_t wrap_read_net_eicmp
1166 (struct activity *);
1167 __read_funct_t wrap_read_net_tcp
1168 (struct activity *);
1169 __read_funct_t wrap_read_net_etcp
1170 (struct activity *);
1171 __read_funct_t wrap_read_net_udp
1172 (struct activity *);
1173 __read_funct_t wrap_read_net_sock6
1174 (struct activity *);
1175 __read_funct_t wrap_read_net_ip6
1176 (struct activity *);
1177 __read_funct_t wrap_read_net_eip6
1178 (struct activity *);
1179 __read_funct_t wrap_read_net_icmp6
1180 (struct activity *);
1181 __read_funct_t wrap_read_net_eicmp6
1182 (struct activity *);
1183 __read_funct_t wrap_read_net_udp6
1184 (struct activity *);
1185 __read_funct_t wrap_read_cpuinfo
1186 (struct activity *);
1187 __read_funct_t wrap_read_fan
1188 (struct activity *);
1189 __read_funct_t wrap_read_temp
1190 (struct activity *);
1191 __read_funct_t wrap_read_in
1192 (struct activity *);
1193 __read_funct_t wrap_read_meminfo_huge
1194 (struct activity *);
1195 __read_funct_t wrap_read_cpu_wghfreq
1196 (struct activity *);
1197 __read_funct_t wrap_read_bus_usb_dev
1198 (struct activity *);
1199 __read_funct_t wrap_read_filesystem
1200 (struct activity *);
1201 __read_funct_t wrap_read_fchost
1202 (struct activity *);
1203 __read_funct_t wrap_read_softnet
1204 (struct activity *);
1206 /* Other functions */
1207 void allocate_bitmaps
1208 (struct activity * []);
1209 void allocate_structures
1210 (struct activity * []);
1211 int check_alt_sa_dir
1214 (struct activity *, int, int, int);
1215 void check_file_actlst
1216 (int *, char *, struct activity * [], struct file_magic *, struct file_header *,
1217 struct file_activity **, unsigned int [], int, int *, int *);
1218 int check_net_dev_reg
1219 (struct activity *, int, int, int);
1220 int check_net_edev_reg
1221 (struct activity *, int, int, int);
1222 double compute_ifutil
1223 (struct stats_net_dev *, double, double);
1224 void copy_structures
1225 (struct activity * [], unsigned int [], struct record_header [], int, int);
1227 (struct tm *, struct tstamp *);
1228 void display_sa_file_version
1229 (FILE *, struct file_magic *);
1230 void enum_version_nr
1231 (struct file_magic *);
1233 (struct activity * []);
1234 void free_structures
1235 (struct activity * []);
1237 (struct activity * [], unsigned int, int);
1238 int get_activity_position
1239 (struct activity * [], unsigned int, int);
1241 (unsigned int, unsigned int, int);
1242 void get_file_timestamp_struct
1243 (unsigned int, struct tm *, struct file_header *);
1245 (struct record_header *, struct record_header *, unsigned long long *);
1246 void handle_invalid_sa_file
1247 (int *, struct file_magic *, char *, int);
1249 (unsigned long long, unsigned long long, int, long);
1251 (char * [], int *, struct activity * [], unsigned int *, int);
1253 (char * [], int *, struct activity * []);
1255 (char * [], int *, unsigned int *, struct activity * []);
1257 (char * [], int *, struct activity * []);
1259 (char * [], int *, struct activity * []);
1261 (char * [], int *, struct tstamp *, const char *);
1262 void print_collect_error
1264 void print_report_hdr
1265 (unsigned int, struct tm *, struct file_header *);
1266 void print_sar_comment
1267 (int *, int, char *, char *, int, char *, struct file_header *);
1268 __printf_funct_t print_sar_restart
1269 (int *, int, char *, char *, int, struct file_header *);
1270 int print_special_record
1271 (struct record_header *, unsigned int, struct tstamp *, struct tstamp *,
1272 int, int, struct tm *, struct tm *, char *, int, struct file_magic *,
1273 struct file_header *, struct activity * [], struct report_format *, int, int);
1274 void read_file_stat_bunch
1275 (struct activity * [], int, int, int, struct file_activity *, int, int,
1276 char *, struct file_magic *);
1277 __nr_t read_nr_value
1278 (int, char *, struct file_magic *, int, int, int);
1280 (int, void *, struct record_header *, struct file_header *, int, int);
1281 void reallocate_all_buffers
1282 (struct activity *);
1284 (unsigned int [], unsigned int [], void *, unsigned int);
1285 void replace_nonprintable_char
1288 (int, void *, int, int);
1289 int sa_get_record_timestamp_struct
1290 (unsigned int, struct record_header *, struct tm *, struct tm *);
1291 int sa_open_read_magic
1292 (int *, char *, struct file_magic *, int, int *);
1293 void select_all_activities
1294 (struct activity * []);
1295 void select_default_activity
1296 (struct activity * []);
1298 (unsigned char [], unsigned char, unsigned int);
1299 void set_default_file
1301 void set_hdr_rectime
1302 (unsigned int, struct tm *, struct file_header *);
1303 void set_record_timestamp_string
1304 (unsigned int, struct record_header *, char *, char *, int, struct tm *);
1306 (unsigned int [], void *, int);