1*7a0c41d5SAlan Somers /*- 2*7a0c41d5SAlan Somers * Copyright (c) 2011, 2012, 2013 Spectra Logic Corporation 3*7a0c41d5SAlan Somers * All rights reserved. 4*7a0c41d5SAlan Somers * 5*7a0c41d5SAlan Somers * Redistribution and use in source and binary forms, with or without 6*7a0c41d5SAlan Somers * modification, are permitted provided that the following conditions 7*7a0c41d5SAlan Somers * are met: 8*7a0c41d5SAlan Somers * 1. Redistributions of source code must retain the above copyright 9*7a0c41d5SAlan Somers * notice, this list of conditions, and the following disclaimer, 10*7a0c41d5SAlan Somers * without modification. 11*7a0c41d5SAlan Somers * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12*7a0c41d5SAlan Somers * substantially similar to the "NO WARRANTY" disclaimer below 13*7a0c41d5SAlan Somers * ("Disclaimer") and any redistribution must be conditioned upon 14*7a0c41d5SAlan Somers * including a substantially similar Disclaimer requirement for further 15*7a0c41d5SAlan Somers * binary redistribution. 16*7a0c41d5SAlan Somers * 17*7a0c41d5SAlan Somers * NO WARRANTY 18*7a0c41d5SAlan Somers * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19*7a0c41d5SAlan Somers * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20*7a0c41d5SAlan Somers * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 21*7a0c41d5SAlan Somers * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22*7a0c41d5SAlan Somers * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23*7a0c41d5SAlan Somers * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24*7a0c41d5SAlan Somers * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25*7a0c41d5SAlan Somers * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26*7a0c41d5SAlan Somers * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27*7a0c41d5SAlan Somers * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28*7a0c41d5SAlan Somers * POSSIBILITY OF SUCH DAMAGES. 29*7a0c41d5SAlan Somers * 30*7a0c41d5SAlan Somers * Authors: Justin T. Gibbs (Spectra Logic Corporation) 31*7a0c41d5SAlan Somers */ 32*7a0c41d5SAlan Somers 33*7a0c41d5SAlan Somers /** 34*7a0c41d5SAlan Somers * \file zfsd_exception.h 35*7a0c41d5SAlan Somers * 36*7a0c41d5SAlan Somers * Definition of the ZfsdException class hierarchy. All exceptions 37*7a0c41d5SAlan Somers * explicitly thrown by Zfsd are defined here. 38*7a0c41d5SAlan Somers * 39*7a0c41d5SAlan Somers * Header requirements: 40*7a0c41d5SAlan Somers * #include <string> 41*7a0c41d5SAlan Somers * 42*7a0c41d5SAlan Somers * #include <devdctl/exception.h> 43*7a0c41d5SAlan Somers */ 44*7a0c41d5SAlan Somers #ifndef _ZFSD_EXCEPTION_H_ 45*7a0c41d5SAlan Somers #define _ZFSD_EXCEPTION_H_ 46*7a0c41d5SAlan Somers 47*7a0c41d5SAlan Somers /*=========================== Forward Declarations ===========================*/ 48*7a0c41d5SAlan Somers struct zpool_handle; 49*7a0c41d5SAlan Somers typedef struct zpool_handle zpool_handle_t; 50*7a0c41d5SAlan Somers 51*7a0c41d5SAlan Somers struct nvlist; 52*7a0c41d5SAlan Somers typedef struct nvlist nvlist_t; 53*7a0c41d5SAlan Somers 54*7a0c41d5SAlan Somers /*============================= Class Definitions ============================*/ 55*7a0c41d5SAlan Somers /*------------------------------- ZfsdException ------------------------------*/ 56*7a0c41d5SAlan Somers /** 57*7a0c41d5SAlan Somers * \brief Class allowing unified reporting/logging of exceptional events. 58*7a0c41d5SAlan Somers */ 59*7a0c41d5SAlan Somers class ZfsdException : public DevdCtl::Exception 60*7a0c41d5SAlan Somers { 61*7a0c41d5SAlan Somers public: 62*7a0c41d5SAlan Somers /** 63*7a0c41d5SAlan Somers * \brief ZfsdException constructor allowing arbitrary string 64*7a0c41d5SAlan Somers * data to be reported. 65*7a0c41d5SAlan Somers * 66*7a0c41d5SAlan Somers * \param fmt Printf-like string format specifier. 67*7a0c41d5SAlan Somers */ 68*7a0c41d5SAlan Somers ZfsdException(const char *fmt, ...); 69*7a0c41d5SAlan Somers 70*7a0c41d5SAlan Somers /** 71*7a0c41d5SAlan Somers * \brief ZfsdException constructor allowing arbitrary string 72*7a0c41d5SAlan Somers * data to be reported and associated with the configuration 73*7a0c41d5SAlan Somers * data for a ZFS pool. 74*7a0c41d5SAlan Somers * 75*7a0c41d5SAlan Somers * \param pool Pool handle describing the pool to which this 76*7a0c41d5SAlan Somers * exception is associated. 77*7a0c41d5SAlan Somers * \param fmt Printf-like string format specifier. 78*7a0c41d5SAlan Somers * 79*7a0c41d5SAlan Somers * Instantiation with this method is used to report global 80*7a0c41d5SAlan Somers * pool errors. 81*7a0c41d5SAlan Somers */ 82*7a0c41d5SAlan Somers ZfsdException(zpool_handle_t *pool, const char *, ...); 83*7a0c41d5SAlan Somers 84*7a0c41d5SAlan Somers /** 85*7a0c41d5SAlan Somers * \brief ZfsdException constructor allowing arbitrary string 86*7a0c41d5SAlan Somers * data to be reported and associated with the configuration 87*7a0c41d5SAlan Somers * data for a ZFS pool. 88*7a0c41d5SAlan Somers * 89*7a0c41d5SAlan Somers * \param poolConfig Pool configuration describing the pool to 90*7a0c41d5SAlan Somers * which this exception is associated. 91*7a0c41d5SAlan Somers * \param fmt Printf-like string format specifier. 92*7a0c41d5SAlan Somers * 93*7a0c41d5SAlan Somers * Instantiation with this method is used to report global 94*7a0c41d5SAlan Somers * pool errors. 95*7a0c41d5SAlan Somers */ 96*7a0c41d5SAlan Somers ZfsdException(nvlist_t *poolConfig, const char *, ...); 97*7a0c41d5SAlan Somers 98*7a0c41d5SAlan Somers /** 99*7a0c41d5SAlan Somers * \brief Emit exception data to syslog(3). 100*7a0c41d5SAlan Somers */ 101*7a0c41d5SAlan Somers virtual void Log() const; 102*7a0c41d5SAlan Somers private: 103*7a0c41d5SAlan Somers nvlist_t *m_poolConfig; 104*7a0c41d5SAlan Somers nvlist_t *m_vdevConfig; 105*7a0c41d5SAlan Somers }; 106*7a0c41d5SAlan Somers 107*7a0c41d5SAlan Somers #endif /* _ZFSD_EXCEPTION_H_ */ 108