nasmlib/file.h

   1 /* ----------------------------------------------------------------------- *
   2  *
   3  *   Copyright 1996-2017 The NASM Authors - All Rights Reserved
   4  *   See the file AUTHORS included with the NASM distribution for
   5  *   the specific copyright holders.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following
   9  *   conditions are met:
  10  *
  11  *   * Redistributions of source code must retain the above copyright
  12  *     notice, this list of conditions and the following disclaimer.
  13  *   * Redistributions in binary form must reproduce the above
  14  *     copyright notice, this list of conditions and the following
  15  *     disclaimer in the documentation and/or other materials provided
  16  *     with the distribution.
  17  *
  18  *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  19  *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  20  *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21  *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22  *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  25  *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  30  *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * ----------------------------------------------------------------------- */
  33
  34 #ifndef NASMLIB_FILE_H
  35 #define NASMLIB_FILE_H
  36
  37 #include "compiler.h"
  38 #include "nasmlib.h"
  39 #include "error.h"
  40
  41 #include <errno.h>
  42
  43 #ifdef HAVE_FCNTL_H
  44 # include <fcntl.h>
  45 #endif
  46 #ifdef HAVE_SYS_TYPES_H
  47 #endif
  48 #ifdef HAVE_SYS_STAT_H
  49 # include <sys/stat.h>
  50 #endif
  51 #ifdef HAVE_IO_H
  52 # include <io.h>
  53 #endif
  54 #ifdef HAVE_UNISTD_H
  55 # include <unistd.h>
  56 #endif
  57 #ifdef HAVE_SYS_MMAN_H
  58 # include <sys/mman.h>
  59 #endif
  60
  61 #ifndef R_OK
  62 # define R_OK 4                 /* Classic Unix constant, same on Windows */
  63 #endif
  64
  65 /* Can we adjust the file size without actually writing all the bytes? */
  66 #ifdef HAVE__CHSIZE_S
  67 # define os_ftruncate(fd,size)  _chsize_s(fd,size)
  68 #elif defined(HAVE__CHSIZE)
  69 # define os_ftruncate(fd,size)  _chsize(fd,size)
  70 #elif defined(HAVE_FTRUNCATE)
  71 # define os_ftruncate(fd,size)  ftruncate(fd,size)
  72 #endif
  73
  74 /*
  75  * On Windows, we want to use _wfopen(), as fopen() has a much smaller limit
  76  * on the path length that it supports. Furthermore, we want to prefix the
  77  * path name with \\?\ in order to let the Windows kernel know that
  78  * we are not limited to PATH_MAX characters. Thus, we wrap all the functions
  79  * which take filenames...
  80  */
  81 #ifdef _WIN32
  82 # include <wchar.h>
  83 typedef wchar_t *os_filename;
  84 typedef wchar_t  os_fopenflag;
  85
  86 os_filename os_mangle_filename(const char *filename);
  87 static inline void os_free_filename(os_filename filename)
  88 {
  89     nasm_free(filename);
  90 }
  91
  92 # define os_fopen  _wfopen
  93 # define os_access _waccess
  94
  95 /*
  96  * On Win32/64, we have to use the _wstati64() function. Note that
  97  * we can't use _wstat64() without depending on a needlessly new
  98  * version os MSVCRT.
  99  */
 100
 101 typedef struct _stati64 os_struct_stat;
 102
 103 # define os_stat  _wstati64
 104 # define os_fstat _fstati64
 105
 106 /*
 107  * On Win32/64, freopen() and _wfreopen() fails when the mode string
 108  * is with the letter 'b' that represents to set binary mode. On
 109  * POSIX operating systems, the 'b' is ignored, without failure.
 110  */
 111
 112 #include <io.h>
 113 #include <fcntl.h>
 114
 115 static inline void os_set_binary_mode(FILE *f) {
 116     int ret = _setmode(_fileno(f), _O_BINARY);
 117
 118     if (ret == -1) {
 119         nasm_fatalf(ERR_NOFILE, "unable to open file: %s",
 120                     strerror(errno));
 121     }
 122 }
 123
 124 #else  /* not _WIN32 */
 125
 126 typedef const char *os_filename;
 127 typedef char os_fopenflag;
 128
 129 static inline os_filename os_mangle_filename(const char *filename)
 130 {
 131     return filename;
 132 }
 133 static inline void os_free_filename(os_filename filename)
 134 {
 135     (void)filename;             /* Nothing to do */
 136 }
 137
 138 static inline void os_set_binary_mode(FILE *f) {
 139     (void)f;
 140 }
 141
 142 # define os_fopen  fopen
 143
 144 #if defined(HAVE_FACCESSAT) && defined(AT_EACCESS)
 145 static inline int os_access(os_filename pathname, int mode)
 146 {
 147     return faccessat(AT_FDCWD, pathname, mode, AT_EACCESS);
 148 }
 149 # define os_access os_access
 150 #elif defined(HAVE_ACCESS)
 151 # define os_access access
 152 #endif
 153
 154 #ifdef HAVE_STRUCT_STAT
 155 typedef struct stat os_struct_stat;
 156 # ifdef HAVE_STAT
 157 #  define os_stat stat
 158 # endif
 159 # ifdef HAVE_FSTAT
 160 #  define os_fstat fstat
 161 # endif
 162 #else
 163 struct dummy_struct_stat {
 164     int st_mode;
 165     int st_size;
 166 };
 167 typedef struct dummy_struct_stat os_struct_stat;
 168 #endif
 169
 170 #endif  /* Not _WIN32 */
 171
 172 #ifdef S_ISREG
 173 /* all good */
 174 #elif defined(HAVE_S_ISREG)
 175 /* exists, but not a macro */
 176 # define S_ISREG S_ISREG
 177 #elif defined(S_IFMT) && defined(S_IFREG)
 178 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
 179 #elif defined(_S_IFMT) && defined(_S_IFREG)
 180 # define S_ISREG(m) (((m) & _S_IFMT) == _S_IFREG)
 181 #endif
 182
 183 #ifdef fileno
 184 /* all good */
 185 #elif defined(HAVE_FILENO)
 186 /* exists, but not a macro */
 187 # define fileno fileno
 188 #elif defined(_fileno) || defined(HAVE__FILENO)
 189 # define fileno _fileno
 190 #endif
 191
 192 #ifndef S_ISREG
 193 # undef os_stat
 194 # undef os_fstat
 195 #endif
 196
 197 /* Disable these functions if they don't support something we need */
 198 #ifndef fileno
 199 # undef os_fstat
 200 # undef os_ftruncate
 201 # undef HAVE_MMAP
 202 #endif
 203
 204 /*
 205  * If we don't have functional versions of these functions,
 206  * stub them out so we don't need so many #ifndefs
 207  */
 208 #ifndef os_stat
 209 static inline int os_stat(os_filename osfname, os_struct_stat *st)
 210 {
 211     (void)osfname;
 212     (void)st;
 213     return -1;
 214 }
 215 #endif
 216
 217 #ifndef os_fstat
 218 static inline int os_fstat(int fd, os_struct_stat *st)
 219 {
 220     (void)osfname;
 221     (void)st;
 222     return -1;
 223 }
 224 #endif
 225
 226 #ifndef S_ISREG
 227 static inline bool S_ISREG(int m)
 228 {
 229     (void)m;
 230     return false;
 231 }
 232 #endif
 233
 234 #endif /* NASMLIB_FILE_H */