plugins/check_ide_smart.c

   1 /*
   2  *  check_ide-smart v.1 - hacked version of ide-smart for Nagios
   3  *  Copyright (C) 2000 Robert Dale <rdale@digital-mission.com>
   4  *
   5  *  Nagios - http://www.nagios.org
   6  *
   7  *  Notes:
   8  *         ide-smart has the same functionality as before. Some return
   9  *         values were changed, otherwise the --nagios option was added.
  10  *
  11  *         Run with:  check_ide-smart --nagios [-d] <DRIVE>
  12  *         Where DRIVE is an IDE drive, ie. /dev/hda, /dev/hdb, /dev/hdc
  13  *
  14  *           - Returns 0 on no errors
  15  *           - Returns 1 on advisories
  16  *           - Returns 2 on prefailure
  17  *           - Returns -1 not too often
  18  *
  19  *  ide-smart 1.3 - IDE S.M.A.R.T. checking tool
  20  *  Copyright (C) 1998-1999 Ragnar Hojland Espinosa <ragnar@lightside.dhis.org>
  21  *                1998      Gadi Oxman <gadio@netvision.net.il>
  22  *
  23  *  This program is free software; you can redistribute it and/or modify
  24  *  it under the terms of the GNU General Public License as published by
  25  *  the Free Software Foundation; either version 2 of the License, or
  26  *  (at your option) any later version.
  27  *
  28  *  This program is distributed in the hope that it will be useful,
  29  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  *  GNU General Public License for more details.
  32  *
  33  *  You should have received a copy of the GNU General Public License
  34  *  along with this program; if not, write to the Free Software
  35  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  36  *
  37  * $Id$
  38  */
  39
  40 const char *progname = "check_ide_smart";
  41 const char *revision = "$Revision$";
  42 const char *copyright = "2000-2004";
  43 const char *email = "nagiosplug-devel@lists.sourceforge.net";
  44
  45 #include "common.h"
  46 #include "utils.h"
  47
  48 void print_help (void);
  49 void print_usage (void);
  50
  51 #include <sys/stat.h>
  52 #include <sys/ioctl.h>
  53 #include <fcntl.h>
  54 #include <linux/hdreg.h>
  55 #include <linux/types.h>
  56 #include <errno.h>
  57
  58 #define NR_ATTRIBUTES   30
  59
  60 #ifndef TRUE
  61 #define TRUE 1
  62 #endif  /*  */
  63
  64 #define PREFAILURE 2
  65 #define ADVISORY 1
  66 #define OPERATIONAL 0
  67 #define UNKNOWN -1
  68
  69 typedef struct threshold_s
  70 {
  71         __u8 id;
  72         __u8 threshold;
  73         __u8 reserved[10];
  74 }
  75 __attribute__ ((packed)) threshold_t;
  76
  77 typedef struct thresholds_s
  78 {
  79         __u16 revision;
  80         threshold_t thresholds[NR_ATTRIBUTES];
  81         __u8 reserved[18];
  82         __u8 vendor[131];
  83         __u8 checksum;
  84 }
  85 __attribute__ ((packed)) thresholds_t;
  86
  87 typedef struct value_s
  88 {
  89         __u8 id;
  90         __u16 status;
  91         __u8 value;
  92         __u8 vendor[8];
  93 }
  94 __attribute__ ((packed)) value_t;
  95
  96 typedef struct values_s
  97 {
  98         __u16 revision;
  99         value_t values[NR_ATTRIBUTES];
 100         __u8 offline_status;
 101         __u8 vendor1;
 102         __u16 offline_timeout;
 103         __u8 vendor2;
 104         __u8 offline_capability;
 105         __u16 smart_capability;
 106         __u8 reserved[16];
 107         __u8 vendor[125];
 108         __u8 checksum;
 109 }
 110 __attribute__ ((packed)) values_t;
 111
 112 struct
 113 {
 114         __u8 value;
 115         char *text;
 116 }
 117
 118 offline_status_text[] =
 119         {
 120                 {0x00, "NeverStarted"},
 121                 {0x02, "Completed"},
 122                 {0x04, "Suspended"},
 123                 {0x05, "Aborted"},
 124                 {0x06, "Failed"},
 125                 {0, 0}
 126         };
 127
 128 struct
 129 {
 130         __u8 value;
 131         char *text;
 132 }
 133
 134 smart_command[] =
 135         {
 136                 {SMART_ENABLE, "SMART_ENABLE"},
 137                 {SMART_DISABLE, "SMART_DISABLE"},
 138                 {SMART_IMMEDIATE_OFFLINE, "SMART_IMMEDIATE_OFFLINE"},
 139                 {SMART_AUTO_OFFLINE, "SMART_AUTO_OFFLINE"}
 140         };
 141
 142
 143 /* Index to smart_command table, keep in order */
 144 enum SmartCommand
 145         { SMART_CMD_ENABLE,
 146                 SMART_CMD_DISABLE,
 147                 SMART_CMD_IMMEDIATE_OFFLINE,
 148                 SMART_CMD_AUTO_OFFLINE
 149         };
 150
 151 void print_values (values_t * p, thresholds_t * t);
 152 int smart_cmd_simple (int fd, enum SmartCommand command, __u8 val0, char show_error);
 153
 154 int
 155 main (int argc, char *argv[])
 156 {
 157         char *device = NULL;
 158         int command = -1;
 159         int o, longindex;
 160         int retval = 0;
 161
 162         thresholds_t thresholds;
 163         values_t values;
 164         int fd;
 165
 166         static struct option longopts[] = {
 167                 {"device", required_argument, 0, 'd'},
 168                 {"immediate", no_argument, 0, 'i'},
 169                 {"quiet-check", no_argument, 0, 'q'},
 170                 {"auto-on", no_argument, 0, '1'},
 171                 {"auto-off", no_argument, 0, '0'},
 172                 {"nagios", no_argument, 0, 'n'},
 173                 {"help", no_argument, 0, 'h'},
 174                 {"version", no_argument, 0, 'V'}, {0, 0, 0, 0}
 175         };
 176
 177         setlocale (LC_ALL, "");
 178         bindtextdomain (PACKAGE, LOCALEDIR);
 179         textdomain (PACKAGE);
 180
 181         while (1) {
 182
 183                 o = getopt_long (argc, argv, "+d:iq10nhV", longopts, &longindex);
 184
 185                 if (o == -1 || o == EOF || o == 1)
 186                         break;
 187
 188                 switch (o) {
 189                 case 'd':
 190                         device = optarg;
 191                         break;
 192                 case 'q':
 193                         command = 3;
 194                         break;
 195                 case 'i':
 196                         command = 2;
 197                         break;
 198                 case '1':
 199                         command = 1;
 200                         break;
 201                 case '0':
 202                         command = 0;
 203                         break;
 204                 case 'n':
 205                         command = 4;
 206                         break;
 207                 case 'h':
 208                         print_help ();
 209                         return STATE_OK;
 210                 case 'V':
 211                         print_revision (progname, revision);
 212                         return STATE_OK;
 213                 default:
 214                         usage2 (_("Unknown argument"), optarg);
 215                 }
 216         }
 217
 218         if (optind < argc) {
 219                 device = argv[optind];
 220         }
 221
 222         if (!device) {
 223                 print_help ();
 224                 return STATE_OK;
 225         }
 226
 227         fd = open (device, O_RDONLY);
 228
 229         if (fd < 0) {
 230                 printf (_("CRITICAL - Couldn't open device %s: %s\n"), device, strerror (errno));
 231                 return STATE_CRITICAL;
 232         }
 233
 234         if (smart_cmd_simple (fd, SMART_CMD_ENABLE, 0, TRUE)) {
 235                 printf (_("CRITICAL - SMART_CMD_ENABLE\n"));
 236                 return STATE_CRITICAL;
 237         }
 238
 239         switch (command) {
 240         case 0:
 241                 retval = smart_cmd_simple (fd, SMART_CMD_AUTO_OFFLINE, 0, TRUE);
 242                 break;
 243         case 1:
 244                 retval = smart_cmd_simple (fd, SMART_CMD_AUTO_OFFLINE, 0xF8, TRUE);
 245                 break;
 246         case 2:
 247                 retval = smart_cmd_simple (fd, SMART_CMD_IMMEDIATE_OFFLINE, 0, TRUE);
 248                 break;
 249         case 3:
 250                 smart_read_values (fd, &values);
 251                 smart_read_thresholds (fd, &thresholds);
 252                 retval = values_not_passed (&values, &thresholds);
 253                 break;
 254         case 4:
 255                 smart_read_values (fd, &values);
 256                 smart_read_thresholds (fd, &thresholds);
 257                 retval = nagios (&values, &thresholds);
 258                 break;
 259         default:
 260                 smart_read_values (fd, &values);
 261                 smart_read_thresholds (fd, &thresholds);
 262                 print_values (&values, &thresholds);
 263                 break;
 264         }
 265         close (fd);
 266         return retval;
 267 }
 268
 269
 270
 271 char *
 272 get_offline_text (int status)
 273 {
 274         int i;
 275         for (i = 0; offline_status_text[i].text; i++) {
 276                 if (offline_status_text[i].value == status) {
 277                         return offline_status_text[i].text;
 278                 }
 279         }
 280         return "UNKNOW";
 281 }
 282
 283
 284
 285 int
 286 smart_read_values (int fd, values_t * values)
 287 {
 288         int e;
 289         __u8 args[4 + 512];
 290         args[0] = WIN_SMART;
 291         args[1] = 0;
 292         args[2] = SMART_READ_VALUES;
 293         args[3] = 1;
 294         if (ioctl (fd, HDIO_DRIVE_CMD, &args)) {
 295                 e = errno;
 296                 printf (_("CRITICAL - SMART_READ_VALUES: %s\n"), strerror (errno));
 297                 return e;
 298         }
 299         memcpy (values, args + 4, 512);
 300         return 0;
 301 }
 302
 303
 304
 305 int
 306 values_not_passed (values_t * p, thresholds_t * t)
 307 {
 308         value_t * value = p->values;
 309         threshold_t * threshold = t->thresholds;
 310         int failed = 0;
 311         int passed = 0;
 312         int i;
 313         for (i = 0; i < NR_ATTRIBUTES; i++) {
 314                 if (value->id && threshold->id && value->id == threshold->id) {
 315                         if (value->value <= threshold->threshold) {
 316                                 ++failed;
 317                         }
 318                         else {
 319                                 ++passed;
 320                         }
 321                 }
 322                 ++value;
 323                 ++threshold;
 324         }
 325         return (passed ? -failed : 2);
 326 }
 327
 328
 329
 330 int
 331 nagios (values_t * p, thresholds_t * t)
 332 {
 333         value_t * value = p->values;
 334         threshold_t * threshold = t->thresholds;
 335         int status = OPERATIONAL;
 336         int prefailure = 0;
 337         int advisory = 0;
 338         int failed = 0;
 339         int passed = 0;
 340         int total = 0;
 341         int i;
 342         for (i = 0; i < NR_ATTRIBUTES; i++) {
 343                 if (value->id && threshold->id && value->id == threshold->id) {
 344                         if (value->value <= threshold->threshold) {
 345                                 ++failed;
 346                                 if (value->status & 1) {
 347                                         status = PREFAILURE;
 348                                         ++prefailure;
 349                                 }
 350                                 else {
 351                                         status = ADVISORY;
 352                                         ++advisory;
 353                                 }
 354                         }
 355                         else {
 356                                 ++passed;
 357                         }
 358                         ++total;
 359                 }
 360                 ++value;
 361                 ++threshold;
 362         }
 363         switch (status) {
 364         case PREFAILURE:
 365                 printf (_("CRITICAL - %d Harddrive PreFailure%cDetected! %d/%d tests failed.\n"),
 366                         prefailure,
 367                         prefailure > 1 ? 's' : ' ',
 368                         failed,
 369                   total);
 370                 status=STATE_CRITICAL;
 371                 break;
 372         case ADVISORY:
 373                 printf (_("WARNING - %d Harddrive Advisor%s Detected. %d/%d tests failed.\n"),
 374                         advisory,
 375                         advisory > 1 ? "ies" : "y",
 376                         failed,
 377                         total);
 378                 status=STATE_WARNING;
 379                 break;
 380         case OPERATIONAL:
 381                 printf (_("OK - Operational (%d/%d tests passed)\n"), passed, total);
 382                 status=STATE_OK;
 383                 break;
 384         default:
 385                 printf (_("ERROR - Status '%d' unkown. %d/%d tests passed\n"), status,
 386                                                 passed, total);
 387                 status = STATE_UNKNOWN;
 388                 break;
 389         }
 390         return status;
 391 }
 392
 393
 394
 395 void
 396 print_value (value_t * p, threshold_t * t)
 397 {
 398         printf ("Id=%3d, Status=%2d {%s , %s}, Value=%3d, Threshold=%3d, %s\n",
 399                                         p->id, p->status, p->status & 1 ? "PreFailure" : "Advisory   ",
 400                                         p->status & 2 ? "OnLine " : "OffLine", p->value, t->threshold,
 401                                         p->value > t->threshold ? "Passed" : "Failed");
 402 }
 403
 404
 405
 406 void
 407 print_values (values_t * p, thresholds_t * t)
 408 {
 409         value_t * value = p->values;
 410         threshold_t * threshold = t->thresholds;
 411         int i;
 412         for (i = 0; i < NR_ATTRIBUTES; i++) {
 413                 if (value->id && threshold->id && value->id == threshold->id) {
 414                         print_value (value++, threshold++);
 415                 }
 416         }
 417         printf
 418                 (_("OffLineStatus=%d {%s}, AutoOffLine=%s, OffLineTimeout=%d minutes\n"),
 419                  p->offline_status,
 420                  get_offline_text (p->offline_status & 0x7f),
 421                  (p->offline_status & 0x80 ? "Yes" : "No"),
 422                  p->offline_timeout / 60);
 423         printf
 424                 (_("OffLineCapability=%d {%s %s %s}\n"),
 425                  p->offline_capability,
 426                  p->offline_capability & 1 ? "Immediate" : "",
 427                  p->offline_capability & 2 ? "Auto" : "",
 428                  p->offline_capability & 4 ? "AbortOnCmd" : "SuspendOnCmd");
 429         printf
 430                 (_("SmartRevision=%d, CheckSum=%d, SmartCapability=%d {%s %s}\n"),
 431                  p->revision,
 432                  p->checksum,
 433                  p->smart_capability,
 434                  p->smart_capability & 1 ? "SaveOnStandBy" : "",
 435                  p->smart_capability & 2 ? "AutoSave" : "");
 436 }
 437
 438
 439
 440 void
 441 print_thresholds (thresholds_t * p)
 442 {
 443         threshold_t * threshold = p->thresholds;
 444         int i;
 445         printf ("\n");
 446         printf ("SmartRevision=%d\n", p->revision);
 447         for (i = 0; i < NR_ATTRIBUTES; i++) {
 448                 if (threshold->id) {
 449                         printf ("Id=%3d, Threshold=%3d\n", threshold->id,
 450                                                         threshold->threshold); }
 451                 ++threshold;
 452         }
 453         printf ("CheckSum=%d\n", p->checksum);
 454 }
 455
 456 int
 457 smart_cmd_simple (int fd, enum SmartCommand command, __u8 val0, char show_error)
 458 {
 459         int e = 0;
 460         __u8 args[4];
 461         args[0] = WIN_SMART;
 462         args[1] = val0;
 463         args[2] = smart_command[command].value;
 464         args[3] = 0;
 465         if (ioctl (fd, HDIO_DRIVE_CMD, &args)) {
 466                 e = errno;
 467                 if (show_error) {
 468                         printf (_("CRITICAL - %s: %s\n"), smart_command[command].text, strerror (errno));
 469                 }
 470         }
 471         return e;
 472 }
 473
 474
 475
 476 int
 477 smart_read_thresholds (int fd, thresholds_t * thresholds)
 478 {
 479         int e;
 480         __u8 args[4 + 512];
 481         args[0] = WIN_SMART;
 482   args[1] = 0;
 483   args[2] = SMART_READ_THRESHOLDS;
 484   args[3] = 1;
 485         if (ioctl (fd, HDIO_DRIVE_CMD, &args)) {
 486                 e = errno;
 487                 printf (_("CRITICAL - SMART_READ_THRESHOLDS: %s\n"), strerror (errno));
 488                 return e;
 489         }
 490         memcpy (thresholds, args + 4, 512);
 491         return 0;
 492 }
 493
 494
 495 void
 496 print_help (void)
 497 {
 498         print_revision (progname, revision);
 499
 500         printf ("Nagios feature - 1999 Robert Dale <rdale@digital-mission.com>\n");
 501         printf ("(C) 1999 Ragnar Hojland Espinosa <ragnar@lightside.dhis.org>\n");
 502         printf (COPYRIGHT, copyright, email);
 503
 504         printf(_("This plugin checks a local hard drive with the (Linux specific) SMART interface [http://smartlinux.sourceforge.net/smart/index.php].\n\n"));
 505
 506         printf ("\
 507 Usage: %s [OPTION] [DEVICE]\n\
 508  -d, --device=DEVICE\n\
 509     Select device DEVICE\n\
 510     Note: if the device is selected with this option, _no_ other options are accepted\n\
 511  -i, --immediate\n\
 512     Perform immediately offline tests\n\
 513  -q, --quiet-check\n\
 514     Returns the number of failed tests\n\
 515  -1, --auto-on\n\
 516     Turn on automatic offline tests\n\
 517  -0, --auto-off\n\
 518     Turn off automatic offline tests\n\
 519  -n, --nagios\n\
 520     Output suitable for Nagios\n", progname);
 521 }
 522
 523
 524 void
 525 print_usage (void)
 526 {
 527         printf ("\
 528 Usage: %s [-d <device>] [-i <immediate>] [-q quiet] [-1 <auto-on>]\n\
 529                         [-O <auto-off>] [-n <nagios>]\n", progname);
 530 }