share/man/man8/th_manage.8

   1 '\" te
   2 .\" Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH TH_MANAGE 8 "Jan 4, 2001"
   7 .SH NAME
   8 th_manage \- manage the fault injection test harness
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBth_manage\fR \fIname\fR \fIinstance\fR \fIcommand\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fBth_manage\fR \fIpath\fR \fIcommand\fR
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 \fBth_manage\fR applies the action specified by \fIcommand\fR to the instance
  24 specified by \fIinstance\fR of the driver specified by \fIname\fR (or the
  25 driver instance specified by \fIpath\fR). The driver instance must be running
  26 fault injection specifications (errdefs) defined by \fBth_define\fR(8).
  27 .sp
  28 .LP
  29 \fBth_manage\fR supports several commands that operate on the driver instance
  30 specified by \fIname\fR and \fIinstance\fR (or \fIpath\fR). The commands are:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fBbroadcast\fR \fR
  35 .ad
  36 .RS 18n
  37 Awaken all \fBth_define\fR processes, causing them to display their current
  38 status and exit if the errdef is now defunct (that is, if \fIcount\fR,
  39 \fIfailcount\fR, and \fIacc_chk \fR are all zero).
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBclear_acc_chk\fR \fR
  46 .ad
  47 .RS 18n
  48 Awaken all \fBth_define\fR processes. If \fIcount\fR and \fIfailcount\fR are
  49 already zero, then set \fIacc_chk\fR to zero, so that \fBth_define\fR exits
  50 once it has displayed its status.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBclear_errdefs\fR \fR
  57 .ad
  58 .RS 18n
  59 Awaken all \fBth_define\fR \fBprocesses\fR. \fIcount\fR, \fIfailcount\fR and
  60 \fIacc_chk\fR are all set to zero so that all \fBth_define\fR commands exit
  61 once they have displayed their status.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBclear_errors\fR \fR
  68 .ad
  69 .RS 18n
  70 Awaken all \fBth_define\fR processes. If \fIcount\fR is already zero, set
  71 \fIfailcount\fR and \fIacc_chk\fR to zero, so that \fBth_define\fR exits once
  72 it has displayed its status.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBget_handles\fR \fR
  79 .ad
  80 .RS 18n
  81 List all the access handles.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBstart\fR \fR
  88 .ad
  89 .RS 18n
  90 Begin or resume execution of all errdefs.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBstop\fR \fR
  97 .ad
  98 .RS 18n
  99 Suspend all errdefs for this \fIname\fR and \fIinstance\fR (or \fIpath).\fR
 100 .RE
 101
 102 .SH EXAMPLES
 103 .LP
 104 \fBExample 1 \fRUseful Commands
 105 .sp
 106 .LP
 107 To begin the tests, enter:
 108
 109 .sp
 110 .LP
 111 \fB#\fR \fBth_manage\fR \fBfoo\fR \fB0\fR \fBstart\fR
 112
 113 .sp
 114 .LP
 115 To check the status of the errdefs, enter:
 116
 117 .sp
 118 .LP
 119 \fB#\fR \fBth_manage\fR \fBfoo\fR \fB0\fR \fBbroadcast\fR
 120
 121 .sp
 122 .LP
 123 This causes each \fBth_define\fR process to print out its current status.
 124
 125 .sp
 126 .LP
 127 If the driver has reported a fatal error, you can take the driver offline using
 128 \fBlibdevice\fR, clear the error condition by entering:
 129
 130 .sp
 131 .LP
 132 \fB#\fR \fBth_manage\fR \fBfoo\fR \fB0\fR \fBclear_acc_chk\fR
 133
 134 .sp
 135 .LP
 136 or
 137
 138 .sp
 139 .LP
 140 \fB#\fR \fBth_manage\fR \fBfoo\fR \fB0\fR \fBclear_errors\fR
 141
 142 .sp
 143 .LP
 144 and bring the driver online again using \fBlibdevice\fR.
 145
 146 .sp
 147 .LP
 148 To terminate testing, enter:
 149
 150 .sp
 151 .LP
 152 \fB#\fR \fBth_manage\fR \fBfoo\fR \fB0\fR \fBclear_errdefs\fR
 153
 154 .SH SEE ALSO
 155 .sp
 156 .LP
 157 \fBth_define\fR(8)