Coverage Report

Created: 2025-07-01 06:46

/src/FreeRDP/winpr/libwinpr/interlocked/interlocked.c
Line
Count
Source (jump to first uncovered line)
1
/**
2
 * WinPR: Windows Portable Runtime
3
 * Interlocked Singly-Linked Lists
4
 *
5
 * Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
6
 *
7
 * Licensed under the Apache License, Version 2.0 (the "License");
8
 * you may not use this file except in compliance with the License.
9
 * You may obtain a copy of the License at
10
 *
11
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 *
13
 * Unless required by applicable law or agreed to in writing, software
14
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 * See the License for the specific language governing permissions and
17
 * limitations under the License.
18
 */
19
20
#include <winpr/config.h>
21
22
#include <winpr/assert.h>
23
#include <winpr/wlog.h>
24
#include <winpr/platform.h>
25
#include <winpr/synch.h>
26
#include <winpr/handle.h>
27
28
#include <winpr/interlocked.h>
29
30
/* Singly-Linked List */
31
32
#ifndef _WIN32
33
34
#include <stdio.h>
35
#include <stdlib.h>
36
37
VOID InitializeSListHead(WINPR_PSLIST_HEADER ListHead)
38
0
{
39
0
  WINPR_ASSERT(ListHead);
40
#ifdef _WIN64
41
  ListHead->s.Alignment = 0;
42
  ListHead->s.Region = 0;
43
  ListHead->Header8.Init = 1;
44
#else
45
0
  ListHead->Alignment = 0;
46
0
#endif
47
0
}
48
49
WINPR_PSLIST_ENTRY InterlockedPushEntrySList(WINPR_PSLIST_HEADER ListHead,
50
                                             WINPR_PSLIST_ENTRY ListEntry)
51
0
{
52
0
  WINPR_SLIST_HEADER old = { 0 };
53
0
  WINPR_SLIST_HEADER newHeader = { 0 };
54
55
0
  WINPR_ASSERT(ListHead);
56
0
  WINPR_ASSERT(ListEntry);
57
#ifdef _WIN64
58
  newHeader.HeaderX64.NextEntry = (((ULONG_PTR)ListEntry) >> 4);
59
60
  while (1)
61
  {
62
    old = *ListHead;
63
64
    ListEntry->Next = (PSLIST_ENTRY)(((ULONG_PTR)old.HeaderX64.NextEntry) << 4);
65
66
    newHeader.HeaderX64.Depth = old.HeaderX64.Depth + 1;
67
    newHeader.HeaderX64.Sequence = old.HeaderX64.Sequence + 1;
68
69
    if (InterlockedCompareExchange64((LONGLONG*)ListHead, newHeader).Alignment, old).Alignment))
70
    {
71
      InterlockedCompareExchange64(&((LONGLONG*)ListHead)[1], newHeader).Region,
72
                     old).Region);
73
      break;
74
    }
75
  }
76
77
  return (PSLIST_ENTRY)((ULONG_PTR)old.HeaderX64.NextEntry << 4);
78
#else
79
0
  newHeader.s.Next.Next = ListEntry;
80
81
0
  do
82
0
  {
83
0
    old = *ListHead;
84
0
    ListEntry->Next = old.s.Next.Next;
85
0
    newHeader.s.Depth = old.s.Depth + 1;
86
0
    newHeader.s.Sequence = old.s.Sequence + 1;
87
0
    if (old.Alignment > INT64_MAX)
88
0
      return NULL;
89
0
    if (newHeader.Alignment > INT64_MAX)
90
0
      return NULL;
91
0
    if (ListHead->Alignment > INT64_MAX)
92
0
      return NULL;
93
0
  } while (InterlockedCompareExchange64((LONGLONG*)&ListHead->Alignment,
94
0
                                        (LONGLONG)newHeader.Alignment,
95
0
                                        (LONGLONG)old.Alignment) != (LONGLONG)old.Alignment);
96
97
0
  return old.s.Next.Next;
98
0
#endif
99
0
}
100
101
WINPR_PSLIST_ENTRY InterlockedPushListSListEx(WINPR_ATTR_UNUSED WINPR_PSLIST_HEADER ListHead,
102
                                              WINPR_ATTR_UNUSED WINPR_PSLIST_ENTRY List,
103
                                              WINPR_ATTR_UNUSED WINPR_PSLIST_ENTRY ListEnd,
104
                                              WINPR_ATTR_UNUSED ULONG Count)
105
0
{
106
0
  WINPR_ASSERT(ListHead);
107
0
  WINPR_ASSERT(List);
108
0
  WINPR_ASSERT(ListEnd);
109
110
0
  WLog_ERR("TODO", "TODO: implement");
111
#ifdef _WIN64
112
113
#else
114
115
0
#endif
116
0
  return NULL;
117
0
}
118
119
WINPR_PSLIST_ENTRY InterlockedPopEntrySList(WINPR_PSLIST_HEADER ListHead)
120
0
{
121
0
  WINPR_SLIST_HEADER old = { 0 };
122
0
  WINPR_SLIST_HEADER newHeader = { 0 };
123
0
  WINPR_PSLIST_ENTRY entry = NULL;
124
125
0
  WINPR_ASSERT(ListHead);
126
127
#ifdef _WIN64
128
  while (1)
129
  {
130
    old = *ListHead;
131
132
    entry = (PSLIST_ENTRY)(((ULONG_PTR)old.HeaderX64.NextEntry) << 4);
133
134
    if (!entry)
135
      return NULL;
136
137
    newHeader.HeaderX64.NextEntry = ((ULONG_PTR)entry->Next) >> 4;
138
    newHeader.HeaderX64.Depth = old.HeaderX64.Depth - 1;
139
    newHeader.HeaderX64.Sequence = old.HeaderX64.Sequence - 1;
140
141
    if (InterlockedCompareExchange64((LONGLONG*)ListHead, newHeader).Alignment, old).Alignment))
142
    {
143
      InterlockedCompareExchange64(&((LONGLONG*)ListHead)[1], newHeader).Region,
144
                     old).Region);
145
      break;
146
    }
147
  }
148
#else
149
0
  do
150
0
  {
151
0
    old = *ListHead;
152
153
0
    entry = old.s.Next.Next;
154
155
0
    if (!entry)
156
0
      return NULL;
157
158
0
    newHeader.s.Next.Next = entry->Next;
159
0
    newHeader.s.Depth = old.s.Depth - 1;
160
0
    newHeader.s.Sequence = old.s.Sequence + 1;
161
162
0
    if (old.Alignment > INT64_MAX)
163
0
      return NULL;
164
0
    if (newHeader.Alignment > INT64_MAX)
165
0
      return NULL;
166
0
    if (ListHead->Alignment > INT64_MAX)
167
0
      return NULL;
168
0
  } while (InterlockedCompareExchange64((LONGLONG*)&ListHead->Alignment,
169
0
                                        (LONGLONG)newHeader.Alignment,
170
0
                                        (LONGLONG)old.Alignment) != (LONGLONG)old.Alignment);
171
0
#endif
172
0
  return entry;
173
0
}
174
175
WINPR_PSLIST_ENTRY InterlockedFlushSList(WINPR_PSLIST_HEADER ListHead)
176
0
{
177
0
  WINPR_SLIST_HEADER old = { 0 };
178
0
  WINPR_SLIST_HEADER newHeader = { 0 };
179
180
0
  WINPR_ASSERT(ListHead);
181
0
  if (!QueryDepthSList(ListHead))
182
0
    return NULL;
183
184
#ifdef _WIN64
185
  newHeader).Alignment = 0;
186
  newHeader).Region = 0;
187
  newHeader.HeaderX64.HeaderType = 1;
188
189
  while (1)
190
  {
191
    old = *ListHead;
192
    newHeader.HeaderX64.Sequence = old.HeaderX64.Sequence + 1;
193
194
    if (InterlockedCompareExchange64((LONGLONG*)ListHead, newHeader).Alignment, old).Alignment))
195
    {
196
      InterlockedCompareExchange64(&((LONGLONG*)ListHead)[1], newHeader).Region,
197
                     old).Region);
198
      break;
199
    }
200
  }
201
202
  return (PSLIST_ENTRY)(((ULONG_PTR)old.HeaderX64.NextEntry) << 4);
203
#else
204
0
  newHeader.Alignment = 0;
205
206
0
  do
207
0
  {
208
0
    old = *ListHead;
209
0
    newHeader.s.Sequence = old.s.Sequence + 1;
210
211
0
    if (old.Alignment > INT64_MAX)
212
0
      return NULL;
213
0
    if (newHeader.Alignment > INT64_MAX)
214
0
      return NULL;
215
0
    if (ListHead->Alignment > INT64_MAX)
216
0
      return NULL;
217
0
  } while (InterlockedCompareExchange64((LONGLONG*)&ListHead->Alignment,
218
0
                                        (LONGLONG)newHeader.Alignment,
219
0
                                        (LONGLONG)old.Alignment) != (LONGLONG)old.Alignment);
220
221
0
  return old.s.Next.Next;
222
0
#endif
223
0
}
224
225
USHORT QueryDepthSList(WINPR_PSLIST_HEADER ListHead)
226
0
{
227
0
  WINPR_ASSERT(ListHead);
228
229
#ifdef _WIN64
230
  return ListHead->HeaderX64.Depth;
231
#else
232
0
  return ListHead->s.Depth;
233
0
#endif
234
0
}
235
236
LONG InterlockedIncrement(LONG volatile* Addend)
237
0
{
238
0
  WINPR_ASSERT(Addend);
239
240
0
#if defined(__GNUC__) || defined(__clang__)
241
0
  WINPR_PRAGMA_DIAG_PUSH
242
0
  WINPR_PRAGMA_DIAG_IGNORED_ATOMIC_SEQ_CST
243
0
  return __sync_add_and_fetch(Addend, 1);
244
0
  WINPR_PRAGMA_DIAG_POP
245
#else
246
  return 0;
247
#endif
248
0
}
249
250
LONG InterlockedDecrement(LONG volatile* Addend)
251
0
{
252
0
  WINPR_ASSERT(Addend);
253
254
0
#if defined(__GNUC__) || defined(__clang__)
255
0
  WINPR_PRAGMA_DIAG_PUSH
256
0
  WINPR_PRAGMA_DIAG_IGNORED_ATOMIC_SEQ_CST
257
0
  return __sync_sub_and_fetch(Addend, 1);
258
0
  WINPR_PRAGMA_DIAG_POP
259
#else
260
  return 0;
261
#endif
262
0
}
263
264
LONG InterlockedExchange(LONG volatile* Target, LONG Value)
265
0
{
266
0
  WINPR_ASSERT(Target);
267
268
0
#if defined(__GNUC__) || defined(__clang__)
269
0
  WINPR_PRAGMA_DIAG_PUSH
270
0
  WINPR_PRAGMA_DIAG_IGNORED_ATOMIC_SEQ_CST
271
0
  return __sync_val_compare_and_swap(Target, *Target, Value);
272
0
  WINPR_PRAGMA_DIAG_POP
273
#else
274
  return 0;
275
#endif
276
0
}
277
278
LONG InterlockedExchangeAdd(LONG volatile* Addend, LONG Value)
279
0
{
280
0
  WINPR_ASSERT(Addend);
281
282
0
#if defined(__GNUC__) || defined(__clang__)
283
0
  WINPR_PRAGMA_DIAG_PUSH
284
0
  WINPR_PRAGMA_DIAG_IGNORED_ATOMIC_SEQ_CST
285
0
  return __sync_fetch_and_add(Addend, Value);
286
0
  WINPR_PRAGMA_DIAG_POP
287
#else
288
  return 0;
289
#endif
290
0
}
291
292
LONG InterlockedCompareExchange(LONG volatile* Destination, LONG Exchange, LONG Comperand)
293
0
{
294
0
  WINPR_ASSERT(Destination);
295
296
0
#if defined(__GNUC__) || defined(__clang__)
297
0
  WINPR_PRAGMA_DIAG_PUSH
298
0
  WINPR_PRAGMA_DIAG_IGNORED_ATOMIC_SEQ_CST
299
0
  return __sync_val_compare_and_swap(Destination, Comperand, Exchange);
300
0
  WINPR_PRAGMA_DIAG_POP
301
#else
302
  return 0;
303
#endif
304
0
}
305
306
PVOID InterlockedCompareExchangePointer(PVOID volatile* Destination, PVOID Exchange,
307
                                        PVOID Comperand)
308
0
{
309
0
  WINPR_ASSERT(Destination);
310
311
0
#if defined(__GNUC__) || defined(__clang__)
312
0
  WINPR_PRAGMA_DIAG_PUSH
313
0
  WINPR_PRAGMA_DIAG_IGNORED_ATOMIC_SEQ_CST
314
0
  return __sync_val_compare_and_swap(Destination, Comperand, Exchange);
315
0
  WINPR_PRAGMA_DIAG_POP
316
#else
317
  return 0;
318
#endif
319
0
}
320
321
#endif /* _WIN32 */
322
323
#if defined(_WIN32) && !defined(WINPR_INTERLOCKED_COMPARE_EXCHANGE64)
324
325
/* InterlockedCompareExchange64 already defined */
326
327
#elif defined(_WIN32) && defined(WINPR_INTERLOCKED_COMPARE_EXCHANGE64)
328
329
static volatile HANDLE mutex = NULL;
330
331
BOOL static_mutex_lock(volatile HANDLE* static_mutex)
332
{
333
  if (*static_mutex == NULL)
334
  {
335
    HANDLE handle;
336
337
    if (!(handle = CreateMutex(NULL, FALSE, NULL)))
338
      return FALSE;
339
340
    if (InterlockedCompareExchangePointer((PVOID*)static_mutex, (PVOID)handle, NULL) != NULL)
341
      (void)CloseHandle(handle);
342
  }
343
344
  return (WaitForSingleObject(*static_mutex, INFINITE) == WAIT_OBJECT_0);
345
}
346
347
LONGLONG InterlockedCompareExchange64(LONGLONG volatile* Destination, LONGLONG Exchange,
348
                                      LONGLONG Comperand)
349
{
350
  LONGLONG previousValue = 0;
351
  BOOL locked = static_mutex_lock(&mutex);
352
353
  previousValue = *Destination;
354
355
  if (*Destination == Comperand)
356
    *Destination = Exchange;
357
358
  if (locked)
359
    (void)ReleaseMutex(mutex);
360
  else
361
    (void)fprintf(stderr,
362
                  "WARNING: InterlockedCompareExchange64 operation might have failed\n");
363
364
  return previousValue;
365
}
366
367
#elif (defined(ANDROID) && ANDROID) || \
368
    (defined(__GNUC__) && !defined(__GCC_HAVE_SYNC_COMPARE_AND_SWAP_8))
369
370
#include <pthread.h>
371
372
static pthread_mutex_t mutex;
373
374
LONGLONG InterlockedCompareExchange64(LONGLONG volatile* Destination, LONGLONG Exchange,
375
                                      LONGLONG Comperand)
376
{
377
  LONGLONG previousValue = 0;
378
379
  pthread_mutex_lock(&mutex);
380
381
  previousValue = *Destination;
382
383
  if (*Destination == Comperand)
384
    *Destination = Exchange;
385
386
  pthread_mutex_unlock(&mutex);
387
388
  return previousValue;
389
}
390
391
#else
392
393
LONGLONG InterlockedCompareExchange64(LONGLONG volatile* Destination, LONGLONG Exchange,
394
                                      LONGLONG Comperand)
395
0
{
396
0
  WINPR_ASSERT(Destination);
397
398
0
#if defined(__GNUC__) || defined(__clang__)
399
0
  WINPR_PRAGMA_DIAG_PUSH
400
0
  WINPR_PRAGMA_DIAG_IGNORED_ATOMIC_SEQ_CST
401
0
  return __sync_val_compare_and_swap(Destination, Comperand, Exchange);
402
0
  WINPR_PRAGMA_DIAG_POP
403
#else
404
  return 0;
405
#endif
406
0
}
407
408
#endif
409
410
/* Doubly-Linked List */
411
412
/**
413
 * Kernel-Mode Basics: Windows Linked Lists:
414
 * http://www.osronline.com/article.cfm?article=499
415
 *
416
 * Singly and Doubly Linked Lists:
417
 * http://msdn.microsoft.com/en-us/library/windows/hardware/ff563802/
418
 */
419
420
VOID InitializeListHead(WINPR_PLIST_ENTRY ListHead)
421
0
{
422
0
  WINPR_ASSERT(ListHead);
423
0
  ListHead->Flink = ListHead->Blink = ListHead;
424
0
}
425
426
BOOL IsListEmpty(const WINPR_LIST_ENTRY* ListHead)
427
0
{
428
0
  WINPR_ASSERT(ListHead);
429
0
  return (BOOL)(ListHead->Flink == ListHead);
430
0
}
431
432
BOOL RemoveEntryList(WINPR_PLIST_ENTRY Entry)
433
0
{
434
0
  WINPR_ASSERT(Entry);
435
0
  WINPR_PLIST_ENTRY OldFlink = Entry->Flink;
436
0
  WINPR_ASSERT(OldFlink);
437
438
0
  WINPR_PLIST_ENTRY OldBlink = Entry->Blink;
439
0
  WINPR_ASSERT(OldBlink);
440
441
0
  OldFlink->Blink = OldBlink;
442
0
  OldBlink->Flink = OldFlink;
443
444
0
  return (BOOL)(OldFlink == OldBlink);
445
0
}
446
447
VOID InsertHeadList(WINPR_PLIST_ENTRY ListHead, WINPR_PLIST_ENTRY Entry)
448
0
{
449
0
  WINPR_ASSERT(ListHead);
450
0
  WINPR_ASSERT(Entry);
451
452
0
  WINPR_PLIST_ENTRY OldFlink = ListHead->Flink;
453
0
  WINPR_ASSERT(OldFlink);
454
455
0
  Entry->Flink = OldFlink;
456
0
  Entry->Blink = ListHead;
457
0
  OldFlink->Blink = Entry;
458
0
  ListHead->Flink = Entry;
459
0
}
460
461
WINPR_PLIST_ENTRY RemoveHeadList(WINPR_PLIST_ENTRY ListHead)
462
0
{
463
0
  WINPR_ASSERT(ListHead);
464
465
0
  WINPR_PLIST_ENTRY Entry = ListHead->Flink;
466
0
  WINPR_ASSERT(Entry);
467
468
0
  WINPR_PLIST_ENTRY Flink = Entry->Flink;
469
0
  WINPR_ASSERT(Flink);
470
471
0
  ListHead->Flink = Flink;
472
0
  Flink->Blink = ListHead;
473
474
0
  return Entry;
475
0
}
476
477
VOID InsertTailList(WINPR_PLIST_ENTRY ListHead, WINPR_PLIST_ENTRY Entry)
478
0
{
479
0
  WINPR_ASSERT(ListHead);
480
0
  WINPR_ASSERT(Entry);
481
482
0
  WINPR_PLIST_ENTRY OldBlink = ListHead->Blink;
483
0
  WINPR_ASSERT(OldBlink);
484
485
0
  Entry->Flink = ListHead;
486
0
  Entry->Blink = OldBlink;
487
0
  OldBlink->Flink = Entry;
488
0
  ListHead->Blink = Entry;
489
0
}
490
491
WINPR_PLIST_ENTRY RemoveTailList(WINPR_PLIST_ENTRY ListHead)
492
0
{
493
0
  WINPR_ASSERT(ListHead);
494
495
0
  WINPR_PLIST_ENTRY Entry = ListHead->Blink;
496
0
  WINPR_ASSERT(Entry);
497
498
0
  WINPR_PLIST_ENTRY Blink = Entry->Blink;
499
0
  WINPR_ASSERT(Blink);
500
501
0
  ListHead->Blink = Blink;
502
0
  Blink->Flink = ListHead;
503
504
0
  return Entry;
505
0
}
506
507
VOID AppendTailList(WINPR_PLIST_ENTRY ListHead, WINPR_PLIST_ENTRY ListToAppend)
508
0
{
509
0
  WINPR_ASSERT(ListHead);
510
0
  WINPR_ASSERT(ListToAppend);
511
512
0
  WINPR_PLIST_ENTRY ListEnd = ListHead->Blink;
513
514
0
  ListHead->Blink->Flink = ListToAppend;
515
0
  ListHead->Blink = ListToAppend->Blink;
516
0
  ListToAppend->Blink->Flink = ListHead;
517
0
  ListToAppend->Blink = ListEnd;
518
0
}
519
520
VOID PushEntryList(WINPR_PSINGLE_LIST_ENTRY ListHead, WINPR_PSINGLE_LIST_ENTRY Entry)
521
0
{
522
0
  WINPR_ASSERT(ListHead);
523
0
  WINPR_ASSERT(Entry);
524
525
0
  Entry->Next = ListHead->Next;
526
0
  ListHead->Next = Entry;
527
0
}
528
529
WINPR_PSINGLE_LIST_ENTRY PopEntryList(WINPR_PSINGLE_LIST_ENTRY ListHead)
530
0
{
531
0
  WINPR_ASSERT(ListHead);
532
0
  WINPR_PSINGLE_LIST_ENTRY FirstEntry = ListHead->Next;
533
534
0
  if (FirstEntry != NULL)
535
0
    ListHead->Next = FirstEntry->Next;
536
537
0
  return FirstEntry;
538
0
}