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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <string.h>
#include "system.h"
#include <osl/pipe.h>
#include <osl/diagnose.h>
#include <osl/thread.h>
#include <osl/mutex.h>
#include <osl/conditn.h>
#include <osl/interlck.h>
#include <osl/process.h>
#include <rtl/alloc.h>
#define PIPESYSTEM "\\\\.\\pipe\\"
#define PIPEPREFIX "OSL_PIPE_"
typedef struct
{
sal_uInt32 m_Size;
sal_uInt32 m_ReadPos;
sal_uInt32 m_WritePos;
BYTE m_Data[1];
} oslPipeBuffer;
struct oslPipeImpl
{
oslInterlockedCount m_Reference;
HANDLE m_File;
HANDLE m_NamedObject;
PSECURITY_ATTRIBUTES m_Security;
HANDLE m_ReadEvent;
HANDLE m_WriteEvent;
HANDLE m_AcceptEvent;
rtl_uString* m_Name;
oslPipeError m_Error;
bool m_bClosed;
};
oslPipe osl_createPipeImpl(void)
{
oslPipe pPipe;
pPipe = static_cast< oslPipe >(rtl_allocateZeroMemory(sizeof(struct oslPipeImpl)));
pPipe->m_bClosed = false;
pPipe->m_Reference = 0;
pPipe->m_Name = nullptr;
pPipe->m_File = INVALID_HANDLE_VALUE;
pPipe->m_NamedObject = INVALID_HANDLE_VALUE;
pPipe->m_ReadEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr);
pPipe->m_WriteEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr);
pPipe->m_AcceptEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr);
return pPipe;
}
void osl_destroyPipeImpl(oslPipe pPipe)
{
if (pPipe != nullptr)
{
if ( pPipe->m_NamedObject != INVALID_HANDLE_VALUE && pPipe->m_NamedObject != nullptr )
CloseHandle( pPipe->m_NamedObject );
if (pPipe->m_Security != nullptr)
{
rtl_freeMemory(pPipe->m_Security->lpSecurityDescriptor);
rtl_freeMemory(pPipe->m_Security);
}
CloseHandle(pPipe->m_ReadEvent);
CloseHandle(pPipe->m_WriteEvent);
CloseHandle(pPipe->m_AcceptEvent);
if (pPipe->m_Name)
rtl_uString_release(pPipe->m_Name);
rtl_freeMemory(pPipe);
}
}
oslPipe SAL_CALL osl_createPipe(rtl_uString *strPipeName, oslPipeOptions Options,
oslSecurity Security)
{
rtl_uString* name = nullptr;
rtl_uString* path = nullptr;
rtl_uString* temp = nullptr;
oslPipe pPipe;
PSECURITY_ATTRIBUTES pSecAttr = nullptr;
rtl_uString_newFromAscii(&path, PIPESYSTEM);
rtl_uString_newFromAscii(&name, PIPEPREFIX);
if (Security)
{
rtl_uString *Ident = nullptr;
rtl_uString *Delim = nullptr;
OSL_VERIFY(osl_getUserIdent(Security, &Ident));
rtl_uString_newFromAscii(&Delim, "_");
rtl_uString_newConcat(&temp, name, Ident);
rtl_uString_newConcat(&name, temp, Delim);
rtl_uString_release(Ident);
rtl_uString_release(Delim);
}
else
{
if (Options & osl_Pipe_CREATE)
{
PSECURITY_DESCRIPTOR pSecDesc;
pSecDesc = static_cast< PSECURITY_DESCRIPTOR >(rtl_allocateMemory(SECURITY_DESCRIPTOR_MIN_LENGTH));
/* add a NULL disc. ACL to the security descriptor */
OSL_VERIFY(InitializeSecurityDescriptor(pSecDesc, SECURITY_DESCRIPTOR_REVISION));
OSL_VERIFY(SetSecurityDescriptorDacl(pSecDesc, TRUE, nullptr, FALSE));
pSecAttr = static_cast< PSECURITY_ATTRIBUTES >(rtl_allocateMemory(sizeof(SECURITY_ATTRIBUTES)));
pSecAttr->nLength = sizeof(SECURITY_ATTRIBUTES);
pSecAttr->lpSecurityDescriptor = pSecDesc;
pSecAttr->bInheritHandle = TRUE;
}
}
rtl_uString_assign(&temp, name);
rtl_uString_newConcat(&name, temp, strPipeName);
/* alloc memory */
pPipe= osl_createPipeImpl();
osl_atomic_increment(&(pPipe->m_Reference));
/* build system pipe name */
rtl_uString_assign(&temp, path);
rtl_uString_newConcat(&path, temp, name);
rtl_uString_release(temp);
temp = nullptr;
if (Options & osl_Pipe_CREATE)
{
SetLastError( ERROR_SUCCESS );
pPipe->m_NamedObject = CreateMutexW(nullptr, FALSE, SAL_W(name->buffer));
if (pPipe->m_NamedObject != INVALID_HANDLE_VALUE && pPipe->m_NamedObject != nullptr)
{
if (GetLastError() != ERROR_ALREADY_EXISTS)
{
pPipe->m_Security = pSecAttr;
rtl_uString_assign(&pPipe->m_Name, name);
/* try to open system pipe */
pPipe->m_File = CreateNamedPipeW(
SAL_W(path->buffer),
PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
PIPE_WAIT | PIPE_TYPE_MESSAGE | PIPE_READMODE_MESSAGE,
PIPE_UNLIMITED_INSTANCES,
4096, 4096,
NMPWAIT_WAIT_FOREVER,
pPipe->m_Security);
if (pPipe->m_File != INVALID_HANDLE_VALUE)
{
rtl_uString_release( name );
rtl_uString_release( path );
return pPipe;
}
}
else
{
CloseHandle(pPipe->m_NamedObject);
pPipe->m_NamedObject = INVALID_HANDLE_VALUE;
}
}
}
else
{
BOOL fPipeAvailable;
do
{
/* free instance should be available first */
fPipeAvailable = WaitNamedPipeW(SAL_W(path->buffer), NMPWAIT_WAIT_FOREVER);
/* first try to open system pipe */
if (fPipeAvailable)
{
pPipe->m_File = CreateFileW(
SAL_W(path->buffer),
GENERIC_READ|GENERIC_WRITE,
FILE_SHARE_READ | FILE_SHARE_WRITE,
nullptr,
OPEN_EXISTING,
FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED,
nullptr);
if (pPipe->m_File != INVALID_HANDLE_VALUE)
{
// We got it !
rtl_uString_release(name);
rtl_uString_release(path);
return pPipe;
}
else
{
// Pipe instance maybe cached by another client -> try again
}
}
} while ( fPipeAvailable );
}
/* if we reach here something went wrong */
osl_destroyPipeImpl(pPipe);
return nullptr;
}
void SAL_CALL osl_acquirePipe(oslPipe pPipe)
{
osl_atomic_increment(&(pPipe->m_Reference));
}
void SAL_CALL osl_releasePipe(oslPipe pPipe)
{
// OSL_ASSERT( pPipe );
if (nullptr == pPipe)
return;
if (0 == osl_atomic_decrement(&(pPipe->m_Reference)))
{
if (!pPipe->m_bClosed)
osl_closePipe(pPipe);
osl_destroyPipeImpl(pPipe);
}
}
void SAL_CALL osl_closePipe(oslPipe pPipe)
{
if(pPipe && !pPipe->m_bClosed)
{
pPipe->m_bClosed = true;
/* if we have a system pipe close it */
if (pPipe->m_File != INVALID_HANDLE_VALUE)
{
DisconnectNamedPipe(pPipe->m_File);
CloseHandle(pPipe->m_File);
}
}
}
oslPipe SAL_CALL osl_acceptPipe(oslPipe pPipe)
{
oslPipe pAcceptedPipe = nullptr;
OVERLAPPED os;
DWORD nBytesTransfered;
rtl_uString* path = nullptr;
rtl_uString* temp = nullptr;
OSL_ASSERT(pPipe);
OSL_ASSERT(pPipe->m_File != INVALID_HANDLE_VALUE);
memset(&os, 0, sizeof(OVERLAPPED));
os.hEvent = pPipe->m_AcceptEvent;
ResetEvent(pPipe->m_AcceptEvent);
if (!ConnectNamedPipe(pPipe->m_File, &os))
{
switch (GetLastError())
{
case ERROR_PIPE_CONNECTED: // Client already connected to pipe
case ERROR_NO_DATA: // Client was connected but has already closed pipe end
// should only appear in nonblocking mode but in fact does
// in blocking asynchronous mode.
break;
case ERROR_PIPE_LISTENING: // Only for nonblocking mode but see ERROR_NO_DATA
case ERROR_IO_PENDING: // This is normal if not client is connected yet
case ERROR_MORE_DATA: // Should not happen
// blocking call to accept
if( !GetOverlappedResult(pPipe->m_File, &os, &nBytesTransfered, TRUE))
{
// Possible error could be that between ConnectNamedPipe and
// GetOverlappedResult a connect took place.
switch (GetLastError())
{
case ERROR_PIPE_CONNECTED: // Pipe was already connected
case ERROR_NO_DATA: // Pipe was connected but client has already closed -> ver fast client ;-)
break; // Everything's fine !!!
default:
// Something went wrong
return nullptr;
}
}
break;
default: // All other error say that somethings going wrong.
return nullptr;
}
}
pAcceptedPipe = osl_createPipeImpl();
OSL_ASSERT(pAcceptedPipe);
osl_atomic_increment(&(pAcceptedPipe->m_Reference));
rtl_uString_assign(&pAcceptedPipe->m_Name, pPipe->m_Name);
pAcceptedPipe->m_File = pPipe->m_File;
rtl_uString_newFromAscii(&temp, PIPESYSTEM);
rtl_uString_newConcat(&path, temp, pPipe->m_Name);
rtl_uString_release(temp);
// prepare for next accept
pPipe->m_File =
CreateNamedPipeW(SAL_W(path->buffer),
PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
PIPE_WAIT | PIPE_TYPE_MESSAGE | PIPE_READMODE_MESSAGE,
PIPE_UNLIMITED_INSTANCES,
4096, 4096,
NMPWAIT_WAIT_FOREVER,
pAcceptedPipe->m_Security);
rtl_uString_release(path);
return pAcceptedPipe;
}
sal_Int32 SAL_CALL osl_receivePipe(oslPipe pPipe,
void* pBuffer,
sal_Int32 BytesToRead)
{
DWORD nBytes;
OVERLAPPED os;
OSL_ASSERT(pPipe);
memset(&os, 0, sizeof(OVERLAPPED));
os.hEvent = pPipe->m_ReadEvent;
ResetEvent(pPipe->m_ReadEvent);
if (!ReadFile(pPipe->m_File, pBuffer, BytesToRead, &nBytes, &os) &&
((GetLastError() != ERROR_IO_PENDING) ||
!GetOverlappedResult(pPipe->m_File, &os, &nBytes, TRUE)))
{
DWORD lastError = GetLastError();
if (lastError == ERROR_MORE_DATA)
nBytes = BytesToRead;
else
{
if (lastError == ERROR_PIPE_NOT_CONNECTED)
nBytes = 0;
else
nBytes = (DWORD) -1;
pPipe->m_Error = osl_Pipe_E_ConnectionAbort;
}
}
return nBytes;
}
sal_Int32 SAL_CALL osl_sendPipe(oslPipe pPipe,
const void* pBuffer,
sal_Int32 BytesToSend)
{
DWORD nBytes;
OVERLAPPED os;
OSL_ASSERT(pPipe);
memset(&os, 0, sizeof(OVERLAPPED));
os.hEvent = pPipe->m_WriteEvent;
ResetEvent(pPipe->m_WriteEvent);
if (!WriteFile(pPipe->m_File, pBuffer, BytesToSend, &nBytes, &os) &&
((GetLastError() != ERROR_IO_PENDING) ||
! GetOverlappedResult(pPipe->m_File, &os, &nBytes, TRUE)))
{
if (GetLastError() == ERROR_PIPE_NOT_CONNECTED)
nBytes = 0;
else
nBytes = (DWORD) -1;
pPipe->m_Error = osl_Pipe_E_ConnectionAbort;
}
return nBytes;
}
sal_Int32 SAL_CALL osl_writePipe(oslPipe pPipe, const void *pBuffer , sal_Int32 n)
{
/* loop until all desired bytes were send or an error occurred */
sal_Int32 BytesSend = 0;
sal_Int32 BytesToSend = n;
OSL_ASSERT(pPipe);
while (BytesToSend > 0)
{
sal_Int32 RetVal;
RetVal= osl_sendPipe(pPipe, pBuffer, BytesToSend);
/* error occurred? */
if (RetVal <= 0)
break;
BytesToSend -= RetVal;
BytesSend += RetVal;
pBuffer= static_cast< sal_Char const* >(pBuffer) + RetVal;
}
return BytesSend;
}
sal_Int32 SAL_CALL osl_readPipe(oslPipe pPipe, void *pBuffer, sal_Int32 n)
{
/* loop until all desired bytes were read or an error occurred */
sal_Int32 BytesRead = 0;
sal_Int32 BytesToRead = n;
OSL_ASSERT(pPipe);
while (BytesToRead > 0)
{
sal_Int32 RetVal;
RetVal= osl_receivePipe(pPipe, pBuffer, BytesToRead);
/* error occurred? */
if(RetVal <= 0)
break;
BytesToRead -= RetVal;
BytesRead += RetVal;
pBuffer= static_cast< sal_Char* >(pBuffer) + RetVal;
}
return BytesRead;
}
oslPipeError SAL_CALL osl_getLastPipeError(oslPipe pPipe)
{
oslPipeError Error;
if (pPipe != nullptr)
{
Error = pPipe->m_Error;
pPipe->m_Error = osl_Pipe_E_None;
}
else
{
Error = osl_Pipe_E_NotFound;
}
return Error;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|