1300906Sasomers/*- 2300906Sasomers * Copyright (c) 2011, 2012, 2013, 2014 Spectra Logic Corporation 3300906Sasomers * All rights reserved. 4300906Sasomers * 5300906Sasomers * Redistribution and use in source and binary forms, with or without 6300906Sasomers * modification, are permitted provided that the following conditions 7300906Sasomers * are met: 8300906Sasomers * 1. Redistributions of source code must retain the above copyright 9300906Sasomers * notice, this list of conditions, and the following disclaimer, 10300906Sasomers * without modification. 11300906Sasomers * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12300906Sasomers * substantially similar to the "NO WARRANTY" disclaimer below 13300906Sasomers * ("Disclaimer") and any redistribution must be conditioned upon 14300906Sasomers * including a substantially similar Disclaimer requirement for further 15300906Sasomers * binary redistribution. 16300906Sasomers * 17300906Sasomers * NO WARRANTY 18300906Sasomers * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19300906Sasomers * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20300906Sasomers * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 21300906Sasomers * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22300906Sasomers * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23300906Sasomers * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24300906Sasomers * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25300906Sasomers * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26300906Sasomers * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27300906Sasomers * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28300906Sasomers * POSSIBILITY OF SUCH DAMAGES. 29300906Sasomers * 30300906Sasomers * Authors: Justin T. Gibbs (Spectra Logic Corporation) 31300906Sasomers */ 32300906Sasomers 33300906Sasomers/** 34300906Sasomers * \file consumer.cc 35300906Sasomers */ 36300906Sasomers 37300906Sasomers#include <sys/cdefs.h> 38300906Sasomers#include <sys/poll.h> 39300906Sasomers#include <sys/socket.h> 40300906Sasomers#include <sys/un.h> 41300906Sasomers 42300906Sasomers#include <err.h> 43300906Sasomers#include <errno.h> 44300906Sasomers#include <fcntl.h> 45300906Sasomers#include <syslog.h> 46300906Sasomers#include <unistd.h> 47300906Sasomers 48300906Sasomers#include <cstdarg> 49300906Sasomers#include <cstring> 50300906Sasomers#include <list> 51300906Sasomers#include <map> 52300906Sasomers#include <string> 53300906Sasomers 54300906Sasomers#include "guid.h" 55300906Sasomers#include "event.h" 56300906Sasomers#include "event_factory.h" 57300906Sasomers#include "exception.h" 58300906Sasomers 59300906Sasomers#include "consumer.h" 60300906Sasomers 61300906Sasomers__FBSDID("$FreeBSD: stable/11/lib/libdevdctl/consumer.cc 307792 2016-10-22 20:50:49Z bapt $"); 62300906Sasomers 63300906Sasomers/*================================== Macros ==================================*/ 64300906Sasomers#define NUM_ELEMENTS(x) (sizeof(x) / sizeof(*x)) 65300906Sasomers 66300906Sasomers/*============================ Namespace Control =============================*/ 67300906Sasomersusing std::string; 68300906Sasomersnamespace DevdCtl 69300906Sasomers{ 70300906Sasomers 71300906Sasomers/*============================= Class Definitions ============================*/ 72300906Sasomers/*----------------------------- DevdCtl::Consumer ----------------------------*/ 73300906Sasomers//- Consumer Static Private Data ----------------------------------------------- 74300906Sasomersconst char Consumer::s_devdSockPath[] = "/var/run/devd.seqpacket.pipe"; 75300906Sasomers 76300906Sasomers//- Consumer Public Methods ---------------------------------------------------- 77300906SasomersConsumer::Consumer(Event::BuildMethod *defBuilder, 78300906Sasomers EventFactory::Record *regEntries, 79300906Sasomers size_t numEntries) 80300906Sasomers : m_devdSockFD(-1), 81300906Sasomers m_eventFactory(defBuilder), 82300906Sasomers m_replayingEvents(false) 83300906Sasomers{ 84300906Sasomers m_eventFactory.UpdateRegistry(regEntries, numEntries); 85300906Sasomers} 86300906Sasomers 87300906SasomersConsumer::~Consumer() 88300906Sasomers{ 89300906Sasomers DisconnectFromDevd(); 90300906Sasomers} 91300906Sasomers 92300906Sasomersbool 93300906SasomersConsumer::ConnectToDevd() 94300906Sasomers{ 95300906Sasomers struct sockaddr_un devdAddr; 96300906Sasomers int sLen; 97300906Sasomers int result; 98300906Sasomers 99300906Sasomers if (m_devdSockFD != -1) { 100300906Sasomers /* Already connected. */ 101300906Sasomers syslog(LOG_DEBUG, "%s: Already connected.", __func__); 102300906Sasomers return (true); 103300906Sasomers } 104300906Sasomers syslog(LOG_INFO, "%s: Connecting to devd.", __func__); 105300906Sasomers 106300906Sasomers memset(&devdAddr, 0, sizeof(devdAddr)); 107300906Sasomers devdAddr.sun_family= AF_UNIX; 108300906Sasomers strlcpy(devdAddr.sun_path, s_devdSockPath, sizeof(devdAddr.sun_path)); 109300906Sasomers sLen = SUN_LEN(&devdAddr); 110300906Sasomers 111307792Sbapt m_devdSockFD = socket(AF_UNIX, SOCK_SEQPACKET | SOCK_NONBLOCK, 0); 112300906Sasomers if (m_devdSockFD == -1) 113300906Sasomers err(1, "Unable to create socket"); 114300906Sasomers result = connect(m_devdSockFD, 115300906Sasomers reinterpret_cast<sockaddr *>(&devdAddr), 116300906Sasomers sLen); 117300906Sasomers if (result == -1) { 118300906Sasomers syslog(LOG_INFO, "Unable to connect to devd"); 119300906Sasomers DisconnectFromDevd(); 120300906Sasomers return (false); 121300906Sasomers } 122300906Sasomers 123300906Sasomers syslog(LOG_INFO, "Connection to devd successful"); 124300906Sasomers return (true); 125300906Sasomers} 126300906Sasomers 127300906Sasomersvoid 128300906SasomersConsumer::DisconnectFromDevd() 129300906Sasomers{ 130301087Sasomers if (m_devdSockFD != -1) { 131300906Sasomers syslog(LOG_INFO, "Disconnecting from devd."); 132301087Sasomers close(m_devdSockFD); 133301087Sasomers } 134300906Sasomers m_devdSockFD = -1; 135300906Sasomers} 136300906Sasomers 137300906Sasomersstd::string 138300906SasomersConsumer::ReadEvent() 139300906Sasomers{ 140300906Sasomers char buf[MAX_EVENT_SIZE + 1]; 141300906Sasomers ssize_t len; 142300906Sasomers 143300906Sasomers len = ::recv(m_devdSockFD, buf, MAX_EVENT_SIZE, MSG_WAITALL); 144300906Sasomers if (len == -1) 145300906Sasomers return (std::string("")); 146300906Sasomers else { 147300906Sasomers /* NULL-terminate the result */ 148300906Sasomers buf[len] = '\0'; 149300906Sasomers return (std::string(buf)); 150300906Sasomers } 151300906Sasomers} 152300906Sasomers 153300906Sasomersvoid 154300906SasomersConsumer::ReplayUnconsumedEvents(bool discardUnconsumed) 155300906Sasomers{ 156300906Sasomers EventList::iterator event(m_unconsumedEvents.begin()); 157300906Sasomers bool replayed_any = (event != m_unconsumedEvents.end()); 158300906Sasomers 159300906Sasomers m_replayingEvents = true; 160300906Sasomers if (replayed_any) 161300906Sasomers syslog(LOG_INFO, "Started replaying unconsumed events"); 162300906Sasomers while (event != m_unconsumedEvents.end()) { 163300906Sasomers bool consumed((*event)->Process()); 164300906Sasomers if (consumed || discardUnconsumed) { 165300906Sasomers delete *event; 166300906Sasomers event = m_unconsumedEvents.erase(event); 167300906Sasomers } else { 168300906Sasomers event++; 169300906Sasomers } 170300906Sasomers } 171300906Sasomers if (replayed_any) 172300906Sasomers syslog(LOG_INFO, "Finished replaying unconsumed events"); 173300906Sasomers m_replayingEvents = false; 174300906Sasomers} 175300906Sasomers 176300906Sasomersbool 177300906SasomersConsumer::SaveEvent(const Event &event) 178300906Sasomers{ 179300906Sasomers if (m_replayingEvents) 180300906Sasomers return (false); 181300906Sasomers m_unconsumedEvents.push_back(event.DeepCopy()); 182300906Sasomers return (true); 183300906Sasomers} 184300906Sasomers 185300906SasomersEvent * 186300906SasomersConsumer::NextEvent() 187300906Sasomers{ 188300906Sasomers if (!Connected()) 189300906Sasomers return(NULL); 190300906Sasomers 191300906Sasomers Event *event(NULL); 192300906Sasomers try { 193300906Sasomers string evString; 194300906Sasomers 195300906Sasomers evString = ReadEvent(); 196300906Sasomers if (! evString.empty()) { 197300906Sasomers Event::TimestampEventString(evString); 198300906Sasomers event = Event::CreateEvent(m_eventFactory, evString); 199300906Sasomers } 200300906Sasomers } catch (const Exception &exp) { 201300906Sasomers exp.Log(); 202300906Sasomers DisconnectFromDevd(); 203300906Sasomers } 204300906Sasomers return (event); 205300906Sasomers} 206300906Sasomers 207300906Sasomers/* Capture and process buffered events. */ 208300906Sasomersvoid 209300906SasomersConsumer::ProcessEvents() 210300906Sasomers{ 211300906Sasomers Event *event; 212300906Sasomers while ((event = NextEvent()) != NULL) { 213300906Sasomers if (event->Process()) 214300906Sasomers SaveEvent(*event); 215300906Sasomers delete event; 216300906Sasomers } 217300906Sasomers} 218300906Sasomers 219300906Sasomersvoid 220300906SasomersConsumer::FlushEvents() 221300906Sasomers{ 222300906Sasomers std::string s; 223300906Sasomers 224300906Sasomers do 225300906Sasomers s = ReadEvent(); 226300906Sasomers while (! s.empty()) ; 227300906Sasomers} 228300906Sasomers 229300906Sasomersbool 230300906SasomersConsumer::EventsPending() 231300906Sasomers{ 232300906Sasomers struct pollfd fds[1]; 233300906Sasomers int result; 234300906Sasomers 235300906Sasomers do { 236300906Sasomers fds->fd = m_devdSockFD; 237300906Sasomers fds->events = POLLIN; 238300906Sasomers fds->revents = 0; 239300906Sasomers result = poll(fds, NUM_ELEMENTS(fds), /*timeout*/0); 240300906Sasomers } while (result == -1 && errno == EINTR); 241300906Sasomers 242300906Sasomers if (result == -1) 243300906Sasomers err(1, "Polling for devd events failed"); 244300906Sasomers 245300906Sasomers if ((fds->revents & POLLERR) != 0) 246300906Sasomers throw Exception("Consumer::EventsPending(): " 247300906Sasomers "POLLERR detected on devd socket."); 248300906Sasomers 249300906Sasomers if ((fds->revents & POLLHUP) != 0) 250300906Sasomers throw Exception("Consumer::EventsPending(): " 251300906Sasomers "POLLHUP detected on devd socket."); 252300906Sasomers 253300906Sasomers return ((fds->revents & POLLIN) != 0); 254300906Sasomers} 255300906Sasomers 256300906Sasomers} // namespace DevdCtl 257