2 * Copyright (c) 2008, 2009 Yahoo!, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The names of the authors may not be used to endorse or promote
14 * products derived from this software without specific prior written
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $FreeBSD: src/usr.sbin/mfiutil/mfi_evt.c,v 1.5 2011/06/09 19:52:28 bz Exp $
32 #include <sys/types.h>
33 #include <sys/errno.h>
43 mfi_event_get_info(int fd, struct mfi_evt_log_state *info, uint8_t *statusp)
46 return (mfi_dcmd_command(fd, MFI_DCMD_CTRL_EVENT_GETINFO, info,
47 sizeof(struct mfi_evt_log_state), NULL, 0, statusp));
51 mfi_get_events(int fd, struct mfi_evt_list *list, int num_events,
52 union mfi_evt filter, uint32_t start_seq, uint8_t *statusp)
58 mbox[1] = filter.word;
59 size = sizeof(struct mfi_evt_list) + sizeof(struct mfi_evt_detail) *
61 return (mfi_dcmd_command(fd, MFI_DCMD_CTRL_EVENT_GET, list, size,
62 (uint8_t *)&mbox, sizeof(mbox), statusp));
66 show_logstate(int ac, char **av)
68 struct mfi_evt_log_state info;
72 warnx("show logstate: extra arguments");
76 fd = mfi_open(mfi_unit);
83 if (mfi_event_get_info(fd, &info, NULL) < 0) {
85 warn("Failed to get event log info");
90 printf("mfi%d Event Log Sequence Numbers:\n", mfi_unit);
91 printf(" Newest Seq #: %u\n", info.newest_seq_num);
92 printf(" Oldest Seq #: %u\n", info.oldest_seq_num);
93 printf(" Clear Seq #: %u\n", info.clear_seq_num);
94 printf("Shutdown Seq #: %u\n", info.shutdown_seq_num);
95 printf(" Boot Seq #: %u\n", info.boot_seq_num);
101 MFI_COMMAND(show, logstate, show_logstate);
104 parse_seq(struct mfi_evt_log_state *info, char *arg, uint32_t *seq)
109 if (strcasecmp(arg, "newest") == 0) {
110 *seq = info->newest_seq_num;
113 if (strcasecmp(arg, "oldest") == 0) {
114 *seq = info->oldest_seq_num;
117 if (strcasecmp(arg, "clear") == 0) {
118 *seq = info->clear_seq_num;
121 if (strcasecmp(arg, "shutdown") == 0) {
122 *seq = info->shutdown_seq_num;
125 if (strcasecmp(arg, "boot") == 0) {
126 *seq = info->boot_seq_num;
129 val = strtol(arg, &cp, 0);
130 if (*cp != '\0' || val < 0) {
139 parse_locale(char *arg, uint16_t *locale)
144 if (strncasecmp(arg, "vol", 3) == 0 || strcasecmp(arg, "ld") == 0) {
145 *locale = MFI_EVT_LOCALE_LD;
148 if (strncasecmp(arg, "drive", 5) == 0 || strcasecmp(arg, "pd") == 0) {
149 *locale = MFI_EVT_LOCALE_PD;
152 if (strncasecmp(arg, "encl", 4) == 0) {
153 *locale = MFI_EVT_LOCALE_ENCL;
156 if (strncasecmp(arg, "batt", 4) == 0 ||
157 strncasecmp(arg, "bbu", 3) == 0) {
158 *locale = MFI_EVT_LOCALE_BBU;
161 if (strcasecmp(arg, "sas") == 0) {
162 *locale = MFI_EVT_LOCALE_SAS;
165 if (strcasecmp(arg, "ctrl") == 0 || strncasecmp(arg, "cont", 4) == 0) {
166 *locale = MFI_EVT_LOCALE_CTRL;
169 if (strcasecmp(arg, "config") == 0) {
170 *locale = MFI_EVT_LOCALE_CONFIG;
173 if (strcasecmp(arg, "cluster") == 0) {
174 *locale = MFI_EVT_LOCALE_CLUSTER;
177 if (strcasecmp(arg, "all") == 0) {
178 *locale = MFI_EVT_LOCALE_ALL;
181 val = strtol(arg, &cp, 0);
182 if (*cp != '\0' || val < 0 || val > 0xffff) {
191 parse_class(char *arg, int8_t *class)
196 if (strcasecmp(arg, "debug") == 0) {
197 *class = MFI_EVT_CLASS_DEBUG;
200 if (strncasecmp(arg, "prog", 4) == 0) {
201 *class = MFI_EVT_CLASS_PROGRESS;
204 if (strncasecmp(arg, "info", 4) == 0) {
205 *class = MFI_EVT_CLASS_INFO;
208 if (strncasecmp(arg, "warn", 4) == 0) {
209 *class = MFI_EVT_CLASS_WARNING;
212 if (strncasecmp(arg, "crit", 4) == 0) {
213 *class = MFI_EVT_CLASS_CRITICAL;
216 if (strcasecmp(arg, "fatal") == 0) {
217 *class = MFI_EVT_CLASS_FATAL;
220 if (strcasecmp(arg, "dead") == 0) {
221 *class = MFI_EVT_CLASS_DEAD;
224 val = strtol(arg, &cp, 0);
225 if (*cp != '\0' || val < -128 || val > 127) {
234 * The timestamp is the number of seconds since 00:00 Jan 1, 2000. If
235 * the bits in 24-31 are all set, then it is the number of seconds since
239 format_timestamp(uint32_t timestamp)
241 static char buffer[32];
246 if ((timestamp & 0xff000000) == 0xff000000) {
247 snprintf(buffer, sizeof(buffer), "boot + %us", timestamp &
253 /* Compute 00:00 Jan 1, 2000 offset. */
254 bzero(&tm, sizeof(tm));
256 tm.tm_year = (2000 - 1900);
260 snprintf(buffer, sizeof(buffer), "%us", timestamp);
263 t = base + timestamp;
264 strftime(buffer, sizeof(buffer), "%+", localtime(&t));
269 format_locale(uint16_t locale)
271 static char buffer[8];
274 case MFI_EVT_LOCALE_LD:
276 case MFI_EVT_LOCALE_PD:
278 case MFI_EVT_LOCALE_ENCL:
280 case MFI_EVT_LOCALE_BBU:
282 case MFI_EVT_LOCALE_SAS:
284 case MFI_EVT_LOCALE_CTRL:
286 case MFI_EVT_LOCALE_CONFIG:
288 case MFI_EVT_LOCALE_CLUSTER:
290 case MFI_EVT_LOCALE_ALL:
293 snprintf(buffer, sizeof(buffer), "0x%04x", locale);
299 format_class(int8_t class)
301 static char buffer[6];
304 case MFI_EVT_CLASS_DEBUG:
306 case MFI_EVT_CLASS_PROGRESS:
308 case MFI_EVT_CLASS_INFO:
310 case MFI_EVT_CLASS_WARNING:
312 case MFI_EVT_CLASS_CRITICAL:
314 case MFI_EVT_CLASS_FATAL:
316 case MFI_EVT_CLASS_DEAD:
319 snprintf(buffer, sizeof(buffer), "%d", class);
324 /* Simulates %D from kernel printf(9). */
326 simple_hex(void *ptr, size_t length, const char *separator)
334 printf("%02x", cp[0]);
335 for (i = 1; i < length; i++)
336 printf("%s%02x", separator, cp[i]);
340 pdrive_location(struct mfi_evt_pd *pd)
342 static char buffer[16];
344 if (pd->enclosure_index == 0)
345 snprintf(buffer, sizeof(buffer), "%02d(s%d)", pd->device_id,
348 snprintf(buffer, sizeof(buffer), "%02d(e%d/s%d)", pd->device_id,
349 pd->enclosure_index, pd->slot_number);
354 volume_name(int fd, struct mfi_evt_ld *ld)
357 return (mfi_volume_name(fd, ld->target_id));
360 /* Ripped from sys/dev/mfi/mfi.c. */
362 mfi_decode_evt(int fd, struct mfi_evt_detail *detail, int verbose)
365 printf("%5d (%s/%s/%s) - ", detail->seq, format_timestamp(detail->time),
366 format_locale(detail->evt_class.members.locale),
367 format_class(detail->evt_class.members.evt_class));
368 switch (detail->arg_type) {
369 case MR_EVT_ARGS_NONE:
371 case MR_EVT_ARGS_CDB_SENSE:
374 pdrive_location(&detail->args.cdb_sense.pd)
376 simple_hex(detail->args.cdb_sense.cdb,
377 detail->args.cdb_sense.cdb_len, ":");
379 simple_hex(detail->args.cdb_sense.sense,
380 detail->args.cdb_sense.sense_len, ":");
385 printf("VOL %s event: ", volume_name(fd, &detail->args.ld));
387 case MR_EVT_ARGS_LD_COUNT:
388 printf("VOL %s", volume_name(fd, &detail->args.ld_count.ld));
390 printf(" count %lld: ",
391 (long long)detail->args.ld_count.count);
395 case MR_EVT_ARGS_LD_LBA:
396 printf("VOL %s", volume_name(fd, &detail->args.ld_count.ld));
399 (long long)detail->args.ld_lba.lba);
403 case MR_EVT_ARGS_LD_OWNER:
404 printf("VOL %s", volume_name(fd, &detail->args.ld_count.ld));
406 printf(" owner changed: prior %d, new %d",
407 detail->args.ld_owner.pre_owner,
408 detail->args.ld_owner.new_owner);
412 case MR_EVT_ARGS_LD_LBA_PD_LBA:
413 printf("VOL %s", volume_name(fd, &detail->args.ld_count.ld));
415 printf(" lba %lld, physical drive PD %s lba %lld",
416 (long long)detail->args.ld_lba_pd_lba.ld_lba,
417 pdrive_location(&detail->args.ld_lba_pd_lba.pd),
418 (long long)detail->args.ld_lba_pd_lba.pd_lba);
422 case MR_EVT_ARGS_LD_PROG:
423 printf("VOL %s", volume_name(fd, &detail->args.ld_prog.ld));
425 printf(" progress %d%% in %ds",
426 detail->args.ld_prog.prog.progress/655,
427 detail->args.ld_prog.prog.elapsed_seconds);
431 case MR_EVT_ARGS_LD_STATE:
432 printf("VOL %s", volume_name(fd, &detail->args.ld_prog.ld));
434 printf(" state prior %s new %s",
435 mfi_ldstate(detail->args.ld_state.prev_state),
436 mfi_ldstate(detail->args.ld_state.new_state));
440 case MR_EVT_ARGS_LD_STRIP:
441 printf("VOL %s", volume_name(fd, &detail->args.ld_prog.ld));
443 printf(" strip %lld",
444 (long long)detail->args.ld_strip.strip);
450 printf("PD %s event: ",
451 pdrive_location(&detail->args.pd));
454 case MR_EVT_ARGS_PD_ERR:
456 printf("PD %s err %d: ",
457 pdrive_location(&detail->args.pd_err.pd),
458 detail->args.pd_err.err);
461 case MR_EVT_ARGS_PD_LBA:
463 printf("PD %s lba %lld: ",
464 pdrive_location(&detail->args.pd_lba.pd),
465 (long long)detail->args.pd_lba.lba);
468 case MR_EVT_ARGS_PD_LBA_LD:
470 printf("PD %s lba %lld VOL %s: ",
471 pdrive_location(&detail->args.pd_lba_ld.pd),
472 (long long)detail->args.pd_lba.lba,
473 volume_name(fd, &detail->args.pd_lba_ld.ld));
476 case MR_EVT_ARGS_PD_PROG:
478 printf("PD %s progress %d%% seconds %ds: ",
479 pdrive_location(&detail->args.pd_prog.pd),
480 detail->args.pd_prog.prog.progress/655,
481 detail->args.pd_prog.prog.elapsed_seconds);
484 case MR_EVT_ARGS_PD_STATE:
486 printf("PD %s state prior %s new %s: ",
487 pdrive_location(&detail->args.pd_prog.pd),
488 mfi_pdstate(detail->args.pd_state.prev_state),
489 mfi_pdstate(detail->args.pd_state.new_state));
492 case MR_EVT_ARGS_PCI:
494 printf("PCI 0x%04x 0x%04x 0x%04x 0x%04x: ",
495 detail->args.pci.venderId,
496 detail->args.pci.deviceId,
497 detail->args.pci.subVenderId,
498 detail->args.pci.subDeviceId);
501 case MR_EVT_ARGS_RATE:
503 printf("Rebuild rate %d: ", detail->args.rate);
506 case MR_EVT_ARGS_TIME:
508 printf("Adapter time %s; %d seconds since power on: ",
509 format_timestamp(detail->args.time.rtc),
510 detail->args.time.elapsedSeconds);
513 case MR_EVT_ARGS_ECC:
515 printf("Adapter ECC %x,%x: %s: ",
516 detail->args.ecc.ecar,
517 detail->args.ecc.elog,
518 detail->args.ecc.str);
523 printf("Type %d: ", detail->arg_type);
527 printf("%s\n", detail->description);
531 show_events(int ac, char **av)
533 struct mfi_evt_log_state info;
534 struct mfi_evt_list *list;
535 union mfi_evt filter;
539 uint32_t seq, start, stop;
541 int ch, error, fd, num_events, verbose;
544 fd = mfi_open(mfi_unit);
551 if (mfi_event_get_info(fd, &info, NULL) < 0) {
553 warn("Failed to get event log info");
558 /* Default settings. */
560 filter.members.reserved = 0;
561 filter.members.locale = MFI_EVT_LOCALE_ALL;
562 filter.members.evt_class = MFI_EVT_CLASS_WARNING;
563 start = info.boot_seq_num;
564 stop = info.newest_seq_num;
567 /* Parse any options. */
569 while ((ch = getopt(ac, av, "c:l:n:v")) != -1) {
572 if (parse_class(optarg, &filter.members.evt_class) < 0) {
574 warn("Error parsing event class");
580 if (parse_locale(optarg, &filter.members.locale) < 0) {
582 warn("Error parsing event locale");
588 val = strtol(optarg, &cp, 0);
589 if (*cp != '\0' || val <= 0) {
590 warnx("Invalid event count");
608 /* Determine buffer size and validate it. */
609 size = sizeof(struct mfi_evt_list) + sizeof(struct mfi_evt_detail) *
611 if (size > getpagesize()) {
612 warnx("Event count is too high");
617 /* Handle optional start and stop sequence numbers. */
619 warnx("show events: extra arguments");
623 if (ac > 0 && parse_seq(&info, av[0], &start) < 0) {
625 warn("Error parsing starting sequence number");
629 if (ac > 1 && parse_seq(&info, av[1], &stop) < 0) {
631 warn("Error parsing ending sequence number");
638 warnx("malloc failed");
642 for (seq = start;;) {
643 if (mfi_get_events(fd, list, num_events, filter, seq,
646 warn("Failed to fetch events");
651 if (status == MFI_STAT_NOT_FOUND) {
653 warnx("No matching events found");
656 if (status != MFI_STAT_OK) {
657 warnx("Error fetching events: %s", mfi_status(status));
663 for (i = 0; i < list->count; i++) {
665 * If this event is newer than 'stop_seq' then
666 * break out of the loop. Note that the log
667 * is a circular buffer so we have to handle
668 * the case that our stop point is earlier in
669 * the buffer than our start point.
671 if (list->event[i].seq >= stop) {
674 else if (list->event[i].seq < start)
677 mfi_decode_evt(fd, &list->event[i], verbose);
681 * XXX: If the event's seq # is the end of the buffer
682 * then this probably won't do the right thing. We
683 * need to know the size of the buffer somehow.
685 seq = list->event[list->count - 1].seq + 1;
694 MFI_COMMAND(show, events, show_events);