xref: /illumos-gate/usr/src/cmd/fm/modules/common/eversholt/README (revision 581cede61ac9c14d8d4ea452562a567189eead78)
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, Version 1.0 only
6# (the "License").  You may not use this file except in compliance
7# with the License.
8#
9# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10# or http://www.opensolaris.org/os/licensing.
11# See the License for the specific language governing permissions
12# and limitations under the License.
13#
14# When distributing Covered Code, include this CDDL HEADER in each
15# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16# If applicable, add the following below this CDDL HEADER, with the
17# fields enclosed by brackets "[]" replaced with your own identifying
18# information: Portions Copyright [yyyy] [name of copyright owner]
19#
20# CDDL HEADER END
21#
22
23Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24Use is subject to license terms.
25
26#pragma ident	"%Z%%M%	%I%	%E% SMI"
27
28This file is usr/src/cmd/fma/modules/common/eversholt/README.
29
30The files in this directory build the "eft.so" plugin to the
31fault management daemon (fmd).  This plugin is a diagnosis engine
32driven by one or more eversholt fault tree (.eft) files.
33
34eft.c implements the diagnosis engine entry points expected by
35the fmd.  The diagnosis engine is considered platform-neutral
36code and is being used on other, non-Solaris platforms.  The platform
37specific services it requires are either provided by the fmd interfaces,
38or by the routines in platform.c in this directory.
39
40Most of the files that go into building eft.so are shared with the
41eversholt compiler.  Those files are pulled in by the Makefile
42in this directory.  They live in:
43	usr/src/cmd/fma/eversholt/common
44
45When running under Solaris, eft.so uses the hardware topology library
46(libtopo) to collect configuration information.
47