]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/EbcDxe/Ipf/EbcSupport.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdeModulePkg PciBusDxe: Add typecast to eliminate possible "loss of precision" warning.
[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / Ipf / EbcSupport.c
1 /** @file
2 This module contains EBC support routines that are customized based on
3 the target processor.
4
5 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include "EbcInt.h"
17 #include "EbcExecute.h"
18 #include "EbcSupport.h"
19
20 /**
21 Given raw bytes of Itanium based code, format them into a bundle and
22 write them out.
23
24 @param MemPtr pointer to memory location to write the bundles
25 to.
26 @param Template 5-bit template.
27 @param Slot0 Instruction slot 0 data for the bundle.
28 @param Slot1 Instruction slot 1 data for the bundle.
29 @param Slot2 Instruction slot 2 data for the bundle.
30
31 @retval EFI_INVALID_PARAMETER Pointer is not aligned
32 @retval EFI_INVALID_PARAMETER No more than 5 bits in template
33 @retval EFI_INVALID_PARAMETER More than 41 bits used in code
34 @retval EFI_SUCCESS All data is written.
35
36 **/
37 EFI_STATUS
38 WriteBundle (
39 IN VOID *MemPtr,
40 IN UINT8 Template,
41 IN UINT64 Slot0,
42 IN UINT64 Slot1,
43 IN UINT64 Slot2
44 );
45
46 /**
47 Pushes a 64 bit unsigned value to the VM stack.
48
49 @param VmPtr The pointer to current VM context.
50 @param Arg The value to be pushed.
51
52 **/
53 VOID
54 PushU64 (
55 IN VM_CONTEXT *VmPtr,
56 IN UINT64 Arg
57 )
58 {
59 //
60 // Advance the VM stack down, and then copy the argument to the stack.
61 // Hope it's aligned.
62 //
63 VmPtr->Gpr[0] -= sizeof (UINT64);
64 *(UINT64 *) VmPtr->Gpr[0] = Arg;
65 }
66
67 /**
68 Begin executing an EBC image. The address of the entry point is passed
69 in via a processor register, so we'll need to make a call to get the
70 value.
71
72 This is a thunk function. Microsoft x64 compiler only provide fast_call
73 calling convention, so the first four arguments are passed by rcx, rdx,
74 r8, and r9, while other arguments are passed in stack.
75
76 @param Arg1 The 1st argument.
77 @param ... The variable arguments list.
78
79 @return The value returned by the EBC application we're going to run.
80
81 **/
82 UINT64
83 EFIAPI
84 EbcInterpret (
85 UINT64 Arg1,
86 ...
87 )
88 {
89 //
90 // Create a new VM context on the stack
91 //
92 VM_CONTEXT VmContext;
93 UINTN Addr;
94 EFI_STATUS Status;
95 UINTN StackIndex;
96 VA_LIST List;
97 UINT64 Arg2;
98 UINT64 Arg3;
99 UINT64 Arg4;
100 UINT64 Arg5;
101 UINT64 Arg6;
102 UINT64 Arg7;
103 UINT64 Arg8;
104 UINT64 Arg9;
105 UINT64 Arg10;
106 UINT64 Arg11;
107 UINT64 Arg12;
108 UINT64 Arg13;
109 UINT64 Arg14;
110 UINT64 Arg15;
111 UINT64 Arg16;
112 //
113 // Get the EBC entry point from the processor register. Make sure you don't
114 // call any functions before this or you could mess up the register the
115 // entry point is passed in.
116 //
117 Addr = EbcLLGetEbcEntryPoint ();
118 //
119 // Need the args off the stack.
120 //
121 VA_START (List, Arg1);
122 Arg2 = VA_ARG (List, UINT64);
123 Arg3 = VA_ARG (List, UINT64);
124 Arg4 = VA_ARG (List, UINT64);
125 Arg5 = VA_ARG (List, UINT64);
126 Arg6 = VA_ARG (List, UINT64);
127 Arg7 = VA_ARG (List, UINT64);
128 Arg8 = VA_ARG (List, UINT64);
129 Arg9 = VA_ARG (List, UINT64);
130 Arg10 = VA_ARG (List, UINT64);
131 Arg11 = VA_ARG (List, UINT64);
132 Arg12 = VA_ARG (List, UINT64);
133 Arg13 = VA_ARG (List, UINT64);
134 Arg14 = VA_ARG (List, UINT64);
135 Arg15 = VA_ARG (List, UINT64);
136 Arg16 = VA_ARG (List, UINT64);
137 //
138 // Now clear out our context
139 //
140 ZeroMem ((VOID *) &VmContext, sizeof (VM_CONTEXT));
141 //
142 // Set the VM instruction pointer to the correct location in memory.
143 //
144 VmContext.Ip = (VMIP) Addr;
145 //
146 // Initialize the stack pointer for the EBC. Get the current system stack
147 // pointer and adjust it down by the max needed for the interpreter.
148 //
149 //
150 // NOTE: Eventually we should have the interpreter allocate memory
151 // for stack space which it will use during its execution. This
152 // would likely improve performance because the interpreter would
153 // no longer be required to test each memory access and adjust
154 // those reading from the stack gap.
155 //
156 // For IPF, the stack looks like (assuming 10 args passed)
157 // arg10
158 // arg9 (Bottom of high stack)
159 // [ stack gap for interpreter execution ]
160 // [ magic value for detection of stack corruption ]
161 // arg8 (Top of low stack)
162 // arg7....
163 // arg1
164 // [ 64-bit return address ]
165 // [ ebc stack ]
166 // If the EBC accesses memory in the stack gap, then we assume that it's
167 // actually trying to access args9 and greater. Therefore we need to
168 // adjust memory accesses in this region to point above the stack gap.
169 //
170 //
171 // Now adjust the EBC stack pointer down to leave a gap for interpreter
172 // execution. Then stuff a magic value there.
173 //
174
175 Status = GetEBCStack((EFI_HANDLE)(UINTN)-1, &VmContext.StackPool, &StackIndex);
176 if (EFI_ERROR(Status)) {
177 return Status;
178 }
179 VmContext.StackTop = (UINT8*)VmContext.StackPool + (STACK_REMAIN_SIZE);
180 VmContext.Gpr[0] = (UINT64) ((UINT8*)VmContext.StackPool + STACK_POOL_SIZE);
181 VmContext.HighStackBottom = (UINTN) VmContext.Gpr[0];
182 VmContext.Gpr[0] -= sizeof (UINTN);
183
184
185 PushU64 (&VmContext, (UINT64) VM_STACK_KEY_VALUE);
186 VmContext.StackMagicPtr = (UINTN *) VmContext.Gpr[0];
187 VmContext.LowStackTop = (UINTN) VmContext.Gpr[0];
188 //
189 // Push the EBC arguments on the stack. Does not matter that they may not
190 // all be valid.
191 //
192 PushU64 (&VmContext, Arg16);
193 PushU64 (&VmContext, Arg15);
194 PushU64 (&VmContext, Arg14);
195 PushU64 (&VmContext, Arg13);
196 PushU64 (&VmContext, Arg12);
197 PushU64 (&VmContext, Arg11);
198 PushU64 (&VmContext, Arg10);
199 PushU64 (&VmContext, Arg9);
200 PushU64 (&VmContext, Arg8);
201 PushU64 (&VmContext, Arg7);
202 PushU64 (&VmContext, Arg6);
203 PushU64 (&VmContext, Arg5);
204 PushU64 (&VmContext, Arg4);
205 PushU64 (&VmContext, Arg3);
206 PushU64 (&VmContext, Arg2);
207 PushU64 (&VmContext, Arg1);
208 //
209 // Push a bogus return address on the EBC stack because the
210 // interpreter expects one there. For stack alignment purposes on IPF,
211 // EBC return addresses are always 16 bytes. Push a bogus value as well.
212 //
213 PushU64 (&VmContext, 0);
214 PushU64 (&VmContext, 0xDEADBEEFDEADBEEF);
215 VmContext.StackRetAddr = (UINT64) VmContext.Gpr[0];
216 //
217 // Begin executing the EBC code
218 //
219 EbcExecute (&VmContext);
220 //
221 // Return the value in R[7] unless there was an error
222 //
223 ReturnEBCStack(StackIndex);
224 return (UINT64) VmContext.Gpr[7];
225 }
226
227
228 /**
229 Begin executing an EBC image. The address of the entry point is passed
230 in via a processor register, so we'll need to make a call to get the
231 value.
232
233 @param ImageHandle image handle for the EBC application we're executing
234 @param SystemTable standard system table passed into an driver's entry
235 point
236
237 @return The value returned by the EBC application we're going to run.
238
239 **/
240 UINT64
241 EFIAPI
242 ExecuteEbcImageEntryPoint (
243 IN EFI_HANDLE ImageHandle,
244 IN EFI_SYSTEM_TABLE *SystemTable
245 )
246 {
247 //
248 // Create a new VM context on the stack
249 //
250 VM_CONTEXT VmContext;
251 UINTN Addr;
252 EFI_STATUS Status;
253 UINTN StackIndex;
254
255 //
256 // Get the EBC entry point from the processor register. Make sure you don't
257 // call any functions before this or you could mess up the register the
258 // entry point is passed in.
259 //
260 Addr = EbcLLGetEbcEntryPoint ();
261
262 //
263 // Now clear out our context
264 //
265 ZeroMem ((VOID *) &VmContext, sizeof (VM_CONTEXT));
266
267 //
268 // Save the image handle so we can track the thunks created for this image
269 //
270 VmContext.ImageHandle = ImageHandle;
271 VmContext.SystemTable = SystemTable;
272
273 //
274 // Set the VM instruction pointer to the correct location in memory.
275 //
276 VmContext.Ip = (VMIP) Addr;
277
278 //
279 // Get the stack pointer. This is the bottom of the upper stack.
280 //
281
282 Status = GetEBCStack(ImageHandle, &VmContext.StackPool, &StackIndex);
283 if (EFI_ERROR(Status)) {
284 return Status;
285 }
286 VmContext.StackTop = (UINT8*)VmContext.StackPool + (STACK_REMAIN_SIZE);
287 VmContext.Gpr[0] = (UINT64) ((UINT8*)VmContext.StackPool + STACK_POOL_SIZE);
288 VmContext.HighStackBottom = (UINTN) VmContext.Gpr[0];
289 VmContext.Gpr[0] -= sizeof (UINTN);
290
291
292 //
293 // Allocate stack space for the interpreter. Then put a magic value
294 // at the bottom so we can detect stack corruption.
295 //
296 PushU64 (&VmContext, (UINT64) VM_STACK_KEY_VALUE);
297 VmContext.StackMagicPtr = (UINTN *) (UINTN) VmContext.Gpr[0];
298
299 //
300 // When we thunk to external native code, we copy the last 8 qwords from
301 // the EBC stack into the processor registers, and adjust the stack pointer
302 // up. If the caller is not passing 8 parameters, then we've moved the
303 // stack pointer up into the stack gap. If this happens, then the caller
304 // can mess up the stack gap contents (in particular our magic value).
305 // Therefore, leave another gap below the magic value. Pick 10 qwords down,
306 // just as a starting point.
307 //
308 VmContext.Gpr[0] -= 10 * sizeof (UINT64);
309
310 //
311 // Align the stack pointer such that after pushing the system table,
312 // image handle, and return address on the stack, it's aligned on a 16-byte
313 // boundary as required for IPF.
314 //
315 VmContext.Gpr[0] &= (INT64)~0x0f;
316 VmContext.LowStackTop = (UINTN) VmContext.Gpr[0];
317 //
318 // Simply copy the image handle and system table onto the EBC stack.
319 // Greatly simplifies things by not having to spill the args
320 //
321 PushU64 (&VmContext, (UINT64) SystemTable);
322 PushU64 (&VmContext, (UINT64) ImageHandle);
323
324 //
325 // Interpreter assumes 64-bit return address is pushed on the stack.
326 // IPF does not do this so pad the stack accordingly. Also, a
327 // "return address" is 16 bytes as required for IPF stack alignments.
328 //
329 PushU64 (&VmContext, (UINT64) 0);
330 PushU64 (&VmContext, (UINT64) 0x1234567887654321);
331 VmContext.StackRetAddr = (UINT64) VmContext.Gpr[0];
332
333 //
334 // Begin executing the EBC code
335 //
336 EbcExecute (&VmContext);
337
338 //
339 // Return the value in R[7] unless there was an error
340 //
341 ReturnEBCStack(StackIndex);
342 return (UINT64) VmContext.Gpr[7];
343 }
344
345
346 /**
347 Create thunks for an EBC image entry point, or an EBC protocol service.
348
349 @param ImageHandle Image handle for the EBC image. If not null, then
350 we're creating a thunk for an image entry point.
351 @param EbcEntryPoint Address of the EBC code that the thunk is to call
352 @param Thunk Returned thunk we create here
353 @param Flags Flags indicating options for creating the thunk
354
355 @retval EFI_SUCCESS The thunk was created successfully.
356 @retval EFI_INVALID_PARAMETER The parameter of EbcEntryPoint is not 16-bit
357 aligned.
358 @retval EFI_OUT_OF_RESOURCES There is not enough memory to created the EBC
359 Thunk.
360 @retval EFI_BUFFER_TOO_SMALL EBC_THUNK_SIZE is not larger enough.
361
362 **/
363 EFI_STATUS
364 EbcCreateThunks (
365 IN EFI_HANDLE ImageHandle,
366 IN VOID *EbcEntryPoint,
367 OUT VOID **Thunk,
368 IN UINT32 Flags
369 )
370 {
371 UINT8 *Ptr;
372 UINT8 *ThunkBase;
373 UINT64 Addr;
374 UINT64 Code[3]; // Code in a bundle
375 UINT64 RegNum; // register number for MOVL
376 UINT64 BitI; // bits of MOVL immediate data
377 UINT64 BitIc; // bits of MOVL immediate data
378 UINT64 BitImm5c; // bits of MOVL immediate data
379 UINT64 BitImm9d; // bits of MOVL immediate data
380 UINT64 BitImm7b; // bits of MOVL immediate data
381 UINT64 Br; // branch register for loading and jumping
382 UINT64 *Data64Ptr;
383 UINT32 ThunkSize;
384 UINT32 Size;
385
386 //
387 // Check alignment of pointer to EBC code, which must always be aligned
388 // on a 2-byte boundary.
389 //
390 if ((UINT32) (UINTN) EbcEntryPoint & 0x01) {
391 return EFI_INVALID_PARAMETER;
392 }
393 //
394 // Allocate memory for the thunk. Make the (most likely incorrect) assumption
395 // that the returned buffer is not aligned, so round up to the next
396 // alignment size.
397 //
398 Size = EBC_THUNK_SIZE + EBC_THUNK_ALIGNMENT - 1;
399 ThunkSize = Size;
400 Ptr = AllocatePool (Size);
401
402 if (Ptr == NULL) {
403 return EFI_OUT_OF_RESOURCES;
404 }
405 //
406 // Save the start address of the buffer.
407 //
408 ThunkBase = Ptr;
409
410 //
411 // Make sure it's aligned for code execution. If not, then
412 // round up.
413 //
414 if ((UINT32) (UINTN) Ptr & (EBC_THUNK_ALIGNMENT - 1)) {
415 Ptr = (UINT8 *) (((UINTN) Ptr + (EBC_THUNK_ALIGNMENT - 1)) &~ (UINT64) (EBC_THUNK_ALIGNMENT - 1));
416 }
417 //
418 // Return the pointer to the thunk to the caller to user as the
419 // image entry point.
420 //
421 *Thunk = (VOID *) Ptr;
422
423 //
424 // Clear out the thunk entry
425 // ZeroMem(Ptr, Size);
426 //
427 // For IPF, when you do a call via a function pointer, the function pointer
428 // actually points to a function descriptor which consists of a 64-bit
429 // address of the function, followed by a 64-bit gp for the function being
430 // called. See the the Software Conventions and Runtime Architecture Guide
431 // for details.
432 // So first off in our thunk, create a descriptor for our actual thunk code.
433 // This means we need to create a pointer to the thunk code (which follows
434 // the descriptor we're going to create), followed by the gp of the Vm
435 // interpret function we're going to eventually execute.
436 //
437 Data64Ptr = (UINT64 *) Ptr;
438
439 //
440 // Write the function's entry point (which is our thunk code that follows
441 // this descriptor we're creating).
442 //
443 *Data64Ptr = (UINT64) (Data64Ptr + 2);
444 //
445 // Get the gp from the descriptor for EbcInterpret and stuff it in our thunk
446 // descriptor.
447 //
448 *(Data64Ptr + 1) = *(UINT64 *) ((UINT64 *) (UINTN) EbcInterpret + 1);
449 //
450 // Advance our thunk data pointer past the descriptor. Since the
451 // descriptor consists of 16 bytes, the pointer is still aligned for
452 // IPF code execution (on 16-byte boundary).
453 //
454 Ptr += sizeof (UINT64) * 2;
455
456 //
457 // *************************** MAGIC BUNDLE ********************************
458 //
459 // Write magic code bundle for: movl r8 = 0xca112ebcca112ebc to help the VM
460 // to recognize it is a thunk.
461 //
462 Addr = (UINT64) 0xCA112EBCCA112EBC;
463
464 //
465 // Now generate the code bytes. First is nop.m 0x0
466 //
467 Code[0] = OPCODE_NOP;
468
469 //
470 // Next is simply Addr[62:22] (41 bits) of the address
471 //
472 Code[1] = RShiftU64 (Addr, 22) & 0x1ffffffffff;
473
474 //
475 // Extract bits from the address for insertion into the instruction
476 // i = Addr[63:63]
477 //
478 BitI = RShiftU64 (Addr, 63) & 0x01;
479 //
480 // ic = Addr[21:21]
481 //
482 BitIc = RShiftU64 (Addr, 21) & 0x01;
483 //
484 // imm5c = Addr[20:16] for 5 bits
485 //
486 BitImm5c = RShiftU64 (Addr, 16) & 0x1F;
487 //
488 // imm9d = Addr[15:7] for 9 bits
489 //
490 BitImm9d = RShiftU64 (Addr, 7) & 0x1FF;
491 //
492 // imm7b = Addr[6:0] for 7 bits
493 //
494 BitImm7b = Addr & 0x7F;
495
496 //
497 // The EBC entry point will be put into r8, so r8 can be used here
498 // temporary. R8 is general register and is auto-serialized.
499 //
500 RegNum = 8;
501
502 //
503 // Next is jumbled data, including opcode and rest of address
504 //
505 Code[2] = LShiftU64 (BitImm7b, 13);
506 Code[2] = Code[2] | LShiftU64 (0x00, 20); // vc
507 Code[2] = Code[2] | LShiftU64 (BitIc, 21);
508 Code[2] = Code[2] | LShiftU64 (BitImm5c, 22);
509 Code[2] = Code[2] | LShiftU64 (BitImm9d, 27);
510 Code[2] = Code[2] | LShiftU64 (BitI, 36);
511 Code[2] = Code[2] | LShiftU64 ((UINT64)MOVL_OPCODE, 37);
512 Code[2] = Code[2] | LShiftU64 ((RegNum & 0x7F), 6);
513
514 WriteBundle ((VOID *) Ptr, 0x05, Code[0], Code[1], Code[2]);
515
516 //
517 // *************************** FIRST BUNDLE ********************************
518 //
519 // Write code bundle for: movl r8 = EBC_ENTRY_POINT so we pass
520 // the ebc entry point in to the interpreter function via a processor
521 // register.
522 // Note -- we could easily change this to pass in a pointer to a structure
523 // that contained, among other things, the EBC image's entry point. But
524 // for now pass it directly.
525 //
526 Ptr += 16;
527 Addr = (UINT64) EbcEntryPoint;
528
529 //
530 // Now generate the code bytes. First is nop.m 0x0
531 //
532 Code[0] = OPCODE_NOP;
533
534 //
535 // Next is simply Addr[62:22] (41 bits) of the address
536 //
537 Code[1] = RShiftU64 (Addr, 22) & 0x1ffffffffff;
538
539 //
540 // Extract bits from the address for insertion into the instruction
541 // i = Addr[63:63]
542 //
543 BitI = RShiftU64 (Addr, 63) & 0x01;
544 //
545 // ic = Addr[21:21]
546 //
547 BitIc = RShiftU64 (Addr, 21) & 0x01;
548 //
549 // imm5c = Addr[20:16] for 5 bits
550 //
551 BitImm5c = RShiftU64 (Addr, 16) & 0x1F;
552 //
553 // imm9d = Addr[15:7] for 9 bits
554 //
555 BitImm9d = RShiftU64 (Addr, 7) & 0x1FF;
556 //
557 // imm7b = Addr[6:0] for 7 bits
558 //
559 BitImm7b = Addr & 0x7F;
560
561 //
562 // Put the EBC entry point in r8, which is the location of the return value
563 // for functions.
564 //
565 RegNum = 8;
566
567 //
568 // Next is jumbled data, including opcode and rest of address
569 //
570 Code[2] = LShiftU64 (BitImm7b, 13);
571 Code[2] = Code[2] | LShiftU64 (0x00, 20); // vc
572 Code[2] = Code[2] | LShiftU64 (BitIc, 21);
573 Code[2] = Code[2] | LShiftU64 (BitImm5c, 22);
574 Code[2] = Code[2] | LShiftU64 (BitImm9d, 27);
575 Code[2] = Code[2] | LShiftU64 (BitI, 36);
576 Code[2] = Code[2] | LShiftU64 ((UINT64)MOVL_OPCODE, 37);
577 Code[2] = Code[2] | LShiftU64 ((RegNum & 0x7F), 6);
578
579 WriteBundle ((VOID *) Ptr, 0x05, Code[0], Code[1], Code[2]);
580
581 //
582 // *************************** NEXT BUNDLE *********************************
583 //
584 // Write code bundle for:
585 // movl rx = offset_of(EbcInterpret|ExecuteEbcImageEntryPoint)
586 //
587 // Advance pointer to next bundle, then compute the offset from this bundle
588 // to the address of the entry point of the interpreter.
589 //
590 Ptr += 16;
591 if ((Flags & FLAG_THUNK_ENTRY_POINT) != 0) {
592 Addr = (UINT64) ExecuteEbcImageEntryPoint;
593 } else {
594 Addr = (UINT64) EbcInterpret;
595 }
596 //
597 // Indirection on Itanium-based systems
598 //
599 Addr = *(UINT64 *) Addr;
600
601 //
602 // Now write the code to load the offset into a register
603 //
604 Code[0] = OPCODE_NOP;
605
606 //
607 // Next is simply Addr[62:22] (41 bits) of the address
608 //
609 Code[1] = RShiftU64 (Addr, 22) & 0x1ffffffffff;
610
611 //
612 // Extract bits from the address for insertion into the instruction
613 // i = Addr[63:63]
614 //
615 BitI = RShiftU64 (Addr, 63) & 0x01;
616 //
617 // ic = Addr[21:21]
618 //
619 BitIc = RShiftU64 (Addr, 21) & 0x01;
620 //
621 // imm5c = Addr[20:16] for 5 bits
622 //
623 BitImm5c = RShiftU64 (Addr, 16) & 0x1F;
624 //
625 // imm9d = Addr[15:7] for 9 bits
626 //
627 BitImm9d = RShiftU64 (Addr, 7) & 0x1FF;
628 //
629 // imm7b = Addr[6:0] for 7 bits
630 //
631 BitImm7b = Addr & 0x7F;
632
633 //
634 // Put it in r31, a scratch register
635 //
636 RegNum = 31;
637
638 //
639 // Next is jumbled data, including opcode and rest of address
640 //
641 Code[2] = LShiftU64(BitImm7b, 13);
642 Code[2] = Code[2] | LShiftU64 (0x00, 20); // vc
643 Code[2] = Code[2] | LShiftU64 (BitIc, 21);
644 Code[2] = Code[2] | LShiftU64 (BitImm5c, 22);
645 Code[2] = Code[2] | LShiftU64 (BitImm9d, 27);
646 Code[2] = Code[2] | LShiftU64 (BitI, 36);
647 Code[2] = Code[2] | LShiftU64 ((UINT64)MOVL_OPCODE, 37);
648 Code[2] = Code[2] | LShiftU64 ((RegNum & 0x7F), 6);
649
650 WriteBundle ((VOID *) Ptr, 0x05, Code[0], Code[1], Code[2]);
651
652 //
653 // *************************** NEXT BUNDLE *********************************
654 //
655 // Load branch register with EbcInterpret() function offset from the bundle
656 // address: mov b6 = RegNum
657 //
658 // See volume 3 page 4-29 of the Arch. Software Developer's Manual.
659 //
660 // Advance pointer to next bundle
661 //
662 Ptr += 16;
663 Code[0] = OPCODE_NOP;
664 Code[1] = OPCODE_NOP;
665 Code[2] = OPCODE_MOV_BX_RX;
666
667 //
668 // Pick a branch register to use. Then fill in the bits for the branch
669 // register and user register (same user register as previous bundle).
670 //
671 Br = 6;
672 Code[2] |= LShiftU64 (Br, 6);
673 Code[2] |= LShiftU64 (RegNum, 13);
674 WriteBundle ((VOID *) Ptr, 0x0d, Code[0], Code[1], Code[2]);
675
676 //
677 // *************************** NEXT BUNDLE *********************************
678 //
679 // Now do the branch: (p0) br.cond.sptk.few b6
680 //
681 // Advance pointer to next bundle.
682 // Fill in the bits for the branch register (same reg as previous bundle)
683 //
684 Ptr += 16;
685 Code[0] = OPCODE_NOP;
686 Code[1] = OPCODE_NOP;
687 Code[2] = OPCODE_BR_COND_SPTK_FEW;
688 Code[2] |= LShiftU64 (Br, 13);
689 WriteBundle ((VOID *) Ptr, 0x1d, Code[0], Code[1], Code[2]);
690
691 //
692 // Add the thunk to our list of allocated thunks so we can do some cleanup
693 // when the image is unloaded. Do this last since the Add function flushes
694 // the instruction cache for us.
695 //
696 EbcAddImageThunk (ImageHandle, (VOID *) ThunkBase, ThunkSize);
697
698 //
699 // Done
700 //
701 return EFI_SUCCESS;
702 }
703
704
705 /**
706 Given raw bytes of Itanium based code, format them into a bundle and
707 write them out.
708
709 @param MemPtr pointer to memory location to write the bundles
710 to.
711 @param Template 5-bit template.
712 @param Slot0 Instruction slot 0 data for the bundle.
713 @param Slot1 Instruction slot 1 data for the bundle.
714 @param Slot2 Instruction slot 2 data for the bundle.
715
716 @retval EFI_INVALID_PARAMETER Pointer is not aligned
717 @retval EFI_INVALID_PARAMETER No more than 5 bits in template
718 @retval EFI_INVALID_PARAMETER More than 41 bits used in code
719 @retval EFI_SUCCESS All data is written.
720
721 **/
722 EFI_STATUS
723 WriteBundle (
724 IN VOID *MemPtr,
725 IN UINT8 Template,
726 IN UINT64 Slot0,
727 IN UINT64 Slot1,
728 IN UINT64 Slot2
729 )
730 {
731 UINT8 *BPtr;
732 UINT32 Index;
733 UINT64 Low64;
734 UINT64 High64;
735
736 //
737 // Verify pointer is aligned
738 //
739 if ((UINT64) MemPtr & 0xF) {
740 return EFI_INVALID_PARAMETER;
741 }
742 //
743 // Verify no more than 5 bits in template
744 //
745 if ((Template &~0x1F) != 0) {
746 return EFI_INVALID_PARAMETER;
747 }
748 //
749 // Verify max of 41 bits used in code
750 //
751 if (((Slot0 | Slot1 | Slot2) &~0x1ffffffffff) != 0) {
752 return EFI_INVALID_PARAMETER;
753 }
754
755 Low64 = LShiftU64 (Slot1, 46);
756 Low64 = Low64 | LShiftU64 (Slot0, 5) | Template;
757
758 High64 = RShiftU64 (Slot1, 18);
759 High64 = High64 | LShiftU64 (Slot2, 23);
760
761 //
762 // Now write it all out
763 //
764 BPtr = (UINT8 *) MemPtr;
765 for (Index = 0; Index < 8; Index++) {
766 *BPtr = (UINT8) Low64;
767 Low64 = RShiftU64 (Low64, 8);
768 BPtr++;
769 }
770
771 for (Index = 0; Index < 8; Index++) {
772 *BPtr = (UINT8) High64;
773 High64 = RShiftU64 (High64, 8);
774 BPtr++;
775 }
776
777 return EFI_SUCCESS;
778 }
779
780
781 /**
782 This function is called to execute an EBC CALLEX instruction.
783 The function check the callee's content to see whether it is common native
784 code or a thunk to another piece of EBC code.
785 If the callee is common native code, use EbcLLCAllEXASM to manipulate,
786 otherwise, set the VM->IP to target EBC code directly to avoid another VM
787 be startup which cost time and stack space.
788
789 @param VmPtr Pointer to a VM context.
790 @param FuncAddr Callee's address
791 @param NewStackPointer New stack pointer after the call
792 @param FramePtr New frame pointer after the call
793 @param Size The size of call instruction
794
795 **/
796 VOID
797 EbcLLCALLEX (
798 IN VM_CONTEXT *VmPtr,
799 IN UINTN FuncAddr,
800 IN UINTN NewStackPointer,
801 IN VOID *FramePtr,
802 IN UINT8 Size
803 )
804 {
805 UINTN IsThunk;
806 UINTN TargetEbcAddr;
807 UINTN CodeOne18;
808 UINTN CodeOne23;
809 UINTN CodeTwoI;
810 UINTN CodeTwoIc;
811 UINTN CodeTwo7b;
812 UINTN CodeTwo5c;
813 UINTN CodeTwo9d;
814 UINTN CalleeAddr;
815
816 IsThunk = 1;
817 TargetEbcAddr = 0;
818
819 //
820 // FuncAddr points to the descriptor of the target instructions.
821 //
822 CalleeAddr = *((UINT64 *)FuncAddr);
823
824 //
825 // Processor specific code to check whether the callee is a thunk to EBC.
826 //
827 if (*((UINT64 *)CalleeAddr) != 0xBCCA000100000005) {
828 IsThunk = 0;
829 goto Action;
830 }
831 if (*((UINT64 *)CalleeAddr + 1) != 0x697623C1004A112E) {
832 IsThunk = 0;
833 goto Action;
834 }
835
836 CodeOne18 = RShiftU64 (*((UINT64 *)CalleeAddr + 2), 46) & 0x3FFFF;
837 CodeOne23 = (*((UINT64 *)CalleeAddr + 3)) & 0x7FFFFF;
838 CodeTwoI = RShiftU64 (*((UINT64 *)CalleeAddr + 3), 59) & 0x1;
839 CodeTwoIc = RShiftU64 (*((UINT64 *)CalleeAddr + 3), 44) & 0x1;
840 CodeTwo7b = RShiftU64 (*((UINT64 *)CalleeAddr + 3), 36) & 0x7F;
841 CodeTwo5c = RShiftU64 (*((UINT64 *)CalleeAddr + 3), 45) & 0x1F;
842 CodeTwo9d = RShiftU64 (*((UINT64 *)CalleeAddr + 3), 50) & 0x1FF;
843
844 TargetEbcAddr = CodeTwo7b;
845 TargetEbcAddr = TargetEbcAddr | LShiftU64 (CodeTwo9d, 7);
846 TargetEbcAddr = TargetEbcAddr | LShiftU64 (CodeTwo5c, 16);
847 TargetEbcAddr = TargetEbcAddr | LShiftU64 (CodeTwoIc, 21);
848 TargetEbcAddr = TargetEbcAddr | LShiftU64 (CodeOne18, 22);
849 TargetEbcAddr = TargetEbcAddr | LShiftU64 (CodeOne23, 40);
850 TargetEbcAddr = TargetEbcAddr | LShiftU64 (CodeTwoI, 63);
851
852 Action:
853 if (IsThunk == 1){
854 //
855 // The callee is a thunk to EBC, adjust the stack pointer down 16 bytes and
856 // put our return address and frame pointer on the VM stack.
857 // Then set the VM's IP to new EBC code.
858 //
859 VmPtr->Gpr[0] -= 8;
860 VmWriteMemN (VmPtr, (UINTN) VmPtr->Gpr[0], (UINTN) FramePtr);
861 VmPtr->FramePtr = (VOID *) (UINTN) VmPtr->Gpr[0];
862 VmPtr->Gpr[0] -= 8;
863 VmWriteMem64 (VmPtr, (UINTN) VmPtr->Gpr[0], (UINT64) (VmPtr->Ip + Size));
864
865 VmPtr->Ip = (VMIP) (UINTN) TargetEbcAddr;
866 } else {
867 //
868 // The callee is not a thunk to EBC, call native code,
869 // and get return value.
870 //
871 VmPtr->Gpr[7] = EbcLLCALLEXNative (FuncAddr, NewStackPointer, FramePtr);
872
873 //
874 // Advance the IP.
875 //
876 VmPtr->Ip += Size;
877 }
878 }
EFI Development Kit II mirror for PVE