hc
2023-05-26 a23f51ed7a39e452c1037343a84d7db1ca2c5bd7
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
/*************************************************************************/ /*!
@File
@Title          Self scaling hash tables.
@Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
@Description 
   Implements simple self scaling hash tables. Hash collisions are
   handled by chaining entries together. Hash tables are increased in
   size when they become more than (50%?) full and decreased in size
   when less than (25%?) full. Hash tables are never decreased below
   their initial size.
@License        Dual MIT/GPLv2
 
The contents of this file are subject to the MIT license as set out below.
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 2 ("GPL") in which case the provisions
of GPL are applicable instead of those above.
 
If you wish to allow use of your version of this file only under the terms of
GPL, and not to allow others to use your version of this file under the terms
of the MIT license, indicate your decision by deleting the provisions above
and replace them with the notice and other provisions required by GPL as set
out in the file called "GPL-COPYING" included in this distribution. If you do
not delete the provisions above, a recipient may use your version of this file
under the terms of either the MIT license or GPL.
 
This License is also included in this distribution in the file called
"MIT-COPYING".
 
EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ /**************************************************************************/
 
/* include/ */
#include "img_defs.h"
#include "img_types.h"
#include "pvr_debug.h"
#include "pvrsrv_error.h"
 
/* services/shared/include/ */
#include "hash.h"
 
/* services/client/include/ or services/server/include/ */
#include "osfunc.h"
#include "allocmem.h"
 
#if defined(__KERNEL__)
#include "pvrsrv.h"
#endif
 
#define PRIVATE_MAX(a,b) ((a)>(b)?(a):(b))
 
#define    KEY_TO_INDEX(pHash, key, uSize) \
   ((pHash)->pfnHashFunc((pHash)->uKeySize, (key), (uSize)) % (uSize))
 
#define    KEY_COMPARE(pHash, pKey1, pKey2) \
   ((pHash)->pfnKeyComp((pHash)->uKeySize, (pKey1), (pKey2)))
 
/* Each entry in a hash table is placed into a bucket */
struct _BUCKET_
{
   /* the next bucket on the same chain */
   struct _BUCKET_ *pNext;
 
   /* entry value */
   uintptr_t v;
 
   /* entry key */
#if defined (WIN32)
   uintptr_t k[1];
#else
   uintptr_t k[];        /* PRQA S 0642 */ /* override dynamic array declaration warning */
#endif
};
typedef struct _BUCKET_ BUCKET;
 
struct _HASH_TABLE_
{
   /* current size of the hash table */
   IMG_UINT32 uSize;
 
   /* number of entries currently in the hash table */
   IMG_UINT32 uCount;
 
   /* the minimum size that the hash table should be re-sized to */
   IMG_UINT32 uMinimumSize;
 
   /* size of key in bytes */
   IMG_UINT32 uKeySize;
 
   /* hash function */
   HASH_FUNC *pfnHashFunc;
 
   /* key comparison function */
   HASH_KEY_COMP *pfnKeyComp;
 
   /* the hash table array */
   BUCKET **ppBucketTable;
};
 
/*************************************************************************/ /*!
@Function       HASH_Func_Default
@Description    Hash function intended for hashing keys composed of
                uintptr_t arrays.
@Input          uKeySize     The size of the hash key, in bytes.
@Input          pKey         A pointer to the key to hash.
@Input          uHashTabLen  The length of the hash table.
@Return         The hash value.
*/ /**************************************************************************/
IMG_INTERNAL IMG_UINT32
HASH_Func_Default (size_t uKeySize, void *pKey, IMG_UINT32 uHashTabLen)
{
   uintptr_t *p = (uintptr_t *)pKey;
   IMG_UINT32 uKeyLen = uKeySize / sizeof(uintptr_t);
   IMG_UINT32 ui;
   IMG_UINT32 uHashKey = 0;
 
   PVR_UNREFERENCED_PARAMETER(uHashTabLen);
 
   PVR_ASSERT((uKeySize % sizeof(uintptr_t)) == 0);
 
   for (ui = 0; ui < uKeyLen; ui++)
   {
       IMG_UINT32 uHashPart = (IMG_UINT32)*p++;
 
       uHashPart += (uHashPart << 12);
       uHashPart ^= (uHashPart >> 22);
       uHashPart += (uHashPart << 4);
       uHashPart ^= (uHashPart >> 9);
       uHashPart += (uHashPart << 10);
       uHashPart ^= (uHashPart >> 2);
       uHashPart += (uHashPart << 7);
       uHashPart ^= (uHashPart >> 12);
 
       uHashKey += uHashPart;
   }
 
   return uHashKey;
}
 
/*************************************************************************/ /*!
@Function       HASH_Key_Comp_Default
@Description    Compares keys composed of uintptr_t arrays.
@Input          uKeySize    The size of the hash key, in bytes.
@Input          pKey1       Pointer to first hash key to compare.
@Input          pKey2       Pointer to second hash key to compare.
@Return         IMG_TRUE    The keys match.
                IMG_FALSE   The keys don't match.
*/ /**************************************************************************/
IMG_INTERNAL IMG_BOOL
HASH_Key_Comp_Default (size_t uKeySize, void *pKey1, void *pKey2)
{
   uintptr_t *p1 = (uintptr_t *)pKey1;
   uintptr_t *p2 = (uintptr_t *)pKey2;
   IMG_UINT32 uKeyLen = uKeySize / sizeof(uintptr_t);
   IMG_UINT32 ui;
 
   PVR_ASSERT((uKeySize % sizeof(uintptr_t)) == 0);
 
   for (ui = 0; ui < uKeyLen; ui++)
   {
       if (*p1++ != *p2++)
           return IMG_FALSE;
   }
 
   return IMG_TRUE;
}
 
/*************************************************************************/ /*!
@Function       _ChainInsert
@Description    Insert a bucket into the appropriate hash table chain.
@Input          pBucket       The bucket
@Input          ppBucketTable The hash table
@Input          uSize         The size of the hash table
@Return         PVRSRV_ERROR
*/ /**************************************************************************/
static void
_ChainInsert (HASH_TABLE *pHash, BUCKET *pBucket, BUCKET **ppBucketTable, IMG_UINT32 uSize)
{
   IMG_UINT32 uIndex;
 
   /* We assume that all parameters passed by the caller are valid. */
   PVR_ASSERT (pBucket != NULL);
   PVR_ASSERT (ppBucketTable != NULL);
   PVR_ASSERT (uSize != 0);
 
   uIndex = KEY_TO_INDEX(pHash, pBucket->k, uSize);    /* PRQA S 0432,0541 */ /* ignore dynamic array warning */
   pBucket->pNext = ppBucketTable[uIndex];
   ppBucketTable[uIndex] = pBucket;
}
 
/*************************************************************************/ /*!
@Function       _Rehash
@Description    Iterate over every entry in an old hash table and
                rehash into the new table.
@Input          ppOldTable   The old hash table
@Input          uOldSize     The size of the old hash table
@Input          ppNewTable   The new hash table
@Input          uNewSize     The size of the new hash table
@Return         None
*/ /**************************************************************************/
static void
_Rehash (HASH_TABLE *pHash,
         BUCKET **ppOldTable, IMG_UINT32 uOldSize,
         BUCKET **ppNewTable, IMG_UINT32 uNewSize)
{
   IMG_UINT32 uIndex;
   for (uIndex=0; uIndex< uOldSize; uIndex++)
    {
       BUCKET *pBucket;
       pBucket = ppOldTable[uIndex];
       while (pBucket != NULL)
       {
           BUCKET *pNextBucket = pBucket->pNext;
           _ChainInsert (pHash, pBucket, ppNewTable, uNewSize);
           pBucket = pNextBucket;
       }
    }
}
 
/*************************************************************************/ /*!
@Function       _Resize
@Description    Attempt to resize a hash table, failure to allocate a
                new larger hash table is not considered a hard failure.
                We simply continue and allow the table to fill up, the
                effect is to allow hash chains to become longer.
@Input          pHash      Hash table to resize.
@Input          uNewSize   Required table size.
@Return         IMG_TRUE Success
                IMG_FALSE Failed
*/ /**************************************************************************/
static IMG_BOOL
_Resize (HASH_TABLE *pHash, IMG_UINT32 uNewSize)
{
   if (uNewSize != pHash->uSize)
    {
       BUCKET **ppNewTable;
        IMG_UINT32 uIndex;
 
#if defined(__linux__) && defined(__KERNEL__)
       ppNewTable = OSAllocMemNoStats(sizeof (BUCKET *) * uNewSize);
#else
       ppNewTable = OSAllocMem(sizeof (BUCKET *) * uNewSize);
#endif
       if (ppNewTable == NULL)
        {
            return IMG_FALSE;
        }
 
        for (uIndex=0; uIndex<uNewSize; uIndex++)
            ppNewTable[uIndex] = NULL;
 
        _Rehash(pHash, pHash->ppBucketTable, pHash->uSize, ppNewTable, uNewSize);
 
#if defined(__linux__) && defined(__KERNEL__)
        OSFreeMemNoStats(pHash->ppBucketTable);
#else
        OSFreeMem(pHash->ppBucketTable);
#endif
        /*not nulling pointer, being reassigned just below*/
        pHash->ppBucketTable = ppNewTable;
        pHash->uSize = uNewSize;
    }
    return IMG_TRUE;
}
 
 
/*************************************************************************/ /*!
@Function       HASH_Create_Extended
@Description    Create a self scaling hash table, using the supplied
                key size, and the supplied hash and key comparsion
                functions.
@Input          uInitialLen   Initial and minimum length of the
                              hash table, where the length refers to the number
                              of entries in the hash table, not its size in
                              bytes.
@Input          uKeySize      The size of the key, in bytes.
@Input          pfnHashFunc   Pointer to hash function.
@Input          pfnKeyComp    Pointer to key comparsion function.
@Return         NULL or hash table handle.
*/ /**************************************************************************/
IMG_INTERNAL 
HASH_TABLE * HASH_Create_Extended (IMG_UINT32 uInitialLen, size_t uKeySize, HASH_FUNC *pfnHashFunc, HASH_KEY_COMP *pfnKeyComp)
{
   HASH_TABLE *pHash;
   IMG_UINT32 uIndex;
 
   if (uInitialLen == 0 || uKeySize == 0 || pfnHashFunc == NULL || pfnKeyComp == NULL)
   {
       PVR_DPF((PVR_DBG_ERROR, "HASH_Create_Extended: invalid input parameters"));
       return NULL;
   }
 
   PVR_DPF ((PVR_DBG_MESSAGE, "HASH_Create_Extended: InitialSize=0x%x", uInitialLen));
 
#if defined(__linux__) && defined(__KERNEL__)
   pHash = OSAllocMemNoStats(sizeof(HASH_TABLE));
#else
   pHash = OSAllocMem(sizeof(HASH_TABLE));
#endif
    if (pHash == NULL)
   {
       return NULL;
   }
 
   pHash->uCount = 0;
   pHash->uSize = uInitialLen;
   pHash->uMinimumSize = uInitialLen;
   pHash->uKeySize = uKeySize;
   pHash->pfnHashFunc = pfnHashFunc;
   pHash->pfnKeyComp = pfnKeyComp;
 
#if defined(__linux__) && defined(__KERNEL__)
    pHash->ppBucketTable = OSAllocMemNoStats(sizeof (BUCKET *) * pHash->uSize);
#else
    pHash->ppBucketTable = OSAllocMem(sizeof (BUCKET *) * pHash->uSize);
#endif
    if (pHash->ppBucketTable == NULL)
    {
#if defined(__linux__) && defined(__KERNEL__)
       OSFreeMemNoStats(pHash);
#else
       OSFreeMem(pHash);
#endif
       /*not nulling pointer, out of scope*/
       return NULL;
    }
 
   for (uIndex=0; uIndex<pHash->uSize; uIndex++)
       pHash->ppBucketTable[uIndex] = NULL;
   return pHash;
}
 
/*************************************************************************/ /*!
@Function       HASH_Create
@Description    Create a self scaling hash table with a key
                consisting of a single uintptr_t, and using
                the default hash and key comparison functions.
@Input          uInitialLen   Initial and minimum length of the
                              hash table, where the length refers to the
                              number of entries in the hash table, not its size
                              in bytes.
@Return         NULL or hash table handle.
*/ /**************************************************************************/
IMG_INTERNAL 
HASH_TABLE * HASH_Create (IMG_UINT32 uInitialLen)
{
   return HASH_Create_Extended(uInitialLen, sizeof(uintptr_t),
       &HASH_Func_Default, &HASH_Key_Comp_Default);
}
 
/*************************************************************************/ /*!
@Function       HASH_Delete
@Description    Delete a hash table created by HASH_Create_Extended or
                HASH_Create.  All entries in the table must have been
                removed before calling this function.
@Input          pHash     Hash table
@Return         None
*/ /**************************************************************************/
IMG_INTERNAL void
HASH_Delete (HASH_TABLE *pHash)
{
   IMG_BOOL bDoCheck = IMG_TRUE;
#if defined(__KERNEL__) && !defined(__QNXNTO__)
   PVRSRV_DATA *psPVRSRVData = PVRSRVGetPVRSRVData();
 
   if (psPVRSRVData != NULL)
   {
       if (psPVRSRVData->eServicesState != PVRSRV_SERVICES_STATE_OK)
       {
           bDoCheck = IMG_FALSE;
       }
   }
#if defined(PVRSRV_FORCE_UNLOAD_IF_BAD_STATE)
   else
   {
       bDoCheck = IMG_FALSE;
   }
#endif
#endif
   if (pHash != NULL)
    {
       PVR_DPF ((PVR_DBG_MESSAGE, "HASH_Delete"));
 
       if (bDoCheck)
       {
           PVR_ASSERT (pHash->uCount==0);
       }
       if(pHash->uCount != 0)
       {
           IMG_UINT32 uiEntriesLeft = pHash->uCount;
           IMG_UINT32 i;
           PVR_DPF ((PVR_DBG_ERROR, "%s: Leak detected in hash table!", __func__));
           PVR_DPF ((PVR_DBG_ERROR, "%s: Likely Cause: client drivers not freeing allocations before destroying devmemcontext", __func__));
           PVR_DPF ((PVR_DBG_ERROR, "%s: Removing remaining %u hash entries.", __func__, uiEntriesLeft));
 
           for (i = 0; i < uiEntriesLeft; i++)
           {
#if defined(__linux__) && defined(__KERNEL__)
               OSFreeMemNoStats(pHash->ppBucketTable[i]);
#else
               OSFreeMem(pHash->ppBucketTable[i]);
#endif
           }
       }
#if defined(__linux__) && defined(__KERNEL__)
       OSFreeMemNoStats(pHash->ppBucketTable);
#else
       OSFreeMem(pHash->ppBucketTable);
#endif
       pHash->ppBucketTable = NULL;
#if defined(__linux__) && defined(__KERNEL__)
       OSFreeMemNoStats(pHash);
#else
       OSFreeMem(pHash);
#endif
       /*not nulling pointer, copy on stack*/
    }
}
 
/*************************************************************************/ /*!
@Function       HASH_Insert_Extended
@Description    Insert a key value pair into a hash table created
                with HASH_Create_Extended.
@Input          pHash     Hash table
@Input          pKey      Pointer to the key.
@Input          v         The value associated with the key.
@Return         IMG_TRUE  - success
                IMG_FALSE  - failure
*/ /**************************************************************************/
IMG_INTERNAL IMG_BOOL
HASH_Insert_Extended (HASH_TABLE *pHash, void *pKey, uintptr_t v)
{
   BUCKET *pBucket;
 
   PVR_ASSERT (pHash != NULL);
 
   if (pHash == NULL)
   {
       PVR_DPF((PVR_DBG_ERROR, "HASH_Insert_Extended: invalid parameter"));
       return IMG_FALSE;
   }
 
#if defined(__linux__) && defined(__KERNEL__)
   pBucket = OSAllocMemNoStats(sizeof(BUCKET) + pHash->uKeySize);
#else
   pBucket = OSAllocMem(sizeof(BUCKET) + pHash->uKeySize);
#endif
    if (pBucket == NULL)
   {
       return IMG_FALSE;
   }
 
   pBucket->v = v;
   /* PRQA S 0432,0541 1 */ /* ignore warning about dynamic array k (linux)*/
   OSCachedMemCopy(pBucket->k, pKey, pHash->uKeySize);
 
   _ChainInsert (pHash, pBucket, pHash->ppBucketTable, pHash->uSize);
 
   pHash->uCount++;
 
   /* check if we need to think about re-balancing */
   if (pHash->uCount << 1 > pHash->uSize)
    {
        /* Ignore the return code from _Resize because the hash table is
           still in a valid state and although not ideally sized, it is still
           functional */
        _Resize (pHash, pHash->uSize << 1);
    }
 
 
   return IMG_TRUE;
}
 
/*************************************************************************/ /*!
@Function       HASH_Insert
@Description    Insert a key value pair into a hash table created with
                HASH_Create.
@Input          pHash     Hash table
@Input          k         The key value.
@Input          v         The value associated with the key.
@Return         IMG_TRUE - success.
                IMG_FALSE - failure.
*/ /**************************************************************************/
IMG_INTERNAL IMG_BOOL
HASH_Insert (HASH_TABLE *pHash, uintptr_t k, uintptr_t v)
{
   return HASH_Insert_Extended(pHash, &k, v);
}
 
/*************************************************************************/ /*!
@Function       HASH_Remove_Extended
@Description    Remove a key from a hash table created with
                HASH_Create_Extended.
@Input          pHash     Hash table
@Input          pKey      Pointer to key.
@Return         0 if the key is missing, or the value associated with the key.
*/ /**************************************************************************/
IMG_INTERNAL uintptr_t
HASH_Remove_Extended(HASH_TABLE *pHash, void *pKey)
{
   BUCKET **ppBucket;
   IMG_UINT32 uIndex;
 
   PVR_ASSERT (pHash != NULL);
 
   if (pHash == NULL)
   {
       PVR_DPF((PVR_DBG_ERROR, "HASH_Remove_Extended: Null hash table"));
       return 0;
   }
 
   uIndex = KEY_TO_INDEX(pHash, pKey, pHash->uSize);
 
   for (ppBucket = &(pHash->ppBucketTable[uIndex]); *ppBucket != NULL; ppBucket = &((*ppBucket)->pNext))
   {
       /* PRQA S 0432,0541 1 */ /* ignore warning about dynamic array k */
       if (KEY_COMPARE(pHash, (*ppBucket)->k, pKey))
       {
           BUCKET *pBucket = *ppBucket;
           uintptr_t v = pBucket->v;
           (*ppBucket) = pBucket->pNext;
 
#if defined(__linux__) && defined(__KERNEL__)
           OSFreeMemNoStats(pBucket);
#else
           OSFreeMem(pBucket);
#endif
           /*not nulling original pointer, already overwritten*/
 
           pHash->uCount--;
 
           /* check if we need to think about re-balancing */
           if (pHash->uSize > (pHash->uCount << 2) &&
                pHash->uSize > pHash->uMinimumSize)
            {
                /* Ignore the return code from _Resize because the
                   hash table is still in a valid state and although
                   not ideally sized, it is still functional */
               _Resize (pHash,
                         PRIVATE_MAX (pHash->uSize >> 1,
                                      pHash->uMinimumSize));
            }
 
           return v;
       }
   }
   return 0;
}
 
/*************************************************************************/ /*!
@Function       HASH_Remove
@Description    Remove a key value pair from a hash table created
                with HASH_Create.
@Input          pHash     Hash table
@Input          k         The key
@Return         0 if the key is missing, or the value associated with the key.
*/ /**************************************************************************/
IMG_INTERNAL uintptr_t
HASH_Remove (HASH_TABLE *pHash, uintptr_t k)
{
   return HASH_Remove_Extended(pHash, &k);
}
 
/*************************************************************************/ /*!
@Function       HASH_Retrieve_Extended
@Description    Retrieve a value from a hash table created with
                HASH_Create_Extended.
@Input          pHash     Hash table
@Input          pKey      Pointer to the key.
@Return         0 if the key is missing, or the value associated with the key.
*/ /**************************************************************************/
IMG_INTERNAL uintptr_t
HASH_Retrieve_Extended (HASH_TABLE *pHash, void *pKey)
{
   BUCKET **ppBucket;
   IMG_UINT32 uIndex;
 
   PVR_ASSERT (pHash != NULL);
 
   if (pHash == NULL)
   {
       PVR_DPF((PVR_DBG_ERROR, "HASH_Retrieve_Extended: Null hash table"));
       return 0;
   }
 
   uIndex = KEY_TO_INDEX(pHash, pKey, pHash->uSize);
 
   for (ppBucket = &(pHash->ppBucketTable[uIndex]); *ppBucket != NULL; ppBucket = &((*ppBucket)->pNext))
   {
       /* PRQA S 0432,0541 1 */ /* ignore warning about dynamic array k */
       if (KEY_COMPARE(pHash, (*ppBucket)->k, pKey))
       {
           BUCKET *pBucket = *ppBucket;
           uintptr_t v = pBucket->v;
 
           return v;
       }
   }
   return 0;
}
 
/*************************************************************************/ /*!
@Function       HASH_Retrieve
@Description    Retrieve a value from a hash table created with
                HASH_Create.
@Input          pHash     Hash table
@Input          k         The key
@Return         0 if the key is missing, or the value associated with the key.
*/ /**************************************************************************/
IMG_INTERNAL uintptr_t
HASH_Retrieve (HASH_TABLE *pHash, uintptr_t k)
{
   return HASH_Retrieve_Extended(pHash, &k);
}
 
/*************************************************************************/ /*!
@Function       HASH_Iterate
@Description    Iterate over every entry in the hash table
@Input          pHash - Hash table to iterate
@Input          pfnCallback - Callback to call with the key and data for each
                             entry in the hash table
@Return         Callback error if any, otherwise PVRSRV_OK
*/ /**************************************************************************/
IMG_INTERNAL PVRSRV_ERROR
HASH_Iterate(HASH_TABLE *pHash, HASH_pfnCallback pfnCallback)
{
    IMG_UINT32 uIndex;
    for (uIndex=0; uIndex < pHash->uSize; uIndex++)
    {
        BUCKET *pBucket;
        pBucket = pHash->ppBucketTable[uIndex];
        while (pBucket != NULL)
        {
            PVRSRV_ERROR eError;
            BUCKET *pNextBucket = pBucket->pNext;
 
            eError = pfnCallback((uintptr_t) ((void *) *(pBucket->k)), (uintptr_t) pBucket->v);
 
            /* The callback might want us to break out early */
            if (eError != PVRSRV_OK)
                return eError;
 
            pBucket = pNextBucket;
        }
    }
    return PVRSRV_OK;
}
 
#ifdef HASH_TRACE
/*************************************************************************/ /*!
@Function       HASH_Dump
@Description    To dump the contents of a hash table in human readable
                form.
@Input          pHash     Hash table
*/ /**************************************************************************/
void
HASH_Dump (HASH_TABLE *pHash)
{
   IMG_UINT32 uIndex;
   IMG_UINT32 uMaxLength=0;
   IMG_UINT32 uEmptyCount=0;
 
   PVR_ASSERT (pHash != NULL);
   for (uIndex=0; uIndex<pHash->uSize; uIndex++)
   {
       BUCKET *pBucket;
       IMG_UINT32 uLength = 0;
       if (pHash->ppBucketTable[uIndex] == NULL)
       {
           uEmptyCount++;
       }
       for (pBucket=pHash->ppBucketTable[uIndex];
               pBucket != NULL;
               pBucket = pBucket->pNext)
       {
           uLength++;
       }
       uMaxLength = PRIVATE_MAX (uMaxLength, uLength);
   }
 
   PVR_TRACE(("hash table: uMinimumSize=%d  size=%d  count=%d",
           pHash->uMinimumSize, pHash->uSize, pHash->uCount));
   PVR_TRACE(("  empty=%d  max=%d", uEmptyCount, uMaxLength));
}
#endif