1 
2 /*--------------------------------------------------------------------*/
3 /*--- File/socket-related libc stuff.          pub_core_libcfile.h ---*/
4 /*--------------------------------------------------------------------*/
5 
6 /*
7    This file is part of Valgrind, a dynamic binary instrumentation
8    framework.
9 
10    Copyright (C) 2000-2015 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_LIBCFILE_H
32 #define __PUB_CORE_LIBCFILE_H
33 
34 //--------------------------------------------------------------------
35 // PURPOSE: This module contains all the libc code that relates to
36 // files and sockets:  opening, reading, writing, etc.
37 // To use, you must first include: pub_core_vki.h
38 //--------------------------------------------------------------------
39 
40 #include "pub_tool_libcfile.h"
41 
42 /* Move an fd into the Valgrind-safe range */
43 extern Int VG_(safe_fd) ( Int oldfd );
44 extern Int VG_(fcntl)   ( Int fd, Int cmd, Addr arg );
45 
46 /* Convert an fd into a filename */
47 extern Bool VG_(resolve_filename) ( Int fd, const HChar** buf );
48 
49 /* Return the size of a file, or -1 in case of error */
50 extern Long VG_(fsize) ( Int fd );
51 
52 /* Lookup an extended attribute for a file */
53 extern SysRes VG_(getxattr) ( const HChar* file_name, const HChar* attr_name,
54                               Addr attr_value, SizeT attr_value_len );
55 
56 /* Is the file a directory? */
57 extern Bool VG_(is_dir) ( const HChar* f );
58 
59 /* Default destination port to be used in logging over a network, if
60    none specified. */
61 #define VG_CLO_DEFAULT_LOGPORT 1500
62 
63 extern Int VG_(connect_via_socket)( const HChar* str );
64 
65 extern UInt   VG_(htonl) ( UInt x );
66 extern UInt   VG_(ntohl) ( UInt x );
67 extern UShort VG_(htons) ( UShort x );
68 extern UShort VG_(ntohs) ( UShort x );
69 
70 extern Int VG_(socket) ( Int domain, Int type, Int protocol );
71 
72 extern Int VG_(write_socket)( Int sd, const void *msg, Int count );
73 extern Int VG_(getsockname) ( Int sd, struct vki_sockaddr *name, Int *namelen );
74 extern Int VG_(getpeername) ( Int sd, struct vki_sockaddr *name, Int *namelen );
75 extern Int VG_(getsockopt)  ( Int sd, Int level, Int optname,
76                               void *optval, Int *optlen );
77 extern Int VG_(setsockopt)  ( Int sd, Int level, Int optname,
78                               void *optval, Int optlen );
79 
80 extern Int VG_(access) ( const HChar* path, Bool irusr, Bool iwusr,
81                                             Bool ixusr );
82 
83 /* Is the file executable?  Returns: 0 = success, non-0 is failure */
84 extern Int VG_(check_executable)(/*OUT*/Bool* is_setuid,
85                                  const HChar* f, Bool allow_setuid);
86 
87 /* DDD: Note this moves (or at least, is believed to move) the file
88    pointer on Linux but doesn't on Darwin.  This inconsistency should
89    be fixed.  (In other words, why isn't the Linux version implemented
90    in terms of pread()?) */
91 extern SysRes VG_(pread) ( Int fd, void* buf, Int count, OffT offset );
92 
93 /* Size of fullname buffer needed for a call to VG_(mkstemp) with
94    part_of_name having the given part_of_name_len. */
95 extern SizeT VG_(mkstemp_fullname_bufsz) ( SizeT part_of_name_len );
96 
97 /* Create and open (-rw------) a tmp file name incorporating said arg.
98    Returns -1 on failure, else the fd of the file.  The file name is
99    written to the memory pointed to be fullname. The number of bytes written
100    is equal to VG_(mkstemp_fullname_bufsz)(VG_(strlen)(part_of_name)). */
101 extern Int VG_(mkstemp) ( const HChar* part_of_name, /*OUT*/HChar* fullname );
102 
103 /* Record the process' working directory at startup.  Is intended to
104    be called exactly once, at startup, before the working directory
105    changes.  Return True for success, False for failure, so that the
106    caller can bomb out suitably without creating module cycles if
107    there is a problem.  The saved value can later be acquired by
108    calling VG_(get_startup_wd) (in pub_tool_libcfile.h). */
109 extern Bool VG_(record_startup_wd) ( void );
110 
111 #endif   // __PUB_CORE_LIBCFILE_H
112 
113 /*--------------------------------------------------------------------*/
114 /*--- end                                                          ---*/
115 /*--------------------------------------------------------------------*/
116