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
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
|
/****************************************************************************
(c) SYSTEC electronic GmbH, D-07973 Greiz, August-Bebel-Str. 29
www.systec-electronic.com
Project: Project independend shared buffer (linear + circular)
Description: Implementation of platform specific part for the
shared buffer
(Implementation for Win32)
License:
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.
3. Neither the name of SYSTEC electronic GmbH nor the names of its
contributors may be used to endorse or promote products derived
from this software without prior written permission. For written
permission, please contact info@systec-electronic.com.
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 HOLDERS 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.
Severability Clause:
If a provision of this License is or becomes illegal, invalid or
unenforceable in any jurisdiction, that shall not affect:
1. the validity or enforceability in that jurisdiction of any other
provision of this License; or
2. the validity or enforceability in other jurisdictions of that or
any other provision of this License.
-------------------------------------------------------------------------
2006/06/27 -rs: V 1.00 (initial version)
****************************************************************************/
#define WINVER 0x0400 // #defines necessary for usage of
#define _WIN32_WINNT 0x0400 // function <SignalObjectAndWait>
#include <windows.h>
#include <stdio.h>
#include "global.h"
#include "sharedbuff.h"
#include "shbipc.h"
/***************************************************************************/
/* */
/* */
/* G L O B A L D E F I N I T I O N S */
/* */
/* */
/***************************************************************************/
#if (!defined(SHBIPC_INLINED)) || defined(SHBIPC_INLINE_ENABLED)
//---------------------------------------------------------------------------
// Configuration
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// Constant definitions
//---------------------------------------------------------------------------
#define MAX_LEN_BUFFER_ID MAX_PATH
#define IDX_EVENT_NEW_DATA 0
#define IDX_EVENT_TERM_REQU 1
#define IDX_EVENT_TERM_RESP 2
#define NAME_MUTEX_BUFF_ACCESS "BuffAccess"
#define NAME_EVENT_NEW_DATA "NewData"
#define NAME_EVENT_TERM_REQU "TermRequ"
#define NAME_EVENT_TERM_RESP "TermResp"
#define NAME_EVENT_JOB_READY "JobReady"
#define TIMEOUT_ENTER_ATOMIC 1000 // for debgging: INFINITE
#define TIMEOUT_TERM_THREAD 2000
#define SBI_MAGIC_ID 0x5342492B // magic ID ("SBI+")
#define SBH_MAGIC_ID 0x5342482A // magic ID ("SBH*")
//---------------------------------------------------------------------------
// Local types
//---------------------------------------------------------------------------
// This structure is the common header for the shared memory region used
// by all processes attached this shared memory. It includes common
// information to administrate/manage the shared buffer from a couple of
// separated processes (e.g. the refernce counter). This structure is
// located at the start of the shared memory region itself and exists
// consequently only one times per shared memory instance.
typedef struct
{
unsigned long m_SbhMagicID; // magic ID ("SBH*")
unsigned long m_ulShMemSize;
unsigned long m_ulRefCount;
char m_szBufferID[MAX_LEN_BUFFER_ID];
#ifndef NDEBUG
unsigned long m_ulOwnerProcID;
#endif
} tShbMemHeader;
// This structure is the "external entry point" from a separate process
// to get access to a shared buffer. This structure includes all platform
// resp. target specific information to administrate/manage the shared
// buffer from a separate process. Every process attached to the shared
// buffer has its own runtime instance of this structure with its individual
// runtime data (e.g. the scope of an event handle is limitted to the
// owner process only). The structure member <m_pShbMemHeader> points
// to the (process specific) start address of the shared memory region
// itself.
typedef struct
{
unsigned long m_SbiMagicID; // magic ID ("SBI+")
HANDLE m_hSharedMem;
HANDLE m_hMutexBuffAccess;
HANDLE m_hThreadNewData; // thraed to signal that new data are available
HANDLE m_ahEventNewData[3]; // IDX_EVENT_NEW_DATA + IDX_EVENT_TERM_REQU + ID_EVENT_TERM_RESP
tSigHndlrNewData m_pfnSigHndlrNewData;
HANDLE m_hThreadJobReady; // thread to signal that a job/operation is ready now (e.g. reset buffer)
HANDLE m_hEventJobReady;
unsigned long m_ulTimeOutJobReady;
tSigHndlrJobReady m_pfnSigHndlrJobReady;
tShbMemHeader* m_pShbMemHeader;
#ifndef NDEBUG
unsigned long m_ulThreadIDNewData;
unsigned long m_ulThreadIDJobReady;
#endif
} tShbMemInst;
//---------------------------------------------------------------------------
// Global variables
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// Local variables
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// Prototypes of internal functions
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// Get pointer to process local information structure
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbMemInst* ShbIpcGetShbMemInst (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
pShbMemInst = (tShbMemInst*)pShbInstance_p;
ASSERT (pShbMemInst->m_SbiMagicID == SBI_MAGIC_ID);
return (pShbMemInst);
}
//---------------------------------------------------------------------------
// Get pointer to shared memory header
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbMemHeader* ShbIpcGetShbMemHeader (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
tShbMemHeader* pShbMemHeader;
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
pShbMemHeader = pShbMemInst->m_pShbMemHeader;
ASSERT(pShbMemHeader->m_SbhMagicID == SBH_MAGIC_ID);
return (pShbMemHeader);
}
// not inlined internal functions
DWORD WINAPI ShbIpcThreadSignalNewData (LPVOID pvThreadParam_p);
DWORD WINAPI ShbIpcThreadSignalJobReady (LPVOID pvThreadParam_p);
const char* ShbIpcGetUniformObjectName (const char* pszEventJobName_p, const char* pszBufferID_p, BOOL fGlobalObject_p);
#endif
#if !defined(SHBIPC_INLINE_ENABLED)
// true internal functions (not inlined)
static void* ShbIpcAllocPrivateMem (unsigned long ulMemSize_p);
static void ShbIpcReleasePrivateMem (void* pMem_p);
#endif
//=========================================================================//
// //
// P U B L I C F U N C T I O N S //
// //
//=========================================================================//
#if !defined(SHBIPC_INLINE_ENABLED)
// not inlined external functions
//---------------------------------------------------------------------------
// Initialize IPC for Shared Buffer Module
//---------------------------------------------------------------------------
tShbError ShbIpcInit (void)
{
return (kShbOk);
}
//---------------------------------------------------------------------------
// Deinitialize IPC for Shared Buffer Module
//---------------------------------------------------------------------------
tShbError ShbIpcExit (void)
{
return (kShbOk);
}
//---------------------------------------------------------------------------
// Allocate Shared Buffer
//---------------------------------------------------------------------------
tShbError ShbIpcAllocBuffer (
unsigned long ulBufferSize_p,
const char* pszBufferID_p,
tShbInstance* ppShbInstance_p,
unsigned int* pfShbNewCreated_p)
{
HANDLE hSharedMem;
LPVOID pSharedMem;
unsigned long ulShMemSize;
tShbMemInst* pShbMemInst;
tShbMemHeader* pShbMemHeader;
tShbInstance pShbInstance;
unsigned int fShMemNewCreated;
const char* pszObjectName;
HANDLE hMutexBuffAccess;
HANDLE hEventNewData;
HANDLE hEventJobReady;
tShbError ShbError;
ulShMemSize = ulBufferSize_p + sizeof(tShbMemHeader);
pSharedMem = NULL;
pShbInstance = NULL;
fShMemNewCreated = FALSE;
ShbError = kShbOk;
//---------------------------------------------------------------
// (1) open an existing or create a new shared memory
//---------------------------------------------------------------
// try to open an already existing shared memory
// (created by an another process)
hSharedMem = OpenFileMapping (FILE_MAP_ALL_ACCESS, // DWORD dwDesiredAccess
FALSE, // BOOL bInheritHandle
pszBufferID_p); // LPCTSTR lpName
if (hSharedMem != NULL)
{
// a shared memory already exists
fShMemNewCreated = FALSE;
}
else
{
// it seams that this process is the first who wants to use the
// shared memory, so it has to create a new shared memory
hSharedMem = CreateFileMapping(INVALID_HANDLE_VALUE,// HANDLE hFile
NULL, // LPSECURITY_ATTRIBUTES lpAttributes
PAGE_READWRITE, // DWORD flProtect
0, // DWORD dwMaximumSizeHigh
ulShMemSize, // DWORD dwMaximumSizeLow
pszBufferID_p); // LPCTSTR lpName
fShMemNewCreated = TRUE;
}
if (hSharedMem == NULL)
{
ShbError = kShbOutOfMem;
goto Exit;
}
//---------------------------------------------------------------
// (2) get the pointer to the shared memory
//---------------------------------------------------------------
pSharedMem = MapViewOfFile (hSharedMem, // HANDLE hFileMappingObject
FILE_MAP_ALL_ACCESS, // DWORD dwDesiredAccess,
0, // DWORD dwFileOffsetHigh,
0, // DWORD dwFileOffsetLow,
ulShMemSize); // SIZE_T dwNumberOfBytesToMap
if (pSharedMem == NULL)
{
ShbError = kShbOutOfMem;
goto Exit;
}
//---------------------------------------------------------------
// (3) setup or update header and management information
//---------------------------------------------------------------
pShbMemHeader = (tShbMemHeader*)pSharedMem;
// allocate a memory block from process specific mempool to save
// process local information to administrate/manage the shared buffer
pShbMemInst = (tShbMemInst*) ShbIpcAllocPrivateMem (sizeof(tShbMemInst));
if (pShbMemInst == NULL)
{
ShbError = kShbOutOfMem;
goto Exit;
}
// reset complete header to default values
pShbMemInst->m_SbiMagicID = SBI_MAGIC_ID;
pShbMemInst->m_hSharedMem = hSharedMem;
pShbMemInst->m_hMutexBuffAccess = INVALID_HANDLE_VALUE;
pShbMemInst->m_hThreadNewData = INVALID_HANDLE_VALUE;
pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA] = INVALID_HANDLE_VALUE;
pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU] = INVALID_HANDLE_VALUE;
pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP] = INVALID_HANDLE_VALUE;
pShbMemInst->m_pfnSigHndlrNewData = NULL;
pShbMemInst->m_hThreadJobReady = INVALID_HANDLE_VALUE;
pShbMemInst->m_hEventJobReady = INVALID_HANDLE_VALUE;
pShbMemInst->m_ulTimeOutJobReady = 0;
pShbMemInst->m_pfnSigHndlrJobReady = NULL;
pShbMemInst->m_pShbMemHeader = pShbMemHeader;
#ifndef NDEBUG
{
pShbMemInst->m_ulThreadIDNewData = 0;
pShbMemInst->m_ulThreadIDJobReady = 0;
}
#endif
// create mutex for buffer access
pszObjectName = ShbIpcGetUniformObjectName (NAME_MUTEX_BUFF_ACCESS, pszBufferID_p, TRUE);
hMutexBuffAccess = CreateMutex (NULL, // LPSECURITY_ATTRIBUTES lpMutexAttributes
FALSE, // BOOL bInitialOwner
pszObjectName); // LPCTSTR lpName
pShbMemInst->m_hMutexBuffAccess = hMutexBuffAccess;
ASSERT(pShbMemInst->m_hMutexBuffAccess != NULL);
// The EventNewData is used for signaling of new data after a write
// operation (SetEvent) as well as for waiting for new data on the
// reader side (WaitForMultipleObjects). Because it's not known if
// this process will be read or write data, the event will be
// always created here.
pszObjectName = ShbIpcGetUniformObjectName (NAME_EVENT_NEW_DATA, pszBufferID_p, TRUE);
hEventNewData = CreateEvent (NULL, // LPSECURITY_ATTRIBUTES lpEventAttributes
FALSE, // BOOL bManualReset
FALSE, // BOOL bInitialState
pszObjectName); // LPCTSTR lpName
pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA] = hEventNewData;
ASSERT(pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA] != NULL);
// The EventJobReady is used for signaling that a job is done (SetEvent)
// as well as for waiting for finishing of a job (WaitForMultipleObjects).
// Because it's not known if this process will signal or wait, the event
// will be always created here.
pszObjectName = ShbIpcGetUniformObjectName (NAME_EVENT_JOB_READY, pszBufferID_p, TRUE);
hEventJobReady = CreateEvent (NULL, // LPSECURITY_ATTRIBUTES lpEventAttributes
FALSE, // BOOL bManualReset
FALSE, // BOOL bInitialState
pszObjectName); // LPCTSTR lpName
pShbMemInst->m_hEventJobReady = hEventJobReady;
ASSERT(pShbMemInst->m_hEventJobReady != NULL);
if ( fShMemNewCreated )
{
// this process was the first who wanted to use the shared memory,
// so a new shared memory was created
// -> setup new header information inside the shared memory region
// itself
pShbMemHeader->m_SbhMagicID = SBH_MAGIC_ID;
pShbMemHeader->m_ulShMemSize = ulShMemSize;
pShbMemHeader->m_ulRefCount = 1;
strncpy (pShbMemHeader->m_szBufferID, pszBufferID_p, sizeof(pShbMemHeader->m_szBufferID)-1);
#ifndef NDEBUG
{
pShbMemHeader->m_ulOwnerProcID = GetCurrentProcessId();
}
#endif
}
else
{
// any other process has created the shared memory and this
// process has only attached to it
// -> check and update existing header information inside the
// shared memory region itself
if (pShbMemHeader->m_ulShMemSize != ulShMemSize)
{
ShbError = kShbOpenMismatch;
goto Exit;
}
#ifndef NDEBUG
{
if ( strncmp(pShbMemHeader->m_szBufferID, pszBufferID_p, sizeof(pShbMemHeader->m_szBufferID)-1) )
{
ShbError = kShbOpenMismatch;
goto Exit;
}
}
#endif
pShbMemHeader->m_ulRefCount++;
}
// set abstarct "handle" for returning to application
pShbInstance = (tShbInstance*)pShbMemInst;
Exit:
if (ShbError != kShbOk)
{
if (pShbMemInst != NULL)
{
ShbIpcReleasePrivateMem (pShbMemInst);
}
if (pSharedMem != NULL)
{
UnmapViewOfFile (pSharedMem);
}
if (hSharedMem != NULL)
{
CloseHandle (hSharedMem);
}
}
*pfShbNewCreated_p = fShMemNewCreated;
*ppShbInstance_p = pShbInstance;
return (ShbError);
}
//---------------------------------------------------------------------------
// Release Shared Buffer
//---------------------------------------------------------------------------
tShbError ShbIpcReleaseBuffer (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
tShbMemHeader* pShbMemHeader;
HANDLE hEventNewData;
HANDLE hMutexBuffAccess;
tShbError ShbError;
tShbError ShbError2;
if (pShbInstance_p == NULL)
{
return (kShbOk);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
pShbMemHeader = ShbIpcGetShbMemHeader (pShbInstance_p);
if ( !--pShbMemHeader->m_ulRefCount )
{
ShbError = kShbOk;
}
else
{
ShbError = kShbMemUsedByOtherProcs;
}
ShbError2 = ShbIpcStopSignalingNewData (pShbInstance_p);
hEventNewData = pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA];
if (hEventNewData != INVALID_HANDLE_VALUE)
{
CloseHandle (hEventNewData);
pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA] = INVALID_HANDLE_VALUE;
}
hMutexBuffAccess = pShbMemInst->m_hMutexBuffAccess;
if (hMutexBuffAccess != INVALID_HANDLE_VALUE)
{
CloseHandle (hMutexBuffAccess);
pShbMemInst->m_hMutexBuffAccess = INVALID_HANDLE_VALUE;
}
UnmapViewOfFile (pShbMemHeader);
if (pShbMemInst->m_hSharedMem != INVALID_HANDLE_VALUE)
{
CloseHandle (pShbMemInst->m_hSharedMem);
pShbMemInst->m_hSharedMem = INVALID_HANDLE_VALUE;
}
ShbIpcReleasePrivateMem (pShbMemInst);
if (ShbError == kShbOk)
{
ShbError = ShbError2;
}
return (ShbError);
}
#endif // !defined(SHBIPC_INLINE_ENABLED)
#if (!defined(SHBIPC_INLINED)) || defined(SHBIPC_INLINE_ENABLED)
//---------------------------------------------------------------------------
// Enter atomic section for Shared Buffer access
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbError ShbIpcEnterAtomicSection (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
HANDLE hMutexBuffAccess;
DWORD dwWaitResult;
tShbError ShbError;
if (pShbInstance_p == NULL)
{
return (kShbInvalidArg);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
ShbError = kShbOk;
hMutexBuffAccess = pShbMemInst->m_hMutexBuffAccess;
if (hMutexBuffAccess != INVALID_HANDLE_VALUE)
{
dwWaitResult = WaitForSingleObject (hMutexBuffAccess, TIMEOUT_ENTER_ATOMIC);
switch (dwWaitResult)
{
case WAIT_OBJECT_0 + 0:
{
break;
}
case WAIT_TIMEOUT:
{
TRACE0("\nShbIpcEnterAtomicSection(): WAIT_TIMEOUT");
ASSERT(0);
ShbError = kShbBufferInvalid;
break;
}
case WAIT_ABANDONED:
{
TRACE0("\nShbIpcEnterAtomicSection(): WAIT_ABANDONED");
ASSERT(0);
ShbError = kShbBufferInvalid;
break;
}
case WAIT_FAILED:
{
TRACE1("\nShbIpcEnterAtomicSection(): WAIT_FAILED -> LastError=%ld", GetLastError());
ASSERT(0);
ShbError = kShbBufferInvalid;
break;
}
default:
{
TRACE1("\nShbIpcEnterAtomicSection(): unknown error -> LastError=%ld", GetLastError());
ASSERT(0);
ShbError = kShbBufferInvalid;
break;
}
}
}
else
{
ShbError = kShbBufferInvalid;
}
return (ShbError);
}
//---------------------------------------------------------------------------
// Leave atomic section for Shared Buffer access
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbError ShbIpcLeaveAtomicSection (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
HANDLE hMutexBuffAccess;
BOOL fRes;
tShbError ShbError;
if (pShbInstance_p == NULL)
{
return (kShbInvalidArg);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
ShbError = kShbOk;
hMutexBuffAccess = pShbMemInst->m_hMutexBuffAccess;
if (hMutexBuffAccess != INVALID_HANDLE_VALUE)
{
fRes = ReleaseMutex (hMutexBuffAccess);
ASSERT( fRes );
}
else
{
ShbError = kShbBufferInvalid;
}
return (ShbError);
}
//---------------------------------------------------------------------------
// Start signaling of new data (called from reading process)
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbError ShbIpcStartSignalingNewData (
tShbInstance pShbInstance_p,
tSigHndlrNewData pfnSignalHandlerNewData_p,
tShbPriority ShbPriority_p)
{
tShbMemInst* pShbMemInst;
tShbMemHeader* pShbMemHeader;
const char* pszObjectName;
HANDLE hEventTermRequ;
HANDLE hEventTermResp;
HANDLE hThreadNewData;
unsigned long ulThreadIDNewData;
tShbError ShbError;
int iPriority;
if ((pShbInstance_p == NULL) || (pfnSignalHandlerNewData_p == NULL))
{
return (kShbInvalidArg);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
pShbMemHeader = ShbIpcGetShbMemHeader (pShbInstance_p);
ShbError = kShbOk;
if ( (pShbMemInst->m_hThreadNewData != INVALID_HANDLE_VALUE) ||
(pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU] != INVALID_HANDLE_VALUE) ||
(pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP] != INVALID_HANDLE_VALUE) ||
(pShbMemInst->m_pfnSigHndlrNewData != NULL) )
{
ShbError = kShbAlreadySignaling;
goto Exit;
}
pShbMemInst->m_pfnSigHndlrNewData = pfnSignalHandlerNewData_p;
// Because the event <pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA]>
// is used for signaling of new data after a write operation too (using
// SetEvent), it is always created here (see <ShbIpcAllocBuffer>).
pszObjectName = ShbIpcGetUniformObjectName (NAME_EVENT_TERM_REQU, pShbMemHeader->m_szBufferID, FALSE);
hEventTermRequ = CreateEvent (NULL, // LPSECURITY_ATTRIBUTES lpEventAttributes
FALSE, // BOOL bManualReset
FALSE, // BOOL bInitialState
pszObjectName); // LPCTSTR lpName
pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU] = hEventTermRequ;
ASSERT(pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU] != NULL);
pszObjectName = ShbIpcGetUniformObjectName (NAME_EVENT_TERM_RESP, pShbMemHeader->m_szBufferID, FALSE);
hEventTermResp = CreateEvent (NULL, // LPSECURITY_ATTRIBUTES lpEventAttributes
FALSE, // BOOL bManualReset
FALSE, // BOOL bInitialState
pszObjectName); // LPCTSTR lpName
pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP] = hEventTermResp;
ASSERT(pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP] != NULL);
hThreadNewData = CreateThread (NULL, // LPSECURITY_ATTRIBUTES lpThreadAttributes
0, // SIZE_T dwStackSize
ShbIpcThreadSignalNewData, // LPTHREAD_START_ROUTINE lpStartAddress
pShbInstance_p, // LPVOID lpParameter
0, // DWORD dwCreationFlags
&ulThreadIDNewData); // LPDWORD lpThreadId
switch (ShbPriority_p)
{
case kShbPriorityLow:
iPriority = THREAD_PRIORITY_BELOW_NORMAL;
break;
case kShbPriorityNormal:
iPriority = THREAD_PRIORITY_NORMAL;
break;
case kshbPriorityHigh:
iPriority = THREAD_PRIORITY_ABOVE_NORMAL;
break;
}
ASSERT(pShbMemInst->m_hThreadNewData != NULL);
SetThreadPriority(hThreadNewData, iPriority);
pShbMemInst->m_hThreadNewData = hThreadNewData;
#ifndef NDEBUG
{
pShbMemInst->m_ulThreadIDNewData = ulThreadIDNewData;
}
#endif
Exit:
return (ShbError);
}
//---------------------------------------------------------------------------
// Stop signaling of new data (called from reading process)
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbError ShbIpcStopSignalingNewData (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
HANDLE hEventTermRequ;
HANDLE hEventTermResp;
DWORD dwWaitResult;
if (pShbInstance_p == NULL)
{
return (kShbInvalidArg);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
// terminate new data signaling thread
// (set event <hEventTermRequ> to wakeup the thread and dispose it
// to exit, then wait for confirmation using event <hEventTermResp>)
hEventTermRequ = pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU];
hEventTermResp = pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP];
if ( (hEventTermRequ != INVALID_HANDLE_VALUE) &&
(hEventTermResp != INVALID_HANDLE_VALUE) )
{
TRACE0("\nShbIpcStopSignalingNewData(): enter wait state");
dwWaitResult = SignalObjectAndWait (hEventTermRequ, // HANDLE hObjectToSignal
hEventTermResp, // HANDLE hObjectToWaitOn
TIMEOUT_TERM_THREAD, // DWORD dwMilliseconds
FALSE); // BOOL bAlertable
TRACE0("\nShbIpcStopSignalingNewData(): wait state leaved: ---> ");
switch (dwWaitResult)
{
case WAIT_OBJECT_0 + 0: // event "new data signaling thread terminated"
{
TRACE0("Event = WAIT_OBJECT_0+0");
break;
}
default:
{
TRACE0("Unhandled Event");
ASSERT(0);
break;
}
}
}
if (pShbMemInst->m_hThreadNewData != INVALID_HANDLE_VALUE)
{
CloseHandle (pShbMemInst->m_hThreadNewData);
pShbMemInst->m_hThreadNewData = INVALID_HANDLE_VALUE;
}
if (pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU] != INVALID_HANDLE_VALUE)
{
CloseHandle (pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU]);
pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_REQU] = INVALID_HANDLE_VALUE;
}
if (pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP] != INVALID_HANDLE_VALUE)
{
CloseHandle (pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP]);
pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP] = INVALID_HANDLE_VALUE;
}
pShbMemInst->m_pfnSigHndlrNewData = NULL;
return (kShbOk);
}
//---------------------------------------------------------------------------
// Signal new data (called from writing process)
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbError ShbIpcSignalNewData (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
HANDLE hEventNewData;
BOOL fRes;
// TRACE0("\nShbIpcSignalNewData(): enter\n");
if (pShbInstance_p == NULL)
{
return (kShbInvalidArg);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
ASSERT(pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA] != INVALID_HANDLE_VALUE);
hEventNewData = pShbMemInst->m_ahEventNewData[IDX_EVENT_NEW_DATA];
if (hEventNewData != INVALID_HANDLE_VALUE)
{
fRes = SetEvent (hEventNewData);
// TRACE1("\nShbIpcSignalNewData(): EventNewData set (Result=%d)\n", (int)fRes);
ASSERT( fRes );
}
// TRACE0("\nShbIpcSignalNewData(): leave\n");
return (kShbOk);
}
//---------------------------------------------------------------------------
// Start signaling for job ready (called from waiting process)
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbError ShbIpcStartSignalingJobReady (
tShbInstance pShbInstance_p,
unsigned long ulTimeOut_p,
tSigHndlrJobReady pfnSignalHandlerJobReady_p)
{
tShbMemInst* pShbMemInst;
tShbMemHeader* pShbMemHeader;
HANDLE hThreadJobReady;
unsigned long ulThreadIDJobReady;
tShbError ShbError;
if ((pShbInstance_p == NULL) || (pfnSignalHandlerJobReady_p == NULL))
{
return (kShbInvalidArg);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
pShbMemHeader = ShbIpcGetShbMemHeader (pShbInstance_p);
ShbError = kShbOk;
if ( (pShbMemInst->m_hThreadJobReady != INVALID_HANDLE_VALUE) ||
(pShbMemInst->m_pfnSigHndlrJobReady != NULL) )
{
ShbError = kShbAlreadySignaling;
goto Exit;
}
pShbMemInst->m_ulTimeOutJobReady = ulTimeOut_p;
pShbMemInst->m_pfnSigHndlrJobReady = pfnSignalHandlerJobReady_p;
// Because the event <pShbMemInst->m_ahEventJobReady> is used for
// signaling of a finished job too (using SetEvent), it is always
// created here (see <ShbIpcAllocBuffer>).
hThreadJobReady = CreateThread (NULL, // LPSECURITY_ATTRIBUTES lpThreadAttributes
0, // SIZE_T dwStackSize
ShbIpcThreadSignalJobReady, // LPTHREAD_START_ROUTINE lpStartAddress
pShbInstance_p, // LPVOID lpParameter
0, // DWORD dwCreationFlags
&ulThreadIDJobReady); // LPDWORD lpThreadId
pShbMemInst->m_hThreadJobReady = hThreadJobReady;
ASSERT(pShbMemInst->m_hThreadJobReady != NULL);
#ifndef NDEBUG
{
pShbMemInst->m_ulThreadIDJobReady = ulThreadIDJobReady;
}
#endif
Exit:
return (ShbError);
}
//---------------------------------------------------------------------------
// Signal job ready (called from executing process)
//---------------------------------------------------------------------------
INLINE_FUNCTION tShbError ShbIpcSignalJobReady (
tShbInstance pShbInstance_p)
{
tShbMemInst* pShbMemInst;
HANDLE hEventJobReady;
BOOL fRes;
// TRACE0("\nShbIpcSignalJobReady(): enter\n");
if (pShbInstance_p == NULL)
{
return (kShbInvalidArg);
}
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance_p);
ASSERT(pShbMemInst->m_hEventJobReady != INVALID_HANDLE_VALUE);
hEventJobReady = pShbMemInst->m_hEventJobReady;
if (hEventJobReady != INVALID_HANDLE_VALUE)
{
fRes = SetEvent (hEventJobReady);
// TRACE1("\nShbIpcSignalJobReady(): EventJobReady set (Result=%d)\n", (int)fRes);
ASSERT( fRes );
}
// TRACE0("\nShbIpcSignalJobReady(): leave\n");
return (kShbOk);
}
//---------------------------------------------------------------------------
// Get pointer to common used share memory area
//---------------------------------------------------------------------------
INLINE_FUNCTION void* ShbIpcGetShMemPtr (
tShbInstance pShbInstance_p)
{
tShbMemHeader* pShbMemHeader;
void* pShbShMemPtr;
pShbMemHeader = ShbIpcGetShbMemHeader (pShbInstance_p);
if (pShbMemHeader != NULL)
{
pShbShMemPtr = (BYTE*)pShbMemHeader + sizeof(tShbMemHeader);
}
else
{
pShbShMemPtr = NULL;
}
return (pShbShMemPtr);
}
#endif
//=========================================================================//
// //
// P R I V A T E F U N C T I O N S //
// //
//=========================================================================//
#if !defined(SHBIPC_INLINE_ENABLED)
//---------------------------------------------------------------------------
// Allocate a memory block from process specific mempool
//---------------------------------------------------------------------------
static void* ShbIpcAllocPrivateMem (
unsigned long ulMemSize_p)
{
HGLOBAL hMem;
void* pMem;
hMem = GlobalAlloc (GMEM_FIXED, ulMemSize_p+sizeof(HGLOBAL));
pMem = GlobalLock (hMem);
if (pMem != NULL)
{
*(HGLOBAL*)pMem = hMem;
(BYTE*)pMem += sizeof(HGLOBAL);
}
#ifndef NDEBUG
{
memset (pMem, 0xaa, ulMemSize_p);
}
#endif
return (pMem);
}
//---------------------------------------------------------------------------
// Release a memory block from process specific mempool
//---------------------------------------------------------------------------
static void ShbIpcReleasePrivateMem (
void* pMem_p)
{
HGLOBAL hMem;
if (pMem_p == NULL)
{
return;
}
(BYTE*)pMem_p -= sizeof(HGLOBAL);
hMem = *(HGLOBAL*)pMem_p;
GlobalUnlock (hMem);
GlobalFree (hMem);
return;
}
//---------------------------------------------------------------------------
// Create uniform object name (needed for inter-process communication)
//---------------------------------------------------------------------------
const char* ShbIpcGetUniformObjectName (
const char* pszObjectJobName_p,
const char* pszBufferID_p,
BOOL fGlobalObject_p)
{
static char szObjectName[MAX_PATH];
char szObjectPrefix[MAX_PATH];
if ( fGlobalObject_p )
{
strncpy (szObjectPrefix, "Global\\", sizeof(szObjectPrefix));
}
else
{
_snprintf (szObjectPrefix, sizeof(szObjectPrefix), "PID%08lX_",
(unsigned long)GetCurrentProcessId());
}
_snprintf (szObjectName, sizeof(szObjectName), "%s%s#%s",
szObjectPrefix, pszBufferID_p, pszObjectJobName_p);
return (szObjectName);
}
//---------------------------------------------------------------------------
// Thread for new data signaling
//---------------------------------------------------------------------------
DWORD WINAPI ShbIpcThreadSignalNewData (
LPVOID pvThreadParam_p)
{
tShbInstance pShbInstance;
tShbMemInst* pShbMemInst;
DWORD dwWaitResult;
BOOL fTermRequ;
int fCallAgain;
TRACE1("\nShbIpcThreadSignalNewData(): SignalThread started (pShbInstance=0x%08lX)\n", (DWORD)pvThreadParam_p);
pShbInstance = (tShbMemInst*)pvThreadParam_p;
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance);
fTermRequ = FALSE;
do
{
ASSERT((pShbMemInst->m_ahEventNewData[0] != INVALID_HANDLE_VALUE) && (pShbMemInst->m_ahEventNewData[0] != NULL));
ASSERT((pShbMemInst->m_ahEventNewData[1] != INVALID_HANDLE_VALUE) && (pShbMemInst->m_ahEventNewData[1] != NULL));
TRACE0("\nShbIpcThreadSignalNewData(): enter wait state");
dwWaitResult = WaitForMultipleObjects (2, // DWORD nCount
pShbMemInst->m_ahEventNewData, // const HANDLE* lpHandles
FALSE, // BOOL bWaitAll
INFINITE); // DWORD dwMilliseconds
TRACE0("\nShbIpcThreadSignalNewData(): wait state leaved: ---> ");
switch (dwWaitResult)
{
case WAIT_OBJECT_0 + 0: // event "new data"
{
TRACE0("Event = WAIT_OBJECT_0+0");
if (pShbMemInst->m_pfnSigHndlrNewData != NULL)
{
TRACE0("\nShbIpcThreadSignalNewData(): calling SignalHandlerNewData");
do
{
fCallAgain = pShbMemInst->m_pfnSigHndlrNewData (pShbInstance);
// d.k.: try to run any shared buffer which has higher priority.
// under Windows this is not really necessary because the Windows scheduler
// already preempts tasks with lower priority.
} while (fCallAgain != FALSE);
}
break;
}
case WAIT_OBJECT_0 + 1: // event "terminate"
{
TRACE0("Event = WAIT_OBJECT_0+1");
fTermRequ = TRUE;
break;
}
default:
{
TRACE0("Unhandled Event");
ASSERT(0);
fTermRequ = TRUE;
break;
}
}
}
while ( !fTermRequ );
if (pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP] != INVALID_HANDLE_VALUE)
{
SetEvent (pShbMemInst->m_ahEventNewData[IDX_EVENT_TERM_RESP]);
}
TRACE1("\nShbIpcThreadSignalNewData(): SignalThread terminated (pShbInstance=0x%08lX)\n", (DWORD)pShbInstance);
ExitThread (0);
}
//---------------------------------------------------------------------------
// Thread for new data signaling
//---------------------------------------------------------------------------
DWORD WINAPI ShbIpcThreadSignalJobReady (
LPVOID pvThreadParam_p)
{
tShbInstance* pShbInstance;
tShbMemInst* pShbMemInst;
DWORD ulTimeOut;
DWORD dwWaitResult;
unsigned int fTimeOut;
TRACE1("\nShbIpcThreadSignalJobReady(): SignalThread started (pShbInstance=0x%08lX)\n", (DWORD)pvThreadParam_p);
pShbInstance = (tShbInstance*)pvThreadParam_p;
pShbMemInst = ShbIpcGetShbMemInst (pShbInstance);
fTimeOut = FALSE;
if (pShbMemInst->m_ulTimeOutJobReady != 0)
{
ulTimeOut = pShbMemInst->m_ulTimeOutJobReady;
}
else
{
ulTimeOut = INFINITE;
}
ASSERT((pShbMemInst->m_hEventJobReady != INVALID_HANDLE_VALUE) && (pShbMemInst->m_hEventJobReady != NULL));
TRACE0("\nShbIpcThreadSignalJobReady(): enter wait state");
dwWaitResult = WaitForSingleObject (pShbMemInst->m_hEventJobReady, // HANDLE hHandle
ulTimeOut); // DWORD dwMilliseconds
TRACE0("\nShbIpcThreadSignalJobReady(): wait state leaved: ---> ");
switch (dwWaitResult)
{
case WAIT_OBJECT_0 + 0: // event "new data"
{
TRACE0("Event = WAIT_OBJECT_0+0");
fTimeOut = FALSE;
break;
}
case WAIT_TIMEOUT:
{
TRACE0("\nEvent = WAIT_TIMEOUT");
fTimeOut = TRUE;
// ASSERT(0);
break;
}
default:
{
TRACE0("Unhandled Event");
fTimeOut = TRUE;
ASSERT(0);
break;
}
}
if (pShbMemInst->m_pfnSigHndlrJobReady != NULL)
{
TRACE0("\nShbIpcThreadSignalJobReady(): calling SignalHandlerJobReady");
pShbMemInst->m_pfnSigHndlrJobReady (pShbInstance, fTimeOut);
}
pShbMemInst->m_hThreadJobReady = INVALID_HANDLE_VALUE;
pShbMemInst->m_pfnSigHndlrJobReady = NULL;
TRACE1("\nShbIpcThreadSignalJobReady(): SignalThread terminated (pShbInstance=0x%08lX)\n", (DWORD)pShbInstance);
ExitThread (0);
}
#endif
// EOF
|