1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- File/socket-related libc stuff.          pub_tool_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
10b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   Copyright (C) 2000-2011 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_TOOL_LIBCFILE_H
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_TOOL_LIBCFILE_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* ---------------------------------------------------------------------
35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   File-related functions.
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ------------------------------------------------------------------ */
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* To use this file you must first include pub_tool_vki.h. */
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Note that VG_(stat) and VG_(fstat) write to a 'struct vg_stat*' and
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   not a 'struct vki_stat*' or a 'struct vki_stat64*'.  'struct
42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   vg_stat*' is not the same as either of the vki_ versions.  No
43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   specific vki_stat{,64} kernel structure will work and is
44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   consistently available on different architectures on Linux, so we
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   have to use this 'struct vg_stat' impedance-matching type
46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   instead.
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Also note that the fieldnames aren't prefixed with "st_".  This is because
49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   st_atime et al are macros in sys/stat.h on Darwin, and using those names
50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   screws things up.
51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownstruct vg_stat {
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   dev;
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   ino;
55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   nlink;
56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   UInt    mode;
57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   UInt    uid;
58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   UInt    gid;
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   rdev;
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Long    size;
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   blksize;
62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   blocks;
63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   atime;
64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   atime_nsec;
65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   mtime;
66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   mtime_nsec;
67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   ctime;
68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   ULong   ctime_nsec;
69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown};
70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
71b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern SysRes VG_(mknod)  ( const Char* pathname, Int mode, UWord dev );
72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(open)   ( const Char* pathname, Int flags, Int mode );
73b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* fd_open words like the open(2) system call:
74b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov   returns fd if success, -1 otherwise */
75b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern Int VG_(fd_open)  (const Char* pathname, Int flags, Int mode);
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void   VG_(close)  ( Int fd );
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(read)   ( Int fd, void* buf, Int count);
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(write)  ( Int fd, const void* buf, Int count);
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(pipe)   ( Int fd[2] );
80b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern Off64T VG_(lseek)  ( Int fd, Off64T offset, Int whence );
81f0cb39bc6abe181a0abdd1f6c778521ae8497277Evgeniy Stepanovextern Int    VG_(ftruncate) ( Int fd, OffT length );
82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(stat)   ( const Char* file_name, struct vg_stat* buf );
84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(fstat)  ( Int   fd,        struct vg_stat* buf );
85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(dup)    ( Int oldfd );
86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern SysRes VG_(dup2)   ( Int oldfd, Int newfd );
87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(rename) ( const Char* old_name, const Char* new_name );
88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(unlink) ( const Char* file_name );
89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
90b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern Int    VG_(poll) (struct vki_pollfd *fds, Int nfds, Int timeout);
91b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov
92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(readlink)( const Char* path, Char* buf, UInt bufsize );
93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Int    VG_(getdents)( Int fd, struct vki_dirent *dirp, UInt count );
94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char*  VG_(basename)( const Char* path );
96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Char*  VG_(dirname) ( const Char* path );
97ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
98b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* Return the name of a directory for temporary files. */
99b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern const HChar* VG_(tmpdir)(void);
100b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov
101ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Copy the working directory at startup into buf[0 .. size-1], or return
102ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   False if buf is too small. */
103ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern Bool VG_(get_startup_wd) ( Char* buf, SizeT size );
104ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
105ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif   // __PUB_TOOL_LIBCFILE_H
106ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
107ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
108ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                                          ---*/
109ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
110