1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- File/socket-related libc stuff.          pub_core_libcfile.h ---*/
4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*
7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This file is part of Valgrind, a dynamic binary instrumentation
8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   framework.
9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
10663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng   Copyright (C) 2000-2012 Julian Seward
11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      jseward@acm.org
12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is free software; you can redistribute it and/or
14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   modify it under the terms of the GNU General Public License as
15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   published by the Free Software Foundation; either version 2 of the
16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   License, or (at your option) any later version.
17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is distributed in the hope that it will be useful, but
19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   WITHOUT ANY WARRANTY; without even the implied warranty of
20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   General Public License for more details.
22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   You should have received a copy of the GNU General Public License
24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   along with this program; if not, write to the Free Software
25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   02111-1307, USA.
27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The GNU General Public License is contained in the file COPYING.
29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_CORE_LIBCFILE_H
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_CORE_LIBCFILE_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//--------------------------------------------------------------------
35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: This module contains all the libc code that relates to
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// files and sockets:  opening, reading, writing, etc.
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// To use, you must first include: pub_core_vki.h
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//--------------------------------------------------------------------
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_libcfile.h"
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Move an fd into the Valgrind-safe range */
43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(safe_fd) ( Int oldfd );
44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(fcntl)   ( Int fd, Int cmd, Addr arg );
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Convert an fd into a filename */
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(resolve_filename) ( Int fd, HChar* buf, Int n_buf );
48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Return the size of a file, or -1 in case of error */
50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Long VG_(fsize) ( Int fd );
51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Is the file a directory? */
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(is_dir) ( const HChar* f );
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Default destination port to be used in logging over a network, if
56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   none specified. */
57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_CLO_DEFAULT_LOGPORT 1500
58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(connect_via_socket)( UChar* str );
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt   VG_(htonl) ( UInt x );
62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt   VG_(ntohl) ( UInt x );
63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UShort VG_(htons) ( UShort x );
64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UShort VG_(ntohs) ( UShort x );
65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(socket) ( Int domain, Int type, Int protocol );
67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(write_socket)( Int sd, void *msg, Int count );
69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(getsockname) ( Int sd, struct vki_sockaddr *name, Int *namelen );
70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(getpeername) ( Int sd, struct vki_sockaddr *name, Int *namelen );
71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(getsockopt)  ( Int sd, Int level, Int optname,
72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              void *optval, Int *optlen );
73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(access) ( const HChar* path, Bool irusr, Bool iwusr,
75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                            Bool ixusr );
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Is the file executable?  Returns: 0 = success, non-0 is failure */
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(check_executable)(/*OUT*/Bool* is_setuid,
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                                 const HChar* f, Bool allow_setuid);
80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
81b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* DDD: Note this moves (or at least, is believed to move) the file
82b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   pointer on Linux but doesn't on Darwin.  This inconsistency should
83b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   be fixed.  (In other words, why isn't the Linux version implemented
84b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   in terms of pread()?) */
85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(pread) ( Int fd, void* buf, Int count, OffT offset );
86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Create and open (-rw------) a tmp file name incorporating said arg.
88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Returns -1 on failure, else the fd of the file.  If fullname is
89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   non-NULL, the file's name is written into it.  The number of bytes
90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   written is guaranteed not to exceed 64+strlen(part_of_name). */
91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(mkstemp) ( HChar* part_of_name, /*OUT*/HChar* fullname );
92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Record the process' working directory at startup.  Is intended to
94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   be called exactly once, at startup, before the working directory
95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   changes.  Return True for success, False for failure, so that the
96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   caller can bomb out suitably without creating module cycles if
97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   there is a problem.  The saved value can later be acquired by
98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   calling VG_(get_startup_wd) (in pub_tool_libcfile.h). */
99ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(record_startup_wd) ( void );
100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif   // __PUB_CORE_LIBCFILE_H
102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                                          ---*/
105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
106