cmd/zed/agents/fmd_api.h

   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 https://opensource.org/licenses/CDDL-1.0.
  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 (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  24  *
  25  * Copyright (c) 2016, Intel Corporation.
  26  */
  27
  28 #ifndef _FMD_API_H
  29 #define _FMD_API_H
  30
  31 #include <sys/types.h>
  32 #include <sys/time.h>
  33 #include <time.h>
  34 #include <libnvpair.h>
  35 #include <stdarg.h>
  36 #include <umem.h>
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /*
  43  * Fault Management Daemon Client Interfaces
  44  */
  45
  46 #define FMD_API_VERSION         5
  47
  48 typedef struct fmd_hdl fmd_hdl_t;
  49
  50 typedef struct fmd_timer {
  51         timer_t         ft_tid;
  52         void            *ft_arg;
  53         fmd_hdl_t       *ft_hdl;
  54 } fmd_timer_t;
  55
  56 #define id_t    fmd_timer_t *
  57
  58
  59 typedef struct fmd_event {
  60         hrtime_t        ev_hrt;         /* event time used by SERD engines */
  61 } fmd_event_t;
  62
  63 typedef struct fmd_case {
  64         char            ci_uuid[48];    /* uuid string for this case */
  65         fmd_hdl_t       *ci_mod;        /* module that owns this case */
  66         void            *ci_data;       /* data from fmd_case_setspecific() */
  67         ushort_t        ci_state;       /* case state (see below) */
  68         ushort_t        ci_flags;       /* case flags (see below) */
  69         struct timeval  ci_tv;          /* time of original diagnosis */
  70         void            *ci_bufptr;     /* case data serialization buffer */
  71         size_t          ci_bufsiz;
  72 } fmd_case_t;
  73
  74
  75 #define FMD_CASE_UNSOLVED       0       /* case is not yet solved (waiting) */
  76 #define FMD_CASE_SOLVED         1       /* case is solved (suspects added) */
  77 #define FMD_CASE_CLOSE_WAIT     2       /* case is executing fmdo_close() */
  78 #define FMD_CASE_CLOSED         3       /* case is closed (reconfig done) */
  79 #define FMD_CASE_REPAIRED       4       /* case is repaired */
  80 #define FMD_CASE_RESOLVED       5       /* case is resolved (can be freed) */
  81
  82 #define FMD_CF_DIRTY            0x01    /* case is in need of checkpoint */
  83 #define FMD_CF_SOLVED           0x02    /* case has been solved */
  84 #define FMD_CF_ISOLATED         0x04    /* case has been isolated */
  85 #define FMD_CF_REPAIRED         0x08    /* case has been repaired */
  86 #define FMD_CF_RESOLVED         0x10    /* case has been resolved */
  87
  88
  89 #define FMD_TYPE_BOOL   0               /* int */
  90 #define FMD_TYPE_INT32  1               /* int32_t */
  91 #define FMD_TYPE_UINT32 2               /* uint32_t */
  92 #define FMD_TYPE_INT64  3               /* int64_t */
  93 #define FMD_TYPE_UINT64 4               /* uint64_t */
  94 #define FMD_TYPE_TIME   5               /* uint64_t */
  95 #define FMD_TYPE_SIZE   6               /* uint64_t */
  96
  97 typedef struct fmd_prop {
  98         const char *fmdp_name;          /* property name */
  99         uint_t fmdp_type;               /* property type (see above) */
 100         const char *fmdp_defv;          /* default value */
 101 } fmd_prop_t;
 102
 103 typedef struct fmd_stat {
 104         char fmds_name[32];             /* statistic name */
 105         uint_t fmds_type;               /* statistic type (see above) */
 106         char fmds_desc[64];             /* statistic description */
 107         union {
 108                 int bool;               /* FMD_TYPE_BOOL */
 109                 int32_t i32;            /* FMD_TYPE_INT32 */
 110                 uint32_t ui32;          /* FMD_TYPE_UINT32 */
 111                 int64_t i64;            /* FMD_TYPE_INT64 */
 112                 uint64_t ui64;          /* FMD_TYPE_UINT64 */
 113         } fmds_value;
 114 } fmd_stat_t;
 115
 116 typedef struct fmd_hdl_ops {
 117         void (*fmdo_recv)(fmd_hdl_t *, fmd_event_t *, nvlist_t *, const char *);
 118         void (*fmdo_timeout)(fmd_hdl_t *, id_t, void *);
 119         void (*fmdo_close)(fmd_hdl_t *, fmd_case_t *);
 120         void (*fmdo_stats)(fmd_hdl_t *);
 121         void (*fmdo_gc)(fmd_hdl_t *);
 122 } fmd_hdl_ops_t;
 123
 124 #define FMD_SEND_SUCCESS        0       /* fmdo_send queued event */
 125 #define FMD_SEND_FAILED         1       /* fmdo_send unrecoverable error */
 126 #define FMD_SEND_RETRY          2       /* fmdo_send requests retry */
 127
 128 typedef struct fmd_hdl_info {
 129         const char *fmdi_desc;          /* fmd client description string */
 130         const char *fmdi_vers;          /* fmd client version string */
 131         const fmd_hdl_ops_t *fmdi_ops;  /* ops vector for client */
 132         const fmd_prop_t *fmdi_props;   /* array of configuration props */
 133 } fmd_hdl_info_t;
 134
 135 extern int fmd_hdl_register(fmd_hdl_t *, int, const fmd_hdl_info_t *);
 136 extern void fmd_hdl_unregister(fmd_hdl_t *);
 137
 138 extern void fmd_hdl_setspecific(fmd_hdl_t *, void *);
 139 extern void *fmd_hdl_getspecific(fmd_hdl_t *);
 140
 141 #define FMD_SLEEP       UMEM_NOFAIL
 142
 143 extern void *fmd_hdl_alloc(fmd_hdl_t *, size_t, int);
 144 extern void *fmd_hdl_zalloc(fmd_hdl_t *, size_t, int);
 145 extern void fmd_hdl_free(fmd_hdl_t *, void *, size_t);
 146
 147 extern char *fmd_hdl_strdup(fmd_hdl_t *, const char *, int);
 148 extern void fmd_hdl_strfree(fmd_hdl_t *, char *);
 149
 150 extern void fmd_hdl_vdebug(fmd_hdl_t *, const char *, va_list);
 151 extern void fmd_hdl_debug(fmd_hdl_t *, const char *, ...);
 152
 153 extern int32_t fmd_prop_get_int32(fmd_hdl_t *, const char *);
 154
 155 #define FMD_STAT_NOALLOC        0x0     /* fmd should use caller's memory */
 156 #define FMD_STAT_ALLOC          0x1     /* fmd should allocate stats memory */
 157
 158 extern fmd_stat_t *fmd_stat_create(fmd_hdl_t *, uint_t, uint_t, fmd_stat_t *);
 159 extern void fmd_stat_destroy(fmd_hdl_t *, uint_t, fmd_stat_t *);
 160 extern void fmd_stat_setstr(fmd_hdl_t *, fmd_stat_t *, const char *);
 161
 162 extern fmd_case_t *fmd_case_open(fmd_hdl_t *, void *);
 163 extern void fmd_case_reset(fmd_hdl_t *, fmd_case_t *);
 164 extern void fmd_case_solve(fmd_hdl_t *, fmd_case_t *);
 165 extern void fmd_case_close(fmd_hdl_t *, fmd_case_t *);
 166
 167 extern const char *fmd_case_uuid(fmd_hdl_t *, fmd_case_t *);
 168 extern fmd_case_t *fmd_case_uulookup(fmd_hdl_t *, const char *);
 169 extern void fmd_case_uuclose(fmd_hdl_t *, const char *);
 170 extern int fmd_case_uuclosed(fmd_hdl_t *, const char *);
 171 extern int fmd_case_uuisresolved(fmd_hdl_t *, const char *);
 172 extern void fmd_case_uuresolved(fmd_hdl_t *, const char *);
 173
 174 extern boolean_t fmd_case_solved(fmd_hdl_t *, fmd_case_t *);
 175
 176 extern void fmd_case_add_ereport(fmd_hdl_t *, fmd_case_t *, fmd_event_t *);
 177 extern void fmd_case_add_serd(fmd_hdl_t *, fmd_case_t *, const char *);
 178 extern void fmd_case_add_suspect(fmd_hdl_t *, fmd_case_t *, nvlist_t *);
 179
 180 extern void fmd_case_setspecific(fmd_hdl_t *, fmd_case_t *, void *);
 181 extern void *fmd_case_getspecific(fmd_hdl_t *, fmd_case_t *);
 182
 183 extern fmd_case_t *fmd_case_next(fmd_hdl_t *, fmd_case_t *);
 184 extern fmd_case_t *fmd_case_prev(fmd_hdl_t *, fmd_case_t *);
 185
 186 extern void fmd_buf_create(fmd_hdl_t *, fmd_case_t *, const char *, size_t);
 187 extern void fmd_buf_destroy(fmd_hdl_t *, fmd_case_t *, const char *);
 188 extern void fmd_buf_read(fmd_hdl_t *, fmd_case_t *,
 189     const char *, void *, size_t);
 190 extern void fmd_buf_write(fmd_hdl_t *, fmd_case_t *,
 191     const char *, const void *, size_t);
 192 extern size_t fmd_buf_size(fmd_hdl_t *, fmd_case_t *, const char *);
 193
 194 extern void fmd_serd_create(fmd_hdl_t *, const char *, uint_t, hrtime_t);
 195 extern void fmd_serd_destroy(fmd_hdl_t *, const char *);
 196 extern int fmd_serd_exists(fmd_hdl_t *, const char *);
 197 extern int fmd_serd_active(fmd_hdl_t *, const char *);
 198 extern void fmd_serd_reset(fmd_hdl_t *, const char *);
 199 extern int fmd_serd_record(fmd_hdl_t *, const char *, fmd_event_t *);
 200 extern int fmd_serd_fired(fmd_hdl_t *, const char *);
 201 extern int fmd_serd_empty(fmd_hdl_t *, const char *);
 202 extern void fmd_serd_gc(fmd_hdl_t *);
 203
 204 extern id_t fmd_timer_install(fmd_hdl_t *, void *, fmd_event_t *, hrtime_t);
 205 extern void fmd_timer_remove(fmd_hdl_t *, id_t);
 206
 207 extern nvlist_t *fmd_nvl_create_fault(fmd_hdl_t *,
 208     const char *, uint8_t, nvlist_t *, nvlist_t *, nvlist_t *);
 209
 210 extern int fmd_nvl_class_match(fmd_hdl_t *, nvlist_t *, const char *);
 211
 212 #define FMD_HAS_FAULT_FRU       0
 213 #define FMD_HAS_FAULT_ASRU      1
 214 #define FMD_HAS_FAULT_RESOURCE  2
 215
 216 extern void fmd_repair_fru(fmd_hdl_t *, const char *);
 217 extern int fmd_repair_asru(fmd_hdl_t *, const char *);
 218
 219 extern nvlist_t *fmd_nvl_alloc(fmd_hdl_t *, int);
 220 extern nvlist_t *fmd_nvl_dup(fmd_hdl_t *, nvlist_t *, int);
 221
 222 /*
 223  * ZED Specific Interfaces
 224  */
 225
 226 extern fmd_hdl_t *fmd_module_hdl(const char *);
 227 extern boolean_t fmd_module_initialized(fmd_hdl_t *);
 228 extern void fmd_module_recv(fmd_hdl_t *, nvlist_t *, const char *);
 229
 230 /* ZFS FMA Retire Agent */
 231 extern void _zfs_retire_init(fmd_hdl_t *);
 232 extern void _zfs_retire_fini(fmd_hdl_t *);
 233
 234 /* ZFS FMA Diagnosis Engine */
 235 extern void _zfs_diagnosis_init(fmd_hdl_t *);
 236 extern void _zfs_diagnosis_fini(fmd_hdl_t *);
 237
 238 #ifdef  __cplusplus
 239 }
 240 #endif
 241
 242 #endif  /* _FMD_API_H */