Home | History | Annotate | Download | only in m_syswrap
      1 
      2 /*--------------------------------------------------------------------*/
      3 /*--- Private syscalls header.              priv_syswrap-generic.h ---*/
      4 /*--------------------------------------------------------------------*/
      5 
      6 /*
      7    This file is part of Valgrind, a dynamic binary instrumentation
      8    framework.
      9 
     10    Copyright (C) 2000-2012 Julian Seward
     11       jseward (at) 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 __PRIV_SYSWRAP_GENERIC_H
     32 #define __PRIV_SYSWRAP_GENERIC_H
     33 
     34 /* requires #include "priv_types_n_macros.h" */
     35 
     36 
     37 // Return true if address range entirely contained within client
     38 // address space.
     39 extern
     40 Bool ML_(valid_client_addr)(Addr start, SizeT size, ThreadId tid,
     41                             const Char *syscallname);
     42 
     43 /* Handy small function to help stop wrappers from segfaulting when
     44    presented with bogus client addresses.  Is not used for generating
     45    user-visible errors. */
     46 extern Bool ML_(safe_to_deref) ( void* start, SizeT size );
     47 
     48 // Returns True if the signal is OK for the client to use.
     49 extern Bool ML_(client_signal_OK)(Int sigNo);
     50 
     51 // Return true if we're allowed to use or create this fd.
     52 extern
     53 Bool ML_(fd_allowed)(Int fd, const Char *syscallname, ThreadId tid, Bool isNewFD);
     54 
     55 extern void ML_(record_fd_open_named)          (ThreadId tid, Int fd);
     56 extern void ML_(record_fd_open_nameless)       (ThreadId tid, Int fd);
     57 extern void ML_(record_fd_open_with_given_name)(ThreadId tid, Int fd,
     58                                                 char *pathname);
     59 
     60 // Used when killing threads -- we must not kill a thread if it's the thread
     61 // that would do Valgrind's final cleanup and output.
     62 extern
     63 Bool ML_(do_sigkill)(Int pid, Int tgid);
     64 
     65 /* When a client mmap or munmap has been successfully done, both the core
     66    and the tool need to be notified of the new mapping.  Hence this fn. */
     67 extern void
     68 ML_(notify_core_and_tool_of_mmap) ( Addr a, SizeT len, UInt prot,
     69                                     UInt mm_flags, Int fd, Off64T offset );
     70 extern void
     71 ML_(notify_core_and_tool_of_munmap) ( Addr a, SizeT len );
     72 extern void
     73 ML_(notify_core_and_tool_of_mprotect) ( Addr a, SizeT len, Int prot );
     74 
     75 extern void
     76 ML_(buf_and_len_pre_check) ( ThreadId tid, Addr buf_p, Addr buflen_p,
     77                              Char* buf_s, Char* buflen_s );
     78 extern void
     79 ML_(buf_and_len_post_check) ( ThreadId tid, SysRes res,
     80                               Addr buf_p, Addr buflen_p, Char* s );
     81 
     82 /* PRE and POST for unknown ioctls based on ioctl request encoding */
     83 extern
     84 void ML_(PRE_unknown_ioctl)(ThreadId tid, UWord request, UWord arg);
     85 extern
     86 void ML_(POST_unknown_ioctl)(ThreadId tid, UInt res, UWord request, UWord arg);
     87 
     88 
     89 DECL_TEMPLATE(generic, sys_ni_syscall);            // * P -- unimplemented
     90 DECL_TEMPLATE(generic, sys_exit);
     91 DECL_TEMPLATE(generic, sys_fork);
     92 DECL_TEMPLATE(generic, sys_read);
     93 DECL_TEMPLATE(generic, sys_write);
     94 DECL_TEMPLATE(generic, sys_open);
     95 DECL_TEMPLATE(generic, sys_close);
     96 DECL_TEMPLATE(generic, sys_waitpid);
     97 DECL_TEMPLATE(generic, sys_creat);
     98 DECL_TEMPLATE(generic, sys_link);
     99 DECL_TEMPLATE(generic, sys_unlink);
    100 DECL_TEMPLATE(generic, sys_execve);    // (*??) P
    101 DECL_TEMPLATE(generic, sys_chdir);
    102 DECL_TEMPLATE(generic, sys_time);
    103 DECL_TEMPLATE(generic, sys_mknod);
    104 DECL_TEMPLATE(generic, sys_chmod);
    105 DECL_TEMPLATE(generic, sys_getpid);
    106 DECL_TEMPLATE(generic, sys_alarm);
    107 DECL_TEMPLATE(generic, sys_pause);
    108 DECL_TEMPLATE(generic, sys_access);
    109 DECL_TEMPLATE(generic, sys_kill);
    110 DECL_TEMPLATE(generic, sys_rename);
    111 DECL_TEMPLATE(generic, sys_mkdir);
    112 DECL_TEMPLATE(generic, sys_rmdir);
    113 DECL_TEMPLATE(generic, sys_dup);
    114 DECL_TEMPLATE(generic, sys_times);
    115 DECL_TEMPLATE(generic, sys_setpgid);
    116 DECL_TEMPLATE(generic, sys_umask);
    117 DECL_TEMPLATE(generic, sys_dup2);
    118 DECL_TEMPLATE(generic, sys_getppid);
    119 DECL_TEMPLATE(generic, sys_getpgrp);
    120 DECL_TEMPLATE(generic, sys_setsid);
    121 DECL_TEMPLATE(generic, sys_munmap);
    122 DECL_TEMPLATE(generic, sys_truncate);
    123 DECL_TEMPLATE(generic, sys_ftruncate);
    124 DECL_TEMPLATE(generic, sys_fchmod);
    125 DECL_TEMPLATE(generic, sys_msync);
    126 DECL_TEMPLATE(generic, sys_readv);
    127 DECL_TEMPLATE(generic, sys_writev);
    128 DECL_TEMPLATE(generic, sys_getsid);
    129 DECL_TEMPLATE(generic, sys_fdatasync);
    130 DECL_TEMPLATE(generic, sys_mlock);
    131 DECL_TEMPLATE(generic, sys_munlock);
    132 DECL_TEMPLATE(generic, sys_mlockall);
    133 DECL_TEMPLATE(generic, sys_nanosleep);
    134 DECL_TEMPLATE(generic, sys_mremap);    // POSIX, but Linux arg order may be odd
    135 DECL_TEMPLATE(generic, sys_getuid);
    136 DECL_TEMPLATE(generic, sys_getgid);
    137 DECL_TEMPLATE(generic, sys_geteuid);
    138 DECL_TEMPLATE(generic, sys_getegid);
    139 DECL_TEMPLATE(generic, sys_getpgid);
    140 DECL_TEMPLATE(generic, sys_fsync);
    141 DECL_TEMPLATE(generic, sys_wait4);
    142 DECL_TEMPLATE(generic, sys_mprotect);
    143 DECL_TEMPLATE(generic, sys_getcwd);
    144 DECL_TEMPLATE(generic, sys_symlink);
    145 DECL_TEMPLATE(generic, sys_getgroups);
    146 DECL_TEMPLATE(generic, sys_setgroups);             // SVr4, SVID, X/OPEN, 4.3BSD
    147 DECL_TEMPLATE(generic, sys_chown);
    148 DECL_TEMPLATE(generic, sys_setuid);
    149 DECL_TEMPLATE(generic, sys_gettimeofday);
    150 DECL_TEMPLATE(generic, sys_madvise);
    151 
    152 // These ones aren't POSIX, but are in some standard and look reasonably
    153 // generic,  and are the same for all architectures under Linux.
    154 DECL_TEMPLATE(generic, sys_nice);      // SVr4, SVID EXT, AT&T, X/OPEN, BSD 4.3
    155 DECL_TEMPLATE(generic, sys_sync);      // SVr4, SVID, X/OPEN, BSD 4.3
    156 DECL_TEMPLATE(generic, sys_brk);       // 4.3BSD
    157 DECL_TEMPLATE(generic, sys_acct);      // SVR4, non-POSIX
    158 DECL_TEMPLATE(generic, sys_chroot);    // SVr4, SVID, 4.4BSD, X/OPEN
    159 DECL_TEMPLATE(generic, sys_readlink);  // X/OPEN, 4.4BSD
    160 DECL_TEMPLATE(generic, sys_fchdir);    // SVr4, SVID, POSIX, X/OPEN, 4.4BSD
    161 DECL_TEMPLATE(generic, sys_getdents);  // SVr4,SVID
    162 DECL_TEMPLATE(generic, sys_select);    // 4.4BSD
    163 DECL_TEMPLATE(generic, sys_flock);     // 4.4BSD
    164 DECL_TEMPLATE(generic, sys_poll);      // XPG4-UNIX
    165 DECL_TEMPLATE(generic, sys_getrusage); // SVr4, 4.3BSD
    166 DECL_TEMPLATE(generic, sys_stime);	    // SVr4, SVID, X/OPEN
    167 DECL_TEMPLATE(generic, sys_settimeofday); // SVr4, 4.3BSD (non-POSIX)
    168 DECL_TEMPLATE(generic, sys_getpriority);  // SVr4, 4.4BSD
    169 DECL_TEMPLATE(generic, sys_setpriority);  // SVr4, 4.4BSD
    170 DECL_TEMPLATE(generic, sys_setitimer);    // SVr4, 4.4BSD
    171 DECL_TEMPLATE(generic, sys_getitimer);    // SVr4, 4.4BSD
    172 DECL_TEMPLATE(generic, sys_setreuid);     // 4.3BSD
    173 DECL_TEMPLATE(generic, sys_setregid);     // 4.3BSD
    174 DECL_TEMPLATE(generic, sys_fchown);       // SVr4,4.3BSD
    175 DECL_TEMPLATE(generic, sys_setgid);       // SVr4,SVID
    176 DECL_TEMPLATE(generic, sys_utimes);       // 4.3BSD
    177 
    178 // May not be generic for every architecture under Linux.
    179 DECL_TEMPLATE(generic, sys_sigaction);             // (x86) P
    180 
    181 // Funny names, not sure...
    182 DECL_TEMPLATE(generic, sys_newstat);               // * P
    183 DECL_TEMPLATE(generic, sys_newlstat);              // *
    184 DECL_TEMPLATE(generic, sys_newfstat);              // * P (SVr4,BSD4.3)
    185 
    186 // For the remainder, not really sure yet
    187 DECL_TEMPLATE(generic, sys_ptrace);                // (x86?) (almost-P)
    188 DECL_TEMPLATE(generic, sys_setrlimit);             // SVr4, 4.3BSD
    189 DECL_TEMPLATE(generic, sys_old_getrlimit);         // SVr4, 4.3BSD L?
    190 DECL_TEMPLATE(generic, sys_statfs);                // * L?
    191 DECL_TEMPLATE(generic, sys_fstatfs);               // * L?
    192 DECL_TEMPLATE(generic, sys_iopl);                  // (x86/amd64) L
    193 DECL_TEMPLATE(generic, sys_ipc);                   // (x86) L
    194 DECL_TEMPLATE(generic, sys_newuname);              // * P
    195 DECL_TEMPLATE(generic, sys_pread64);               // * (Unix98?)
    196 DECL_TEMPLATE(generic, sys_pwrite64);              // * (Unix98?)
    197 DECL_TEMPLATE(generic, sys_sigaltstack);           // (x86) (XPG4-UNIX)
    198 DECL_TEMPLATE(generic, sys_getpmsg);               // (?) (?)
    199 DECL_TEMPLATE(generic, sys_putpmsg);               // (?) (?)
    200 DECL_TEMPLATE(generic, sys_getrlimit);             // * (?)
    201 DECL_TEMPLATE(generic, sys_truncate64);            // %% (P?)
    202 DECL_TEMPLATE(generic, sys_ftruncate64);           // %% (P?)
    203 DECL_TEMPLATE(generic, sys_lchown);                // * (L?)
    204 DECL_TEMPLATE(generic, sys_mincore);               // * L?
    205 DECL_TEMPLATE(generic, sys_getdents64);            // * (SVr4,SVID?)
    206 DECL_TEMPLATE(generic, sys_statfs64);              // * (?)
    207 DECL_TEMPLATE(generic, sys_fstatfs64);             // * (?)
    208 
    209 
    210 /* ---------------------------------------------------------------------
    211    Wrappers for sockets and ipc-ery.  These are split into standalone
    212    procedures because x86-linux hides them inside multiplexors
    213    (sys_socketcall and sys_ipc).
    214    ------------------------------------------------------------------ */
    215 
    216 #define TId ThreadId
    217 #define UW  UWord
    218 #define SR  SysRes
    219 
    220 extern void   ML_(generic_PRE_sys_socketpair)   ( TId, UW, UW, UW, UW );
    221 extern SysRes ML_(generic_POST_sys_socketpair)  ( TId, SR, UW, UW, UW, UW );
    222 extern SysRes ML_(generic_POST_sys_socket)      ( TId, SR );
    223 extern void   ML_(generic_PRE_sys_bind)         ( TId, UW, UW, UW );
    224 extern void   ML_(generic_PRE_sys_accept)       ( TId, UW, UW, UW );
    225 extern SysRes ML_(generic_POST_sys_accept)      ( TId, SR, UW, UW, UW );
    226 extern void   ML_(generic_PRE_sys_sendto)       ( TId, UW, UW, UW, UW, UW, UW );
    227 extern void   ML_(generic_PRE_sys_send)         ( TId, UW, UW, UW );
    228 extern void   ML_(generic_PRE_sys_recvfrom)     ( TId, UW, UW, UW, UW, UW, UW );
    229 extern void   ML_(generic_POST_sys_recvfrom)    ( TId, SR, UW, UW, UW, UW, UW, UW );
    230 extern void   ML_(generic_PRE_sys_recv)         ( TId, UW, UW, UW );
    231 extern void   ML_(generic_POST_sys_recv)        ( TId, UW, UW, UW, UW );
    232 extern void   ML_(generic_PRE_sys_connect)      ( TId, UW, UW, UW );
    233 extern void   ML_(generic_PRE_sys_setsockopt)   ( TId, UW, UW, UW, UW, UW );
    234 extern void   ML_(generic_PRE_sys_getsockname)  ( TId, UW, UW, UW );
    235 extern void   ML_(generic_POST_sys_getsockname) ( TId, SR, UW, UW, UW );
    236 extern void   ML_(generic_PRE_sys_getpeername)  ( TId, UW, UW, UW );
    237 extern void   ML_(generic_POST_sys_getpeername) ( TId, SR, UW, UW, UW );
    238 extern void   ML_(generic_PRE_sys_sendmsg)      ( TId, Char *, struct vki_msghdr * );
    239 extern void   ML_(generic_PRE_sys_recvmsg)      ( TId, Char *, struct vki_msghdr * );
    240 extern void   ML_(generic_POST_sys_recvmsg)     ( TId, Char *, struct vki_msghdr *, UInt );
    241 
    242 extern void   ML_(generic_PRE_sys_semop)        ( TId, UW, UW, UW );
    243 extern void   ML_(generic_PRE_sys_semtimedop)   ( TId, UW, UW, UW, UW );
    244 extern void   ML_(generic_PRE_sys_semctl)       ( TId, UW, UW, UW, UW );
    245 extern void   ML_(generic_POST_sys_semctl)      ( TId, UW, UW, UW, UW, UW );
    246 extern UWord  ML_(generic_PRE_sys_shmat)        ( TId, UW, UW, UW );
    247 extern void   ML_(generic_POST_sys_shmat)       ( TId, UW, UW, UW, UW );
    248 extern Bool   ML_(generic_PRE_sys_shmdt)        ( TId, UW );
    249 extern void   ML_(generic_POST_sys_shmdt)       ( TId, UW, UW );
    250 extern void   ML_(generic_PRE_sys_shmctl)       ( TId, UW, UW, UW );
    251 extern void   ML_(generic_POST_sys_shmctl)      ( TId, UW, UW, UW, UW );
    252 
    253 extern SysRes ML_(generic_PRE_sys_mmap)         ( TId, UW, UW, UW, UW, UW, Off64T );
    254 
    255 #define PRE_timeval_READ(zzname, zzarg)                         \
    256    do {                                                         \
    257       struct vki_timeval *zztv = (struct vki_timeval *)(zzarg); \
    258       PRE_FIELD_READ(zzname, zztv->tv_sec);                     \
    259       PRE_FIELD_READ(zzname, zztv->tv_usec);                    \
    260    } while (0)
    261 #define PRE_timeval_WRITE(zzname, zzarg)                        \
    262    do {                                                         \
    263       struct vki_timeval *zztv = (struct vki_timeval *)(zzarg); \
    264       PRE_FIELD_WRITE(zzname, zztv->tv_sec);                    \
    265       PRE_FIELD_WRITE(zzname, zztv->tv_usec);                   \
    266    } while (0)
    267 #define POST_timeval_WRITE(zzarg)                               \
    268    do {                                                         \
    269       struct vki_timeval *zztv = (struct vki_timeval *)(zzarg); \
    270       POST_FIELD_WRITE(zztv->tv_sec);                           \
    271       POST_FIELD_WRITE(zztv->tv_usec);                          \
    272    } while (0)
    273 
    274 
    275 #undef TId
    276 #undef UW
    277 #undef SR
    278 
    279 
    280 /////////////////////////////////////////////////////////////////
    281 
    282 
    283 #endif   // __PRIV_SYSWRAP_GENERIC_H
    284 
    285 /*--------------------------------------------------------------------*/
    286 /*--- end                                                          ---*/
    287 /*--------------------------------------------------------------------*/
    288