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 10436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov Copyright (C) 2000-2013 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 52eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov/* Lookup an extended attribute for a file */ 53eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanovextern SysRes VG_(getxattr) ( const HChar* file_name, const HChar* attr_name, Addr attr_value, SizeT attr_value_len ); 54eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Is the file a directory? */ 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(is_dir) ( const HChar* f ); 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Default destination port to be used in logging over a network, if 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown none specified. */ 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define VG_CLO_DEFAULT_LOGPORT 1500 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 62436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Int VG_(connect_via_socket)( const HChar* str ); 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt VG_(htonl) ( UInt x ); 65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UInt VG_(ntohl) ( UInt x ); 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UShort VG_(htons) ( UShort x ); 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern UShort VG_(ntohs) ( UShort x ); 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(socket) ( Int domain, Int type, Int protocol ); 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 71436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Int VG_(write_socket)( Int sd, const void *msg, Int count ); 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(getsockname) ( Int sd, struct vki_sockaddr *name, Int *namelen ); 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(getpeername) ( Int sd, struct vki_sockaddr *name, Int *namelen ); 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(getsockopt) ( Int sd, Int level, Int optname, 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown void *optval, Int *optlen ); 76436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern Int VG_(setsockopt) ( Int sd, Int level, Int optname, 77436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov void *optval, Int optlen ); 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(access) ( const HChar* path, Bool irusr, Bool iwusr, 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Bool ixusr ); 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Is the file executable? Returns: 0 = success, non-0 is failure */ 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(check_executable)(/*OUT*/Bool* is_setuid, 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown const HChar* f, Bool allow_setuid); 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 86b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* DDD: Note this moves (or at least, is believed to move) the file 87b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov pointer on Linux but doesn't on Darwin. This inconsistency should 88b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov be fixed. (In other words, why isn't the Linux version implemented 89b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov in terms of pread()?) */ 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(pread) ( Int fd, void* buf, Int count, OffT offset ); 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 92436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov/* Size of fullname buffer needed for a call to VG_(mkstemp) with 93436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov part_of_name having the given part_of_name_len. */ 94436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern SizeT VG_(mkstemp_fullname_bufsz) ( SizeT part_of_name_len ); 95436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Create and open (-rw------) a tmp file name incorporating said arg. 97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Returns -1 on failure, else the fd of the file. If fullname is 98ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown non-NULL, the file's name is written into it. The number of bytes 99436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov written is equal to VG_(mkstemp_fullname_bufsz)(part_of_name). */ 100ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int VG_(mkstemp) ( HChar* part_of_name, /*OUT*/HChar* fullname ); 101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Record the process' working directory at startup. Is intended to 103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown be called exactly once, at startup, before the working directory 104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown changes. Return True for success, False for failure, so that the 105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown caller can bomb out suitably without creating module cycles if 106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown there is a problem. The saved value can later be acquired by 107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown calling VG_(get_startup_wd) (in pub_tool_libcfile.h). */ 108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(record_startup_wd) ( void ); 109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 110ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_CORE_LIBCFILE_H 111ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 112ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 113ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 114ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 115