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
|
/* $NoKeywords:$ */
/**
* @file
*
* AMD Heap Manager and Heap Allocation APIs, and related functions.
*
* Contains code that initialize, maintain, and allocate the heap space.
*
* @xrefitem bom "File Content Label" "Release Content"
* @e project: AGESA
* @e sub-project: CPU
* @e \$Revision: 63425 $ @e \$Date: 2011-12-22 11:24:10 -0600 (Thu, 22 Dec 2011) $
*
*/
/*******************************************************************************
*
* Copyright 2008 - 2012 ADVANCED MICRO DEVICES, INC. All Rights Reserved.
*
* AMD is granting you permission to use this software (the Materials)
* pursuant to the terms and conditions of your Software License Agreement
* with AMD. This header does *NOT* give you permission to use the Materials
* or any rights under AMD's intellectual property. Your use of any portion
* of these Materials shall constitute your acceptance of those terms and
* conditions. If you do not agree to the terms and conditions of the Software
* License Agreement, please do not use any portion of these Materials.
*
* CONFIDENTIALITY: The Materials and all other information, identified as
* confidential and provided to you by AMD shall be kept confidential in
* accordance with the terms and conditions of the Software License Agreement.
*
* LIMITATION OF LIABILITY: THE MATERIALS AND ANY OTHER RELATED INFORMATION
* PROVIDED TO YOU BY AMD ARE PROVIDED "AS IS" WITHOUT ANY EXPRESS OR IMPLIED
* WARRANTY OF ANY KIND, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
* MERCHANTABILITY, NONINFRINGEMENT, TITLE, FITNESS FOR ANY PARTICULAR PURPOSE,
* OR WARRANTIES ARISING FROM CONDUCT, COURSE OF DEALING, OR USAGE OF TRADE.
* IN NO EVENT SHALL AMD OR ITS LICENSORS BE LIABLE FOR ANY DAMAGES WHATSOEVER
* (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS
* INTERRUPTION, OR LOSS OF INFORMATION) ARISING OUT OF AMD'S NEGLIGENCE,
* GROSS NEGLIGENCE, THE USE OF OR INABILITY TO USE THE MATERIALS OR ANY OTHER
* RELATED INFORMATION PROVIDED TO YOU BY AMD, EVEN IF AMD HAS BEEN ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME JURISDICTIONS PROHIBIT THE
* EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES,
* THE ABOVE LIMITATION MAY NOT APPLY TO YOU.
*
* AMD does not assume any responsibility for any errors which may appear in
* the Materials or any other related information provided to you by AMD, or
* result from use of the Materials or any related information.
*
* You agree that you will not reverse engineer or decompile the Materials.
*
* NO SUPPORT OBLIGATION: AMD is not obligated to furnish, support, or make any
* further information, software, technical information, know-how, or show-how
* available to you. Additionally, AMD retains the right to modify the
* Materials at any time, without notice, and is not obligated to provide such
* modified Materials to you.
*
* U.S. GOVERNMENT RESTRICTED RIGHTS: The Materials are provided with
* "RESTRICTED RIGHTS." Use, duplication, or disclosure by the Government is
* subject to the restrictions as set forth in FAR 52.227-14 and
* DFAR252.227-7013, et seq., or its successor. Use of the Materials by the
* Government constitutes acknowledgement of AMD's proprietary rights in them.
*
* EXPORT ASSURANCE: You agree and certify that neither the Materials, nor any
* direct product thereof will be exported directly or indirectly, into any
* country prohibited by the United States Export Administration Act and the
* regulations thereunder, without the required authorization from the U.S.
* government nor will be used for any purpose prohibited by the same.
******************************************************************************
*/
/*----------------------------------------------------------------------------------------
* M O D U L E S U S E D
*----------------------------------------------------------------------------------------
*/
#include "AGESA.h"
#include "amdlib.h"
#include "Ids.h"
#include "cpuRegisters.h"
#include "cpuServices.h"
#include "GeneralServices.h"
#include "heapManager.h"
#include "cpuCacheInit.h"
#include "cpuFamilyTranslation.h"
#include "Filecode.h"
CODE_GROUP (G1_PEICC)
RDATA_GROUP (G1_PEICC)
#define FILECODE PROC_CPU_HEAPMANAGER_FILECODE
/*----------------------------------------------------------------------------------------
* D E F I N I T I O N S A N D M A C R O S
*----------------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------------------
* T Y P E D E F S A N D S T R U C T U R E S
*----------------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------------------
* P R O T O T Y P E S O F L O C A L F U N C T I O N S
*----------------------------------------------------------------------------------------
*/
UINT64
STATIC
HeapGetCurrentBase (
IN AMD_CONFIG_PARAMS *StdHeader
);
VOID
STATIC
DeleteFreeSpaceNode (
IN AMD_CONFIG_PARAMS *StdHeader,
IN UINT32 OffsetOfDeletedNode
);
VOID
STATIC
InsertFreeSpaceNode (
IN AMD_CONFIG_PARAMS *StdHeader,
IN UINT32 OffsetOfInsertNode
);
/*----------------------------------------------------------------------------------------
* P U B L I C F U N C T I O N S
*----------------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------------------
* E X P O R T E D F U N C T I O N S
*----------------------------------------------------------------------------------------
*/
extern BUILD_OPT_CFG UserOptions;
/*---------------------------------------------------------------------------------------*/
/**
* This function initializes the heap for each CPU core.
*
* Check for already initialized. If not, determine offset of local heap in CAS and
* setup initial heap markers and bookkeeping status. Initialize a couple heap items
* all cores need, for convenience. Currently these are caching the AP mailbox info and
* an initial event log.
*
* @param[in] StdHeader Handle of Header for calling lib functions and services.
*
* @retval AGESA_SUCCESS This core's heap is initialized
* @retval AGESA_FATAL This core's heap cannot be initialized due to any reasons below:
* - current processor family cannot be identified.
*
*/
AGESA_STATUS
HeapManagerInit (
IN AMD_CONFIG_PARAMS *StdHeader
)
{
// First Time Initialization
// Note: First 16 bytes of buffer is reserved for Heap Manager use
UINT16 HeapAlreadyInitSizeDword;
UINT32 HeapAlreadyRead;
UINT8 L2LineSize;
UINT8 *HeapBufferPtr;
UINT8 *HeapInitPtr;
UINT32 *HeapDataPtr;
UINT64 MsrData;
UINT64 MsrMask;
UINT8 Ignored;
CPUID_DATA CpuId;
BUFFER_NODE *FreeSpaceNode;
CACHE_INFO *CacheInfoPtr;
AGESA_STATUS IgnoredSts;
CPU_SPECIFIC_SERVICES *FamilySpecificServices;
CPU_LOGICAL_ID CpuFamilyRevision;
// Check whether this is a known processor family.
GetLogicalIdOfCurrentCore (&CpuFamilyRevision, StdHeader);
if ((CpuFamilyRevision.Family == 0) && (CpuFamilyRevision.Revision == 0)) {
IDS_ERROR_TRAP;
return AGESA_FATAL;
}
GetCpuServicesOfCurrentCore ((CONST CPU_SPECIFIC_SERVICES **)&FamilySpecificServices, StdHeader);
FamilySpecificServices->GetCacheInfo (FamilySpecificServices, (CONST VOID **) &CacheInfoPtr, &Ignored, StdHeader);
HeapBufferPtr = (UINT8 *)(UINT32) StdHeader->HeapBasePtr;
// Check whether the heap manager is already initialized
LibAmdMsrRead (AMD_MTRR_VARIABLE_HEAP_MASK, &MsrData, StdHeader);
if (MsrData == (CacheInfoPtr->VariableMtrrMask & AMD_HEAP_MTRR_MASK)) {
LibAmdMsrRead (AMD_MTRR_VARIABLE_HEAP_BASE, &MsrData, StdHeader);
if ((MsrData & CacheInfoPtr->HeapBaseMask) == ((UINT64) (UINTN) HeapBufferPtr & CacheInfoPtr->HeapBaseMask)) {
if (((HEAP_MANAGER *) HeapBufferPtr)->Signature == HEAP_SIGNATURE_VALID) {
// This is not a bug, there are multiple premem basic entry points,
// and each will call heap init to make sure create struct will succeed.
// If that is later deemed a problem, there needs to be a reasonable test
// for the calling code to make to determine if it needs to init heap or not.
// In the mean time, add this to the event log
PutEventLog (AGESA_SUCCESS,
CPU_ERROR_HEAP_IS_ALREADY_INITIALIZED,
0, 0, 0, 0, StdHeader);
return AGESA_SUCCESS;
}
}
}
// Set variable MTRR base and mask
MsrData = ((UINT64) (UINTN) HeapBufferPtr & CacheInfoPtr->HeapBaseMask);
MsrMask = CacheInfoPtr->VariableMtrrHeapMask & AMD_HEAP_MTRR_MASK;
MsrData |= 0x06;
LibAmdMsrWrite (AMD_MTRR_VARIABLE_HEAP_BASE, &MsrData, StdHeader);
LibAmdMsrWrite (AMD_MTRR_VARIABLE_HEAP_MASK, &MsrMask, StdHeader);
// Set top of memory to a temp value
MsrData = (UINT64) (AMD_TEMP_TOM);
LibAmdMsrWrite (TOP_MEM, &MsrData, StdHeader);
// Enable variable MTTRs
LibAmdMsrRead (SYS_CFG, &MsrData, StdHeader);
MsrData |= AMD_VAR_MTRR_ENABLE_BIT;
LibAmdMsrWrite (SYS_CFG, &MsrData, StdHeader);
// Initialize Heap Space
// BIOS may store to a line only after it has been allocated by a load
LibAmdCpuidRead (AMD_CPUID_L2L3Cache_L2TLB, &CpuId, StdHeader);
L2LineSize = (UINT8) (CpuId.ECX_Reg);
HeapInitPtr = HeapBufferPtr ;
for (HeapAlreadyRead = 0; HeapAlreadyRead < AMD_HEAP_SIZE_PER_CORE;
(HeapAlreadyRead = HeapAlreadyRead + L2LineSize)) {
Ignored = *HeapInitPtr;
HeapInitPtr += L2LineSize;
}
HeapDataPtr = (UINT32 *) HeapBufferPtr;
for (HeapAlreadyInitSizeDword = 0; HeapAlreadyInitSizeDword < AMD_HEAP_SIZE_DWORD_PER_CORE; HeapAlreadyInitSizeDword++) {
*HeapDataPtr = 0;
HeapDataPtr++;
}
// Note: We are reserving the first 16 bytes for Heap Manager use
// UsedSize indicates the size of heap spaced is used for HEAP_MANAGER, BUFFER_NODE,
// Pad for 16-byte alignment, buffer data, and IDS SENTINEL.
// FirstActiveBufferOffset is initalized as invalid heap offset, AMD_HEAP_INVALID_HEAP_OFFSET.
// FirstFreeSpaceOffset is initalized as the byte right after HEAP_MANAGER header.
// Then we set Signature of HEAP_MANAGER header as valid, HEAP_SIGNATURE_VALID.
((HEAP_MANAGER*) HeapBufferPtr)->UsedSize = sizeof (HEAP_MANAGER);
((HEAP_MANAGER*) HeapBufferPtr)->FirstActiveBufferOffset = AMD_HEAP_INVALID_HEAP_OFFSET;
((HEAP_MANAGER*) HeapBufferPtr)->FirstFreeSpaceOffset = sizeof (HEAP_MANAGER);
((HEAP_MANAGER*) HeapBufferPtr)->Signature = HEAP_SIGNATURE_VALID;
// Create free space link
FreeSpaceNode = (BUFFER_NODE *) (HeapBufferPtr + sizeof (HEAP_MANAGER));
FreeSpaceNode->BufferSize = AMD_HEAP_SIZE_PER_CORE - sizeof (HEAP_MANAGER) - sizeof (BUFFER_NODE);
FreeSpaceNode->OffsetOfNextNode = AMD_HEAP_INVALID_HEAP_OFFSET;
StdHeader->HeapStatus = HEAP_LOCAL_CACHE;
if (!IsBsp (StdHeader, &IgnoredSts)) {
// The BSP's hardware mailbox has not been initialized, so only APs
// can do this at this point.
CacheApMailbox (StdHeader);
}
EventLogInitialization (StdHeader);
return AGESA_SUCCESS;
}
/*---------------------------------------------------------------------------------------*/
/**
* Allocates space for a new buffer in the heap
*
* This function will allocate new buffer either by using internal 'AGESA' heapmanager
* or by using externa (IBV) heapmanager. This function will also determine if whether or not
* there is enough space for the new structure. If so, it will zero out the buffer,
* and return a pointer to the region.
*
* @param[in,out] AllocateHeapParams structure pointer containing the size of the
* desired new region, its handle, and the
* return pointer.
* @param[in,out] StdHeader Config handle for library and services.
*
* @retval AGESA_SUCCESS No error
* @retval AGESA_BOUNDS_CHK Handle already exists, or not enough
* free space
* @retval AGESA_UNSUPPORTED Do not support this kind of heap allocation
* @retval AGESA_ERROR Heap is invaild
*
*/
AGESA_STATUS
HeapAllocateBuffer (
IN OUT ALLOCATE_HEAP_PARAMS *AllocateHeapParams,
IN OUT AMD_CONFIG_PARAMS *StdHeader
)
{
UINT8 *BaseAddress;
UINT8 AlignTo16Byte;
UINT8 CalloutFcnData;
UINT32 RemainSize;
UINT32 OffsetOfSplitNode;
UINT32 OffsetOfNode;
HEAP_MANAGER *HeapManager;
BUFFER_NODE *FreeSpaceNode;
BUFFER_NODE *SplitFreeSpaceNode;
BUFFER_NODE *CurrentBufferNode;
BUFFER_NODE *NewBufferNode;
AGESA_BUFFER_PARAMS AgesaBuffer;
ASSERT (StdHeader != NULL);
if (AllocateHeapParams->Persist == HEAP_RUNTIME_SYSTEM_MEM) {
ASSERT (StdHeader->HeapStatus == HEAP_SYSTEM_MEM);
if (StdHeader->HeapStatus != HEAP_SYSTEM_MEM) {
return AGESA_UNSUPPORTED;
}
}
// At this stage we will decide to either use external (IBV) heap manger
// or internal (AGESA) heap manager.
// If (HeapStatus == HEAP_SYSTEM_MEM), then use the call function to call
// external heap manager
if (StdHeader->HeapStatus == HEAP_SYSTEM_MEM) {
AgesaBuffer.StdHeader = *StdHeader;
AgesaBuffer.BufferHandle = AllocateHeapParams->BufferHandle;
AgesaBuffer.BufferLength = AllocateHeapParams->RequestedBufferSize;
if (AllocateHeapParams->Persist == HEAP_RUNTIME_SYSTEM_MEM) {
CalloutFcnData = HEAP_CALLOUT_RUNTIME;
} else {
CalloutFcnData = HEAP_CALLOUT_BOOTTIME;
}
AGESA_TESTPOINT (TpIfBeforeAllocateHeapBuffer, StdHeader);
if (AgesaAllocateBuffer (CalloutFcnData, &AgesaBuffer) != AGESA_SUCCESS) {
AllocateHeapParams->BufferPtr = NULL;
return AGESA_ERROR;
}
AGESA_TESTPOINT (TpIfAfterAllocateHeapBuffer, StdHeader);
AllocateHeapParams->BufferPtr = (UINT8 *) (AgesaBuffer.BufferPointer);
return AGESA_SUCCESS;
}
// If (StdHeader->HeapStatus != HEAP_SYSTEM_MEM), then allocated buffer
// using following AGESA Heap Manager code.
// Buffer pointer is NULL unless we return a buffer.
AlignTo16Byte = 0;
AllocateHeapParams->BufferPtr = NULL;
AllocateHeapParams->RequestedBufferSize += NUM_OF_SENTINEL * SIZE_OF_SENTINEL;
// Get base address
BaseAddress = (UINT8 *) (UINTN) StdHeader->HeapBasePtr;
HeapManager = (HEAP_MANAGER *) BaseAddress;
// Check Heap database is valid
if ((BaseAddress == NULL) || (HeapManager->Signature != HEAP_SIGNATURE_VALID)) {
// The base address in StdHeader is incorrect, get base address by itself
BaseAddress = (UINT8 *)(UINT32) HeapGetBaseAddress (StdHeader);
HeapManager = (HEAP_MANAGER *) BaseAddress;
if ((BaseAddress == NULL) || (HeapManager->Signature != HEAP_SIGNATURE_VALID)) {
// Heap is not available, ASSERT here
ASSERT (FALSE);
return AGESA_ERROR;
}
StdHeader->HeapBasePtr = (UINT64)(UINT32) BaseAddress;
}
// Allocate
CurrentBufferNode = (BUFFER_NODE *) (BaseAddress + sizeof (HEAP_MANAGER));
// If there already has been a heap with the incoming BufferHandle, we return AGESA_BOUNDS_CHK.
if (HeapManager->FirstActiveBufferOffset != AMD_HEAP_INVALID_HEAP_OFFSET) {
CurrentBufferNode = (BUFFER_NODE *) (BaseAddress + HeapManager->FirstActiveBufferOffset);
while (CurrentBufferNode->OffsetOfNextNode != AMD_HEAP_INVALID_HEAP_OFFSET) {
if (CurrentBufferNode->BufferHandle == AllocateHeapParams->BufferHandle) {
PutEventLog (AGESA_BOUNDS_CHK,
CPU_ERROR_HEAP_BUFFER_HANDLE_IS_ALREADY_USED,
AllocateHeapParams->BufferHandle, 0, 0, 0, StdHeader);
return AGESA_BOUNDS_CHK;
} else {
CurrentBufferNode = (BUFFER_NODE *) (BaseAddress + CurrentBufferNode->OffsetOfNextNode);
}
}
if (CurrentBufferNode->BufferHandle == AllocateHeapParams->BufferHandle) {
PutEventLog (AGESA_BOUNDS_CHK,
CPU_ERROR_HEAP_BUFFER_HANDLE_IS_ALREADY_USED,
AllocateHeapParams->BufferHandle, 0, 0, 0, StdHeader);
return AGESA_BOUNDS_CHK;
}
}
// Find the buffer size that first matches the requested buffer size (i.e. the first free buffer of greater size).
OffsetOfNode = HeapManager->FirstFreeSpaceOffset;
FreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfNode);
while (OffsetOfNode != AMD_HEAP_INVALID_HEAP_OFFSET) {
AlignTo16Byte = (UINT8) ((0x10 - (((UINTN) (VOID *) FreeSpaceNode + sizeof (BUFFER_NODE) + SIZE_OF_SENTINEL) & 0xF)) & 0xF);
AllocateHeapParams->RequestedBufferSize = (UINT32) (AllocateHeapParams->RequestedBufferSize + AlignTo16Byte);
if (FreeSpaceNode->BufferSize >= AllocateHeapParams->RequestedBufferSize) {
break;
}
AllocateHeapParams->RequestedBufferSize = (UINT32) (AllocateHeapParams->RequestedBufferSize - AlignTo16Byte);
OffsetOfNode = FreeSpaceNode->OffsetOfNextNode;
FreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfNode);
}
if (OffsetOfNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
// We don't find any free space buffer that matches the requested buffer size.
PutEventLog (AGESA_BOUNDS_CHK,
CPU_ERROR_HEAP_IS_FULL,
AllocateHeapParams->BufferHandle, 0, 0, 0, StdHeader);
return AGESA_BOUNDS_CHK;
} else {
// We find one matched free space buffer.
DeleteFreeSpaceNode (StdHeader, OffsetOfNode);
NewBufferNode = FreeSpaceNode;
// Add new buffer node to the buffer chain
if (HeapManager->FirstActiveBufferOffset == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapManager->FirstActiveBufferOffset = sizeof (HEAP_MANAGER);
} else {
CurrentBufferNode->OffsetOfNextNode = OffsetOfNode;
}
// New buffer size
RemainSize = FreeSpaceNode->BufferSize - AllocateHeapParams->RequestedBufferSize;
if (RemainSize > sizeof (BUFFER_NODE)) {
NewBufferNode->BufferSize = AllocateHeapParams->RequestedBufferSize;
OffsetOfSplitNode = OffsetOfNode + sizeof (BUFFER_NODE) + NewBufferNode->BufferSize;
SplitFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfSplitNode);
SplitFreeSpaceNode->BufferSize = RemainSize - sizeof (BUFFER_NODE);
InsertFreeSpaceNode (StdHeader, OffsetOfSplitNode);
} else {
// Remain size is less than BUFFER_NODE, we use whole size instead of requested size.
NewBufferNode->BufferSize = FreeSpaceNode->BufferSize;
}
}
// Initialize BUFFER_NODE structure of NewBufferNode
NewBufferNode->BufferHandle = AllocateHeapParams->BufferHandle;
if ((AllocateHeapParams->Persist == HEAP_TEMP_MEM) || (AllocateHeapParams->Persist == HEAP_SYSTEM_MEM)) {
NewBufferNode->Persist = AllocateHeapParams->Persist;
} else {
NewBufferNode->Persist = HEAP_LOCAL_CACHE;
}
NewBufferNode->OffsetOfNextNode = AMD_HEAP_INVALID_HEAP_OFFSET;
NewBufferNode->PadSize = AlignTo16Byte;
// Clear to 0x00
LibAmdMemFill ((VOID *) ((UINT8 *) NewBufferNode + sizeof (BUFFER_NODE)), 0x00, NewBufferNode->BufferSize, StdHeader);
// Debug feature
SET_SENTINEL_BEFORE (NewBufferNode, AlignTo16Byte);
SET_SENTINEL_AFTER (NewBufferNode);
// Update global variables
HeapManager->UsedSize += NewBufferNode->BufferSize + sizeof (BUFFER_NODE);
// Now fill in the incoming structure
AllocateHeapParams->BufferPtr = (UINT8 *) ((UINT8 *) NewBufferNode + sizeof (BUFFER_NODE) + SIZE_OF_SENTINEL + AlignTo16Byte);
AllocateHeapParams->RequestedBufferSize -= (NUM_OF_SENTINEL * SIZE_OF_SENTINEL + AlignTo16Byte);
return AGESA_SUCCESS;
}
/*---------------------------------------------------------------------------------------*/
/**
* Deallocates a previously allocated buffer in the heap
*
* This function will deallocate buffer either by using internal 'AGESA' heapmanager
* or by using externa (IBV) heapmanager.
*
* @param[in] BufferHandle Handle of the buffer to free.
* @param[in] StdHeader Config handle for library and services.
*
* @retval AGESA_SUCCESS No error
* @retval AGESA_BOUNDS_CHK Handle does not exist on the heap
*
*/
AGESA_STATUS
HeapDeallocateBuffer (
IN UINT32 BufferHandle,
IN AMD_CONFIG_PARAMS *StdHeader
)
{
UINT8 *BaseAddress;
UINT32 NodeSize;
UINT32 OffsetOfFreeSpaceNode;
UINT32 OffsetOfPreviousNode;
UINT32 OffsetOfCurrentNode;
BOOLEAN HeapLocateFlag;
HEAP_MANAGER *HeapManager;
BUFFER_NODE *CurrentNode;
BUFFER_NODE *PreviousNode;
BUFFER_NODE *FreeSpaceNode;
AGESA_BUFFER_PARAMS AgesaBuffer;
ASSERT (StdHeader != NULL);
HeapLocateFlag = TRUE;
BaseAddress = (UINT8 *) (UINTN) StdHeader->HeapBasePtr;
HeapManager = (HEAP_MANAGER *) BaseAddress;
// Check Heap database is valid
if ((BaseAddress == NULL) || (HeapManager->Signature != HEAP_SIGNATURE_VALID)) {
// The base address in StdHeader is incorrect, get base address by itself
BaseAddress = (UINT8 *)(UINT32) HeapGetBaseAddress (StdHeader);
HeapManager = (HEAP_MANAGER *) BaseAddress;
if ((BaseAddress == NULL) || (HeapManager->Signature != HEAP_SIGNATURE_VALID)) {
// Heap is not available, ASSERT here
ASSERT (FALSE);
return AGESA_ERROR;
}
StdHeader->HeapBasePtr = (UINT64)(UINT32) BaseAddress;
}
OffsetOfPreviousNode = AMD_HEAP_INVALID_HEAP_OFFSET;
OffsetOfCurrentNode = HeapManager->FirstActiveBufferOffset;
CurrentNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
// Locate heap
if ((BaseAddress != NULL) && (HeapManager->Signature == HEAP_SIGNATURE_VALID)) {
if (OffsetOfCurrentNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapLocateFlag = FALSE;
} else {
while (CurrentNode->BufferHandle != BufferHandle) {
if (CurrentNode->OffsetOfNextNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapLocateFlag = FALSE;
break;
} else {
OffsetOfPreviousNode = OffsetOfCurrentNode;
OffsetOfCurrentNode = CurrentNode->OffsetOfNextNode;
CurrentNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
}
}
}
} else {
HeapLocateFlag = FALSE;
}
if (HeapLocateFlag == TRUE) {
// CurrentNode points to the buffer which wanted to be deallocated.
// Remove deallocated heap from active buffer chain.
if (OffsetOfPreviousNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapManager->FirstActiveBufferOffset = CurrentNode->OffsetOfNextNode;
} else {
PreviousNode = (BUFFER_NODE *) (BaseAddress + OffsetOfPreviousNode);
PreviousNode->OffsetOfNextNode = CurrentNode->OffsetOfNextNode;
}
// Now, CurrentNode become a free space node.
HeapManager->UsedSize -= CurrentNode->BufferSize + sizeof (BUFFER_NODE);
// Loop free space chain to see if any free space node is just before/after CurrentNode, then merge them.
OffsetOfFreeSpaceNode = HeapManager->FirstFreeSpaceOffset;
FreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfFreeSpaceNode);
while (OffsetOfFreeSpaceNode != AMD_HEAP_INVALID_HEAP_OFFSET) {
if ((OffsetOfFreeSpaceNode + sizeof (BUFFER_NODE) + FreeSpaceNode->BufferSize) == OffsetOfCurrentNode) {
DeleteFreeSpaceNode (StdHeader, OffsetOfFreeSpaceNode);
NodeSize = FreeSpaceNode->BufferSize + CurrentNode->BufferSize + sizeof (BUFFER_NODE);
OffsetOfCurrentNode = OffsetOfFreeSpaceNode;
CurrentNode = FreeSpaceNode;
CurrentNode->BufferSize = NodeSize;
} else if (OffsetOfFreeSpaceNode == (OffsetOfCurrentNode + sizeof (BUFFER_NODE) + CurrentNode->BufferSize)) {
DeleteFreeSpaceNode (StdHeader, OffsetOfFreeSpaceNode);
NodeSize = FreeSpaceNode->BufferSize + CurrentNode->BufferSize + sizeof (BUFFER_NODE);
CurrentNode->BufferSize = NodeSize;
}
OffsetOfFreeSpaceNode = FreeSpaceNode->OffsetOfNextNode;
FreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfFreeSpaceNode);
}
InsertFreeSpaceNode (StdHeader, OffsetOfCurrentNode);
return AGESA_SUCCESS;
} else {
// If HeapStatus == HEAP_SYSTEM_MEM, try callout function
if (StdHeader->HeapStatus == HEAP_SYSTEM_MEM) {
AgesaBuffer.StdHeader = *StdHeader;
AgesaBuffer.BufferHandle = BufferHandle;
AGESA_TESTPOINT (TpIfBeforeDeallocateHeapBuffer, StdHeader);
if (AgesaDeallocateBuffer (0, &AgesaBuffer) != AGESA_SUCCESS) {
return AGESA_ERROR;
}
AGESA_TESTPOINT (TpIfAfterDeallocateHeapBuffer, StdHeader);
return AGESA_SUCCESS;
}
// If we are still unable to locate the buffer handle, return AGESA_BOUNDS_CHK
if ((BaseAddress != NULL) && (HeapManager->Signature == HEAP_SIGNATURE_VALID)) {
PutEventLog (AGESA_BOUNDS_CHK,
CPU_ERROR_HEAP_BUFFER_HANDLE_IS_NOT_PRESENT,
BufferHandle, 0, 0, 0, StdHeader);
} else {
ASSERT (FALSE);
}
return AGESA_BOUNDS_CHK;
}
}
/*---------------------------------------------------------------------------------------*/
/**
* Locates a previously allocated buffer on the heap.
*
* This function searches the heap for a buffer with the desired handle, and
* returns a pointer to the buffer.
*
* @param[in,out] LocateHeap Structure containing the buffer's handle,
* and the return pointer.
* @param[in] StdHeader Config handle for library and services.
*
* @retval AGESA_SUCCESS No error
* @retval AGESA_BOUNDS_CHK Handle does not exist on the heap
*
*/
AGESA_STATUS
HeapLocateBuffer (
IN OUT LOCATE_HEAP_PTR *LocateHeap,
IN AMD_CONFIG_PARAMS *StdHeader
)
{
UINT8 *BaseAddress;
UINT8 AlignTo16Byte;
UINT32 OffsetOfCurrentNode;
BOOLEAN HeapLocateFlag;
HEAP_MANAGER *HeapManager;
BUFFER_NODE *CurrentNode;
AGESA_BUFFER_PARAMS AgesaBuffer;
ASSERT (StdHeader != NULL);
HeapLocateFlag = TRUE;
BaseAddress = (UINT8 *) (UINTN) StdHeader->HeapBasePtr;
HeapManager = (HEAP_MANAGER *) BaseAddress;
// Check Heap database is valid
if ((BaseAddress == NULL) || (HeapManager->Signature != HEAP_SIGNATURE_VALID)) {
// The base address in StdHeader is incorrect, get base address by itself
BaseAddress = (UINT8 *)(UINT32) HeapGetBaseAddress (StdHeader);
HeapManager = (HEAP_MANAGER *) BaseAddress;
if ((BaseAddress == NULL) || (HeapManager->Signature != HEAP_SIGNATURE_VALID)) {
// Heap is not available, ASSERT here
ASSERT (FALSE);
return AGESA_ERROR;
}
StdHeader->HeapBasePtr = (UINT64)(UINT32) BaseAddress;
}
OffsetOfCurrentNode = HeapManager->FirstActiveBufferOffset;
CurrentNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
// Find buffer using internal heap manager
// Locate the heap using handle = LocateHeap-> BufferHandle
// If HeapStatus != HEAP_SYSTEM_ MEM
if ((BaseAddress != NULL) && (HeapManager->Signature == HEAP_SIGNATURE_VALID)) {
if (OffsetOfCurrentNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapLocateFlag = FALSE;
} else {
while (CurrentNode->BufferHandle != LocateHeap->BufferHandle) {
if (CurrentNode->OffsetOfNextNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapLocateFlag = FALSE;
break;
} else {
OffsetOfCurrentNode = CurrentNode->OffsetOfNextNode;
CurrentNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
}
}
}
} else {
HeapLocateFlag = FALSE;
}
if (HeapLocateFlag) {
AlignTo16Byte = CurrentNode->PadSize;
LocateHeap->BufferPtr = (UINT8 *) ((UINT8 *) CurrentNode + sizeof (BUFFER_NODE) + SIZE_OF_SENTINEL + AlignTo16Byte);
LocateHeap->BufferSize = CurrentNode->BufferSize - NUM_OF_SENTINEL * SIZE_OF_SENTINEL - AlignTo16Byte;
return AGESA_SUCCESS;
} else {
// If HeapStatus == HEAP_SYSTEM_MEM, try callout function
if (StdHeader->HeapStatus == HEAP_SYSTEM_MEM) {
AgesaBuffer.StdHeader = *StdHeader;
AgesaBuffer.BufferHandle = LocateHeap->BufferHandle;
AGESA_TESTPOINT (TpIfBeforeLocateHeapBuffer, StdHeader);
if (AgesaLocateBuffer (0, &AgesaBuffer) != AGESA_SUCCESS) {
LocateHeap->BufferPtr = NULL;
return AGESA_ERROR;
}
LocateHeap->BufferSize = AgesaBuffer.BufferLength;
AGESA_TESTPOINT (TpIfAfterLocateHeapBuffer, StdHeader);
LocateHeap->BufferPtr = (UINT8 *) (AgesaBuffer.BufferPointer);
return AGESA_SUCCESS;
}
// If we are still unable to deallocate the buffer handle, return AGESA_BOUNDS_CHK
LocateHeap->BufferPtr = NULL;
LocateHeap->BufferSize = 0;
if ((BaseAddress != NULL) && (HeapManager->Signature == HEAP_SIGNATURE_VALID)) {
PutEventLog (AGESA_BOUNDS_CHK,
CPU_ERROR_HEAP_BUFFER_HANDLE_IS_NOT_PRESENT,
LocateHeap->BufferHandle, 0, 0, 0, StdHeader);
} else {
ASSERT (FALSE);
}
return AGESA_BOUNDS_CHK;
}
}
/*---------------------------------------------------------------------------------------*/
/**
* Get the heap base address
*
* This function will try to locate heap from cache, temp memory, main memory.
* The heap signature will be checked for validity on each possible location.
* Firstly, try if heap base is in cache by calling the function HeapGetCurrentBase.
* Secondly, try if heap base is temp memory by UserOptoions.CfgHeapDramAddress.
* Thirdly, try if heap base is in main memory by doing a buffer locate with buffer handle
* AMD_HEAP_IN_MAIN_MEMORY_HANDLE.
* If no valid heap signature is found in each possible location above, a NULL pointer is returned.
*
* @param[in] StdHeader Config handle for library and services.
*
* @return Heap base address of the executing core's heap.
*
*/
UINT64
HeapGetBaseAddress (
IN AMD_CONFIG_PARAMS *StdHeader
)
{
UINT64 BaseAddress;
HEAP_MANAGER *HeapManager;
AGESA_BUFFER_PARAMS AgesaBuffer;
// Firstly, we try to see if heap is in cache
BaseAddress = HeapGetCurrentBase (StdHeader);
HeapManager = (HEAP_MANAGER *) (UINTN) BaseAddress;
if ((HeapManager->Signature != HEAP_SIGNATURE_VALID) &&
(StdHeader->HeapStatus != HEAP_DO_NOT_EXIST_YET) &&
(StdHeader->HeapStatus != HEAP_LOCAL_CACHE)) {
// Secondly, we try to see if heap is in temp memory
BaseAddress = UserOptions.CfgHeapDramAddress;
HeapManager = (HEAP_MANAGER *) (UINTN) BaseAddress;
if (HeapManager->Signature != HEAP_SIGNATURE_VALID) {
// Thirdly, we try to see if heap in main memory
// by locating with external buffer manager (IBV)
AgesaBuffer.StdHeader = *StdHeader;
AgesaBuffer.BufferHandle = AMD_HEAP_IN_MAIN_MEMORY_HANDLE;
if (AgesaLocateBuffer (0, &AgesaBuffer) == AGESA_SUCCESS) {
BaseAddress = (UINT64) (UINTN) AgesaBuffer.BufferPointer;
HeapManager = (HEAP_MANAGER *) (UINTN) BaseAddress;
if (HeapManager->Signature != HEAP_SIGNATURE_VALID) {
// No valid heap signature ever found, return a NULL pointer
BaseAddress = (UINT64) (UINTN) NULL;
}
} else {
// No heap buffer is allocated by external manager (IBV), return a NULL pointer
BaseAddress = (UINT64) (UINTN) NULL;
}
}
}
return BaseAddress;
}
/*---------------------------------------------------------------------------------------
* L O C A L F U N C T I O N S
*---------------------------------------------------------------------------------------
*/
/* -----------------------------------------------------------------------------*/
/**
*
* DeleteFreeSpaceNode
*
* Description:
* Delete a free space node from free space chain
*
* Parameters:
* @param[in] StdHeader Config handle for library and services.
* @param[in] OffsetOfDeletedNode Offset of deleted node.
*
* Processing:
*
*/
VOID
STATIC
DeleteFreeSpaceNode (
IN AMD_CONFIG_PARAMS *StdHeader,
IN UINT32 OffsetOfDeletedNode
)
{
UINT8 *BaseAddress;
UINT32 OffsetOfPreviousNode;
UINT32 OffsetOfCurrentNode;
HEAP_MANAGER *HeapManager;
BUFFER_NODE *CurrentFreeSpaceNode;
BUFFER_NODE *PreviousFreeSpaceNode;
BaseAddress = (UINT8 *) (UINTN) StdHeader->HeapBasePtr;
HeapManager = (HEAP_MANAGER *) BaseAddress;
OffsetOfPreviousNode = AMD_HEAP_INVALID_HEAP_OFFSET;
OffsetOfCurrentNode = HeapManager->FirstFreeSpaceOffset;
//
// After AmdInitEnv, there is no free space provided for HeapAllocateBuffer.
// Hence if the FirstFreeSpaceOffset is AMD_HEAP_INVALID_HEAP_OFFSET, then
// no need to do more on delete node.
//
if (OffsetOfCurrentNode != AMD_HEAP_INVALID_HEAP_OFFSET) {
CurrentFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
while ((OffsetOfCurrentNode != AMD_HEAP_INVALID_HEAP_OFFSET) && (OffsetOfCurrentNode != OffsetOfDeletedNode)) {
OffsetOfPreviousNode = OffsetOfCurrentNode;
OffsetOfCurrentNode = CurrentFreeSpaceNode->OffsetOfNextNode;
CurrentFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
}
if (OffsetOfCurrentNode != AMD_HEAP_INVALID_HEAP_OFFSET) {
if (OffsetOfPreviousNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapManager->FirstFreeSpaceOffset = CurrentFreeSpaceNode->OffsetOfNextNode;
} else {
PreviousFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfPreviousNode);
PreviousFreeSpaceNode->OffsetOfNextNode = CurrentFreeSpaceNode->OffsetOfNextNode;
}
}
}
return;
}
/* -----------------------------------------------------------------------------*/
/**
*
* InsertFreeSpaceNode
*
* Description:
* Insert a free space node to free space chain, size order
*
* Parameters:
* @param[in] StdHeader Config handle for library and services.
* @param[in] OffsetOfInsertNode Offset of inserted node.
*
* Processing:
*
*/
VOID
STATIC
InsertFreeSpaceNode (
IN AMD_CONFIG_PARAMS *StdHeader,
IN UINT32 OffsetOfInsertNode
)
{
UINT8 *BaseAddress;
UINT32 OffsetOfPreviousNode;
UINT32 OffsetOfCurrentNode;
HEAP_MANAGER *HeapManager;
BUFFER_NODE *CurrentFreeSpaceNode;
BUFFER_NODE *PreviousFreeSpaceNode;
BUFFER_NODE *InsertedFreeSpaceNode;
BaseAddress = (UINT8 *) (UINTN) StdHeader->HeapBasePtr;
HeapManager = (HEAP_MANAGER *) BaseAddress;
OffsetOfPreviousNode = AMD_HEAP_INVALID_HEAP_OFFSET;
OffsetOfCurrentNode = HeapManager->FirstFreeSpaceOffset;
CurrentFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
InsertedFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfInsertNode);
while ((OffsetOfCurrentNode != AMD_HEAP_INVALID_HEAP_OFFSET) &&
(CurrentFreeSpaceNode->BufferSize < InsertedFreeSpaceNode->BufferSize)) {
OffsetOfPreviousNode = OffsetOfCurrentNode;
OffsetOfCurrentNode = CurrentFreeSpaceNode->OffsetOfNextNode;
CurrentFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfCurrentNode);
}
InsertedFreeSpaceNode->OffsetOfNextNode = OffsetOfCurrentNode;
if (OffsetOfPreviousNode == AMD_HEAP_INVALID_HEAP_OFFSET) {
HeapManager->FirstFreeSpaceOffset = OffsetOfInsertNode;
} else {
PreviousFreeSpaceNode = (BUFFER_NODE *) (BaseAddress + OffsetOfPreviousNode);
PreviousFreeSpaceNode->OffsetOfNextNode = OffsetOfInsertNode;
}
return;
}
/*---------------------------------------------------------------------------------------*/
/**
* Determines the base address of the executing core's heap.
*
* This function uses the executing core's socket/core numbers to determine
* where it's heap should be located.
*
* @param[in] StdHeader Config handle for library and services.
*
* @return A pointer to the executing core's heap.
*
*/
UINT64
STATIC
HeapGetCurrentBase (
IN AMD_CONFIG_PARAMS *StdHeader
)
{
UINT32 SystemCoreNumber;
UINT64 ReturnPtr;
AGESA_STATUS IgnoredStatus;
CPU_SPECIFIC_SERVICES *FamilyServices;
if (IsBsp (StdHeader, &IgnoredStatus)) {
ReturnPtr = AMD_HEAP_START_ADDRESS;
} else {
GetCpuServicesOfCurrentCore ((CONST CPU_SPECIFIC_SERVICES **)&FamilyServices, StdHeader);
ASSERT (FamilyServices != NULL);
SystemCoreNumber = FamilyServices->GetApCoreNumber (FamilyServices, StdHeader);
ASSERT (SystemCoreNumber != 0);
ASSERT (SystemCoreNumber < 64);
ReturnPtr = ((SystemCoreNumber * AMD_HEAP_SIZE_PER_CORE) + AMD_HEAP_START_ADDRESS);
}
ASSERT (ReturnPtr <= ((AMD_HEAP_REGION_END_ADDRESS + 1) - AMD_HEAP_SIZE_PER_CORE));
return ReturnPtr;
}
|