mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-12-28 20:09:35 +03:00
266852767f
This topic branch leverages the Solaris style FMA call points
in ZFS to create a user space visible event notification system
under Linux. This new system is called zevent and it unifies
all previous Solaris style ereports and sysevent notifications.
Under this Linux specific scheme when a sysevent or ereport event
occurs an nvlist describing the event is created which looks almost
exactly like a Solaris ereport. These events are queued up in the
kernel when they occur and conditionally logged to the console.
It is then up to a user space application to consume the events
and do whatever it likes with them.
To make this possible the existing /dev/zfs ABI has been extended
with two new ioctls which behave as follows.
* ZFS_IOC_EVENTS_NEXT
Get the next pending event. The kernel will keep track of the last
event consumed by the file descriptor and provide the next one if
available. If no new events are available the ioctl() will block
waiting for the next event. This ioctl may also be called in a
non-blocking mode by setting zc.zc_guid = ZEVENT_NONBLOCK. In the
non-blocking case if no events are available ENOENT will be returned.
It is possible that ESHUTDOWN will be returned if the ioctl() is
called while module unloading is in progress. And finally ENOMEM
may occur if the provided nvlist buffer is not large enough to
contain the entire event.
* ZFS_IOC_EVENTS_CLEAR
Clear are events queued by the kernel. The kernel will keep a fairly
large number of recent events queued, use this ioctl to clear the
in kernel list. This will effect all user space processes consuming
events.
The zpool command has been extended to use this events ABI with the
'events' subcommand. You may run 'zpool events -v' to output a
verbose log of all recent events. This is very similar to the
Solaris 'fmdump -ev' command with the key difference being it also
includes what would be considered sysevents under Solaris. You
may also run in follow mode with the '-f' option. To clear the
in kernel event queue use the '-c' option.
$ sudo cmd/zpool/zpool events -fv
TIME CLASS
May 13 2010 16:31:15.777711000 ereport.fs.zfs.config.sync
class = "ereport.fs.zfs.config.sync"
ena = 0x40982b7897700001
detector = (embedded nvlist)
version = 0x0
scheme = "zfs"
pool = 0xed976600de75dfa6
(end detector)
time = 0x4bec8bc3 0x2e5aed98
pool = "zpios"
pool_guid = 0xed976600de75dfa6
pool_context = 0x0
While the 'zpool events' command is handy for interactive debugging
it is not expected to be the primary consumer of zevents. This ABI
was primarily added to facilitate the addition of a user space
monitoring daemon. This daemon would consume all events posted by
the kernel and based on the type of event perform an action. For
most events simply forwarding them on to syslog is likely enough.
But this interface also cleanly allows for more sophisticated
actions to be taken such as generating an email for a failed drive.
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
116 lines
3.4 KiB
C
116 lines
3.4 KiB
C
/*
|
|
* CDDL HEADER START
|
|
*
|
|
* The contents of this file are subject to the terms of the
|
|
* Common Development and Distribution License (the "License").
|
|
* You may not use this file except in compliance with the License.
|
|
*
|
|
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
* or http://www.opensolaris.org/os/licensing.
|
|
* See the License for the specific language governing permissions
|
|
* and limitations under the License.
|
|
*
|
|
* When distributing Covered Code, include this CDDL HEADER in each
|
|
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
* If applicable, add the following below this CDDL HEADER, with the
|
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
|
* information: Portions Copyright [yyyy] [name of copyright owner]
|
|
*
|
|
* CDDL HEADER END
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
|
|
*/
|
|
|
|
#ifndef _SYS_FM_UTIL_H
|
|
#define _SYS_FM_UTIL_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <sys/nvpair.h>
|
|
|
|
/*
|
|
* Shared user/kernel definitions for class length, error channel name,
|
|
* and kernel event publisher string.
|
|
*/
|
|
#define FM_MAX_CLASS 100
|
|
#define FM_ERROR_CHAN "com.sun:fm:error"
|
|
#define FM_PUB "fm"
|
|
|
|
/*
|
|
* ereport dump device transport support
|
|
*
|
|
* Ereports are written out to the dump device at a proscribed offset from the
|
|
* end, similar to in-transit log messages. The ereports are represented as a
|
|
* erpt_dump_t header followed by ed_size bytes of packed native nvlist data.
|
|
*
|
|
* NOTE: All of these constants and the header must be defined so they have the
|
|
* same representation for *both* 32-bit and 64-bit producers and consumers.
|
|
*/
|
|
#define ERPT_MAGIC 0xf00d4eddU
|
|
#define ERPT_MAX_ERRS 16
|
|
#define ERPT_DATA_SZ (6 * 1024)
|
|
#define ERPT_EVCH_MAX 256
|
|
#define ERPT_HIWAT 64
|
|
|
|
typedef struct erpt_dump {
|
|
uint32_t ed_magic; /* ERPT_MAGIC or zero to indicate end */
|
|
uint32_t ed_chksum; /* checksum32() of packed nvlist data */
|
|
uint32_t ed_size; /* ereport (nvl) fixed buf size */
|
|
uint32_t ed_pad; /* reserved for future use */
|
|
hrtime_t ed_hrt_nsec; /* hrtime of this ereport */
|
|
hrtime_t ed_hrt_base; /* hrtime sample corresponding to ed_tod_base */
|
|
struct {
|
|
uint64_t sec; /* seconds since gettimeofday() Epoch */
|
|
uint64_t nsec; /* nanoseconds past ed_tod_base.sec */
|
|
} ed_tod_base;
|
|
} erpt_dump_t;
|
|
|
|
#ifdef _KERNEL
|
|
|
|
#define ZEVENT_SHUTDOWN 0x1
|
|
|
|
typedef void zevent_cb_t(nvlist_t *, nvlist_t *);
|
|
|
|
typedef struct zevent_s {
|
|
nvlist_t *ev_nvl; /* protected by the zevent_lock */
|
|
nvlist_t *ev_detector; /* " */
|
|
list_t ev_ze_list; /* " */
|
|
list_node_t ev_node; /* " */
|
|
zevent_cb_t *ev_cb; /* " */
|
|
} zevent_t;
|
|
|
|
typedef struct zfs_zevent {
|
|
zevent_t *ze_zevent; /* protected by the zevent_lock */
|
|
list_node_t ze_node; /* " */
|
|
uint64_t ze_dropped; /* " */
|
|
} zfs_zevent_t;
|
|
|
|
extern void fm_init(void);
|
|
extern void fm_fini(void);
|
|
extern void fm_nvprint(nvlist_t *);
|
|
extern void zfs_zevent_post(nvlist_t *, nvlist_t *, zevent_cb_t *);
|
|
extern void zfs_zevent_drain_all(int *);
|
|
extern int zfs_zevent_fd_hold(int, minor_t *, zfs_zevent_t **);
|
|
extern void zfs_zevent_fd_rele(int);
|
|
extern int zfs_zevent_next(zfs_zevent_t *, nvlist_t **, uint64_t *);
|
|
extern int zfs_zevent_wait(zfs_zevent_t *);
|
|
extern void zfs_zevent_init(zfs_zevent_t **);
|
|
extern void zfs_zevent_destroy(zfs_zevent_t *);
|
|
|
|
#else
|
|
|
|
static inline void fm_init(void) { }
|
|
static inline void fm_fini(void) { }
|
|
|
|
#endif /* _KERNEL */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _SYS_FM_UTIL_H */
|