/
iSCSIIOEventSource.h
105 lines (88 loc) · 4.27 KB
/
iSCSIIOEventSource.h
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
/*
* Copyright (c) 2016, Nareg Sinenian
* 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.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 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 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 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 DAMAGE.
*/
#ifndef __ISCSI_IO_EVENT_SOURCE_H__
#define __ISCSI_IO_EVENT_SOURCE_H__
#include <IOKit/IOService.h>
#include <IOKit/IOEventSource.h>
#include <sys/kpi_socket.h>
#include <kern/queue.h>
#include "iSCSIKernelClasses.h"
#include "iSCSITypesKernel.h"
struct iSCSITask;
class iSCSIVirtualHBA;
/*! This event source wraps around a network socket and provides a software
* interrupt when data becomes available at a the socket. It is used to wake
* up the driver's workloop and to process incoming data by using a callback
* function (see Action private member). The callback function is executed
* within the driver's workloop when the workloop calls the function
* checkForWork(). The action member and a socket is specified when this class
* is initialized (by calling init()). For the signaling mechanism to work,
* the static member socketCallback must be used as the callback function when
* your socket is created. Users of this class must first create a socket
* with the static member as the callback, and then instantiate this class
* and call init(), passing in the socket. */
class iSCSIIOEventSource : public IOEventSource
{
OSDeclareDefaultStructors(iSCSIIOEventSource);
public:
/*! Pointer to the method that is called (within the driver's workloop)
* when data becomes available at a network socket. */
typedef bool (*Action) (iSCSISession * session,
iSCSIConnection * connection);
/*! Initializes the event source with an owner and an action.
* @param owner the owner that this event source will be attached to.
* @param action pointer to a function to call when processing
* interrupts. This function is called by checkForWork() and executes in
* the owner's workloop.
* @param session the session object.
* @param connection the connection object.
* @return true if the event source was successfully initialized. */
virtual bool init(iSCSIVirtualHBA * owner,
iSCSIIOEventSource::Action action,
iSCSISession * session,
iSCSIConnection * connection);
/*! Callback function for BSD sockets. Assign this function as the
* call back when opening a socket using sock_socket(). Note that the
* cookie (see sock_socket() documentation) must be an instance of
* an event source. */
static void socketCallback(socket_t so,
iSCSIIOEventSource * eventSource,
int waitf);
protected:
/*! Called by the attached work loop to check if there is any processing
* to be completed. This fu nction will call the action method pointed
* to by this object.
* @return true if there was work, false otherwise. */
virtual bool checkForWork();
private:
/*! The iSCSI session associated with this event source. */
iSCSISession * session;
/*! The iSCSI connection associated with this event source. */
iSCSIConnection * connection;
};
#endif /* defined(__ISCSI_EVENT_SOURCE_H__) */