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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/*
* Linux 2.6.32 and later Kernel module for VMware MVP Guest Communications
*
* Copyright (C) 2010-2012 VMware, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as published by
* the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; see the file COPYING. If not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#line 5
/**
* @file
*
* @brief Generic shared memory transport private API.
*/
#ifndef _COMM_TRANSP_IMPL_H_
#define _COMM_TRANSP_IMPL_H_
#define INCLUDE_ALLOW_PV
#define INCLUDE_ALLOW_MODULE
#define INCLUDE_ALLOW_MONITOR
#define INCLUDE_ALLOW_GPL
#include "include_check.h"
#include "comm_transp.h"
/* Shared memory opaque descriptor/handle. Only meaningful locally. */
typedef struct CommTranspPriv *CommTransp;
/* Asynchronous signaling initialization arguments. */
typedef enum CommTranspIOEvent {
COMM_TRANSP_IO_DETACH = 0x0,
COMM_TRANSP_IO_IN = 0x1,
COMM_TRANSP_IO_OUT = 0x2,
COMM_TRANSP_IO_INOUT = 0x3
} CommTranspIOEvent;
typedef struct CommTranspEvent {
void (*ioEvent)(CommTransp transp, CommTranspIOEvent event, void *data);
void *ioEventData;
} CommTranspEvent;
/*
* Mechanism to detect and optionally attach to, created shared memory regions.
*/
typedef struct CommTranspListener {
int (*probe)(CommTranspInitArgs *transpArgs, void *probeData);
void *probeData;
} CommTranspListener;
/*
* Function prototypes.
*/
int CommTranspEvent_Init(void);
void CommTranspEvent_Exit(void);
int CommTranspEvent_Process(CommTranspID *transpID, CommTranspIOEvent event);
int
CommTranspEvent_Raise(unsigned int peerEvID,
CommTranspID *transpID,
CommTranspIOEvent event);
int CommTransp_Init(void);
void CommTransp_Exit(void);
int CommTransp_Register(const CommTranspListener *listener);
void CommTransp_Unregister(const CommTranspListener *listener);
int
CommTransp_Notify(const CommTranspID *notificationCenterID,
CommTranspInitArgs *transpArgs);
int
CommTransp_Open(CommTransp *transp,
CommTranspInitArgs *transpArgs,
CommTranspEvent *transpEvent);
void CommTransp_Close(CommTransp transp);
int CommTransp_EnqueueSpace(CommTransp transp);
int CommTransp_EnqueueReset(CommTransp transp);
int CommTransp_EnqueueCommit(CommTransp transp);
int
CommTransp_EnqueueSegment(CommTransp transp,
const void *buf,
unsigned int bufLen);
int CommTransp_DequeueSpace(CommTransp transp);
int CommTransp_DequeueReset(CommTransp transp);
int CommTransp_DequeueCommit(CommTransp transp);
int
CommTransp_DequeueSegment(CommTransp transp,
void *buf,
unsigned int bufLen);
unsigned int CommTransp_RequestInlineEvents(CommTransp transp);
unsigned int CommTransp_ReleaseInlineEvents(CommTransp transp);
/**
* @brief Enqueues data into the transport object, data is available for
* reading immediately.
* @param transp handle to the transport object.
* @param buf bytes to enqueue.
* @param bufLen number of bytes to enqueue.
* @return number of bytes enqueued on success, < 0 otherwise.
*/
static inline int
CommTransp_EnqueueAtomic(CommTransp transp,
const void *buf,
unsigned int bufLen)
{
int rc;
CommTransp_EnqueueReset(transp);
rc = CommTransp_EnqueueSegment(transp, buf, bufLen);
if (CommTransp_EnqueueCommit(transp)) {
rc = -1;
}
return rc;
}
/**
* @brief Dequeues data from the transport object into a buffer.
* @param transp handle to the transport object.
* @param[out] buf buffer to copy to.
* @param bufLen number of bytes to dequeue.
* @return number of bytes dequeued on success, < 0 otherwise,
*/
static inline int
CommTransp_DequeueAtomic(CommTransp transp,
void *buf,
unsigned int bufLen)
{
int rc;
CommTransp_DequeueReset(transp);
rc = CommTransp_DequeueSegment(transp, buf, bufLen);
if (CommTransp_DequeueCommit(transp)) {
rc = -1;
}
return rc;
}
#endif // _COMM_TRANSP_IMPL_H_
|
