2 * sar/sadc: Report system activity
3 * (C) 1999-2017 by Sebastien Godard (sysstat <at> orange.fr)
14 #include "rd_sensors.h"
17 ***************************************************************************
18 * Activity identification values.
19 ***************************************************************************
22 /* Number of activities */
24 /* The value below is used for sanity check */
25 #define MAX_NR_ACT 256
27 /* Number of functions used to count items */
50 #define A_NET_EICMP 20
54 #define A_NET_SOCK6 24
57 #define A_NET_ICMP6 27
58 #define A_NET_EICMP6 28
60 #define A_PWR_CPUFREQ 30
65 #define A_PWR_WGHFREQ 35
67 #define A_FILESYSTEM 37
72 /* Macro used to flag an activity that should be collected */
73 #define COLLECT_ACTIVITY(m) act[get_activity_position(act, m, EXIT_IF_NOT_FOUND)]->options |= AO_COLLECTED
75 /* Macro used to flag an activity that should be selected */
76 #define SELECT_ACTIVITY(m) act[get_activity_position(act, m, EXIT_IF_NOT_FOUND)]->options |= AO_SELECTED
80 ***************************************************************************
82 ***************************************************************************
85 #define S_F_SINCE_BOOT 0x00000001
86 #define S_F_SA_ROTAT 0x00000002
87 #define S_F_DEV_PRETTY 0x00000004
88 #define S_F_FORCE_FILE 0x00000008
89 #define S_F_INTERVAL_SET 0x00000010
90 #define S_F_TRUE_TIME 0x00000020
91 #define S_F_LOCK_FILE 0x00000040
92 #define S_F_SEC_EPOCH 0x00000080
93 #define S_F_HDR_ONLY 0x00000100
94 #define S_F_FILE_LOCKED 0x00000200
95 #define S_F_SA_YYYYMMDD 0x00000400
96 #define S_F_HORIZONTALLY 0x00000800
97 #define S_F_COMMENT 0x00001000
98 #define S_F_PERSIST_NAME 0x00002000
99 #define S_F_LOCAL_TIME 0x00004000
100 #define S_F_PREFD_TIME_OUTPUT 0x00008000
101 #define S_F_SVG_SKIP 0x00010000
102 /* Same value as S_F_SVG_SKIP above. Used for a different output format */
103 #define S_F_RAW_SHOW_HINTS 0x00010000
104 #define S_F_SVG_AUTOSCALE 0x00020000
105 #define S_F_SVG_ONE_DAY 0x00040000
106 #define S_F_SVG_SHOW_IDLE 0x00080000
107 #define S_F_UNIT 0x00100000
108 #define S_F_SVG_HEIGHT 0x00200000
109 #define S_F_SVG_PACKED 0x00400000
110 #define S_F_SVG_SHOW_INFO 0x00800000
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)
138 #define AO_F_NULL 0x00000000
140 /* Output flags for options -r / -S */
141 #define AO_F_MEMORY 0x00000001
142 #define AO_F_SWAP 0x00000002
143 /* AO_F_MEM_ALL: See opt_flags in struct activity below */
144 #define AO_F_MEM_ALL (AO_F_MEMORY << 8)
146 #define DISPLAY_MEMORY(m) (((m) & AO_F_MEMORY) == AO_F_MEMORY)
147 #define DISPLAY_SWAP(m) (((m) & AO_F_SWAP) == AO_F_SWAP)
148 #define DISPLAY_MEM_ALL(m) (((m) & AO_F_MEM_ALL) == AO_F_MEM_ALL)
150 /* Output flags for option -u [ ALL ] */
151 #define AO_F_CPU_DEF 0x00000001
152 #define AO_F_CPU_ALL 0x00000002
154 #define DISPLAY_CPU_DEF(m) (((m) & AO_F_CPU_DEF) == AO_F_CPU_DEF)
155 #define DISPLAY_CPU_ALL(m) (((m) & AO_F_CPU_ALL) == AO_F_CPU_ALL)
157 /* Output flags for option -d */
158 #define AO_F_DISK_PART 0x00000001
160 #define COLLECT_PARTITIONS(m) (((m) & AO_F_DISK_PART) == AO_F_DISK_PART)
162 /* Output flags for option -F */
163 #define AO_F_FILESYSTEM 0x00000001
164 #define AO_F_MOUNT 0x00000002
166 #define DISPLAY_MOUNT(m) (((m) & AO_F_MOUNT) == AO_F_MOUNT)
169 ***************************************************************************
170 * Various keywords and constants.
171 ***************************************************************************
175 #define K_XALL "XALL"
178 #define K_EDEV "EDEV"
180 #define K_NFSD "NFSD"
181 #define K_SOCK "SOCK"
184 #define K_ICMP "ICMP"
185 #define K_EICMP "EICMP"
187 #define K_ETCP "ETCP"
189 #define K_SOCK6 "SOCK6"
191 #define K_EIP6 "EIP6"
192 #define K_ICMP6 "ICMP6"
193 #define K_EICMP6 "EICMP6"
194 #define K_UDP6 "UDP6"
197 #define K_TEMP "TEMP"
199 #define K_FREQ "FREQ"
200 #define K_MOUNT "MOUNT"
202 #define K_SOFT "SOFT"
205 #define K_DISK "DISK"
206 #define K_XDISK "XDISK"
207 #define K_SNMP "SNMP"
208 #define K_IPV6 "IPV6"
209 #define K_POWER "POWER"
212 #define K_SKIP_EMPTY "skipempty"
213 #define K_AUTOSCALE "autoscale"
214 #define K_ONEDAY "oneday"
215 #define K_SHOWIDLE "showidle"
216 #define K_SHOWINFO "showinfo"
217 #define K_SHOWHINTS "showhints"
218 #define K_HEIGHT "height="
219 #define K_PACKED "packed"
221 /* Groups of activities */
222 #define G_DEFAULT 0x00
233 /* Time must have the format HH:MM:SS with HH in 24-hour format */
234 #define DEF_TMSTART "08:00:00"
235 #define DEF_TMEND "18:00:00"
237 #define UTSNAME_LEN 65
238 #define HEADER_LINE_LEN 512
241 * Define upper limit for various items.
242 * Made necessary because we have to check the number of
243 * items for each activity when we read a (possibly tainted)
246 #define MAX_NR_SERIAL_LINES 512
247 #define MAX_NR_DISKS 8192
248 #define MAX_NR_IFACES 512
249 #define MAX_NR_FANS 128
250 #define MAX_NR_TEMP_SENSORS 128
251 #define MAX_NR_IN_SENSORS 128
252 #define MAX_NR_USB 1024
253 #define MAX_NR_FS 8192
254 #define MAX_NR_FCHOSTS 8192
256 /* NR_MAX is the upper limit used for unknown activities */
260 /* Maximum number of args that can be passed to sadc */
261 #define MAX_ARGV_NR 32
263 /* Miscellaneous constants */
265 #define USE_SA_FILE 1
266 #define NO_TM_START 0
273 #define ALL_ACTIVITIES ~0U
274 #define EXIT_IF_NOT_FOUND 1
275 #define RESUME_IF_NOT_FOUND 0
283 #define CLOSE_XML_MARKUP 0
284 #define OPEN_XML_MARKUP 1
286 #define CLOSE_JSON_MARKUP 0
287 #define OPEN_JSON_MARKUP 1
289 #define COUNT_ACTIVITIES 0
290 #define COUNT_OUTPUTS 1
292 /* Type for all functions counting items */
294 /* Type for all functions reading statistics */
295 #define __read_funct_t void
296 /* Type for all functions displaying statistics */
297 #define __print_funct_t void
299 /* Structure for SVG specific parameters */
301 unsigned long long dt; /* Interval of time for current sample */
302 unsigned long long ust_time_ref; /* X axis start time in seconds since the epoch */
303 unsigned long long ust_time_end; /* X axis end time in seconds since the epoch */
304 unsigned long long ust_time_first; /* Time (in seconds since the epoch) for first sample */
305 int graph_no; /* Total number of views already displayed */
306 int restart; /* TRUE if we have just met a RESTART record */
307 struct file_header *file_hdr; /* Pointer on file header structure */
310 /* Structure used when displaying SVG header */
311 struct svg_hdr_parm {
312 int graph_nr; /* Number of rows of views to display or canvas height entered on the command line */
313 int views_per_row; /* Maximum number of views on a single row */
317 ***************************************************************************
318 * Definitions of header structures.
320 * The rule is: "strict writing, broad reading", meaning that sar/sadc can
321 * only append data to a datafile whose format is strictly the same as that
322 * of current version (checking FORMAT_MAGIC is not enough), but sar/sadf
323 * can read data from different versions, providing that FORMAT_MAGIC value
326 * Format of system activity data files:
329 * | file_magic structure
333 * | file_header structure
337 * | file_activity structure | * sa_act_nr
341 * | record_header structure |
345 * | Statistics structures...(*) |
349 * (*)Note: If it's a special record, we may find a comment instead of
350 * statistics (R_COMMENT record type) or, if it's a R_RESTART record type,
351 * <sa_nr_vol_act> structures (of type file_activity) for the volatile
353 ***************************************************************************
357 * Sysstat magic number. Should never be modified.
358 * Indicate that the file was created by sysstat.
360 #define SYSSTAT_MAGIC 0xd596
361 #define SYSSTAT_MAGIC_SWAPPED (((SYSSTAT_MAGIC << 8) | (SYSSTAT_MAGIC >> 8)) & 0xffff)
364 * Datafile format magic number.
365 * Modified to indicate that the format of the file is
366 * no longer compatible with that of previous sysstat versions.
368 #define FORMAT_MAGIC 0x2175
369 #define FORMAT_MAGIC_SWAPPED (((FORMAT_MAGIC << 8) | (FORMAT_MAGIC >> 8)) & 0xffff)
371 /* Previous datafile format magic number used by older sysstat versions */
372 #define PREVIOUS_FORMAT_MAGIC 0x2173
374 /* Padding in file_magic structure. See below. */
375 #define FILE_MAGIC_PADDING 48
377 /* Structure for file magic header data */
380 * This field identifies the file as a file created by sysstat.
382 unsigned short sysstat_magic;
384 * The value of this field varies whenever datafile format changes.
386 unsigned short format_magic;
388 * Sysstat version used to create the file.
390 unsigned char sysstat_version;
391 unsigned char sysstat_patchlevel;
392 unsigned char sysstat_sublevel;
393 unsigned char sysstat_extraversion;
394 #define FILE_MAGIC_ULL_NR 0 /* Nr of unsigned long long below */
395 #define FILE_MAGIC_UL_NR 0 /* Nr of unsigned long below */
396 #define FILE_MAGIC_U_NR 5 /* Nr of [unsigned] int below */
398 * Size of file's header (size of file_header structure used by file).
400 unsigned int header_size;
402 * Set to non zero if data file has been converted with "sadf -c" from
403 * an old format (version x.y.z) to a newest format (version X.Y.Z).
404 * In this case, the value is: Y*256 + Z + 1.
405 * The FORMAT_MAGIC value of the file can be used to determine X.
407 unsigned int upgraded;
409 * Description of the file_header structure
410 * (nr of "long long", nr of "long" and nr of "int").
412 unsigned int hdr_types_nr[3];
414 * Padding. Reserved for future use while avoiding a format change.
415 * sysstat always reads a number of bytes which is that expected for
416 * current sysstat version (FILE_MAGIC_SIZE). We cannot guess if we
417 * are going to read a file from current, an older or a newer version.
419 unsigned char pad[FILE_MAGIC_PADDING];
422 #define FILE_MAGIC_SIZE (sizeof(struct file_magic))
424 /* Header structure for system activity data file */
427 * Timestamp in seconds since the epoch.
429 unsigned long long sa_ust_time;
431 * Number of CPU items (1 .. CPU_NR + 1) for the last sample in file.
433 unsigned int sa_last_cpu_nr;
435 * Number of activities saved in file.
437 unsigned int sa_act_nr;
439 * Number of volatile activities in file. This is the number of
440 * file_activity structures saved after each restart mark in file.
442 unsigned int sa_vol_act_nr;
444 * Current day, month and year.
445 * No need to save DST (Daylight Saving Time) flag, since it is not taken
446 * into account by the strftime() function used to print the timestamp.
449 unsigned char sa_day;
450 unsigned char sa_month;
452 * Size of a long integer. Useful to know the architecture on which
453 * the datafile was created.
457 * Operating system name.
459 char sa_sysname[UTSNAME_LEN];
463 char sa_nodename[UTSNAME_LEN];
465 * Operating system release number.
467 char sa_release[UTSNAME_LEN];
469 * Machine architecture.
471 char sa_machine[UTSNAME_LEN];
474 #define FILE_HEADER_SIZE (sizeof(struct file_header))
475 #define FILE_HEADER_ULL_NR 1 /* Nr of unsigned long long in file_header structure */
476 #define FILE_HEADER_UL_NR 0 /* Nr of unsigned long in file_header structure */
477 #define FILE_HEADER_U_NR 4 /* Nr of [unsigned] int in file_header structure */
478 /* The values below are used for sanity check */
479 #define MIN_FILE_HEADER_SIZE 0
480 #define MAX_FILE_HEADER_SIZE 8192
484 * Base magical number for activities.
486 #define ACTIVITY_MAGIC_BASE 0x8a
488 * Magical value used for activities with
489 * unknown format (used for sadf -H only).
491 #define ACTIVITY_MAGIC_UNKNOWN 0x89
493 /* List of activities saved in file */
494 struct file_activity {
496 * Identification value of activity.
500 * Activity magical number.
504 * Number of items for this activity.
508 * Number of sub-items for this activity.
512 * Size of an item structure.
516 * Description of the structure containing statistics for the
517 * given activity (nr of "long long", nr of "long" and nr of "int").
519 unsigned int types_nr[3];
522 #define FILE_ACTIVITY_SIZE (sizeof(struct file_activity))
523 #define FILE_ACTIVITY_ULL_NR 0 /* Nr of unsigned long long in file_activity structure */
524 #define FILE_ACTIVITY_UL_NR 0 /* Nr of unsigned long in file_activity structure */
525 #define FILE_ACTIVITY_U_NR 8 /* Nr of [unsigned] int in file_activity structure */
530 * R_STATS means that this is a record of statistics.
534 * R_RESTART means that this is a special record containing
535 * a LINUX RESTART message.
539 * R_LAST_STATS warns sar that this is the last record to be written
540 * to file before a file rotation, and that the next data to come will
542 * Such a record is tagged R_STATS anyway before being written to file.
544 #define R_LAST_STATS 3
546 * R_COMMENT means that this is a special record containing
551 /* Maximum length of a comment */
552 #define MAX_COMMENT_LEN 64
554 /* Header structure for every record */
555 struct record_header {
557 * Machine uptime (multiplied by the # of proc).
559 unsigned long long uptime;
561 * Uptime reduced to one processor. Always set, even on UP machines.
563 unsigned long long uptime0;
565 * Timestamp (number of seconds since the epoch).
567 unsigned long long ust_time;
569 * Record type: R_STATS, R_RESTART,...
571 unsigned char record_type;
573 * Timestamp: Hour (0-23), minute (0-59) and second (0-59).
574 * Used to determine TRUE time (immutable, non locale dependent time).
577 unsigned char minute;
578 unsigned char second;
581 #define RECORD_HEADER_SIZE (sizeof(struct record_header))
582 #define RECORD_HEADER_ULL_NR 3 /* Nr of unsigned long long in record_header structure */
583 #define RECORD_HEADER_UL_NR 0 /* Nr of unsigned long in record_header structure */
584 #define RECORD_HEADER_U_NR 0 /* Nr of unsigned int in record_header structure */
588 ***************************************************************************
589 * Generic description of an activity.
590 ***************************************************************************
593 /* Activity options */
596 * Indicate that corresponding activity should be collected by sadc.
598 #define AO_COLLECTED 0x01
600 * Indicate that corresponding activity should be displayed by sar.
602 #define AO_SELECTED 0x02
604 * When appending data to a file, the number of items (for every activity)
605 * is forced to that of the file (number of network interfaces, serial lines,
606 * etc.) Exceptions are volatile activities (like A_CPU) whose number of items
607 * is related to the number of CPUs: If current machine has a different number
608 * of CPU than that of the file (but is equal to sa_last_cpu_nr) then data
609 * will be appended with a number of items equal to that of the machine.
611 #define AO_VOLATILE 0x04
613 * Indicate that the interval of time, given to f_print() function
614 * displaying statistics, should be the interval of time in jiffies
615 * multiplied by the number of processors.
617 #define AO_GLOBAL_ITV 0x08
619 * This flag should be set for every activity closing a markup used
620 * by several activities. Used by sadf f_xml_print() functions to
621 * display XML output.
623 #define AO_CLOSE_MARKUP 0x10
625 * Indicate that corresponding activity has multiple different
626 * output formats. This is the case for example for memory activity
627 * with options -r and -R.
628 * PS: Such an activity should appear in the list of activities that
629 * sar -A is supposed to display.
631 #define AO_MULTIPLE_OUTPUTS 0x20
633 * Indicate that one (SVG) graph will be displayed for each
634 * distinct item for this activity (sadf -g).
636 #define AO_GRAPH_PER_ITEM 0x40
638 #define IS_COLLECTED(m) (((m) & AO_COLLECTED) == AO_COLLECTED)
639 #define IS_SELECTED(m) (((m) & AO_SELECTED) == AO_SELECTED)
640 #define IS_VOLATILE(m) (((m) & AO_VOLATILE) == AO_VOLATILE)
641 #define NEED_GLOBAL_ITV(m) (((m) & AO_GLOBAL_ITV) == AO_GLOBAL_ITV)
642 #define CLOSE_MARKUP(m) (((m) & AO_CLOSE_MARKUP) == AO_CLOSE_MARKUP)
643 #define HAS_MULTIPLE_OUTPUTS(m) (((m) & AO_MULTIPLE_OUTPUTS) == AO_MULTIPLE_OUTPUTS)
644 #define ONE_GRAPH_PER_ITEM(m) (((m) & AO_GRAPH_PER_ITEM) == AO_GRAPH_PER_ITEM)
648 /* Structure used to define a bitmap needed by an activity */
651 * Bitmap for activities that need one. Remember to allocate it
654 unsigned char *b_array;
656 * Size of the bitmap in bits. In fact, bitmap is sized to b_size + 1
657 * to take into account CPU "all"
663 * Structure used to define an activity.
664 * Note: This structure can be modified without changing the format of data files.
668 * This variable contains the identification value (A_...) for this activity.
672 * Activity options (AO_...)
674 unsigned int options;
676 * Activity magical number. This number changes when activity format in file
677 * is no longer compatible with the format of that same activity from
682 * An activity belongs to a group (and only one).
683 * Groups are those selected with option -S of sadc.
687 * Index in f_count[] array to determine function used to count
688 * the number of items (serial lines, network interfaces, etc.) -> @nr
689 * Such a function should _always_ return a value greater than
692 * A value of -1 indicates that the number of items
693 * is a constant (and @nr is set to this value).
695 * These functions are called even if corresponding activities have not
696 * been selected, to make sure that all items have been calculated
697 * (including #CPU, etc.)
701 * The f_count2() function is used to count the number of
703 * Such a function should _always_ return a value greater than
706 * A NULL value for this function pointer indicates that the number of items
707 * is a constant (and @nr2 is set to this value).
709 __nr_t (*f_count2) (struct activity *);
711 * This function reads the relevant file and fill the buffer
712 * with statistics corresponding to given activity.
714 __read_funct_t (*f_read) (struct activity *);
716 * This function displays activity statistics onto the screen.
718 __print_funct_t (*f_print) (struct activity *, int, int, unsigned long long);
720 * This function displays average activity statistics onto the screen.
722 __print_funct_t (*f_print_avg) (struct activity *, int, int, unsigned long long);
724 * This function is used by sadf to display activity in a format that can
725 * easily be ingested by a relational database, or a format that can be
726 * handled by pattern processing commands like "awk".
728 __print_funct_t (*f_render) (struct activity *, int, char *, int, unsigned long long);
730 * This function is used by sadf to display activity statistics in XML.
732 __print_funct_t (*f_xml_print) (struct activity *, int, int, unsigned long long);
734 * This function is used by sadf to display activity statistics in JSON.
736 __print_funct_t (*f_json_print) (struct activity *, int, int, unsigned long long);
738 * This function is used by sadf to display activity statistics in SVG.
740 __print_funct_t (*f_svg_print) (struct activity *, int, int, struct svg_parm *,
741 unsigned long long, struct record_header *);
743 * This function is used by sadf to display activity statistics in raw format.
745 __print_funct_t (*f_raw_print) (struct activity *, char *, int);
747 * Header string displayed by sadf -d.
748 * Header lines for each output (for activities with multiple outputs) are
749 * separated with a '|' character.
750 * For a given output, the first field corresponding to extended statistics
751 * (eg. -r ALL) begins with a '&' character.
759 * Description of the corresponding structure containing statistics (as defined
760 * in rd_stats.h or rd_sensors.h). Such a structure has 0+ fields of type
761 * "long long", followed by 0+ fields of type "long", followed by 0+ fields of
762 * type "int", followed by 0+ other fields (e.g. of type char). The array below
763 * gives the number of "long long" fields composing the structure, then the number
764 * of "long" fields, then the number of "int" fields.
766 unsigned int gtypes_nr[3];
768 * This array has the same meaning as @gtypes_nr[] above, but the values are those
769 * read from current data file. They may be different from those of @gtypes_nr[]
770 * because we can read data from a different sysstat version (older or newer).
772 unsigned int ftypes_nr[3];
774 * Number of SVG graphs for this activity. The total number of graphs for
775 * the activity can be greater though if flag AO_GRAPH_PER_ITEM is set, in
776 * which case the total number will be @g_nr * @nr.
780 * Number of items on the system.
781 * A negative value (-1) is the default value and indicates that this number
782 * has still not been calculated by the f_count() function.
783 * A value of 0 means that this number has been calculated, but no items have
785 * A positive value (>0) has either been calculated or is a constant.
789 * Number of sub-items on the system.
790 * @nr2 is in fact the second dimension of a matrix of items, the first
791 * one being @nr. @nr is the number of lines, and @nr2 the number of columns.
792 * A negative value (-1) is the default value and indicates that this number
793 * has still not been calculated by the f_count2() function.
794 * A value of 0 means that this number has been calculated, but no sub-items have
796 * A positive value (>0) has either been calculated or is a constant.
798 * 1) IF @nr2 = 0 THEN @nr = 0
799 * Note: If @nr = 0, then @nr2 is undetermined (may be -1, 0 or >0).
800 * 2) IF @nr > 0 THEN @nr2 > 0.
801 * Note: If @nr2 > 0 then @nr is undetermined (may be -1, 0 or >0).
802 * 3) IF @nr <= 0 THEN @nr2 = -1 (this is the default value for @nr2,
803 * meaning that it has not been calculated).
807 * Maximum number of elements that sar can handle for this item.
808 * NB: The maximum number of elements that sar can handle for sub-items
814 * This is the size of the corresponding structure, as read from or written
815 * to a file, or read from or written by the data collector.
820 * This is the size of the corresponding structure as mapped into memory.
821 * @msize can be different from @fsize when data are read from or written to
822 * a data file from a different sysstat version.
826 * Optional flags for activity. This is eg. used when AO_MULTIPLE_OUTPUTS
828 * 0x0001 - 0x0080 : Multiple outputs (eg. AO_F_MEMORY, AO_F_SWAP...)
829 * 0x0100 - 0x8000 : If bit set then display complete header (hdr_line) for
830 * corresponding output
831 * 0x010000+ : Optional flags
833 unsigned int opt_flags;
835 * Buffers that will contain the statistics read. Its size is @nr * @nr2 * @size each.
837 * [0] and [1]: current/previous statistics values (used by sar).
838 * [2]: Used by sar to save first collected stats (used later to
843 * Bitmap for activities that need one. Such a bitmap is needed by activity
844 * if @bitmap is not NULL.
846 struct act_bitmap *bitmap;
851 ***************************************************************************
852 * Generic description of an output format for sadf (and sar).
853 ***************************************************************************
856 /* Type for all functions used by sadf to display stats in various formats */
857 #define __printf_funct_t void
858 #define __tm_funct_t char *
861 * Structure used to define a report.
862 * A XML-like report has the following format:
868 * | | Statistics block
871 * | | | Timestamp block
874 * | | | | Activity #1
880 * | | | | Activity #n
885 * | | Restart messages block
892 struct report_format {
894 * This variable contains the identification value (F_...) for this report format.
898 * Format options (FO_...).
900 unsigned int options;
902 * This function displays the report header
903 * (data displayed once at the beginning of the report).
905 __printf_funct_t (*f_header) (void *, int, char *, struct file_magic *, struct file_header *,
906 __nr_t, struct activity * [], unsigned int []);
908 * This function defines the statistics part of the report.
909 * Used only with textual (XML-like) reports.
911 __printf_funct_t (*f_statistics) (int *, int);
913 * This function defines the timestamp part of the report.
914 * Used only with textual (XML-like) reports.
916 __tm_funct_t (*f_timestamp) (void *, int, char *, char *, unsigned long long,
917 struct file_header *, unsigned int);
919 * This function displays the restart messages.
921 __printf_funct_t (*f_restart) (int *, int, char *, char *, int, struct file_header *,
924 * This function displays the comments.
926 __printf_funct_t (*f_comment) (int *, int, char *, char *, int, char *, struct file_header *);
929 /* Possible actions for functions used to display reports */
935 ***************************************************************************
936 * SVG output definitions
937 ***************************************************************************
945 * | | 4 | Graph title
955 * | | v |-------------------------------
957 * | v <---><------------------------------>
960 * v<---------------------------------------------------------------> Gap
962 * <--------------------------------------------------------------------->
967 #define SVG_G_XSIZE 720
969 #define SVG_M_XSIZE 70
971 #define SVG_V_XSIZE 1050
973 #define SVG_T_XSIZE 1060
976 #define SVG_G_YSIZE 200
978 #define SVG_H_YSIZE 50
980 #define SVG_M_YSIZE 50
982 #define SVG_T_YSIZE 310
984 #define SVG_V_YSIZE 300
986 /* Grid: Nr of horizontal lines */
987 #define SVG_H_GRIDNR 3
988 /* Grid: Nr of vertical lines */
989 #define SVG_V_GRIDNR 10
991 /* Block size used to allocate arrays for graphs data */
992 #define CHUNKSIZE 4096
994 /* Maximum number of views on a single row */
995 #define MAX_VIEWS_ON_A_ROW 6
997 #define SVG_LINE_GRAPH 1
998 #define SVG_BAR_GRAPH 2
1000 /* Maximum number of horizontal lines for the background grid */
1001 #define MAX_HLINES_NR 10
1006 ***************************************************************************
1007 * Macro functions definitions.
1009 * Note: Using 'do ... while' makes the macros safer to use
1010 * (remember that macro use is followed by a semicolon).
1011 ***************************************************************************
1014 /* Close file descriptors */
1015 #define CLOSE_ALL(_fd_) do { \
1020 #define CLOSE(_fd_) if (_fd_ >= 0) \
1025 ***************************************************************************
1026 * Various structure definitions.
1027 ***************************************************************************
1030 /* Structure for timestamps */
1040 ***************************************************************************
1041 * Functions prototypes.
1042 ***************************************************************************
1045 /* Functions used to count number of items */
1046 __nr_t wrap_get_cpu_nr
1047 (struct activity *);
1048 __nr_t wrap_get_irq_nr
1049 (struct activity *);
1050 __nr_t wrap_get_serial_nr
1051 (struct activity *);
1052 __nr_t wrap_get_disk_nr
1053 (struct activity *);
1054 __nr_t wrap_get_iface_nr
1055 (struct activity *);
1056 __nr_t wrap_get_fan_nr
1057 (struct activity *);
1058 __nr_t wrap_get_temp_nr
1059 (struct activity *);
1060 __nr_t wrap_get_in_nr
1061 (struct activity *);
1062 __nr_t wrap_get_freq_nr
1063 (struct activity *);
1064 __nr_t wrap_get_usb_nr
1065 (struct activity *);
1066 __nr_t wrap_get_filesystem_nr
1067 (struct activity *);
1068 __nr_t wrap_get_fchost_nr
1069 (struct activity *);
1071 /* Functions used to read activities statistics */
1072 __read_funct_t wrap_read_stat_cpu
1073 (struct activity *);
1074 __read_funct_t wrap_read_stat_pcsw
1075 (struct activity *);
1076 __read_funct_t wrap_read_stat_irq
1077 (struct activity *);
1078 __read_funct_t wrap_read_swap
1079 (struct activity *);
1080 __read_funct_t wrap_read_paging
1081 (struct activity *);
1082 __read_funct_t wrap_read_io
1083 (struct activity *);
1084 __read_funct_t wrap_read_meminfo
1085 (struct activity *);
1086 __read_funct_t wrap_read_kernel_tables
1087 (struct activity *);
1088 __read_funct_t wrap_read_loadavg
1089 (struct activity *);
1090 __read_funct_t wrap_read_tty_driver_serial
1091 (struct activity *);
1092 __read_funct_t wrap_read_disk
1093 (struct activity *);
1094 __read_funct_t wrap_read_net_dev
1095 (struct activity *);
1096 __read_funct_t wrap_read_net_edev
1097 (struct activity *);
1098 __read_funct_t wrap_read_net_nfs
1099 (struct activity *);
1100 __read_funct_t wrap_read_net_nfsd
1101 (struct activity *);
1102 __read_funct_t wrap_read_net_sock
1103 (struct activity *);
1104 __read_funct_t wrap_read_net_ip
1105 (struct activity *);
1106 __read_funct_t wrap_read_net_eip
1107 (struct activity *);
1108 __read_funct_t wrap_read_net_icmp
1109 (struct activity *);
1110 __read_funct_t wrap_read_net_eicmp
1111 (struct activity *);
1112 __read_funct_t wrap_read_net_tcp
1113 (struct activity *);
1114 __read_funct_t wrap_read_net_etcp
1115 (struct activity *);
1116 __read_funct_t wrap_read_net_udp
1117 (struct activity *);
1118 __read_funct_t wrap_read_net_sock6
1119 (struct activity *);
1120 __read_funct_t wrap_read_net_ip6
1121 (struct activity *);
1122 __read_funct_t wrap_read_net_eip6
1123 (struct activity *);
1124 __read_funct_t wrap_read_net_icmp6
1125 (struct activity *);
1126 __read_funct_t wrap_read_net_eicmp6
1127 (struct activity *);
1128 __read_funct_t wrap_read_net_udp6
1129 (struct activity *);
1130 __read_funct_t wrap_read_cpuinfo
1131 (struct activity *);
1132 __read_funct_t wrap_read_fan
1133 (struct activity *);
1134 __read_funct_t wrap_read_temp
1135 (struct activity *);
1136 __read_funct_t wrap_read_in
1137 (struct activity *);
1138 __read_funct_t wrap_read_meminfo_huge
1139 (struct activity *);
1140 __read_funct_t wrap_read_time_in_state
1141 (struct activity *);
1142 __read_funct_t wrap_read_bus_usb_dev
1143 (struct activity *);
1144 __read_funct_t wrap_read_filesystem
1145 (struct activity *);
1146 __read_funct_t wrap_read_fchost
1147 (struct activity *);
1148 __read_funct_t wrap_read_softnet
1149 (struct activity *);
1151 /* Other functions */
1152 void allocate_bitmaps
1153 (struct activity * []);
1154 void allocate_structures
1155 (struct activity * []);
1156 int check_alt_sa_dir
1159 (struct activity *, int, int, int);
1160 void check_file_actlst
1161 (int *, char *, struct activity * [], struct file_magic *, struct file_header *,
1162 struct file_activity **, unsigned int [], int, int *, int *);
1163 int check_net_dev_reg
1164 (struct activity *, int, int, int);
1165 int check_net_edev_reg
1166 (struct activity *, int, int, int);
1167 double compute_ifutil
1168 (struct stats_net_dev *, double, double);
1169 void copy_structures
1170 (struct activity * [], unsigned int [], struct record_header [], int, int);
1172 (struct tm *, struct tstamp *);
1173 void display_sa_file_version
1174 (FILE *, struct file_magic *);
1175 void enum_version_nr
1176 (struct file_magic *);
1178 (struct activity * []);
1179 void free_structures
1180 (struct activity * []);
1182 (struct activity * [], unsigned int, int);
1183 int get_activity_position
1184 (struct activity * [], unsigned int, int);
1186 (unsigned int, unsigned int, int);
1187 void get_file_timestamp_struct
1188 (unsigned int, struct tm *, struct file_header *);
1190 (struct record_header *, struct record_header *, unsigned int,
1191 unsigned long long *, unsigned long long *);
1192 void handle_invalid_sa_file
1193 (int *, struct file_magic *, char *, int);
1195 (unsigned long long, unsigned long long, int, long);
1197 (char * [], int *, struct activity * [], unsigned int *, int);
1199 (char * [], int *, struct activity * []);
1201 (char * [], int *, unsigned int *, struct activity * []);
1203 (char * [], int *, struct activity * []);
1205 (char * [], int *, struct activity * []);
1207 (char * [], int *, struct tstamp *, const char *);
1208 void print_report_hdr
1209 (unsigned int, struct tm *, struct file_header *, int);
1210 void print_sar_comment
1211 (int *, int, char *, char *, int, char *, struct file_header *);
1212 void print_sar_restart
1213 (int *, int, char *, char *, int, struct file_header *, unsigned int);
1214 int print_special_record
1215 (struct record_header *, unsigned int, struct tstamp *, struct tstamp *,
1216 int, int, struct tm *, struct tm *, char *, int, struct file_magic *,
1217 struct file_header *, struct activity * [], struct report_format *, int, int);
1218 void read_file_stat_bunch
1219 (struct activity * [], int, int, int, struct file_activity *, int, int);
1220 __nr_t read_vol_act_structures
1221 (int, struct activity * [], char *, struct file_magic *, unsigned int, int, int);
1222 int reallocate_vol_act_structures
1223 (struct activity * [], unsigned int, unsigned int);
1225 (int [], int [], void *, int);
1226 void replace_nonprintable_char
1229 (int, void *, int, int);
1230 int sa_get_record_timestamp_struct
1231 (unsigned int, struct record_header *, struct tm *, struct tm *);
1232 int sa_open_read_magic
1233 (int *, char *, struct file_magic *, int, int *);
1234 void select_all_activities
1235 (struct activity * []);
1236 void select_default_activity
1237 (struct activity * []);
1239 (unsigned char [], unsigned char, unsigned int);
1240 void set_default_file
1242 void set_hdr_rectime
1243 (unsigned int, struct tm *, struct file_header *);
1244 void set_record_timestamp_string
1245 (unsigned int, struct record_header *, char *, char *, int, struct tm *);
1247 (int [], void *, int);