This repository has been archived by the owner on Oct 17, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathPeCoffRelocate.c
1634 lines (1492 loc) · 82.9 KB
/
PeCoffRelocate.c
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
/** @file
Implements APIs to relocate PE/COFF Images.
Portions copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
Portions Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>
Copyright (c) 2020, Marvin Häuser. All rights reserved.<BR>
Copyright (c) 2020, Vitaly Cheptsov. All rights reserved.<BR>
Copyright (c) 2020, ISP RAS. All rights reserved.<BR>
SPDX-License-Identifier: BSD-3-Clause
**/
#include "BasePeCoffLibInternals.h"
#include "PeCoffRelocate.h"
/**
Retrieve the immediate data encoded in an ARM MOVT or MOVW immediate
instruciton.
@param[in] Instruction Pointer to an ARM MOVT or MOVW immediate instruction.
@returns The Immediate address encoded in the instruction.
**/
/*@ requires \typeof(Instruction) <: \type(char *);
@ requires pointer_aligned (Instruction, OC_ALIGNOF (UINT16));
@ requires \valid((char *) Instruction + (0 .. 3));
@ assigns \nothing;
*/
STATIC
UINT16
ThumbMovtImmediateAddress (
IN CONST VOID *Instruction
)
{
UINT32 Movt;
UINT16 Movt1;
UINT16 Movt2;
UINT16 Address;
//
// Thumb2 is two separate 16-bit instructions working together, e.g.
// MOVT R0, #0 is 0x0000f2c0 or 0xf2c0 0x0000
//
Movt1 = READ_ALIGNED_16 (Instruction);
Movt2 = READ_ALIGNED_16 ((CONST CHAR8 *) Instruction + sizeof (UINT16));
Movt = COMPOSE_32 (Movt1, Movt2);
//
// imm16 = imm4:i:imm3:imm8
// imm4 -> Bit19:Bit16
// i -> Bit26
// imm3 -> Bit14:Bit12
// imm8 -> Bit7:Bit0
//
Address = (UINT16) (Movt & 0x000000FFU); // imm8
Address |= (UINT16) ((Movt >> 4U) & 0x0000F700U); // imm4 imm3
Address |= (UINT16) ((Movt & BIT26) >> 15U); // i, Bit26->11
return Address;
}
/**
Update an ARM MOVT or MOVW immediate instruction immediate data.
@param[in,out] Instruction Pointer to an ARM MOVT or MOVW immediate
instruction.
@param[in] Address New address to patch into the instruction.
**/
/*@ requires \typeof(Instruction) <: \type(char *);
@ requires pointer_aligned (Instruction, OC_ALIGNOF (UINT16));
@ requires \valid(((char *) Instruction) + (0 .. 3));
@ assigns ((char *) Instruction)[0 .. 3];
*/
STATIC
VOID
ThumbMovtImmediatePatch (
IN OUT VOID *Instruction,
IN UINT16 Address
)
{
UINT16 Patch;
UINT16 PatchedInstruction;
//
// First 16-bit chunk of instruction.
//
Patch = (Address & 0xF000U) >> 12U; // imm4
Patch |= (Address & BIT11) >> 1U; // i, Bit11->10
//
// Mask out instruction bits and or in address.
//
PatchedInstruction = READ_ALIGNED_16 (Instruction);
WRITE_ALIGNED_16 (Instruction, (PatchedInstruction & ~(UINT16) 0x040FU) | Patch);
//
// Second 16-bit chunk of instruction.
//
Patch = Address & 0x000000FFU; // imm8
Patch |= ((UINT32) Address << 4U) & 0x00007000U; // imm3
//
// Mask out instruction bits and or in address.
//
PatchedInstruction = READ_ALIGNED_16 ((CHAR8 *) Instruction + sizeof (UINT16));
WRITE_ALIGNED_16 (
(CHAR8 *) Instruction + sizeof (UINT16),
(PatchedInstruction & ~(UINT16) 0x70FFU) | Patch
);
}
/**
Retrieve the immediate data encoded in an ARM MOVW/MOVT instruciton pair.
@param[in] Instructions Pointer to an ARM MOVW/MOVT insturction pair.
@returns The Immediate address encoded in the instructions.
**/
/*@ requires \typeof(Instructions) <: \type(char *);
@ requires pointer_aligned (Instructions, OC_ALIGNOF (UINT16));
@ requires \valid((char *) Instructions + (0 .. 7));
@ assigns \nothing;
*/
STATIC
UINT32
ThumbMovwMovtImmediateAddress (
IN CONST VOID *Instructions
)
{
CONST CHAR8 *Word;
CONST CHAR8 *Top;
/*@ assigns Word;
@ ensures pointer_aligned (Word, OC_ALIGNOF (UINT16));
*/
Word = Instructions; // MOVW
//@ assert is_aligned_N ((UINT32) (2 * sizeof (UINT16)), OC_ALIGNOF (UINT16));
/*@ assigns Top;
@ ensures pointer_aligned (Top, OC_ALIGNOF (UINT16));
*/
Top = (CONST CHAR8 *) Instructions + 2 * sizeof (UINT16); // MOVT
return (UINT32) (((UINT32) ThumbMovtImmediateAddress (Top) << 16U) | ThumbMovtImmediateAddress (Word));
}
/**
Update an ARM MOVW/MOVT immediate instruction instruction pair.
@param[in,out] Instructions Pointer to ARM MOVW/MOVT instruction pair.
@param[in] Address New address to patch into the instructions.
**/
/*@ requires \typeof(Instructions) <: \type(char *);
@ requires pointer_aligned (Instructions, OC_ALIGNOF (UINT16));
@ requires \valid((char *) Instructions + (0 .. 7));
@ assigns ((char *) Instructions)[0 .. 7];
*/
STATIC
VOID
ThumbMovwMovtImmediatePatch (
IN OUT VOID *Instructions,
IN UINT32 Address
)
{
CHAR8 *Word;
CHAR8 *Top;
/*@ assigns Word;
@ ensures Word == (char *) Instructions;
@ ensures pointer_aligned (Word, OC_ALIGNOF (UINT16));
*/
Word = Instructions; // MOVW
//@ assert is_aligned_N ((UINT32) (2 * sizeof (UINT16)), OC_ALIGNOF (UINT16));
/*@ assigns Top;
@ ensures Top == (char *) Instructions + 2 * sizeof (UINT16);
@ ensures pointer_aligned (Top, OC_ALIGNOF (UINT16));
*/
Top = (CHAR8 *) Instructions + 2 * sizeof (UINT16); // MOVT
//@ assigns ((char *) Instructions)[0 .. 3];
ThumbMovtImmediatePatch (Word, (UINT16) (Address & 0x0000FFFFU));
//@ assigns ((char *) Instructions)[4 .. 7];
ThumbMovtImmediatePatch (Top, (UINT16) ((Address & 0xFFFF0000U) >> 16U));
}
/**
Relocate an ARM MOVW/MOVT immediate instruction instruction pair.
@param[in,out] Instructions Pointer to ARM MOVW/MOVT instruction pair.
@param[in] Adjust The delta to add to the addresses.
**/
/*@ requires \typeof(Fixup) <: \type(char *);
@ requires pointer_aligned (Fixup, OC_ALIGNOF (UINT16));
@ requires \valid((char *) Fixup + (0 .. 7));
@ assigns ((char *) Fixup)[0 .. 7];
*/
STATIC
VOID
ThumbMovwMovtImmediateFixup (
IN OUT VOID *Fixup,
IN UINT64 Adjust
)
{
UINT32 Fixup32;
//@ assigns Fixup32;
Fixup32 = ThumbMovwMovtImmediateAddress (Fixup) +/*@%*/ (UINT32)/*@%*/ Adjust;
//@ assigns ((char *) Fixup)[0 .. 7];
ThumbMovwMovtImmediatePatch (Fixup, Fixup32);
}
//
// TODO: Prove Relocation Directory memory is not assigned.
//
/**
Apply an Image Base Relocation.
Only a subset of the PE/COFF Base Relocation types are permited.
The Base Relocation target must be in bounds, aligned, and must not overlap
with the Relocation Directory.
@param[in] Context The context describing the Image. Must have been
loaded by PeCoffLoadImage().
@param[in] RelocBlock The Base Relocation Block to apply from.
@param[in] RelocIndex The index of the Base Relocation to apply.
@param[in] Adjust The delta to add to the addresses.
@param[out] FixupData On input, a pointer to a bookkeeping value or NULL.
On output, a value to preserve for Runtime Relocation.
@retval RETURN_SUCCESS The Base Relocation has been applied successfully.
@retval other The Base Relocation could not be applied successfully.
**/
/*@ requires FixupData != \null ==> \valid(FixupData + RelocIndex);
@ requires \valid(Context);
@ requires \typeof(Context->ImageBuffer) <: \type(char *);
@ requires pointer_max_aligned(Context->ImageBuffer);
@ requires \valid(RelocBlock);
@ requires RelocIndex < (RelocBlock->SizeOfBlock - sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK)) / sizeof (UINT16);
@ requires Context->RelocDirRva < Context->RelocDirRva + Context->RelocDirSize <= Context->SizeOfImage;
@ requires image_base_reloc_mem_valid ((char *) Context->ImageBuffer, RelocBlock, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
@
@ assigns ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ assigns FixupData[RelocIndex];
@
@ behavior valid_abs_valid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_ABSOLUTE;
@ assumes FixupData != \null;
@ ensures FixupData[RelocIndex] == 0;
@ ensures \result == RETURN_SUCCESS;
@
@ behavior valid_abs_nvalid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_ABSOLUTE;
@ assumes FixupData == \null;
@ assigns ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ ensures \result == RETURN_SUCCESS;
@
@ behavior valid_highlow_valid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_HIGHLOW &&
@ (RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) < RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) && RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
@ assumes FixupData != \null;
@ ensures image_reloc_applied_highlow{Pre,Post} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex, Adjust) &&
@ FixupData[RelocIndex] == image_reloc_value{Post} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ ensures \result == RETURN_SUCCESS;
@
@ behavior valid_highlow_nvalid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_HIGHLOW &&
@ (RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) < RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) && RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
@ assumes FixupData == \null;
@ assigns ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ ensures image_reloc_applied_highlow{Pre,Post} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex, Adjust);
@ ensures \result == RETURN_SUCCESS;
@
@ behavior valid_dir64_valid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_DIR64 &&
@ (RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) < RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) && RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
@ assumes FixupData != \null;
@ ensures image_reloc_applied_dir64{Pre,Post} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex, Adjust) &&
@ FixupData[RelocIndex] == image_reloc_value{Post} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ ensures \result == RETURN_SUCCESS;
@
@ behavior valid_dir64_nvalid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_DIR64 &&
@ (RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) < RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) && RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
@ assumes FixupData == \null;
@ assigns ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ ensures image_reloc_applied_dir64{Pre,Post} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex, Adjust);
@ ensures \result == RETURN_SUCCESS;
@
@ behavior valid_mov32t_valid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_ARM_MOV32T && PcdGetBool (PcdImageLoaderSupportArmThumb) &&
@ (RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) < RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) && RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
@ assumes is_aligned_32 (RelocBlock->VirtualAddress +% (UINT32) image_reloc_offset (RelocBlock->Relocations[RelocIndex]), AV_ALIGNOF (UINT16));
@ assumes FixupData != \null;
@ ensures FixupData[RelocIndex] == image_reloc_value{Post} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ ensures \result == RETURN_SUCCESS;
@
@ behavior valid_mov32t_nvalid_fixup_data:
@ assumes image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_ARM_MOV32T && PcdGetBool (PcdImageLoaderSupportArmThumb) &&
@ (RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) < RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) && RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
@ assumes is_aligned_32 (RelocBlock->VirtualAddress +% (UINT32) image_reloc_offset (RelocBlock->Relocations[RelocIndex]), AV_ALIGNOF (UINT16));
@ assumes FixupData == \null;
@ assigns ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ ensures \result == RETURN_SUCCESS;
@
@ behavior invalid:
@ assumes !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
@ assigns \nothing;
@ ensures \result != RETURN_SUCCESS;
@
@ complete behaviors;
@ disjoint behaviors;
*/
STATIC
RETURN_STATUS
InternalApplyRelocation (
IN CONST PE_COFF_IMAGE_CONTEXT *Context,
IN CONST EFI_IMAGE_BASE_RELOCATION_BLOCK *RelocBlock,
IN UINT32 RelocIndex,
IN UINT64 Adjust,
OUT UINT64 *FixupData OPTIONAL
)
{
UINT16 RelocType;
UINT16 RelocOff;
BOOLEAN Result;
UINT32 RelocTarget;
UINT32 RemRelocTargetSize;
UINT32 Fixup32;
UINT64 Fixup64;
CHAR8 *Fixup;
/*@ assigns RelocType;
@ ensures RelocType == image_reloc_type (RelocBlock->Relocations[RelocIndex]);
*/
RelocType = IMAGE_RELOC_TYPE (RelocBlock->Relocations[RelocIndex]);
/*@ assigns RelocOff;
@ ensures RelocOff == image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
*/
RelocOff = IMAGE_RELOC_OFFSET (RelocBlock->Relocations[RelocIndex]);
//
// Absolute Base Relocations are used for padding any must be skipped.
//
/*@ assigns FixupData[RelocIndex];
@ ensures image_reloc_type (RelocBlock->Relocations[RelocIndex]) != EFI_IMAGE_REL_BASED_ABSOLUTE;
*/
if (RelocType == EFI_IMAGE_REL_BASED_ABSOLUTE) {
/*@ assigns FixupData[RelocIndex];
@ ensures FixupData != \null ==>
@ FixupData[RelocIndex] == 0;
*/
if (FixupData != NULL) {
/*@ assigns FixupData[RelocIndex];
@ ensures FixupData[RelocIndex] == 0;
*/
FixupData[RelocIndex] = 0;
}
//@ assert image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_SUCCESS;
}
//
// Determine the Base Relocation target address.
//
/*@ assigns Result, RelocTarget;
@ ensures !Result <==> RelocTarget == RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
@ ensures Result <==> RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) > MAX_UINT32;
*/
Result = BaseOverflowAddU32 (
RelocBlock->VirtualAddress,
RelocOff,
&RelocTarget
);
/*@ assigns \nothing;
@ ensures RelocTarget == RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
*/
if (Result) {
//@ assert RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) > MAX_UINT32;
//@ assert !(RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
/*@ assigns Result, RemRelocTargetSize;
@ ensures !Result <==> RemRelocTargetSize == Context->SizeOfImage - RelocTarget;
@ ensures Result <==> Context->SizeOfImage < RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
*/
Result = BaseOverflowSubU32 (
Context->SizeOfImage,
RelocTarget,
&RemRelocTargetSize
);
/*@ assigns \nothing;
@ ensures RemRelocTargetSize == Context->SizeOfImage - RelocTarget;
@ ensures RelocTarget + RemRelocTargetSize <= Context->SizeOfImage;
*/
if (Result) {
//@ assert !(RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]) + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->SizeOfImage);
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
/*@ assert image_reloc_supported (RelocBlock->Relocations[RelocIndex]) && (image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_ARM_MOV32T ==> is_aligned_32 (RelocTarget, AV_ALIGNOF (UINT16))) ==>
@ \let s = image_reloc_size (RelocBlock->Relocations[RelocIndex]);
@ s <= RemRelocTargetSize ==>
@ ((RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget) ==>
@ \valid((char *) Context->ImageBuffer + (RelocTarget .. RelocTarget + s - 1)));
*/
/*@ assigns Fixup;
@ ensures Fixup == (char *) Context->ImageBuffer + RelocTarget;
@ ensures image_reloc_supported (RelocBlock->Relocations[RelocIndex]) && (image_reloc_type (RelocBlock->Relocations[RelocIndex]) == EFI_IMAGE_REL_BASED_ARM_MOV32T ==> is_aligned_32 (RelocTarget, AV_ALIGNOF (UINT16))) ==>
@ \let s = image_reloc_size (RelocBlock->Relocations[RelocIndex]);
@ s <= RemRelocTargetSize ==>
@ ((RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget) ==>
@ \valid(Fixup + (0 .. s - 1)));
*/
Fixup = (CHAR8 *) Context->ImageBuffer + RelocTarget;
//
// Apply the Base Relocation fixup per type.
// If RelocationData is not NULL, store the current value of the fixup
// target to determine whether it has been changed during runtime
// execution.
//
// It is not clear how EFI_IMAGE_REL_BASED_HIGH and
// EFI_IMAGE_REL_BASED_LOW are supposed to be handled. While the PE
// specification suggests to just add the high or low part of the
// displacement, there are concerns about how it's supposed to deal with
// wraparounds. As they are virtually non-existent, they are unsupported for
// the time being.
//
/*@ assigns Fixup32, Fixup64, FixupData[RelocIndex], ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ ensures image_reloc_supported (RelocBlock->Relocations[RelocIndex]);
@ ensures image_context_reloc_sane (Context, RelocBlock, RelocIndex);
*/
switch (RelocType) {
case EFI_IMAGE_REL_BASED_HIGHLOW:
/*@ assigns \nothing;
@ ensures image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= RemRelocTargetSize;
*/
if (sizeof (UINT32) > RemRelocTargetSize) {
//@ assert !(image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= RemRelocTargetSize);
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
//
// Ensure the Base Relocation does not target the Relocation Directory.
//
/*@ assigns \nothing;
@ ensures RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget;
@ ensures \valid(Fixup + (0 .. 3));
*/
if (RelocTarget + sizeof (UINT32) > Context->RelocDirRva
&& Context->RelocDirRva + Context->RelocDirSize > RelocTarget) {
/*@ assert !(RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget);
*/
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
/*@ requires Fixup == (char *) Context->ImageBuffer + RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
@ assigns Fixup32;
@ ensures Fixup32 == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
Fixup32 = ReadUnaligned32 (Fixup);
/*@ requires Fixup32 == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ assigns Fixup32;
@ ensures Fixup32 == (UINT32) image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex) +% (UINT32 %) Adjust;
*/
Fixup32 +=/*@%*/ (UINT32)/*@%*/ Adjust;
/*@ requires Fixup == (char *) Context->ImageBuffer + RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
@ requires Fixup32 == (UINT32) image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex) +% (UINT32 %) Adjust;
@ assigns Fixup[0 .. 3];
@ ensures image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex) == Fixup32;
@ ensures image_reloc_applied_highlow{Old,Here} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex, Adjust);
*/
WriteUnaligned32 (Fixup, Fixup32);
/*@ requires Fixup32 == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ assigns FixupData[RelocIndex];
@ ensures FixupData != \null ==> FixupData[RelocIndex] == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
if (FixupData != NULL) {
/*@ requires Fixup32 == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ assigns FixupData[RelocIndex];
@ ensures FixupData[RelocIndex] == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
FixupData[RelocIndex] = Fixup32;
}
//@ assert image_context_reloc_sane (Context, RelocBlock, RelocIndex);
break;
case EFI_IMAGE_REL_BASED_DIR64:
/*@ assigns \nothing;
@ ensures image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= RemRelocTargetSize;
*/
if (sizeof (UINT64) > RemRelocTargetSize) {
//@ assert !(image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= RemRelocTargetSize);
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
//
// Ensure the Base Relocation does not target the Relocation Directory.
//
/*@ assigns \nothing;
@ ensures RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget;
@ ensures \valid(Fixup + (0 .. 7));
*/
if (RelocTarget + sizeof (UINT64) > Context->RelocDirRva
&& Context->RelocDirRva + Context->RelocDirSize > RelocTarget) {
/*@ assert !(RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget);
*/
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
/*@ requires Fixup == (char *) Context->ImageBuffer + RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
@ assigns Fixup64;
@ ensures Fixup64 == uint64_from_char ((char *) Context->ImageBuffer + RelocTarget);
@ ensures Fixup64 == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
Fixup64 = ReadUnaligned64 (Fixup);
/*@ requires Fixup64 == (UINT64) image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ assigns Fixup64;
@ ensures Fixup64 == (UINT64) image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex) +% Adjust;
*/
Fixup64 +=/*@%*/ Adjust;
/*@ requires Fixup == (char *) Context->ImageBuffer + RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
@ requires Fixup64 == (UINT64) image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex) +% Adjust;
@ assigns Fixup[0 .. 7];
@ ensures image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex) == Fixup64;
@ ensures image_reloc_applied_dir64{Old,Here} ((char *) Context->ImageBuffer, RelocBlock, RelocIndex, Adjust);
*/
WriteUnaligned64 (Fixup, Fixup64);
/*@ requires Fixup64 == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ assigns FixupData[RelocIndex];
@ ensures FixupData != \null ==> FixupData[RelocIndex] == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
if (FixupData != NULL) {
/*@ requires Fixup64 == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
@ assigns FixupData[RelocIndex];
@ ensures FixupData[RelocIndex] == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
FixupData[RelocIndex] = Fixup64;
}
//@ assert image_context_reloc_sane (Context, RelocBlock, RelocIndex);
break;
case EFI_IMAGE_REL_BASED_ARM_MOV32T:
/*@ ensures PcdGetBool (PcdImageLoaderSupportArmThumb);
@ assigns \nothing;
*/
if (!PcdGetBool (PcdImageLoaderSupportArmThumb)) {
//@ assert !PcdGetBool (PcdImageLoaderSupportArmThumb);
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
/*@ assigns \nothing;
@ ensures image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= RemRelocTargetSize;
*/
if (sizeof (UINT64) > RemRelocTargetSize) {
//@ assert !(image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= RemRelocTargetSize);
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
// FIXME: 32-bit
/*@ assigns \nothing;
@ ensures is_aligned_32 (RelocTarget, AV_ALIGNOF (UINT16));
*/
if (!IS_ALIGNED (RelocTarget, OC_ALIGNOF (UINT16))) {
//@ assert !is_aligned_32 (RelocTarget, AV_ALIGNOF (UINT16));
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
//
// Ensure the Base Relocation does not target the Relocation Directory.
//
//@ assert is_aligned_N (RelocTarget, AV_ALIGNOF (UINT16));
//@ assert pointer_max_aligned (Context->ImageBuffer);
/*@ assert is_aligned_N (RelocTarget, AV_ALIGNOF (UINT16)) && pointer_max_aligned (Context->ImageBuffer) ==>
@ pointer_aligned ((char *) Context->ImageBuffer + RelocTarget, AV_ALIGNOF (UINT16));
*/
//@ assert pointer_aligned (Fixup, OC_ALIGNOF (UINT16));
/*@ assigns \nothing;
@ ensures RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget;
@ ensures \valid(Fixup + (0 .. 7));
*/
if (RelocTarget + sizeof (UINT64) > Context->RelocDirRva
&& Context->RelocDirRva + Context->RelocDirSize > RelocTarget) {
/*@ assert !(RelocTarget + image_reloc_size (RelocBlock->Relocations[RelocIndex]) <= Context->RelocDirRva ||
@ Context->RelocDirRva + Context->RelocDirSize <= RelocTarget);
*/
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
//@ assigns Fixup[0 .. 7];
ThumbMovwMovtImmediateFixup (Fixup, Adjust);
/*@ requires Fixup == (char *) Context->ImageBuffer + RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
@ assigns FixupData[RelocIndex];
@ ensures FixupData != \null ==> FixupData[RelocIndex] == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
if (FixupData != NULL) {
/*@ requires Fixup == (char *) Context->ImageBuffer + RelocBlock->VirtualAddress + image_reloc_offset (RelocBlock->Relocations[RelocIndex]);
@ assigns FixupData[RelocIndex];
@ ensures FixupData[RelocIndex] == image_reloc_value ((char *) Context->ImageBuffer, RelocBlock, RelocIndex);
*/
FixupData[RelocIndex] = ReadUnaligned64 (Fixup);
}
//@ assert is_aligned_32 (RelocTarget, AV_ALIGNOF (UINT16));
//@ assert image_context_reloc_sane (Context, RelocBlock, RelocIndex);
break;
default:
//@ assert !image_context_reloc_sane (Context, RelocBlock, RelocIndex);
return RETURN_UNSUPPORTED;
}
return RETURN_SUCCESS;
}
RETURN_STATUS
PeCoffRelocateImage (
IN CONST PE_COFF_IMAGE_CONTEXT *Context,
IN UINT64 BaseAddress,
OUT PE_COFF_RUNTIME_CONTEXT *RelocationData OPTIONAL,
IN UINT32 RelocationDataSize
)
{
BOOLEAN Result;
RETURN_STATUS Status;
UINT64 Adjust;
CONST EFI_IMAGE_BASE_RELOCATION_BLOCK *RelocWalker;
UINT32 SizeOfRelocs;
UINT32 NumRelocs;
UINT32 RelocDataIndex;
UINT32 RelocOffset;
UINT32 RelocMax;
UINT32 RelocIndex;
UINT64 *WalkerFixupData;
ASSERT (Context != NULL);
ASSERT (!Context->RelocsStripped);
ASSERT (RelocationData != NULL || RelocationDataSize == 0);
ASSERT (RelocationData == NULL || RelocationDataSize >= sizeof (PE_COFF_RUNTIME_CONTEXT) + Context->RelocDirSize * (sizeof (UINT64) / sizeof (UINT16)));
//
// Calculate the Image displacement from its prefered load address.
//
/*@ assigns Adjust;
@ ensures Adjust == BaseAddress -% Context->ImageBase;
*/
Adjust = BaseAddress -/*@%*/ Context->ImageBase;
//
// Runtime drivers should unconditionally go through the full Relocation
// procedure early to eliminate the possibility of errors later at runtime.
// Runtime drivers don't have their Base Relocations stripped, this is
// verified during context creation.
// Skip explicit Relocation when the Image is already loaded at its
// prefered location.
//
/*@ assigns \nothing;
@ ensures RelocationData != \null || BaseAddress != Context->ImageBase;
*/
if (RelocationData == NULL && Adjust == 0) {
return RETURN_SUCCESS;
}
/*@ assigns RelocationData->RelocDirRva, RelocationData->RelocDirSize;
@ ensures RelocationData != \null ==>
@ RelocationData->RelocDirRva == Context->RelocDirRva &&
@ RelocationData->RelocDirSize == Context->RelocDirSize;
*/
if (RelocationData != NULL) {
/*@ assigns RelocationData->RelocDirRva;
@ ensures RelocationData->RelocDirRva == Context->RelocDirRva;
*/
RelocationData->RelocDirRva = Context->RelocDirRva;
/*@ assigns RelocationData->RelocDirSize;
@ ensures RelocationData->RelocDirSize == Context->RelocDirSize;
*/
RelocationData->RelocDirSize = Context->RelocDirSize;
}
//
// Apply Base Relocation fixups to the image.
//
/*@ assigns RelocOffset;
@ ensures RelocOffset == Context->RelocDirRva;
@ ensures is_aligned_32 (RelocOffset, AV_ALIGNOF (EFI_IMAGE_BASE_RELOCATION_BLOCK));
*/
RelocOffset = Context->RelocDirRva;
/*@ assigns RelocMax;
@ ensures RelocMax == Context->RelocDirRva + Context->RelocDirSize - sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK);
@ ensures RelocOffset <= RelocMax;
*/
RelocMax = Context->RelocDirRva + Context->RelocDirSize - sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK);
/*@ assigns RelocDataIndex;
@ ensures RelocDataIndex == 0;
*/
RelocDataIndex = 0;
//@ ghost UINT32 BaseRelocIndex = 0;
//
// Process all Base Relocation Blocks.
//
/*@ loop assigns ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ loop assigns RelocationData->FixupData[0 .. (RelocationDataSize - sizeof (PE_COFF_RUNTIME_CONTEXT)) / sizeof (UINT64) - 1];
@ loop assigns RelocOffset, RelocWalker, SizeOfRelocs, NumRelocs, Result, Status, RelocDataIndex;
@
@ loop invariant Context->RelocDirRva <= RelocOffset <= Context->RelocDirRva + Context->RelocDirSize;
@ loop invariant is_aligned_32 (RelocOffset, AV_ALIGNOF (EFI_IMAGE_BASE_RELOCATION_BLOCK));
@
@ loop invariant RelocDataIndex <= (RelocOffset - Context->RelocDirRva) / sizeof (UINT16) <= Context->RelocDirSize / sizeof (UINT16);
@
@ loop invariant RelocMax == Context->RelocDirRva + Context->RelocDirSize - sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK);
@
@ loop invariant RelocOffset <= RelocMax <==> image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
@ loop invariant RelocOffset <= RelocMax ==>
@ (\forall UINT32 i; 0 <= i <= BaseRelocIndex ==>
@ !image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, i));
@
@ loop invariant image_base_reloc_validity ((char *) Context->ImageBuffer, RelocOffset, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
@
@ loop invariant BaseRelocIndex <= RelocOffset - Context->RelocDirRva;
@ loop invariant RelocOffset == image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, BaseRelocIndex);
@
@ loop invariant Context->RelocDirRva < RelocOffset ==>
@ \let PreviousOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, BaseRelocIndex - 1);
@ image_base_reloc_exists (PreviousOffset, Context->RelocDirRva, Context->RelocDirSize) && image_base_reloc_sane ((char *) Context->ImageBuffer, PreviousOffset, Context->RelocDirRva, Context->RelocDirSize);
@
@ loop invariant \forall integer i; 0 <= i < BaseRelocIndex ==>
@ \let CurRelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, i);
@ image_reloc_correct ((char *) Context->ImageBuffer, CurRelocOffset, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
@
@ loop invariant \forall integer i; 0 <= i < BaseRelocIndex ==>
@ \let BaseRelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, i);
@ \let BaseReloc = (EFI_IMAGE_BASE_RELOCATION_BLOCK *) ((char *) Context->ImageBuffer + BaseRelocOffset);
@ \let NumRelocs = image_base_reloc_num_relocs (BaseReloc);
@ \valid (BaseReloc) &&
@ \valid (BaseReloc->Relocations + (0 .. NumRelocs - 1)) &&
@ (\forall integer i; 0 <= i < NumRelocs ==>
@ \let RelocTarget = BaseReloc->VirtualAddress + image_reloc_offset (BaseReloc->Relocations[i]);
@ \valid ((char *) Context->ImageBuffer + (RelocTarget .. RelocTarget + image_reloc_size (BaseReloc->Relocations[i]) - 1)));
@
@ loop variant RelocMax - RelocOffset;
*/
while (RelocOffset <= RelocMax) {
/*@ requires image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
@ requires pointer_aligned ((char *) Context->ImageBuffer + RelocOffset, AV_ALIGNOF (EFI_IMAGE_BASE_RELOCATION_BLOCK));
@ assigns RelocWalker;
@ ensures RelocWalker == (EFI_IMAGE_BASE_RELOCATION_BLOCK *) ((char *) Context->ImageBuffer + RelocOffset);
@ ensures \valid(RelocWalker);
*/
RelocWalker = (CONST EFI_IMAGE_BASE_RELOCATION_BLOCK *) (CONST VOID *) (
(CONST CHAR8 *) Context->ImageBuffer + RelocOffset
);
/*@ assigns Result, SizeOfRelocs;
@ ensures !Result <==> SizeOfRelocs == RelocWalker->SizeOfBlock - sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK);
@ ensures Result <==> 0 > RelocWalker->SizeOfBlock - sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK);
*/
Result = BaseOverflowSubU32 (
RelocWalker->SizeOfBlock,
sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK),
&SizeOfRelocs
);
//
// Ensure there is at least one entry.
// Ensure the block's size is padded to ensure proper alignment.
//
/*@ assigns \nothing;
@ ensures SizeOfRelocs == RelocWalker->SizeOfBlock - sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK);
@ ensures sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK) <= RelocWalker->SizeOfBlock;
*/
if (Result) {
//@ assert sizeof (EFI_IMAGE_BASE_RELOCATION_BLOCK) > RelocWalker->SizeOfBlock;
/*@ assert \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, BaseRelocIndex);
@ !image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ \exists UINT32 j; 0 <= j < i &&
@ \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, j);
@ !image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize) ||
@ !image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ !(\forall UINT32 j; 0 <= j < i ==>
@ \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, j);
@ image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize) &&
@ image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize));
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ !image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, i);
*/
//@ assert !\exists UINT32 NumRelocs; image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs);
/*@ assert \forall UINT32 NumRelocs;
@ image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert (\forall UINT32 NumRelocs;
@ image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize)) ==>
@ ((\exists UINT32 NumRelocs; image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ \exists UINT32 NumRelocs; NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize)));
*/
//@ assert !\exists UINT32 NumRelocs; NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize);
//@ assert !image_reloc_dir_correct ((char *) Context->ImageBuffer, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
return RETURN_UNSUPPORTED;
}
/*@ assigns \nothing;
@ ensures RelocOffset + RelocWalker->SizeOfBlock <= Context->RelocDirRva + Context->RelocDirSize;
*/
if (SizeOfRelocs > RelocMax - RelocOffset) {
//@ assert RelocOffset + RelocWalker->SizeOfBlock > Context->RelocDirRva + Context->RelocDirSize;
/*@ assert \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, BaseRelocIndex);
@ !image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ \exists UINT32 j; 0 <= j < i &&
@ \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, j);
@ !image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize) ||
@ !image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ !(\forall UINT32 j; 0 <= j < i ==>
@ \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, j);
@ image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize) &&
@ image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize));
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ !image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, i);
*/
//@ assert !\exists UINT32 NumRelocs; image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs);
/*@ assert \forall UINT32 NumRelocs;
@ image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert (\forall UINT32 NumRelocs;
@ image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize)) ==>
@ ((\exists UINT32 NumRelocs; image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ \exists UINT32 NumRelocs; NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize)));
*/
//@ assert !\exists UINT32 NumRelocs; NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize);
//@ assert !image_reloc_dir_correct ((char *) Context->ImageBuffer, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
return RETURN_UNSUPPORTED;
}
/*@ assigns \nothing;
@ ensures is_aligned_32 (RelocWalker->SizeOfBlock, AV_ALIGNOF (EFI_IMAGE_BASE_RELOCATION_BLOCK));
*/
if (!IS_ALIGNED (RelocWalker->SizeOfBlock, OC_ALIGNOF (EFI_IMAGE_BASE_RELOCATION_BLOCK))) {
//@ assert !is_aligned_32 (RelocWalker->SizeOfBlock, AV_ALIGNOF (EFI_IMAGE_BASE_RELOCATION_BLOCK));
/*@ assert \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, BaseRelocIndex);
@ !image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ \exists UINT32 j; 0 <= j < i &&
@ \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, j);
@ !image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize) ||
@ !image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ !(\forall UINT32 j; 0 <= j < i ==>
@ \let RelocOffset = image_base_reloc_offset_index ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, j);
@ image_base_reloc_exists (RelocOffset, Context->RelocDirRva, Context->RelocDirSize) &&
@ image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize));
*/
/*@ assert \forall UINT32 i; BaseRelocIndex < i ==>
@ !image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, i);
*/
//@ assert !\exists UINT32 NumRelocs; image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs);
/*@ assert \forall UINT32 NumRelocs;
@ image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize);
*/
/*@ assert (\forall UINT32 NumRelocs;
@ image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize)) ==>
@ ((\exists UINT32 NumRelocs; image_is_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize, NumRelocs) <==>
@ \exists UINT32 NumRelocs; NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize)));
*/
//@ assert !\exists UINT32 NumRelocs; NumRelocs == image_base_reloc_num ((char *) Context->ImageBuffer, Context->RelocDirRva, Context->RelocDirSize);
//@ assert !image_reloc_dir_correct ((char *) Context->ImageBuffer, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
return RETURN_UNSUPPORTED;
}
/*@ assert image_base_reloc_sane ((char *) Context->ImageBuffer, RelocOffset, Context->RelocDirRva, Context->RelocDirSize) &&
@ image_base_reloc_mem_valid ((char *) Context->ImageBuffer, RelocWalker, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize) &&
@ image_base_reloc_validity ((char *) Context->ImageBuffer, RelocOffset + RelocWalker->SizeOfBlock, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
*/
//
// This division is safe due to the guarantee made above.
//
/*@ assigns NumRelocs;
@ ensures NumRelocs == image_base_reloc_num_relocs (RelocWalker);
*/
NumRelocs = SizeOfRelocs / sizeof (*RelocWalker->Relocations);
//
// Apply all Base Relocation fixups of the current block.
//
/*@ assigns WalkerFixupData;
@ ensures RelocationData != \null ==>
@ WalkerFixupData == &RelocationData->FixupData[RelocDataIndex];
@ ensures RelocationData == \null ==>
@ WalkerFixupData == \null;
@ ensures WalkerFixupData == &RelocationData->FixupData[RelocDataIndex] || WalkerFixupData == \null;
*/
if (RelocationData != NULL) {
/*@ assigns WalkerFixupData;
@ ensures WalkerFixupData == &RelocationData->FixupData[RelocDataIndex];
@ ensures WalkerFixupData != \null;
*/
WalkerFixupData = &RelocationData->FixupData[RelocDataIndex];
} else {
/*@ assigns WalkerFixupData;
@ ensures WalkerFixupData == \null;
*/
WalkerFixupData = NULL;
}
//
// Process all Base Relocations of the current Block.
//
/*@ loop assigns RelocIndex, Result, RelocationData->FixupData[RelocDataIndex .. RelocDataIndex + NumRelocs - 1], ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@
@ loop invariant 0 <= RelocIndex <= image_base_reloc_num_relocs (RelocWalker);
@ loop invariant 0 <= RelocIndex <= NumRelocs;
@ loop invariant \valid(RelocWalker->Relocations + (0 .. image_base_reloc_num_relocs (RelocWalker) - 1));
@ loop invariant RelocationData != \null ==> \valid(RelocationData->FixupData + (0 .. image_base_reloc_num_relocs (RelocWalker) - 1));
@ loop invariant image_base_reloc_mem_valid ((char *) Context->ImageBuffer, RelocWalker, Context->SizeOfImage, Context->RelocDirRva, Context->RelocDirSize);
@ loop invariant \forall integer i; 0 <= i < RelocIndex ==>
@ image_reloc_sane (RelocWalker, i, Context->RelocDirRva, Context->RelocDirSize, Context->SizeOfImage);
@ loop invariant WalkerFixupData == &RelocationData->FixupData[RelocDataIndex] || WalkerFixupData == \null;
@
@ loop invariant \forall integer i; 0 <= i < RelocIndex ==>
@ \let RelocTarget = RelocWalker->VirtualAddress + image_reloc_offset (RelocWalker->Relocations[i]);
@ \valid ((char *) Context->ImageBuffer + (RelocTarget .. RelocTarget + image_reloc_size (RelocWalker->Relocations[i]) - 1));
@
@ loop variant image_base_reloc_num_relocs (RelocWalker) - RelocIndex;
*/
for (RelocIndex = 0; RelocIndex < NumRelocs; ++RelocIndex) {
//
// Apply the Base Relocation fixup per type.
// If RelocationData is not NULL, store the current value of the fixup
// target to determine whether it has been changed during runtime
// execution.
//
// It is not clear how EFI_IMAGE_REL_BASED_HIGH and
// EFI_IMAGE_REL_BASED_LOW are supposed to be handled. While PE reference
// suggests to just add the high or low part of the displacement, there
// are concerns about how it's supposed to deal with wraparounds.
// As neither LLD,
//
/*@ assigns Status, RelocationData->FixupData[RelocDataIndex .. RelocDataIndex + NumRelocs - 1], ((char *) Context->ImageBuffer)[0 .. Context->SizeOfImage - 1];
@ ensures Status == RETURN_SUCCESS <==> image_reloc_sane (RelocWalker, RelocIndex, Context->RelocDirRva, Context->RelocDirSize, Context->SizeOfImage);
*/
Status = InternalApplyRelocation (
Context,
RelocWalker,
RelocIndex,
Adjust,
WalkerFixupData
);