1 /* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21 22 /* 23 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _FMD_CASE_H 28 #define _FMD_CASE_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 #include <pthread.h> 33 #include <libnvpair.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #include <fmd_list.h> 40 #include <fmd_api.h> 41 #include <fmd_buf.h> 42 43 struct fmd_module; /* see <fmd_module.h> */ 44 45 typedef struct fmd_case_item { 46 struct fmd_case_item *cit_next; /* pointer to next element in list */ 47 fmd_event_t *cit_event; /* pointer to held event */ 48 } fmd_case_item_t; 49 50 typedef struct fmd_case_susp { 51 struct fmd_case_susp *cis_next; /* pointer to next element in list */ 52 nvlist_t *cis_nvl; /* nvpair representing fault event */ 53 } fmd_case_susp_t; 54 55 typedef struct fmd_case_impl { 56 fmd_list_t ci_list; /* linked list next/prev pointers */ 57 struct fmd_case_impl *ci_next; /* next pointer for hash bucket chain */ 58 char *ci_uuid; /* uuid string for this case */ 59 uint_t ci_uuidlen; /* length of ci_uuid (not incl. \0) */ 60 char *ci_code; /* code associated with this case */ 61 size_t ci_codelen; /* size of ci_code buffer in bytes */ 62 struct fmd_module *ci_mod; /* module that owns this case */ 63 fmd_xprt_t *ci_xprt; /* transport for this case (or NULL) */ 64 void *ci_data; /* data from fmd_case_setspecific() */ 65 pthread_mutex_t ci_lock; /* lock for remainder of contents */ 66 uint_t ci_refs; /* reference count */ 67 ushort_t ci_state; /* case state (see below) */ 68 ushort_t ci_flags; /* case flags (see below) */ 69 fmd_case_item_t *ci_items; /* list of items in this case */ 70 uint_t ci_nitems; /* number of ci_items */ 71 fmd_event_t *ci_principal; /* principal event (if any) */ 72 fmd_case_susp_t *ci_suspects; /* list of suspects in this case */ 73 uint_t ci_nsuspects; /* number of ci_suspects */ 74 size_t ci_nvsz; /* packed suspect nvlist array size */ 75 fmd_buf_hash_t ci_bufs; /* hash of bufs associated with case */ 76 struct timeval ci_tv; /* time of original diagnosis */ 77 int ci_tv_valid; /* time of original diagnosis valid */ 78 } fmd_case_impl_t; 79 80 #define FMD_CASE_CURRENT -1u /* flag for current state */ 81 82 #define FMD_CASE_UNSOLVED 0 /* case is not yet solved (waiting) */ 83 #define FMD_CASE_SOLVED 1 /* case is solved (suspects added) */ 84 #define FMD_CASE_CLOSE_WAIT 2 /* case is executing fmdo_close() */ 85 #define FMD_CASE_CLOSED 3 /* case is closed (reconfig done) */ 86 #define FMD_CASE_REPAIRED 4 /* case is repaired (can be freed) */ 87 88 #define FMD_CF_DIRTY 0x01 /* case is in need of checkpoint */ 89 #define FMD_CF_SOLVED 0x02 /* case has been solved */ 90 #define FMD_CF_ISOLATED 0x04 /* case has been isolated */ 91 #define FMD_CF_REPAIRED 0x08 /* case has been repaired */ 92 #define FMD_CF_REPAIRING 0x10 /* case repair in progress */ 93 #define FMD_CF_INVISIBLE 0x20 /* case should be invisible */ 94 95 typedef struct fmd_case_hash { 96 pthread_rwlock_t ch_lock; /* lock protecting case hash */ 97 fmd_case_impl_t **ch_hash; /* hash bucket array for cases */ 98 uint_t ch_hashlen; /* size of hash bucket array */ 99 uint_t ch_count; /* number of cases in hash */ 100 } fmd_case_hash_t; 101 102 extern fmd_case_hash_t *fmd_case_hash_create(void); 103 extern void fmd_case_hash_destroy(fmd_case_hash_t *); 104 extern fmd_case_t *fmd_case_hash_lookup(fmd_case_hash_t *, const char *); 105 extern void fmd_case_hash_apply(fmd_case_hash_t *, 106 void (*)(fmd_case_t *, void *), void *); 107 108 extern fmd_case_t *fmd_case_create(struct fmd_module *, void *); 109 extern fmd_case_t *fmd_case_recreate(struct fmd_module *, 110 struct fmd_xprt *, uint_t, const char *, const char *); 111 extern void fmd_case_destroy(fmd_case_t *, int); 112 extern void fmd_case_hold(fmd_case_t *); 113 extern void fmd_case_hold_locked(fmd_case_t *); 114 extern void fmd_case_rele(fmd_case_t *); 115 116 extern int fmd_case_insert_principal(fmd_case_t *, fmd_event_t *); 117 extern int fmd_case_insert_event(fmd_case_t *, fmd_event_t *); 118 119 extern void fmd_case_insert_suspect(fmd_case_t *, nvlist_t *); 120 extern void fmd_case_recreate_suspect(fmd_case_t *, nvlist_t *); 121 extern void fmd_case_reset_suspects(fmd_case_t *); 122 123 extern nvlist_t *fmd_case_mkevent(fmd_case_t *, const char *); 124 extern void fmd_case_publish(fmd_case_t *, uint_t); 125 extern void fmd_case_transition(fmd_case_t *, uint_t, uint_t); 126 extern void fmd_case_transition_update(fmd_case_t *, uint_t, uint_t); 127 extern void fmd_case_setdirty(fmd_case_t *); 128 extern void fmd_case_clrdirty(fmd_case_t *); 129 extern void fmd_case_commit(fmd_case_t *); 130 extern void fmd_case_update(fmd_case_t *); 131 extern void fmd_case_delete(fmd_case_t *); 132 extern void fmd_case_discard(fmd_case_t *); 133 extern void fmd_case_settime(fmd_case_t *, time_t, suseconds_t); 134 135 extern int fmd_case_repair(fmd_case_t *); 136 extern int fmd_case_contains(fmd_case_t *, fmd_event_t *); 137 extern int fmd_case_orphaned(fmd_case_t *); 138 139 #ifdef __cplusplus 140 } 141 #endif 142 143 #endif /* _FMD_CASE_H */ 144