njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
| 3 | /*--- The dispatcher. pub_core_dispatch.h ---*/ |
| 4 | /*--------------------------------------------------------------------*/ |
| 5 | |
| 6 | /* |
| 7 | This file is part of Valgrind, a dynamic binary instrumentation |
| 8 | framework. |
| 9 | |
| 10 | Copyright (C) 2000-2005 Julian Seward |
| 11 | jseward@acm.org |
| 12 | |
| 13 | This program is free software; you can redistribute it and/or |
| 14 | modify it under the terms of the GNU General Public License as |
| 15 | published by the Free Software Foundation; either version 2 of the |
| 16 | License, or (at your option) any later version. |
| 17 | |
| 18 | This program is distributed in the hope that it will be useful, but |
| 19 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 21 | General Public License for more details. |
| 22 | |
| 23 | You should have received a copy of the GNU General Public License |
| 24 | along with this program; if not, write to the Free Software |
| 25 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 26 | 02111-1307, USA. |
| 27 | |
| 28 | The GNU General Public License is contained in the file COPYING. |
| 29 | */ |
| 30 | |
| 31 | #ifndef __PUB_CORE_DISPATCH_H |
| 32 | #define __PUB_CORE_DISPATCH_H |
| 33 | |
| 34 | //-------------------------------------------------------------------- |
sewardj | 6418291 | 2005-05-12 08:27:04 +0000 | [diff] [blame] | 35 | // PURPOSE: This module contains the inner loop of the execution |
| 36 | // mechanism, which is: find next basic block, execute it, repeat until |
| 37 | // the next bb isn't found in the fast-cache; or if the current bb |
| 38 | // exited with a request for some special action before continuing; or |
| 39 | // if the current thread has used up its scheduling quantum. |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 40 | //-------------------------------------------------------------------- |
| 41 | |
njn | a733b5f | 2005-05-12 13:15:38 +0000 | [diff] [blame] | 42 | #include "pub_core_dispatch_asm.h" |
| 43 | |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 44 | /* This subroutine is called from the C world. It is passed |
| 45 | a pointer to the VEX guest state (arch.vex). It must run code |
| 46 | from the instruction pointer in the guest state, and exit when |
| 47 | VG_(dispatch_ctr) reaches zero, or we need to defer to the scheduler. |
| 48 | The return value must indicate why it returned back to the scheduler. |
| 49 | It can also be exited if the executing code throws a non-resumable |
| 50 | signal, for example SIGSEGV, in which case control longjmp()s back past |
| 51 | here. |
| 52 | |
sewardj | 274807d | 2005-12-15 14:07:07 +0000 | [diff] [blame] | 53 | If do_profiling is nonzero, the profile counters arrays should be |
| 54 | updated for each translation run. |
| 55 | |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 56 | This code simply handles the common case fast -- when the translation |
| 57 | address is found in the translation cache. For anything else, the |
| 58 | scheduler does the work. |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame^] | 59 | |
| 60 | NOTE, VG_(run_innerloop) MUST NOT BE USED for noredir translations. |
| 61 | Instead use VG_(run_a_noredir_translation). |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 62 | */ |
sewardj | 274807d | 2005-12-15 14:07:07 +0000 | [diff] [blame] | 63 | extern |
| 64 | UWord VG_(run_innerloop) ( void* guest_state, UWord do_profiling ); |
sewardj | 274807d | 2005-12-15 14:07:07 +0000 | [diff] [blame] | 65 | #if defined(VGA_x86) || defined(VGA_amd64) |
| 66 | /* We need to locate a couple of labels inside VG_(run_innerloop), so |
| 67 | that Vex can add branches to them from generated code. Hence the |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame^] | 68 | following somewhat bogus decls. At least on x86 and amd64. ppc32 |
| 69 | and ppc64 use straightforward bl-blr to get from dispatcher to |
| 70 | translation and back and so do not need these labels. */ |
sewardj | 274807d | 2005-12-15 14:07:07 +0000 | [diff] [blame] | 71 | extern void VG_(run_innerloop__dispatch_unprofiled); |
| 72 | extern void VG_(run_innerloop__dispatch_profiled); |
| 73 | #endif |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 74 | |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame^] | 75 | |
| 76 | /* Run a no-redir translation. argblock points to 4 UWords, 2 to carry args |
| 77 | and 2 to carry results: |
| 78 | 0: input: ptr to translation |
| 79 | 1: input: ptr to guest state |
| 80 | 2: output: next guest PC |
| 81 | 3: output: guest state pointer afterwards (== thread return code) |
| 82 | MUST NOT BE USED for non-noredir (normal) translations. |
| 83 | */ |
| 84 | extern void VG_(run_a_noredir_translation) ( volatile UWord* argblock ); |
| 85 | #if defined(VGA_x86) || defined(VGA_amd64) |
| 86 | /* We need to a label inside VG_(run_a_noredir_translation), so that |
| 87 | Vex can add branches to them from generated code. Hence the |
| 88 | following somewhat bogus decl. */ |
| 89 | extern void VG_(run_a_noredir_translation__return_point); |
| 90 | #endif |
| 91 | |
| 92 | |
njn | 36b66df | 2005-05-12 05:13:04 +0000 | [diff] [blame] | 93 | #endif // __PUB_CORE_DISPATCH_H |
| 94 | |
| 95 | /*--------------------------------------------------------------------*/ |
| 96 | /*--- end ---*/ |
| 97 | /*--------------------------------------------------------------------*/ |