1 /*****************************************************************************
3 * Monitoring check_swap plugin
6 * Copyright (c) 2000 Karl DeBisschop (kdebisschop@users.sourceforge.net)
7 * Copyright (c) 2000-2024 Monitoring Plugins Development Team
11 * This file contains the check_swap plugin
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 *****************************************************************************/
30 const char *progname
= "check_swap";
31 const char *copyright
= "2000-2024";
32 const char *email
= "devel@monitoring-plugins.org";
38 #ifdef HAVE_DECL_SWAPCTL
39 # ifdef HAVE_SYS_PARAM_H
40 # include <sys/param.h>
42 # ifdef HAVE_SYS_SWAP_H
43 # include <sys/swap.h>
45 # ifdef HAVE_SYS_STAT_H
46 # include <sys/stat.h>
50 #ifndef SWAP_CONVERSION
51 # define SWAP_CONVERSION 1
59 int check_swap (float free_swap_mb
, float total_swap_mb
);
60 int process_arguments (int argc
, char **argv
);
61 int validate_arguments (void);
62 void print_usage (void);
63 void print_help (void);
68 bool allswaps
= false;
69 int no_swap_state
= STATE_CRITICAL
;
72 main (int argc
, char **argv
)
74 unsigned int percent_used
, percent
;
75 uint64_t total_swap_mb
= 0, used_swap_mb
= 0, free_swap_mb
= 0;
76 uint64_t dsktotal_mb
= 0, dskused_mb
= 0, dskfree_mb
= 0;
78 int result
= STATE_UNKNOWN
;
79 char input_buffer
[MAX_INPUT_BUFFER
];
80 #ifdef HAVE_PROC_MEMINFO
83 int conv_factor
= SWAP_CONVERSION
;
89 # ifdef HAVE_DECL_SWAPCTL
90 int i
=0, nswaps
=0, swapctl_res
=0;
91 # ifdef CHECK_SWAP_SWAPCTL_SVR4
95 # ifdef CHECK_SWAP_SWAPCTL_BSD
97 # endif /* CHECK_SWAP_SWAPCTL_BSD */
98 # endif /* CHECK_SWAP_SWAPCTL_SVR4 */
99 # endif /* HAVE_DECL_SWAPCTL */
105 setlocale (LC_ALL
, "");
106 bindtextdomain (PACKAGE
, LOCALEDIR
);
107 textdomain (PACKAGE
);
109 status
= strdup ("");
111 /* Parse extra opts if any */
112 argv
=np_extra_opts (&argc
, argv
, progname
);
114 if (process_arguments (argc
, argv
) == ERROR
)
115 usage4 (_("Could not parse arguments"));
117 #ifdef HAVE_PROC_MEMINFO
119 printf("Reading PROC_MEMINFO at %s\n", PROC_MEMINFO
);
121 fp
= fopen (PROC_MEMINFO
, "r");
122 while (fgets (input_buffer
, MAX_INPUT_BUFFER
- 1, fp
)) {
124 * The following sscanf call looks for a line looking like: "Swap: 123 123 123"
125 * On which kind of system this format exists, I can not say, but I wanted to
126 * document this for people who are not adapt with sscanf anymore, like me
128 if (sscanf (input_buffer
, "%*[S]%*[w]%*[a]%*[p]%*[:] %lu %lu %lu", &dsktotal_mb
, &dskused_mb
, &dskfree_mb
) == 3) {
129 dsktotal_mb
= dsktotal_mb
/ (1024 * 1024); /* Apply conversion */
130 dskused_mb
= dskused_mb
/ (1024 * 1024);
131 dskfree_mb
= dskfree_mb
/ (1024 * 1024);
132 total_swap_mb
+= dsktotal_mb
;
133 used_swap_mb
+= dskused_mb
;
134 free_swap_mb
+= dskfree_mb
;
136 if (dsktotal_mb
== 0)
139 percent
= 100 * (((double) dskused_mb
) / ((double) dsktotal_mb
));
140 result
= max_state (result
, check_swap (dskfree_mb
, dsktotal_mb
));
142 xasprintf (&status
, "%s [%lu (%d%%)]", status
, dskfree_mb
, 100 - percent
);
147 * The following sscanf call looks for lines looking like: "SwapTotal: 123" and "SwapFree: 123"
148 * This format exists at least on Debian Linux with a 5.* kernel
150 else if (sscanf (input_buffer
, "%*[S]%*[w]%*[a]%*[p]%[TotalFreCchd]%*[:] %lu %*[k]%*[B]", str
, &tmp_KB
)) {
152 printf("Got %s with %lu\n", str
, tmp_KB
);
154 /* I think this part is always in Kb, so convert to mb */
155 if (strcmp ("Total", str
) == 0) {
156 dsktotal_mb
= tmp_KB
/ 1024;
158 else if (strcmp ("Free", str
) == 0) {
159 dskfree_mb
= dskfree_mb
+ tmp_KB
/ 1024;
161 else if (strcmp ("Cached", str
) == 0) {
162 dskfree_mb
= dskfree_mb
+ tmp_KB
/ 1024;
167 dskused_mb
= dsktotal_mb
- dskfree_mb
;
168 total_swap_mb
= dsktotal_mb
;
169 used_swap_mb
= dskused_mb
;
170 free_swap_mb
= dskfree_mb
;
173 xasprintf(&swap_command
, "%s", SWAP_COMMAND
);
174 xasprintf(&swap_format
, "%s", SWAP_FORMAT
);
176 /* These override the command used if a summary (and thus ! allswaps) is required */
177 /* The summary flag returns more accurate information about swap usage on these OSes */
180 xasprintf(&swap_command
, "%s", "/usr/sbin/lsps -s");
181 xasprintf(&swap_format
, "%s", "%lu%*s %lu");
187 printf (_("Command: %s\n"), swap_command
);
189 printf (_("Format: %s\n"), swap_format
);
191 child_process
= spopen (swap_command
);
192 if (child_process
== NULL
) {
193 printf (_("Could not open pipe: %s\n"), swap_command
);
194 return STATE_UNKNOWN
;
197 child_stderr
= fdopen (child_stderr_array
[fileno (child_process
)], "r");
198 if (child_stderr
== NULL
)
199 printf (_("Could not open stderr for %s\n"), swap_command
);
201 sprintf (str
, "%s", "");
203 fgets (input_buffer
, MAX_INPUT_BUFFER
- 1, child_process
);
204 if (strcmp (swap_format
, "") == 0) {
205 temp_buffer
= strtok (input_buffer
, " \n");
206 while (temp_buffer
) {
207 if (strstr (temp_buffer
, "blocks"))
208 sprintf (str
, "%s %s", str
, "%lu");
209 else if (strstr (temp_buffer
, "dskfree"))
210 sprintf (str
, "%s %s", str
, "%lu");
212 sprintf (str
, "%s %s", str
, "%*s");
213 temp_buffer
= strtok (NULL
, " \n");
217 /* If different swap command is used for summary switch, need to read format differently */
220 fgets(input_buffer
, MAX_INPUT_BUFFER
- 1, child_process
); /* Ignore first line */
221 sscanf (input_buffer
, swap_format
, &total_swap_mb
, &used_swap_mb
);
222 free_swap_mb
= total_swap_mb
* (100 - used_swap_mb
) /100;
223 used_swap_mb
= total_swap_mb
- free_swap_mb
;
225 printf (_("total=%.0f, used=%.0f, free=%.0f\n"), total_swap_mb
, used_swap_mb
, free_swap_mb
);
228 while (fgets (input_buffer
, MAX_INPUT_BUFFER
- 1, child_process
)) {
229 sscanf (input_buffer
, swap_format
, &dsktotal_mb
, &dskfree_mb
);
231 dsktotal_mb
= dsktotal_mb
/ conv_factor
;
232 /* AIX lists percent used, so this converts to dskfree in MBs */
234 dskfree_mb
= dsktotal_mb
* (100 - dskfree_mb
) / 100;
236 dskfree_mb
= dskfree_mb
/ conv_factor
;
239 printf (_("total=%.0f, free=%.0f\n"), dsktotal_mb
, dskfree_mb
);
241 dskused_mb
= dsktotal_mb
- dskfree_mb
;
242 total_swap_mb
+= dsktotal_mb
;
243 used_swap_mb
+= dskused_mb
;
244 free_swap_mb
+= dskfree_mb
;
246 percent
= 100 * (((double) dskused_mb
) / ((double) dsktotal_mb
));
247 result
= max_state (result
, check_swap (dskfree_mb
, dsktotal_mb
));
249 xasprintf (&status
, "%s [%.0f (%d%%)]", status
, dskfree_mb
, 100 - percent
);
256 /* If we get anything on STDERR, at least set warning */
257 while (fgets (input_buffer
, MAX_INPUT_BUFFER
- 1, child_stderr
))
258 result
= max_state (result
, STATE_WARNING
);
261 (void) fclose (child_stderr
);
264 if (spclose (child_process
))
265 result
= max_state (result
, STATE_WARNING
);
267 # ifdef CHECK_SWAP_SWAPCTL_SVR4
269 /* get the number of active swap devices */
270 if((nswaps
=swapctl(SC_GETNSWP
, NULL
))== -1)
271 die(STATE_UNKNOWN
, _("Error getting swap devices\n") );
274 die(STATE_OK
, _("SWAP OK: No swap devices defined\n"));
277 printf("Found %d swap device(s)\n", nswaps
);
279 /* initialize swap table + entries */
280 tbl
=(swaptbl_t
*)malloc(sizeof(swaptbl_t
)+(sizeof(swapent_t
)*nswaps
));
283 die(STATE_UNKNOWN
, _("malloc() failed!\n"));
285 memset(tbl
, 0, sizeof(swaptbl_t
)+(sizeof(swapent_t
)*nswaps
));
287 for(i
=0;i
<nswaps
;i
++){
288 if((tbl
->swt_ent
[i
].ste_path
=(char*)malloc(sizeof(char)*MAXPATHLEN
)) == NULL
)
289 die(STATE_UNKNOWN
, _("malloc() failed!\n"));
292 /* and now, tally 'em up */
293 swapctl_res
=swapctl(SC_LIST
, tbl
);
295 perror(_("swapctl failed: "));
296 die(STATE_UNKNOWN
, _("Error in swapctl call\n"));
299 for(i
=0;i
<nswaps
;i
++){
300 dsktotal_mb
= (float) tbl
->swt_ent
[i
].ste_pages
/ SWAP_CONVERSION
;
301 dskfree_mb
= (float) tbl
->swt_ent
[i
].ste_free
/ SWAP_CONVERSION
;
302 dskused_mb
= ( dsktotal_mb
- dskfree_mb
);
305 printf ("dsktotal_mb=%.0f dskfree_mb=%.0f dskused_mb=%.0f\n", dsktotal_mb
, dskfree_mb
, dskused_mb
);
307 if(allswaps
&& dsktotal_mb
> 0){
308 percent
= 100 * (((double) dskused_mb
) / ((double) dsktotal_mb
));
309 result
= max_state (result
, check_swap (dskfree_mb
, dsktotal_mb
));
311 xasprintf (&status
, "%s [%.0f (%d%%)]", status
, dskfree_mb
, 100 - percent
);
315 total_swap_mb
+= dsktotal_mb
;
316 free_swap_mb
+= dskfree_mb
;
317 used_swap_mb
+= dskused_mb
;
320 /* and clean up after ourselves */
321 for(i
=0;i
<nswaps
;i
++){
322 free(tbl
->swt_ent
[i
].ste_path
);
326 # ifdef CHECK_SWAP_SWAPCTL_BSD
328 /* get the number of active swap devices */
329 nswaps
=swapctl(SWAP_NSWAP
, NULL
, 0);
331 /* initialize swap table + entries */
332 ent
=(struct swapent
*)malloc(sizeof(struct swapent
)*nswaps
);
334 /* and now, tally 'em up */
335 swapctl_res
=swapctl(SWAP_STATS
, ent
, nswaps
);
337 perror(_("swapctl failed: "));
338 die(STATE_UNKNOWN
, _("Error in swapctl call\n"));
341 for(i
=0;i
<nswaps
;i
++){
342 dsktotal_mb
= (float) ent
[i
].se_nblks
/ conv_factor
;
343 dskused_mb
= (float) ent
[i
].se_inuse
/ conv_factor
;
344 dskfree_mb
= ( dsktotal_mb
- dskused_mb
);
346 if(allswaps
&& dsktotal_mb
> 0){
347 percent
= 100 * (((double) dskused_mb
) / ((double) dsktotal_mb
));
348 result
= max_state (result
, check_swap(dskfree_mb
, dsktotal_mb
));
350 xasprintf (&status
, "%s [%.0f (%d%%)]", status
, dskfree_mb
, 100 - percent
);
354 total_swap_mb
+= dsktotal_mb
;
355 free_swap_mb
+= dskfree_mb
;
356 used_swap_mb
+= dskused_mb
;
359 /* and clean up after ourselves */
362 # endif /* CHECK_SWAP_SWAPCTL_BSD */
363 # endif /* CHECK_SWAP_SWAPCTL_SVR4 */
364 # endif /* HAVE_SWAP */
365 #endif /* HAVE_PROC_MEMINFO */
367 /* if total_swap_mb == 0, let's not divide by 0 */
369 percent_used
= 100 * ((double) used_swap_mb
) / ((double) total_swap_mb
);
372 status
= "- Swap is either disabled, not present, or of zero size. ";
375 result
= max_state (result
, check_swap(free_swap_mb
, total_swap_mb
));
376 printf (_("SWAP %s - %d%% free (%dMB out of %dMB) %s|"),
378 (100 - percent_used
), (int) free_swap_mb
, (int) total_swap_mb
, status
);
380 uint64_t warn_print
= warn
.value
;
381 if (warn
.is_percentage
) warn_print
= warn
.value
* (total_swap_mb
*1024 *1024/100);
382 uint64_t crit_print
= crit
.value
;
383 if (crit
.is_percentage
) crit_print
= crit
.value
* (total_swap_mb
*1024 *1024/100);
385 puts (perfdata_uint64 ("swap", free_swap_mb
*1024 *1024, "B",
389 true, (long) total_swap_mb
* 1024 * 1024));
396 check_swap(float free_swap_mb
, float total_swap_mb
)
399 if (!total_swap_mb
) return no_swap_state
;
401 uint64_t free_swap
= free_swap_mb
* (1024 * 1024); /* Convert back to bytes as warn and crit specified in bytes */
402 uint64_t usage_percentage
= ((total_swap_mb
- free_swap_mb
) / total_swap_mb
) * 100;
404 if (warn
.value
|| crit
.value
) { /* Thresholds defined */
405 if (!crit
.is_percentage
&& crit
.value
>= free_swap
) return STATE_CRITICAL
;
406 if (!warn
.is_percentage
&& warn
.value
>= free_swap
) return STATE_WARNING
;
408 if (crit
.is_percentage
&&
410 usage_percentage
>= (100 - crit
.value
))
412 return STATE_CRITICAL
;
415 if (warn
.is_percentage
&&
417 usage_percentage
>= (100 - warn
.value
))
419 return STATE_WARNING
;
423 } else { /* Without thresholds */
430 /* process command-line arguments */
432 process_arguments (int argc
, char **argv
)
434 int c
= 0; /* option character */
437 static struct option longopts
[] = {
438 {"warning", required_argument
, 0, 'w'},
439 {"critical", required_argument
, 0, 'c'},
440 {"allswaps", no_argument
, 0, 'a'},
441 {"no-swap", required_argument
, 0, 'n'},
442 {"verbose", no_argument
, 0, 'v'},
443 {"version", no_argument
, 0, 'V'},
444 {"help", no_argument
, 0, 'h'},
449 c
= getopt_long (argc
, argv
, "+?Vvhac:w:n:", longopts
, &option
);
451 if (c
== -1 || c
== EOF
)
455 case 'w': /* warning size threshold */
458 * We expect either a positive integer value without a unit, which means
459 * the unit is Bytes or a positive integer value and a percentage sign (%),
460 * which means the value must be with 0 and 100 and is relative to the total swap
463 length
= strlen(optarg
);
465 if (optarg
[length
- 1] == '%') {
466 /* It's percentage */
467 warn
.is_percentage
= true;
468 optarg
[length
- 1] = '\0';
469 if (is_uint64(optarg
, &warn
.value
)) {
470 if (warn
.value
> 100) {
471 usage4 (_("Warning threshold percentage must be <= 100!"));
477 warn
.is_percentage
= false;
478 if (is_uint64(optarg
, &warn
.value
)) {
481 usage4 (_("Warning threshold be positive integer or percentage!"));
485 case 'c': /* critical size threshold */
488 * We expect either a positive integer value without a unit, which means
489 * the unit is Bytes or a positive integer value and a percentage sign (%),
490 * which means the value must be with 0 and 100 and is relative to the total swap
493 length
= strlen(optarg
);
495 if (optarg
[length
- 1] == '%') {
496 /* It's percentage */
497 crit
.is_percentage
= true;
498 optarg
[length
- 1] = '\0';
499 if (is_uint64(optarg
, &crit
.value
)) {
500 if (crit
.value
> 100) {
501 usage4 (_("Critical threshold percentage must be <= 100!"));
507 crit
.is_percentage
= false;
508 if (is_uint64(optarg
, &crit
.value
)) {
511 usage4 (_("Critical threshold be positive integer or percentage!"));
515 case 'a': /* all swap */
519 if ((no_swap_state
= mp_translate_state(optarg
)) == ERROR
) {
520 usage4 (_("no-swap result must be a valid state name (OK, WARNING, CRITICAL, UNKNOWN) or integer (0-3)."));
523 case 'v': /* verbose */
526 case 'V': /* version */
527 print_revision (progname
, NP_VERSION
);
528 exit (STATE_UNKNOWN
);
531 exit (STATE_UNKNOWN
);
532 case '?': /* error */
539 return validate_arguments ();
541 return validate_arguments ();
547 validate_arguments (void)
549 if ((warn
.is_percentage
== crit
.is_percentage
) && (warn
.value
< crit
.value
)) {
550 /* This is NOT triggered if warn and crit are different units, e.g warn is percentage
551 * and crit is absolute. We cannot determine the condition at this point since we
552 * dont know the value of total swap yet
554 usage4(_("Warning should be more than critical"));
564 print_revision (progname
, NP_VERSION
);
566 printf (_(COPYRIGHT
), copyright
, email
);
568 printf ("%s\n", _("Check swap space on local machine."));
574 printf (UT_HELP_VRSN
);
575 printf (UT_EXTRA_OPTS
);
577 printf (" %s\n", "-w, --warning=INTEGER");
578 printf (" %s\n", _("Exit with WARNING status if less than INTEGER bytes of swap space are free"));
579 printf (" %s\n", "-w, --warning=PERCENT%");
580 printf (" %s\n", _("Exit with WARNING status if less than PERCENT of swap space is free"));
581 printf (" %s\n", "-c, --critical=INTEGER");
582 printf (" %s\n", _("Exit with CRITICAL status if less than INTEGER bytes of swap space are free"));
583 printf (" %s\n", "-c, --critical=PERCENT%");
584 printf (" %s\n", _("Exit with CRITICAL status if less than PERCENT of swap space is free"));
585 printf (" %s\n", "-a, --allswaps");
586 printf (" %s\n", _("Conduct comparisons for all swap partitions, one by one"));
587 printf (" %s\n", "-n, --no-swap=<ok|warning|critical|unknown>");
588 printf (" %s %s\n", _("Resulting state when there is no swap regardless of thresholds. Default:"), state_text(no_swap_state
));
592 printf ("%s\n", _("Notes:"));
593 printf (" %s\n", _("Both INTEGER and PERCENT thresholds can be specified, they are all checked."));
594 printf (" %s\n", _("Without thresholds, the plugin shows free swap space and performance data, but always returns OK."));
595 printf (" %s\n", _("On AIX, if -a is specified, uses lsps -a, otherwise uses lsps -s."));
604 printf ("%s\n", _("Usage:"));
605 printf (" %s [-av] [-w <percent_free>%%] [-c <percent_free>%%]\n",progname
);
606 printf (" [-w <bytes_free>] [-c <bytes_free>] [-n <state>]\n");