usr.sbin/zfsd/case_file.h

38  * CaseFile objects aggregate vdev faults that may require ZFSD action
52 class CaseFile;
60 typedef std::list< CaseFile *> CaseFileList;
62 /*--------------------------------- CaseFile ---------------------------------*/
64  * A CaseFile object is instantiated anytime a vdev for an active pool
68  * A vdev may have at most one CaseFile.
71  * or an action is taken to resolve the issues recorded in the CaseFile.
74  * to resolve a fault is required or even desired.  For example, a CaseFile
79  * reasons, CaseFile%%s with accumulated I/O error events are serialized
82  * CaseFile%%s for missing, faulted, or degradded members are just recreated
85 class CaseFile
89 	 * \brief Find a CaseFile object by a vdev's pool/vdev GUID tuple.
91 	 * \param poolGUID  Pool GUID for the vdev of the CaseFile to find.
94 	 * \param vdevGUID  Vdev GUID for the vdev of the CaseFile to find.
96 	 * \return  If found, a pointer to a valid CaseFile object.
99 	static CaseFile *Find(DevdCtl::Guid poolGUID, DevdCtl::Guid vdevGUID);
102 	 * \brief Find a CaseFile object by a vdev's current/last known
105 	 * \param physPath  Physical path of the vdev of the CaseFile to find.
107 	 * \return  If found, a pointer to a valid CaseFile object.
110 	static CaseFile *Find(const string &physPath);
122 	 * \brief Create or return an existing active CaseFile for the
125 	 * \param vdev  The vdev object for which to find/create a CaseFile.
127 	 * \return  A reference to a valid CaseFile object.
129 	static CaseFile &Create(Vdev &vdev);
132 	 * \brief Deserialize all serialized CaseFile objects found in
143 	 * \brief Emit syslog data on all active CaseFile%%s in the system.
148 	 * \brief Destroy the in-core cache of CaseFile data.
150 	 * This routine does not disturb the on disk, serialized, CaseFile
163 	 * \brief Attempt to resolve this CaseFile using the disk
174 	 * \return  True if this event was consumed by this CaseFile.
180 	 * \brief Update this CaseFile in light of the provided ZfsEvent.
186 	 * \return  True if this event was consumed by this CaseFile.
208 	 * \brief Emit data about this CaseFile via syslog(3).
236 	 *        serialized CaseFile data.
247 	 *        CaseFile object, create/update an in-core CaseFile object
251 	 *                  from a CaseFile object.
256 	CaseFile(const Vdev &vdev);
262 	virtual ~CaseFile();
265 	 * \brief Reload state for the vdev associated with this CaseFile.
268 	 *          has no record of the pool or vdev for this CaseFile.
304 	 * \brief Unconditionally close a CaseFile.
358 	 * \brief The file system path to serialized CaseFile data.
398 CaseFile::PoolGUID() const
404 CaseFile::VdevGUID() const
410 CaseFile::VdevState() const
416 CaseFile::PoolGUIDString() const
422 CaseFile::VdevGUIDString() const
428 CaseFile::PhysicalPath() const