mirror of
https://github.com/Zenithsiz/ftmemsim-valgrind.git
synced 2026-02-03 10:05:29 +00:00
51c6c85e22
At various places, there were either some assumption that the 'end'
boundary (highest address) was either not included, included,
or was the highest addressable word, or the highest addressable byte.
This e.g. was very visible when doing:
./vg-in-place -d -d ./helgrind/tests/tc01_simple_race|&grep regi
giving
--24040:2:stacks register 0xBEDB4000-0xBEDB4FFF as stack 0
--24040:2:stacks register 0x402C000-0x4A2C000 as stack 1
showing that the main stack end was (on x86) not the highest word
but the highest byte, while for the thread 1, the registered end
was a byte not part of the stack.
The attached patch ensures that stack bounds semantic are documented and
consistent. Also, some of the stack handling code is factorised.
The convention that the patch ensures and documents is:
start is the lowest addressable byte, end is the highest addressable byte.
(the words 'min' and 'max' have been kept when already used, as this wording is
consistent with the new semantic of start/end).
In various debug log, used brackets [ and ] to make clear that
both bounds are included.
The code to guess and register the client stack was duplicated
in all the platform specific syswrap-<plat>-<os>.c files.
Code has been factorised in syswrap-generic.c
The patch has been regression tested on
x86, amd64, ppc32/64, s390x.
It has been compiled and one test run on arm64.
Not compiled/not tested on darwin, android, mips32/64, arm
More in details, the patch does the following:
coregrind/pub_core_aspacemgr.h
include/valgrind.h
include/pub_tool_machine.h
coregrind/pub_core_scheduler.h
coregrind/pub_core_stacks.h
- document start/end semantic in various functions
also in pub_tool_machine.h:
- replaces unclear 'bottommost address' by 'lowest address'
(unclear as stack bottom is or at least can be interpreted as
the 'functional' bottom of the stack, which is the highest
address for 'stack growing downwards').
coregrind/pub_core_initimg.h
replace unclear clstack_top by clstack_end
coregrind/m_main.c
updated to clstack_end
coregrind/pub_core_threadstate.h
renamed client_stack_highest_word to client_stack_highest_byte
coregrind/m_scheduler/scheduler.c
computes client_stack_highest_byte as the highest addressable byte
Update comments in call to VG_(show_sched_status)
coregrind/m_machine.c
coregrind/m_stacktrace.c
updated to client_stack_highest_byte, and switched
stack_lowest/highest_word to stack_lowest/highest_byte accordingly
coregrind/m_stacks.c
clarify semantic of start/end,
added a comment to indicate why we invert start/end in register call
(note that the code find_stack_by_addr was already assuming that
end was included as the checks were doing e.g.
sp >= i->start && sp <= i->end
coregrind/pub_core_clientstate.h
coregrind/m_clientstate.c
renames Addr VG_(clstk_base) to Addr VG_(clstk_start_base)
(start to indicate it is the lowest address, base suffix kept
to indicate it is the initial lowest address).
coregrind/m_initimg/initimg-darwin.c
updated to VG_(clstk_start_base)
replace unclear iicii.clstack_top by iicii.clstack_end
updated clstack_max_size computation according to both bounds included.
coregrind/m_initimg/initimg-linux.c
updated to VG_(clstk_start_base)
updated VG_(clstk_end) computation according to both bounds included.
replace unclear iicii.clstack_top by iicii.clstack_end
coregrind/pub_core_aspacemgr.h
extern Addr VG_(am_startup) : clarify semantic of the returned value
coregrind/m_aspacemgr/aspacemgr-linux.c
removed a copy of a comment that was already in pub_core_aspacemgr.h
(avoid double maintenance)
renamed unclear suggested_clstack_top to suggested_clstack_end
(note that here, it looks like suggested_clstack_top was already
the last addressable byte)
* factorisation of the stack guessing and registration causes
mechanical changes in the following files:
coregrind/m_syswrap/syswrap-ppc64-linux.c
coregrind/m_syswrap/syswrap-x86-darwin.c
coregrind/m_syswrap/syswrap-amd64-linux.c
coregrind/m_syswrap/syswrap-arm-linux.c
coregrind/m_syswrap/syswrap-generic.c
coregrind/m_syswrap/syswrap-mips64-linux.c
coregrind/m_syswrap/syswrap-ppc32-linux.c
coregrind/m_syswrap/syswrap-amd64-darwin.c
coregrind/m_syswrap/syswrap-mips32-linux.c
coregrind/m_syswrap/priv_syswrap-generic.h
coregrind/m_syswrap/syswrap-x86-linux.c
coregrind/m_syswrap/syswrap-s390x-linux.c
coregrind/m_syswrap/syswrap-darwin.c
coregrind/m_syswrap/syswrap-arm64-linux.c
Some files to look at more in details:
syswrap-darwin.c : the handling of sysctl(kern.usrstack) looked
buggy to me, and has probably be made correct by the fact that
VG_(clstk_end) is now the last addressable byte. However,unsure
about this, as I could not find any documentation about
sysctl(kern.usrstack). I only find several occurences on the web,
showing that the result of this is page aligned, which I guess
means it must be 1+ the last addressable byte.
syswrap-x86-darwin.c and syswrap-amd64-darwin.c
I suspect the code that was computing client_stack_highest_word
was wrong, and the patch makes it correct.
syswrap-mips64-linux.c
not sure what to do for this code. This is the only code
that was guessing the stack differently from others.
Kept (almost) untouched. To be discussed with mips maintainers.
coregrind/pub_core_libcassert.h
coregrind/m_libcassert.c
* void VG_(show_sched_status):
renamed Bool valgrind_stack_usage to Bool stack_usage
if stack_usage, shows both the valgrind stack usage and
the client stack boundaries
coregrind/m_scheduler/scheduler.c
coregrind/m_gdbserver/server.c
coregrind/m_gdbserver/remote-utils.c
Updated comments in callers to VG_(show_sched_status)
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@14392
124 lines
5.0 KiB
C
124 lines
5.0 KiB
C
|
|
/*--------------------------------------------------------------------*/
|
|
/*--- The scheduler. pub_core_scheduler.h ---*/
|
|
/*--------------------------------------------------------------------*/
|
|
|
|
/*
|
|
This file is part of Valgrind, a dynamic binary instrumentation
|
|
framework.
|
|
|
|
Copyright (C) 2000-2013 Julian Seward
|
|
jseward@acm.org
|
|
|
|
This program is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License as
|
|
published by the Free Software Foundation; either version 2 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
|
|
02111-1307, USA.
|
|
|
|
The GNU General Public License is contained in the file COPYING.
|
|
*/
|
|
|
|
#ifndef __PUB_CORE_SCHEDULER_H
|
|
#define __PUB_CORE_SCHEDULER_H
|
|
|
|
#include "pub_core_basics.h" // VG_ macro
|
|
#include "pub_core_threadstate.h" // VgSchedReturnCode
|
|
|
|
//--------------------------------------------------------------------
|
|
// PURPOSE: This module is the scheduler, which is the main loop
|
|
// controlling the running of all the program's threads.
|
|
// It's at the centre of everything.
|
|
//--------------------------------------------------------------------
|
|
|
|
/* Allocate a new ThreadState */
|
|
extern ThreadId VG_(alloc_ThreadState)(void);
|
|
|
|
/* A thread exits. tid must currently be running. */
|
|
extern void VG_(exit_thread)(ThreadId tid);
|
|
|
|
/* If 'tid' is blocked in a syscall, send it SIGVGKILL so as to get it
|
|
out of the syscall and onto doing the next thing, whatever that is.
|
|
If it isn't blocked in a syscall, has no effect on the thread. */
|
|
extern void VG_(get_thread_out_of_syscall)(ThreadId tid);
|
|
|
|
/* Nuke all threads except tid. */
|
|
extern void VG_(nuke_all_threads_except) ( ThreadId me,
|
|
VgSchedReturnCode reason );
|
|
|
|
/* Make a thread the running thread. The thread must previously been
|
|
sleeping, and not holding the CPU lock. This will set the
|
|
thread state to VgTs_Runnable, and the thread will attempt to take
|
|
the CPU lock. By the time it returns, tid will be the running
|
|
thread. */
|
|
extern void VG_(acquire_BigLock) ( ThreadId tid, const HChar* who );
|
|
|
|
/* Simple version, which simply acquires the lock, but does not mess
|
|
with the guest state in the same way as the non _LL version
|
|
does. */
|
|
extern void VG_(acquire_BigLock_LL) ( const HChar* who );
|
|
|
|
/* Set a thread into a sleeping state. Before the call, the thread
|
|
must be runnable, and holding the CPU lock. When this call
|
|
returns, the thread will be set to the specified sleeping state,
|
|
and will not be holding the CPU lock. Note that another
|
|
thread could be running by the time this call returns, so the
|
|
caller must be careful not to touch any shared state. It is also
|
|
the caller's responsibility to actually block until the thread is
|
|
ready to run again. */
|
|
extern void VG_(release_BigLock) ( ThreadId tid,
|
|
ThreadStatus state, const HChar* who );
|
|
|
|
/* Matching function to acquire_BigLock_LL. */
|
|
extern void VG_(release_BigLock_LL) ( const HChar* who );
|
|
|
|
/* Whether the specified thread owns the big lock. */
|
|
extern Bool VG_(owns_BigLock_LL) ( ThreadId tid );
|
|
|
|
/* Yield the CPU for a while. Drops/acquires the lock using the
|
|
normal (non _LL) functions. */
|
|
extern void VG_(vg_yield)(void);
|
|
|
|
// The scheduler.
|
|
extern VgSchedReturnCode VG_(scheduler) ( ThreadId tid );
|
|
|
|
// Initialise, phase 1. Zero out VG_(threads), decide on the root
|
|
// ThreadId and initialise the bigLock.
|
|
extern ThreadId VG_(scheduler_init_phase1) ( void );
|
|
|
|
// Initialise, phase 2. Is passed the extent of the root thread's
|
|
// client stack end (highest addressable byte) and the root ThreadId
|
|
// decided on by phase 1.
|
|
extern void VG_(scheduler_init_phase2) ( ThreadId main_tid,
|
|
Addr clstack_end,
|
|
SizeT clstack_size );
|
|
|
|
// Allows to disable the polling done to detect vgdb input
|
|
// or to force a poll at next scheduler call.
|
|
extern void VG_(disable_vgdb_poll) (void );
|
|
extern void VG_(force_vgdb_poll) ( void );
|
|
|
|
/* Stats ... */
|
|
extern void VG_(print_scheduler_stats) ( void );
|
|
|
|
/* If False, a fault is Valgrind-internal (ie, a bug) */
|
|
extern Bool VG_(in_generated_code);
|
|
|
|
/* Sanity checks which may be done at any time. The scheduler decides when. */
|
|
extern void VG_(sanity_check_general) ( Bool force_expensive );
|
|
|
|
#endif // __PUB_CORE_SCHEDULER_H
|
|
|
|
/*--------------------------------------------------------------------*/
|
|
/*--- end ---*/
|
|
/*--------------------------------------------------------------------*/
|