libfmnotify/common/libfmnotify.h

f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby/*
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * CDDL HEADER START
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby *
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * The contents of this file are subject to the terms of the
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Common Development and Distribution License (the "License").
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * You may not use this file except in compliance with the License.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby *
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * or http://www.opensolaris.org/os/licensing.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * See the License for the specific language governing permissions
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * and limitations under the License.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby *
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * When distributing Covered Code, include this CDDL HEADER in each
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * If applicable, add the following below this CDDL HEADER, with the
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * fields enclosed by brackets "[]" replaced with your own identifying
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * information: Portions Copyright [yyyy] [name of copyright owner]
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby *
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * CDDL HEADER END
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby */
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby/*
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby */
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#ifndef _LIBFMNOTIFY_H
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define _LIBFMNOTIFY_H
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <stdio.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <stdlib.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <string.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <alloca.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <errno.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <libscf.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <limits.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <strings.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <sys/corectl.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <sys/resource.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <sys/types.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <unistd.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <fm/diagcode.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <fm/fmd_msg.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#include <fm/libfmevent.h>
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#ifdef __cplusplus
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyextern "C" {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#endif
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define ND_DICTDIR "usr/lib/fm/dict"
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#define ND_UNKNOWN "UNKNOWN"
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbytypedef struct nd_hdl {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    boolean_t   nh_debug;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    boolean_t   nh_is_daemon;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    boolean_t   nh_keep_running;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    /* handle for libfmevent calls */
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    fmev_shdl_t nh_evhdl;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    /* handle for libfmd_msg calls */
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    fmd_msg_hdl_t   *nh_msghdl;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    FILE        *nh_log_fd;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char        *nh_rootdir;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    const char  *nh_pname;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby} nd_hdl_t;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyconst char FMNOTIFY_MSG_DOMAIN[] = "FMNOTIFY";
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbytypedef struct nd_ev_info {
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    fmev_t ei_ev;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    const char *ei_class;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_descr;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_severity;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_diagcode;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_url;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_uuid;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_fmri;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_from_state;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_to_state;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char *ei_reason;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    nvlist_t *ei_payload;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby} nd_ev_info_t;
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_cleanup(nd_hdl_t *);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_dump_nvlist(nd_hdl_t *, nvlist_t *);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_debug(nd_hdl_t *, const char *, ...);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_error(nd_hdl_t *, const char *, ...);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_abort(nd_hdl_t *, const char *, ...);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_daemonize(nd_hdl_t *);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_get_boolean_prop(nd_hdl_t *, const char *, const char *, const char *,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    uint8_t *);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_get_astring_prop(nd_hdl_t *, const char *, const char *, const char *,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    char **);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbychar *nd_get_event_fmri(nd_hdl_t *, fmev_t);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_get_event_info(nd_hdl_t *, const char *, fmev_t, nd_ev_info_t **);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_get_notify_prefs(nd_hdl_t *, const char *, fmev_t, nvlist_t ***,
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby    uint_t *);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_split_list(nd_hdl_t *, char *, char *, char ***, uint_t *);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_join_strarray(nd_hdl_t *, char **, uint_t, char **);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_merge_strarray(nd_hdl_t *, char **, uint_t, char **, uint_t, char ***);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_free_event_info(nd_ev_info_t *);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_free_nvlarray(nvlist_t **, uint_t);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyvoid nd_free_strarray(char **, uint_t);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltbyint nd_get_diagcode(nd_hdl_t *, const char *, const char *, char *, size_t);
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#ifdef  __cplusplus
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby}
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#endif
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby
f6e214c7418f43af38bd8c3a557e3d0a1d311cfaGavin Maltby#endif  /* _LIBFMNOTIFY_H */