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