4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
27 * Fault Management Architecture (FMA) Resource and Protocol Support
29 * The routines contained herein provide services to support kernel subsystems
30 * in publishing fault management telemetry (see PSARC 2002/412 and 2003/089).
32 * Name-Value Pair Lists
34 * The embodiment of an FMA protocol element (event, fmri or authority) is a
35 * name-value pair list (nvlist_t). FMA-specific nvlist construtor and
36 * destructor functions, fm_nvlist_create() and fm_nvlist_destroy(), are used
37 * to create an nvpair list using custom allocators. Callers may choose to
38 * allocate either from the kernel memory allocator, or from a preallocated
39 * buffer, useful in constrained contexts like high-level interrupt routines.
41 * Protocol Event and FMRI Construction
43 * Convenience routines are provided to construct nvlist events according to
44 * the FMA Event Protocol and Naming Schema specification for ereports and
45 * FMRIs for the dev, cpu, hc, mem, legacy hc and de schemes.
49 * Routines to generate ENA formats 0, 1 and 2 are available as well as
50 * routines to increment formats 1 and 2. Individual fields within the
51 * ENA are extractable via fm_ena_time_get(), fm_ena_id_get(),
52 * fm_ena_format_get() and fm_ena_gen_get().
55 #include <sys/types.h>
57 #include <sys/sysevent.h>
58 #include <sys/sysevent_impl.h>
59 #include <sys/nvpair.h>
60 #include <sys/cmn_err.h>
61 #include <sys/cpuvar.h>
62 #include <sys/sysmacros.h>
63 #include <sys/systm.h>
64 #include <sys/ddifm.h>
65 #include <sys/ddifm_impl.h>
67 #include <sys/dumphdr.h>
68 #include <sys/compress.h>
69 #include <sys/cpuvar.h>
70 #include <sys/console.h>
71 #include <sys/panic.h>
73 #include <sys/sunddi.h>
74 #include <sys/systeminfo.h>
75 #include <sys/sysevent/eventdefs.h>
76 #include <sys/fm/util.h>
77 #include <sys/fm/protocol.h>
80 * URL and SUNW-MSG-ID value to display for fm_panic(), defined below. These
81 * values must be kept in sync with the FMA source code in usr/src/cmd/fm.
83 static const char *fm_url = "http://www.sun.com/msg";
84 static const char *fm_msgid = "SUNOS-8000-0G";
85 static char *volatile fm_panicstr = NULL;
87 errorq_t *ereport_errorq;
88 void *ereport_dumpbuf;
89 size_t ereport_dumplen;
91 static uint_t ereport_chanlen = ERPT_EVCH_MAX;
92 static evchan_t *ereport_chan = NULL;
93 static ulong_t ereport_qlen = 0;
94 static size_t ereport_size = 0;
95 static int ereport_cols = 80;
98 * Common fault management kstats to record ereport generation
103 kstat_named_t erpt_dropped; /* num erpts dropped on post */
104 kstat_named_t erpt_set_failed; /* num erpt set failures */
105 kstat_named_t fmri_set_failed; /* num fmri set failures */
106 kstat_named_t payload_set_failed; /* num payload set failures */
109 static struct erpt_kstat erpt_kstat_data = {
110 { "erpt-dropped", KSTAT_DATA_UINT64 },
111 { "erpt-set-failed", KSTAT_DATA_UINT64 },
112 { "fmri-set-failed", KSTAT_DATA_UINT64 },
113 { "payload-set-failed", KSTAT_DATA_UINT64 }
118 fm_drain(void *private, void *data, errorq_elem_t *eep)
120 nvlist_t *nvl = errorq_elem_nvl(ereport_errorq, eep);
123 (void) fm_ereport_post(nvl, EVCH_TRYHARD);
133 (void) sysevent_evc_bind(FM_ERROR_CHAN,
134 &ereport_chan, EVCH_CREAT | EVCH_HOLD_PEND);
136 (void) sysevent_evc_control(ereport_chan,
137 EVCH_SET_CHAN_LEN, &ereport_chanlen);
139 if (ereport_qlen == 0)
140 ereport_qlen = ERPT_MAX_ERRS * MAX(max_ncpus, 4);
142 if (ereport_size == 0)
143 ereport_size = ERPT_DATA_SZ;
145 ereport_errorq = errorq_nvcreate("fm_ereport_queue",
146 (errorq_func_t)fm_drain, NULL, ereport_qlen, ereport_size,
147 FM_ERR_PIL, ERRORQ_VITAL);
148 if (ereport_errorq == NULL)
149 panic("failed to create required ereport error queue");
151 ereport_dumpbuf = kmem_alloc(ereport_size, KM_SLEEP);
152 ereport_dumplen = ereport_size;
154 /* Initialize ereport allocation and generation kstats */
155 ksp = kstat_create("unix", 0, "fm", "misc", KSTAT_TYPE_NAMED,
156 sizeof (struct erpt_kstat) / sizeof (kstat_named_t),
160 ksp->ks_data = &erpt_kstat_data;
163 cmn_err(CE_NOTE, "failed to create fm/misc kstat\n");
169 * Formatting utility function for fm_nvprintr. We attempt to wrap chunks of
170 * output so they aren't split across console lines, and return the end column.
174 fm_printf(int depth, int c, int cols, const char *format, ...)
180 va_start(ap, format);
181 width = vsnprintf(&c1, sizeof (c1), format, ap);
184 if (c + width >= cols) {
185 console_printf("\n\r");
187 if (format[0] != ' ' && depth > 0) {
193 va_start(ap, format);
194 console_vprintf(format, ap);
197 return ((c + width) % cols);
201 * Recursively print a nvlist in the specified column width and return the
202 * column we end up in. This function is called recursively by fm_nvprint(),
203 * below. We generically format the entire nvpair using hexadecimal
204 * integers and strings, and elide any integer arrays. Arrays are basically
205 * used for cache dumps right now, so we suppress them so as not to overwhelm
206 * the amount of console output we produce at panic time. This can be further
207 * enhanced as FMA technology grows based upon the needs of consumers. All
208 * FMA telemetry is logged using the dump device transport, so the console
209 * output serves only as a fallback in case this procedure is unsuccessful.
212 fm_nvprintr(nvlist_t *nvl, int d, int c, int cols)
216 for (nvp = nvlist_next_nvpair(nvl, NULL);
217 nvp != NULL; nvp = nvlist_next_nvpair(nvl, nvp)) {
219 data_type_t type = nvpair_type(nvp);
220 const char *name = nvpair_name(nvp);
230 if (strcmp(name, FM_CLASS) == 0)
231 continue; /* already printed by caller */
233 c = fm_printf(d, c, cols, " %s=", name);
236 case DATA_TYPE_BOOLEAN:
237 c = fm_printf(d + 1, c, cols, " 1");
240 case DATA_TYPE_BOOLEAN_VALUE:
241 (void) nvpair_value_boolean_value(nvp, &b);
242 c = fm_printf(d + 1, c, cols, b ? "1" : "0");
246 (void) nvpair_value_byte(nvp, &i8);
247 c = fm_printf(d + 1, c, cols, "%x", i8);
251 (void) nvpair_value_int8(nvp, (void *)&i8);
252 c = fm_printf(d + 1, c, cols, "%x", i8);
255 case DATA_TYPE_UINT8:
256 (void) nvpair_value_uint8(nvp, &i8);
257 c = fm_printf(d + 1, c, cols, "%x", i8);
260 case DATA_TYPE_INT16:
261 (void) nvpair_value_int16(nvp, (void *)&i16);
262 c = fm_printf(d + 1, c, cols, "%x", i16);
265 case DATA_TYPE_UINT16:
266 (void) nvpair_value_uint16(nvp, &i16);
267 c = fm_printf(d + 1, c, cols, "%x", i16);
270 case DATA_TYPE_INT32:
271 (void) nvpair_value_int32(nvp, (void *)&i32);
272 c = fm_printf(d + 1, c, cols, "%x", i32);
275 case DATA_TYPE_UINT32:
276 (void) nvpair_value_uint32(nvp, &i32);
277 c = fm_printf(d + 1, c, cols, "%x", i32);
280 case DATA_TYPE_INT64:
281 (void) nvpair_value_int64(nvp, (void *)&i64);
282 c = fm_printf(d + 1, c, cols, "%llx",
286 case DATA_TYPE_UINT64:
287 (void) nvpair_value_uint64(nvp, &i64);
288 c = fm_printf(d + 1, c, cols, "%llx",
292 case DATA_TYPE_HRTIME:
293 (void) nvpair_value_hrtime(nvp, (void *)&i64);
294 c = fm_printf(d + 1, c, cols, "%llx",
298 case DATA_TYPE_STRING:
299 (void) nvpair_value_string(nvp, &str);
300 c = fm_printf(d + 1, c, cols, "\"%s\"",
301 str ? str : "<NULL>");
304 case DATA_TYPE_NVLIST:
305 c = fm_printf(d + 1, c, cols, "[");
306 (void) nvpair_value_nvlist(nvp, &cnv);
307 c = fm_nvprintr(cnv, d + 1, c, cols);
308 c = fm_printf(d + 1, c, cols, " ]");
311 case DATA_TYPE_NVLIST_ARRAY: {
315 c = fm_printf(d + 1, c, cols, "[");
316 (void) nvpair_value_nvlist_array(nvp, &val, &nelem);
317 for (i = 0; i < nelem; i++) {
318 c = fm_nvprintr(val[i], d + 1, c, cols);
320 c = fm_printf(d + 1, c, cols, " ]");
324 case DATA_TYPE_BOOLEAN_ARRAY:
325 case DATA_TYPE_BYTE_ARRAY:
326 case DATA_TYPE_INT8_ARRAY:
327 case DATA_TYPE_UINT8_ARRAY:
328 case DATA_TYPE_INT16_ARRAY:
329 case DATA_TYPE_UINT16_ARRAY:
330 case DATA_TYPE_INT32_ARRAY:
331 case DATA_TYPE_UINT32_ARRAY:
332 case DATA_TYPE_INT64_ARRAY:
333 case DATA_TYPE_UINT64_ARRAY:
334 case DATA_TYPE_STRING_ARRAY:
335 c = fm_printf(d + 1, c, cols, "[...]");
337 case DATA_TYPE_UNKNOWN:
338 c = fm_printf(d + 1, c, cols, "<unknown>");
347 fm_nvprint(nvlist_t *nvl)
352 console_printf("\r");
354 if (nvlist_lookup_string(nvl, FM_CLASS, &class) == 0)
355 c = fm_printf(0, c, ereport_cols, "%s", class);
357 if (fm_nvprintr(nvl, 0, c, ereport_cols) != 0)
358 console_printf("\n");
360 console_printf("\n");
364 * Wrapper for panic() that first produces an FMA-style message for admins.
365 * Normally such messages are generated by fmd(1M)'s syslog-msgs agent: this
366 * is the one exception to that rule and the only error that gets messaged.
367 * This function is intended for use by subsystems that have detected a fatal
368 * error and enqueued appropriate ereports and wish to then force a panic.
372 fm_panic(const char *format, ...)
376 (void) casptr((void *)&fm_panicstr, NULL, (void *)format);
377 va_start(ap, format);
383 * Print any appropriate FMA banner message before the panic message. This
384 * function is called by panicsys() and prints the message for fm_panic().
385 * We print the message here so that it comes after the system is quiesced.
386 * A one-line summary is recorded in the log only (cmn_err(9F) with "!" prefix).
387 * The rest of the message is for the console only and not needed in the log,
388 * so it is printed using console_printf(). We break it up into multiple
389 * chunks so as to avoid overflowing any small legacy prom_printf() buffers.
398 return; /* panic was not initiated by fm_panic(); do nothing */
401 tod = panic_hrestime;
405 now = gethrtime_waitfree();
408 cmn_err(CE_NOTE, "!SUNW-MSG-ID: %s, "
409 "TYPE: Error, VER: 1, SEVERITY: Major\n", fm_msgid);
412 "\n\rSUNW-MSG-ID: %s, TYPE: Error, VER: 1, SEVERITY: Major\n"
413 "EVENT-TIME: 0x%lx.0x%lx (0x%llx)\n",
414 fm_msgid, tod.tv_sec, tod.tv_nsec, (u_longlong_t)now);
417 "PLATFORM: %s, CSN: -, HOSTNAME: %s\n"
418 "SOURCE: %s, REV: %s %s\n",
419 platform, utsname.nodename, utsname.sysname,
420 utsname.release, utsname.version);
423 "DESC: Errors have been detected that require a reboot to ensure system\n"
424 "integrity. See %s/%s for more information.\n",
428 "AUTO-RESPONSE: Solaris will attempt to save and diagnose the error telemetry\n"
429 "IMPACT: The system will sync files, save a crash dump if needed, and reboot\n"
430 "REC-ACTION: Save the error summary below in case telemetry cannot be saved\n");
432 console_printf("\n");
436 * Utility function to write all of the pending ereports to the dump device.
437 * This function is called at either normal reboot or panic time, and simply
438 * iterates over the in-transit messages in the ereport sysevent channel.
441 fm_ereport_dump(void)
453 tod = panic_hrestime;
456 if (ereport_errorq != NULL)
457 errorq_drain(ereport_errorq);
459 now = gethrtime_waitfree();
463 * In the panic case, sysevent_evc_walk_init() will return NULL.
465 if ((chq = sysevent_evc_walk_init(ereport_chan, NULL)) == NULL &&
467 return; /* event channel isn't initialized yet */
469 while ((sep = sysevent_evc_walk_step(chq)) != NULL) {
470 if ((buf = sysevent_evc_event_attr(sep, &len)) == NULL)
473 ed.ed_magic = ERPT_MAGIC;
474 ed.ed_chksum = checksum32(buf, len);
475 ed.ed_size = (uint32_t)len;
477 ed.ed_hrt_nsec = SE_TIME(sep);
478 ed.ed_hrt_base = now;
479 ed.ed_tod_base.sec = tod.tv_sec;
480 ed.ed_tod_base.nsec = tod.tv_nsec;
482 dumpvp_write(&ed, sizeof (ed));
483 dumpvp_write(buf, len);
486 sysevent_evc_walk_fini(chq);
490 * Post an error report (ereport) to the sysevent error channel. The error
491 * channel must be established with a prior call to sysevent_evc_create()
492 * before publication may occur.
495 fm_ereport_post(nvlist_t *ereport, int evc_flag)
498 evchan_t *error_chan;
500 (void) nvlist_size(ereport, &nvl_size, NV_ENCODE_NATIVE);
501 if (nvl_size > ERPT_DATA_SZ || nvl_size == 0) {
502 atomic_add_64(&erpt_kstat_data.erpt_dropped.value.ui64, 1);
506 if (sysevent_evc_bind(FM_ERROR_CHAN, &error_chan,
507 EVCH_CREAT|EVCH_HOLD_PEND) != 0) {
508 atomic_add_64(&erpt_kstat_data.erpt_dropped.value.ui64, 1);
512 if (sysevent_evc_publish(error_chan, EC_FM, ESC_FM_ERROR,
513 SUNW_VENDOR, FM_PUB, ereport, evc_flag) != 0) {
514 atomic_add_64(&erpt_kstat_data.erpt_dropped.value.ui64, 1);
515 sysevent_evc_unbind(error_chan);
518 sysevent_evc_unbind(error_chan);
522 * Wrapppers for FM nvlist allocators
526 i_fm_alloc(nv_alloc_t *nva, size_t size)
528 return (kmem_zalloc(size, KM_SLEEP));
533 i_fm_free(nv_alloc_t *nva, void *buf, size_t size)
535 kmem_free(buf, size);
538 const nv_alloc_ops_t fm_mem_alloc_ops = {
547 * Create and initialize a new nv_alloc_t for a fixed buffer, buf. A pointer
548 * to the newly allocated nv_alloc_t structure is returned upon success or NULL
549 * is returned to indicate that the nv_alloc structure could not be created.
552 fm_nva_xcreate(char *buf, size_t bufsz)
554 nv_alloc_t *nvhdl = kmem_zalloc(sizeof (nv_alloc_t), KM_SLEEP);
556 if (bufsz == 0 || nv_alloc_init(nvhdl, nv_fixed_ops, buf, bufsz) != 0) {
557 kmem_free(nvhdl, sizeof (nv_alloc_t));
565 * Destroy a previously allocated nv_alloc structure. The fixed buffer
566 * associated with nva must be freed by the caller.
569 fm_nva_xdestroy(nv_alloc_t *nva)
572 kmem_free(nva, sizeof (nv_alloc_t));
576 * Create a new nv list. A pointer to a new nv list structure is returned
577 * upon success or NULL is returned to indicate that the structure could
578 * not be created. The newly created nv list is created and managed by the
579 * operations installed in nva. If nva is NULL, the default FMA nva
580 * operations are installed and used.
582 * When called from the kernel and nva == NULL, this function must be called
583 * from passive kernel context with no locks held that can prevent a
584 * sleeping memory allocation from occurring. Otherwise, this function may
585 * be called from other kernel contexts as long a valid nva created via
586 * fm_nva_create() is supplied.
589 fm_nvlist_create(nv_alloc_t *nva)
596 nvhdl = kmem_zalloc(sizeof (nv_alloc_t), KM_SLEEP);
598 if (nv_alloc_init(nvhdl, &fm_mem_alloc_ops, NULL, 0) != 0) {
599 kmem_free(nvhdl, sizeof (nv_alloc_t));
607 if (nvlist_xalloc(&nvl, NV_UNIQUE_NAME, nvhdl) != 0) {
609 kmem_free(nvhdl, sizeof (nv_alloc_t));
610 nv_alloc_fini(nvhdl);
619 * Destroy a previously allocated nvlist structure. flag indicates whether
620 * or not the associated nva structure should be freed (FM_NVA_FREE) or
621 * retained (FM_NVA_RETAIN). Retaining the nv alloc structure allows
622 * it to be re-used for future nvlist creation operations.
625 fm_nvlist_destroy(nvlist_t *nvl, int flag)
627 nv_alloc_t *nva = nvlist_lookup_nv_alloc(nvl);
632 if (flag == FM_NVA_FREE)
633 fm_nva_xdestroy(nva);
638 i_fm_payload_set(nvlist_t *payload, const char *name, va_list ap)
643 while (ret == 0 && name != NULL) {
644 type = va_arg(ap, data_type_t);
647 ret = nvlist_add_byte(payload, name,
650 case DATA_TYPE_BYTE_ARRAY:
651 nelem = va_arg(ap, int);
652 ret = nvlist_add_byte_array(payload, name,
653 va_arg(ap, uchar_t *), nelem);
655 case DATA_TYPE_BOOLEAN_VALUE:
656 ret = nvlist_add_boolean_value(payload, name,
657 va_arg(ap, boolean_t));
659 case DATA_TYPE_BOOLEAN_ARRAY:
660 nelem = va_arg(ap, int);
661 ret = nvlist_add_boolean_array(payload, name,
662 va_arg(ap, boolean_t *), nelem);
665 ret = nvlist_add_int8(payload, name,
668 case DATA_TYPE_INT8_ARRAY:
669 nelem = va_arg(ap, int);
670 ret = nvlist_add_int8_array(payload, name,
671 va_arg(ap, int8_t *), nelem);
673 case DATA_TYPE_UINT8:
674 ret = nvlist_add_uint8(payload, name,
677 case DATA_TYPE_UINT8_ARRAY:
678 nelem = va_arg(ap, int);
679 ret = nvlist_add_uint8_array(payload, name,
680 va_arg(ap, uint8_t *), nelem);
682 case DATA_TYPE_INT16:
683 ret = nvlist_add_int16(payload, name,
686 case DATA_TYPE_INT16_ARRAY:
687 nelem = va_arg(ap, int);
688 ret = nvlist_add_int16_array(payload, name,
689 va_arg(ap, int16_t *), nelem);
691 case DATA_TYPE_UINT16:
692 ret = nvlist_add_uint16(payload, name,
695 case DATA_TYPE_UINT16_ARRAY:
696 nelem = va_arg(ap, int);
697 ret = nvlist_add_uint16_array(payload, name,
698 va_arg(ap, uint16_t *), nelem);
700 case DATA_TYPE_INT32:
701 ret = nvlist_add_int32(payload, name,
702 va_arg(ap, int32_t));
704 case DATA_TYPE_INT32_ARRAY:
705 nelem = va_arg(ap, int);
706 ret = nvlist_add_int32_array(payload, name,
707 va_arg(ap, int32_t *), nelem);
709 case DATA_TYPE_UINT32:
710 ret = nvlist_add_uint32(payload, name,
711 va_arg(ap, uint32_t));
713 case DATA_TYPE_UINT32_ARRAY:
714 nelem = va_arg(ap, int);
715 ret = nvlist_add_uint32_array(payload, name,
716 va_arg(ap, uint32_t *), nelem);
718 case DATA_TYPE_INT64:
719 ret = nvlist_add_int64(payload, name,
720 va_arg(ap, int64_t));
722 case DATA_TYPE_INT64_ARRAY:
723 nelem = va_arg(ap, int);
724 ret = nvlist_add_int64_array(payload, name,
725 va_arg(ap, int64_t *), nelem);
727 case DATA_TYPE_UINT64:
728 ret = nvlist_add_uint64(payload, name,
729 va_arg(ap, uint64_t));
731 case DATA_TYPE_UINT64_ARRAY:
732 nelem = va_arg(ap, int);
733 ret = nvlist_add_uint64_array(payload, name,
734 va_arg(ap, uint64_t *), nelem);
736 case DATA_TYPE_STRING:
737 ret = nvlist_add_string(payload, name,
740 case DATA_TYPE_STRING_ARRAY:
741 nelem = va_arg(ap, int);
742 ret = nvlist_add_string_array(payload, name,
743 va_arg(ap, char **), nelem);
745 case DATA_TYPE_NVLIST:
746 ret = nvlist_add_nvlist(payload, name,
747 va_arg(ap, nvlist_t *));
749 case DATA_TYPE_NVLIST_ARRAY:
750 nelem = va_arg(ap, int);
751 ret = nvlist_add_nvlist_array(payload, name,
752 va_arg(ap, nvlist_t **), nelem);
758 name = va_arg(ap, char *);
764 fm_payload_set(nvlist_t *payload, ...)
770 va_start(ap, payload);
771 name = va_arg(ap, char *);
772 ret = i_fm_payload_set(payload, name, ap);
777 &erpt_kstat_data.payload_set_failed.value.ui64, 1);
781 * Set-up and validate the members of an ereport event according to:
783 * Member name Type Value
784 * ====================================================
785 * class string ereport
788 * detector nvlist_t <detector>
789 * ereport-payload nvlist_t <var args>
793 fm_ereport_set(nvlist_t *ereport, int version, const char *erpt_class,
794 uint64_t ena, const nvlist_t *detector, ...)
796 char ereport_class[FM_MAX_CLASS];
801 if (version != FM_EREPORT_VERS0) {
802 atomic_add_64(&erpt_kstat_data.erpt_set_failed.value.ui64, 1);
806 (void) snprintf(ereport_class, FM_MAX_CLASS, "%s.%s",
807 FM_EREPORT_CLASS, erpt_class);
808 if (nvlist_add_string(ereport, FM_CLASS, ereport_class) != 0) {
809 atomic_add_64(&erpt_kstat_data.erpt_set_failed.value.ui64, 1);
813 if (nvlist_add_uint64(ereport, FM_EREPORT_ENA, ena)) {
814 atomic_add_64(&erpt_kstat_data.erpt_set_failed.value.ui64, 1);
817 if (nvlist_add_nvlist(ereport, FM_EREPORT_DETECTOR,
818 (nvlist_t *)detector) != 0) {
819 atomic_add_64(&erpt_kstat_data.erpt_set_failed.value.ui64, 1);
822 va_start(ap, detector);
823 name = va_arg(ap, const char *);
824 ret = i_fm_payload_set(ereport, name, ap);
828 atomic_add_64(&erpt_kstat_data.erpt_set_failed.value.ui64, 1);
832 * Set-up and validate the members of an hc fmri according to;
834 * Member name Type Value
835 * ===================================================
837 * auth nvlist_t <auth>
838 * hc-name string <name>
841 * Note that auth and hc-id are optional members.
844 #define HC_MAXPAIRS 20
845 #define HC_MAXNAMELEN 50
848 fm_fmri_hc_set_common(nvlist_t *fmri, int version, const nvlist_t *auth)
850 if (version != FM_HC_SCHEME_VERSION) {
851 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
855 if (nvlist_add_uint8(fmri, FM_VERSION, version) != 0 ||
856 nvlist_add_string(fmri, FM_FMRI_SCHEME, FM_FMRI_SCHEME_HC) != 0) {
857 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
861 if (auth != NULL && nvlist_add_nvlist(fmri, FM_FMRI_AUTHORITY,
862 (nvlist_t *)auth) != 0) {
863 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
871 fm_fmri_hc_set(nvlist_t *fmri, int version, const nvlist_t *auth,
872 nvlist_t *snvl, int npairs, ...)
874 nv_alloc_t *nva = nvlist_lookup_nv_alloc(fmri);
875 nvlist_t *pairs[HC_MAXPAIRS];
879 if (!fm_fmri_hc_set_common(fmri, version, auth))
882 npairs = MIN(npairs, HC_MAXPAIRS);
884 va_start(ap, npairs);
885 for (i = 0; i < npairs; i++) {
886 const char *name = va_arg(ap, const char *);
887 uint32_t id = va_arg(ap, uint32_t);
890 (void) snprintf(idstr, sizeof (idstr), "%u", id);
892 pairs[i] = fm_nvlist_create(nva);
893 if (nvlist_add_string(pairs[i], FM_FMRI_HC_NAME, name) != 0 ||
894 nvlist_add_string(pairs[i], FM_FMRI_HC_ID, idstr) != 0) {
896 &erpt_kstat_data.fmri_set_failed.value.ui64, 1);
901 if (nvlist_add_nvlist_array(fmri, FM_FMRI_HC_LIST, pairs, npairs) != 0)
902 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
904 for (i = 0; i < npairs; i++)
905 fm_nvlist_destroy(pairs[i], FM_NVA_RETAIN);
908 if (nvlist_add_nvlist(fmri, FM_FMRI_HC_SPECIFIC, snvl) != 0) {
910 &erpt_kstat_data.fmri_set_failed.value.ui64, 1);
916 * Set-up and validate the members of an dev fmri according to:
918 * Member name Type Value
919 * ====================================================
921 * auth nvlist_t <auth>
922 * devpath string <devpath>
923 * devid string <devid>
925 * Note that auth and devid are optional members.
928 fm_fmri_dev_set(nvlist_t *fmri_dev, int version, const nvlist_t *auth,
929 const char *devpath, const char *devid)
931 if (version != DEV_SCHEME_VERSION0) {
932 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
936 if (nvlist_add_uint8(fmri_dev, FM_VERSION, version) != 0) {
937 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
941 if (nvlist_add_string(fmri_dev, FM_FMRI_SCHEME,
942 FM_FMRI_SCHEME_DEV) != 0) {
943 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
948 if (nvlist_add_nvlist(fmri_dev, FM_FMRI_AUTHORITY,
949 (nvlist_t *)auth) != 0) {
951 &erpt_kstat_data.fmri_set_failed.value.ui64, 1);
955 if (nvlist_add_string(fmri_dev, FM_FMRI_DEV_PATH, devpath) != 0) {
956 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
960 if (nvlist_add_string(fmri_dev, FM_FMRI_DEV_ID, devid) != 0)
962 &erpt_kstat_data.fmri_set_failed.value.ui64, 1);
966 * Set-up and validate the members of an cpu fmri according to:
968 * Member name Type Value
969 * ====================================================
971 * auth nvlist_t <auth>
972 * cpuid uint32_t <cpu_id>
973 * cpumask uint8_t <cpu_mask>
974 * serial uint64_t <serial_id>
976 * Note that auth, cpumask, serial are optional members.
980 fm_fmri_cpu_set(nvlist_t *fmri_cpu, int version, const nvlist_t *auth,
981 uint32_t cpu_id, uint8_t *cpu_maskp, const char *serial_idp)
983 uint64_t *failedp = &erpt_kstat_data.fmri_set_failed.value.ui64;
985 if (version < CPU_SCHEME_VERSION1) {
986 atomic_add_64(failedp, 1);
990 if (nvlist_add_uint8(fmri_cpu, FM_VERSION, version) != 0) {
991 atomic_add_64(failedp, 1);
995 if (nvlist_add_string(fmri_cpu, FM_FMRI_SCHEME,
996 FM_FMRI_SCHEME_CPU) != 0) {
997 atomic_add_64(failedp, 1);
1001 if (auth != NULL && nvlist_add_nvlist(fmri_cpu, FM_FMRI_AUTHORITY,
1002 (nvlist_t *)auth) != 0)
1003 atomic_add_64(failedp, 1);
1005 if (nvlist_add_uint32(fmri_cpu, FM_FMRI_CPU_ID, cpu_id) != 0)
1006 atomic_add_64(failedp, 1);
1008 if (cpu_maskp != NULL && nvlist_add_uint8(fmri_cpu, FM_FMRI_CPU_MASK,
1010 atomic_add_64(failedp, 1);
1012 if (serial_idp == NULL || nvlist_add_string(fmri_cpu,
1013 FM_FMRI_CPU_SERIAL_ID, (char *)serial_idp) != 0)
1014 atomic_add_64(failedp, 1);
1018 * Set-up and validate the members of a mem according to:
1020 * Member name Type Value
1021 * ====================================================
1023 * auth nvlist_t <auth> [optional]
1024 * unum string <unum>
1025 * serial string <serial> [optional*]
1026 * offset uint64_t <offset> [optional]
1028 * * serial is required if offset is present
1031 fm_fmri_mem_set(nvlist_t *fmri, int version, const nvlist_t *auth,
1032 const char *unum, const char *serial, uint64_t offset)
1034 if (version != MEM_SCHEME_VERSION0) {
1035 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1039 if (!serial && (offset != (uint64_t)-1)) {
1040 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1044 if (nvlist_add_uint8(fmri, FM_VERSION, version) != 0) {
1045 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1049 if (nvlist_add_string(fmri, FM_FMRI_SCHEME, FM_FMRI_SCHEME_MEM) != 0) {
1050 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1055 if (nvlist_add_nvlist(fmri, FM_FMRI_AUTHORITY,
1056 (nvlist_t *)auth) != 0) {
1058 &erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1062 if (nvlist_add_string(fmri, FM_FMRI_MEM_UNUM, unum) != 0) {
1063 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1066 if (serial != NULL) {
1067 if (nvlist_add_string_array(fmri, FM_FMRI_MEM_SERIAL_ID,
1068 (char **)&serial, 1) != 0) {
1070 &erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1072 if (offset != (uint64_t)-1) {
1073 if (nvlist_add_uint64(fmri, FM_FMRI_MEM_OFFSET,
1075 atomic_add_64(&erpt_kstat_data.
1076 fmri_set_failed.value.ui64, 1);
1083 fm_fmri_zfs_set(nvlist_t *fmri, int version, uint64_t pool_guid,
1086 if (version != ZFS_SCHEME_VERSION0) {
1087 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1091 if (nvlist_add_uint8(fmri, FM_VERSION, version) != 0) {
1092 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1096 if (nvlist_add_string(fmri, FM_FMRI_SCHEME, FM_FMRI_SCHEME_ZFS) != 0) {
1097 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1101 if (nvlist_add_uint64(fmri, FM_FMRI_ZFS_POOL, pool_guid) != 0) {
1102 atomic_add_64(&erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1105 if (vdev_guid != 0) {
1106 if (nvlist_add_uint64(fmri, FM_FMRI_ZFS_VDEV, vdev_guid) != 0) {
1108 &erpt_kstat_data.fmri_set_failed.value.ui64, 1);
1114 fm_ena_increment(uint64_t ena)
1118 switch (ENA_FORMAT(ena)) {
1120 new_ena = ena + (1 << ENA_FMT1_GEN_SHFT);
1123 new_ena = ena + (1 << ENA_FMT2_GEN_SHFT);
1133 fm_ena_generate_cpu(uint64_t timestamp, processorid_t cpuid, uchar_t format)
1140 ena = (uint64_t)((format & ENA_FORMAT_MASK) |
1141 ((cpuid << ENA_FMT1_CPUID_SHFT) &
1142 ENA_FMT1_CPUID_MASK) |
1143 ((timestamp << ENA_FMT1_TIME_SHFT) &
1144 ENA_FMT1_TIME_MASK));
1146 ena = (uint64_t)((format & ENA_FORMAT_MASK) |
1147 ((cpuid << ENA_FMT1_CPUID_SHFT) &
1148 ENA_FMT1_CPUID_MASK) |
1149 ((gethrtime_waitfree() << ENA_FMT1_TIME_SHFT) &
1150 ENA_FMT1_TIME_MASK));
1154 ena = (uint64_t)((format & ENA_FORMAT_MASK) |
1155 ((timestamp << ENA_FMT2_TIME_SHFT) & ENA_FMT2_TIME_MASK));
1165 fm_ena_generate(uint64_t timestamp, uchar_t format)
1167 return (fm_ena_generate_cpu(timestamp, CPU->cpu_id, format));
1171 fm_ena_generation_get(uint64_t ena)
1175 switch (ENA_FORMAT(ena)) {
1177 gen = (ena & ENA_FMT1_GEN_MASK) >> ENA_FMT1_GEN_SHFT;
1180 gen = (ena & ENA_FMT2_GEN_MASK) >> ENA_FMT2_GEN_SHFT;
1191 fm_ena_format_get(uint64_t ena)
1194 return (ENA_FORMAT(ena));
1198 fm_ena_id_get(uint64_t ena)
1202 switch (ENA_FORMAT(ena)) {
1204 id = (ena & ENA_FMT1_ID_MASK) >> ENA_FMT1_ID_SHFT;
1207 id = (ena & ENA_FMT2_ID_MASK) >> ENA_FMT2_ID_SHFT;
1217 fm_ena_time_get(uint64_t ena)
1221 switch (ENA_FORMAT(ena)) {
1223 time = (ena & ENA_FMT1_TIME_MASK) >> ENA_FMT1_TIME_SHFT;
1226 time = (ena & ENA_FMT2_TIME_MASK) >> ENA_FMT2_TIME_SHFT;
1236 * Convert a getpcstack() trace to symbolic name+offset, and add the resulting
1237 * string array to a Fault Management ereport as FM_EREPORT_PAYLOAD_NAME_STACK.
1240 fm_payload_stack_add(nvlist_t *payload, const pc_t *stack, int depth)
1245 char *stkpp[FM_STK_DEPTH];
1246 char buf[FM_STK_DEPTH * FM_SYM_SZ];
1249 for (i = 0; i < depth && i != FM_STK_DEPTH; i++, stkp += FM_SYM_SZ) {
1250 if ((sym = kobj_getsymname(stack[i], &off)) != NULL)
1251 (void) snprintf(stkp, FM_SYM_SZ, "%s+%lx", sym, off);
1253 (void) snprintf(stkp, FM_SYM_SZ, "%lx", (long)stack[i]);
1257 fm_payload_set(payload, FM_EREPORT_PAYLOAD_NAME_STACK,
1258 DATA_TYPE_STRING_ARRAY, depth, stkpp, NULL);
1262 print_msg_hwerr(ctid_t ct_id, proc_t *p)
1264 uprintf("Killed process %d (%s) in contract id %d "
1265 "due to hardware error\n", p->p_pid, p->p_user.u_comm, ct_id);