1
2/*--------------------------------------------------------------------*/
3/*--- System call wrappers, etc.                pub_core_syswrap.h ---*/
4/*--------------------------------------------------------------------*/
5
6/*
7   This file is part of Valgrind, a dynamic binary instrumentation
8   framework.
9
10   Copyright (C) 2000-2017 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_SYSWRAP_H
32#define __PUB_CORE_SYSWRAP_H
33
34#include "pub_core_basics.h"        // VG_ macro
35#include "pub_core_threadstate.h"   // ThreadArchState
36#include "pub_core_tooliface.h"     // CorePart
37
38//--------------------------------------------------------------------
39// PURPOSE: This module contains all the syscall junk:  mostly PRE/POST
40// wrappers, but also the main syscall jacketing code.
41//--------------------------------------------------------------------
42
43// Allocates a stack for the first thread, then runs it,
44// as if the thread had been set up by clone()
45extern void VG_(main_thread_wrapper_NORETURN)(ThreadId tid);
46
47extern void VG_(client_syscall) ( ThreadId tid, UInt trc );
48
49extern void VG_(post_syscall)   ( ThreadId tid );
50
51/* Clear this module's private state for thread 'tid' */
52extern void VG_(clear_syscallInfo) ( Int tid );
53
54// Returns True if the given thread is currently in a system call
55extern Bool VG_(is_in_syscall) ( Int tid );
56
57// Fix up a thread's state when syscall is interrupted by a signal.
58extern void VG_(fixup_guest_state_after_syscall_interrupted)(
59               ThreadId tid,
60               Addr     ip,
61               SysRes   sysret,
62               Bool     restart,
63               struct vki_ucontext *uc
64            );
65
66#if defined(VGO_solaris)
67// Determine if in a blocking syscall.
68extern Bool VG_(is_ip_in_blocking_syscall)(ThreadId tid, Addr ip);
69#endif
70
71// Wait until all other threads are dead
72extern void VG_(reap_threads)(ThreadId self);
73
74// Release resources held by this thread
75extern void VG_(cleanup_thread) ( ThreadArchState* );
76
77/* fd leakage calls. */
78extern void VG_(init_preopened_fds) ( void );
79extern void VG_(show_open_fds) ( const HChar* when );
80
81// When the final thread is done, where shall I call to shutdown the
82// system cleanly?  Is set once at startup (in m_main) and never
83// changes after that.  Is basically a pointer to the exit
84// continuation.  This is all just a nasty hack to avoid calling
85// directly from m_syswrap to m_main at exit, since that would cause
86// m_main to become part of a module cycle, which is silly.
87extern void (* VG_(address_of_m_main_shutdown_actions_NORETURN) )
88            (ThreadId,VgSchedReturnCode);
89
90#if defined(VGO_solaris)
91extern void VG_(save_context)(ThreadId tid, vki_ucontext_t *uc,
92                              CorePart part);
93extern void VG_(restore_context)(ThreadId tid, vki_ucontext_t *uc,
94                                 CorePart part, Bool esp_is_thrptr);
95extern void VG_(syswrap_init)(void);
96extern void VG_(change_mapping_ownership)(Addr addr, Bool once_only);
97extern Bool VG_(setup_client_dataseg)(void);
98extern void VG_(track_client_dataseg)(ThreadId tid);
99#endif
100
101#endif   // __PUB_CORE_SYSWRAP_H
102
103/*--------------------------------------------------------------------*/
104/*--- end                                                          ---*/
105/*--------------------------------------------------------------------*/
106
107