aboutsummaryrefslogtreecommitdiff
path: root/cddl/usr.sbin/zfsd/zfsd_event.h
blob: fd3f9f7c5200e2d92095c1ee3e6cd8e7dc643d79 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*-
 * Copyright (c) 2011, 2012, 2013, 2014, 2016 Spectra Logic Corporation
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 *
 * Authors: Justin T. Gibbs     (Spectra Logic Corporation)
 *
 * $FreeBSD$
 */

/**
 * \file dev_ctl_event.h
 *
 * \brief Class hierarchy used to express events received via
 *        the devdctl API.
 *
 * Header requirements:
 *    #include <string>
 *    #include <list>
 *    #include <map>
 *
 *    #include <devdctl/guid.h>
 *    #include <devdctl/event.h>
 */

#ifndef _ZFSD_EVENT_H_
#define	_ZFSD_EVENT_H_

/*============================ Namespace Control =============================*/
using std::string;

/*=========================== Forward Declarations ===========================*/
struct zpool_handle;
typedef struct zpool_handle zpool_handle_t;

struct nvlist;
typedef struct nvlist nvlist_t;

/*--------------------------------- ZfsEvent ---------------------------------*/
class ZfsEvent : public DevdCtl::ZfsEvent
{
public:
	/** Specialized DevdCtlEvent object factory for ZFS events. */
	static BuildMethod Builder;

	virtual DevdCtl::Event *DeepCopy() const;

	/**
	 * Interpret and perform any actions necessary to
	 * consume the event.
	 * \return True if this event should be queued for later reevaluation
	 */
	virtual bool Process()		  const;

protected:
	/** DeepCopy Constructor. */
	ZfsEvent(const ZfsEvent &src);

	/** Constructor */
	ZfsEvent(Type, DevdCtl::NVPairMap &, const string &);

	/**
	 * Detach any spares that are no longer needed, but were not
	 * automatically detached by the kernel
	 */
	virtual void CleanupSpares()	  const;
	virtual void ProcessPoolEvent()	  const;
	static VdevCallback_t TryDetach;
};

class GeomEvent : public DevdCtl::GeomEvent
{
public:
	static BuildMethod Builder;

	virtual DevdCtl::Event *DeepCopy() const; 

	virtual bool Process()		  const;

protected:
	/** DeepCopy Constructor. */
	GeomEvent(const GeomEvent &src);

	/** Constructor */
	GeomEvent(Type, DevdCtl::NVPairMap &, const string &);

	/**
	 * Attempt to match the ZFS labeled device at devPath with an active
	 * CaseFile for a missing vdev.  If a CaseFile is found, attempt
	 * to re-integrate the device with its pool.
	 *
	 * \param devPath    The devfs path to the potential leaf vdev.
	 * \param physPath   The physical path string reported by the device
	 *                   at devPath.
	 * \param devConfig  The ZFS label information found on the device
	 *                   at devPath.
	 *
	 * \return  true if the event that caused the online action can
	 *          be considered consumed.
	 */
	static bool	    OnlineByLabel(const string &devPath,
					  const string& physPath,
					  nvlist_t *devConfig);

	/**
	 * \brief Read and return label information for a device.
	 *
	 * \param devFd     The device from which to read ZFS label information.
	 * \param inUse     The device is part of an active or potentially
	 *                  active configuration.
	 * \param degraded  The device label indicates the vdev is not healthy.
	 *
	 * \return  If label information is available, an nvlist describing
	 *          the vdev configuraiton found on the device specified by
	 *          devFd.  Otherwise NULL.
	 */
	static nvlist_t    *ReadLabel(int devFd, bool &inUse, bool &degraded);

};
#endif /*_ZFSD_EVENT_H_ */