njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
| 3 | /*--- The scheduler. pub_core_scheduler.h ---*/ |
| 4 | /*--------------------------------------------------------------------*/ |
| 5 | |
| 6 | /* |
| 7 | This file is part of Valgrind, a dynamic binary instrumentation |
| 8 | framework. |
| 9 | |
Elliott Hughes | ed39800 | 2017-06-21 14:41:24 -0700 | [diff] [blame] | 10 | Copyright (C) 2000-2017 Julian Seward |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 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_SCHEDULER_H |
| 32 | #define __PUB_CORE_SCHEDULER_H |
| 33 | |
florian | 535fb1b | 2013-09-15 13:54:34 +0000 | [diff] [blame] | 34 | #include "pub_core_basics.h" // VG_ macro |
| 35 | #include "pub_core_threadstate.h" // VgSchedReturnCode |
| 36 | |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 37 | //-------------------------------------------------------------------- |
| 38 | // PURPOSE: This module is the scheduler, which is the main loop |
| 39 | // controlling the running of all the program's threads. |
| 40 | // It's at the centre of everything. |
| 41 | //-------------------------------------------------------------------- |
| 42 | |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 43 | /* Allocate a new ThreadState */ |
| 44 | extern ThreadId VG_(alloc_ThreadState)(void); |
| 45 | |
| 46 | /* A thread exits. tid must currently be running. */ |
| 47 | extern void VG_(exit_thread)(ThreadId tid); |
| 48 | |
sewardj | f54342a | 2006-10-17 01:51:24 +0000 | [diff] [blame] | 49 | /* If 'tid' is blocked in a syscall, send it SIGVGKILL so as to get it |
| 50 | out of the syscall and onto doing the next thing, whatever that is. |
| 51 | If it isn't blocked in a syscall, has no effect on the thread. */ |
| 52 | extern void VG_(get_thread_out_of_syscall)(ThreadId tid); |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 53 | |
Elliott Hughes | a0664b9 | 2017-04-18 17:46:52 -0700 | [diff] [blame] | 54 | /* This causes all threads except tid to forceably exit. They aren't actually |
| 55 | dead by the time this returns; you need to call |
| 56 | VG_(reap_threads)() to wait for them. */ |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 57 | extern void VG_(nuke_all_threads_except) ( ThreadId me, |
| 58 | VgSchedReturnCode reason ); |
| 59 | |
| 60 | /* Make a thread the running thread. The thread must previously been |
sewardj | f54342a | 2006-10-17 01:51:24 +0000 | [diff] [blame] | 61 | sleeping, and not holding the CPU lock. This will set the |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 62 | thread state to VgTs_Runnable, and the thread will attempt to take |
sewardj | f54342a | 2006-10-17 01:51:24 +0000 | [diff] [blame] | 63 | the CPU lock. By the time it returns, tid will be the running |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 64 | thread. */ |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 65 | extern void VG_(acquire_BigLock) ( ThreadId tid, const HChar* who ); |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 66 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 67 | /* Simple version, which simply acquires the lock, but does not mess |
| 68 | with the guest state in the same way as the non _LL version |
| 69 | does. */ |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 70 | extern void VG_(acquire_BigLock_LL) ( const HChar* who ); |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 71 | |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 72 | /* Set a thread into a sleeping state. Before the call, the thread |
sewardj | f54342a | 2006-10-17 01:51:24 +0000 | [diff] [blame] | 73 | must be runnable, and holding the CPU lock. When this call |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 74 | returns, the thread will be set to the specified sleeping state, |
sewardj | f54342a | 2006-10-17 01:51:24 +0000 | [diff] [blame] | 75 | and will not be holding the CPU lock. Note that another |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 76 | thread could be running by the time this call returns, so the |
| 77 | caller must be careful not to touch any shared state. It is also |
| 78 | the caller's responsibility to actually block until the thread is |
| 79 | ready to run again. */ |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 80 | extern void VG_(release_BigLock) ( ThreadId tid, |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 81 | ThreadStatus state, const HChar* who ); |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 82 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 83 | /* Matching function to acquire_BigLock_LL. */ |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 84 | extern void VG_(release_BigLock_LL) ( const HChar* who ); |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 85 | |
bart | 9a2b80d | 2012-03-25 17:51:59 +0000 | [diff] [blame] | 86 | /* Whether the specified thread owns the big lock. */ |
| 87 | extern Bool VG_(owns_BigLock_LL) ( ThreadId tid ); |
| 88 | |
njn | f76d27a | 2009-05-28 01:53:07 +0000 | [diff] [blame] | 89 | /* Yield the CPU for a while. Drops/acquires the lock using the |
| 90 | normal (non _LL) functions. */ |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 91 | extern void VG_(vg_yield)(void); |
| 92 | |
| 93 | // The scheduler. |
| 94 | extern VgSchedReturnCode VG_(scheduler) ( ThreadId tid ); |
| 95 | |
sewardj | de764e8 | 2007-11-09 23:13:22 +0000 | [diff] [blame] | 96 | // Initialise, phase 1. Zero out VG_(threads), decide on the root |
| 97 | // ThreadId and initialise the bigLock. |
| 98 | extern ThreadId VG_(scheduler_init_phase1) ( void ); |
| 99 | |
| 100 | // Initialise, phase 2. Is passed the extent of the root thread's |
philippe | 38a74d2 | 2014-08-29 22:53:19 +0000 | [diff] [blame] | 101 | // client stack end (highest addressable byte) and the root ThreadId |
| 102 | // decided on by phase 1. |
sewardj | de764e8 | 2007-11-09 23:13:22 +0000 | [diff] [blame] | 103 | extern void VG_(scheduler_init_phase2) ( ThreadId main_tid, |
| 104 | Addr clstack_end, |
| 105 | SizeT clstack_size ); |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 106 | |
sewardj | 3b29048 | 2011-05-06 21:02:55 +0000 | [diff] [blame] | 107 | // Allows to disable the polling done to detect vgdb input |
| 108 | // or to force a poll at next scheduler call. |
| 109 | extern void VG_(disable_vgdb_poll) (void ); |
| 110 | extern void VG_(force_vgdb_poll) ( void ); |
| 111 | |
njn | 04e1698 | 2005-05-31 00:23:43 +0000 | [diff] [blame] | 112 | /* Stats ... */ |
| 113 | extern void VG_(print_scheduler_stats) ( void ); |
| 114 | |
sewardj | 0ec07f3 | 2006-01-12 12:32:32 +0000 | [diff] [blame] | 115 | /* If False, a fault is Valgrind-internal (ie, a bug) */ |
| 116 | extern Bool VG_(in_generated_code); |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 117 | |
njn | 6676d5b | 2005-06-19 18:49:19 +0000 | [diff] [blame] | 118 | /* Sanity checks which may be done at any time. The scheduler decides when. */ |
| 119 | extern void VG_(sanity_check_general) ( Bool force_expensive ); |
| 120 | |
njn | 278b3d6 | 2005-05-30 23:20:51 +0000 | [diff] [blame] | 121 | #endif // __PUB_CORE_SCHEDULER_H |
| 122 | |
| 123 | /*--------------------------------------------------------------------*/ |
| 124 | /*--- end ---*/ |
| 125 | /*--------------------------------------------------------------------*/ |