1 {-# OPTIONS -fno-implicit-prelude #-}
3 -----------------------------------------------------------------------------
5 -- Module : System.Posix.Internals
6 -- Copyright : (c) The University of Glasgow, 1992-2002
7 -- License : see libraries/base/LICENSE
9 -- Maintainer : cvs-ghc@haskell.org
10 -- Stability : internal
11 -- Portability : non-portable
13 -- POSIX support layer for the standard libraries.
14 -- This library is built on *every* platform, including Win32.
16 -- Non-posix compliant in order to support the following features:
17 -- * S_ISSOCK (no sockets in POSIX)
19 -----------------------------------------------------------------------------
22 module System.Posix.Internals where
27 import System.Posix.Types
35 #ifdef __GLASGOW_HASKELL__
45 import Hugs.Prelude (IOException(..), IOErrorType(..))
47 {-# CBITS PrelIOUtils.c dirUtils.c consUtils.c #-}
51 -- ---------------------------------------------------------------------------
69 #ifndef __GLASGOW_HASKELL__
73 -- ---------------------------------------------------------------------------
74 -- stat()-related stuff
76 fdFileSize :: Int -> IO Integer
78 allocaBytes sizeof_stat $ \ p_stat -> do
79 throwErrnoIfMinus1Retry "fileSize" $
80 c_fstat (fromIntegral fd) p_stat
81 c_mode <- st_mode p_stat :: IO CMode
82 if not (s_isreg c_mode)
85 c_size <- st_size p_stat :: IO COff
86 return (fromIntegral c_size)
88 data FDType = Directory | Stream | RegularFile
91 fileType :: FilePath -> IO FDType
93 allocaBytes sizeof_stat $ \ p_stat -> do
94 withCString file $ \p_file -> do
95 throwErrnoIfMinus1Retry "fileType" $
99 -- NOTE: On Win32 platforms, this will only work with file descriptors
100 -- referring to file handles. i.e., it'll fail for socket FDs.
101 fdType :: Int -> IO FDType
103 allocaBytes sizeof_stat $ \ p_stat -> do
104 throwErrnoIfMinus1Retry "fdType" $
105 c_fstat (fromIntegral fd) p_stat
108 statGetType p_stat = do
109 c_mode <- st_mode p_stat :: IO CMode
111 _ | s_isdir c_mode -> return Directory
112 | s_isfifo c_mode || s_issock c_mode || s_ischr c_mode
114 | s_isreg c_mode -> return RegularFile
115 | otherwise -> ioError ioe_unknownfiletype
118 ioe_unknownfiletype = IOError Nothing UnsupportedOperation "fdType"
119 "unknown file type" Nothing
121 -- It isn't clear whether ftruncate is POSIX or not (I've read several
122 -- manpages and they seem to conflict), so we truncate using open/2.
123 fileTruncate :: FilePath -> IO ()
124 fileTruncate file = do
125 let flags = o_WRONLY .|. o_TRUNC
126 withCString file $ \file_cstr -> do
127 fd <- fromIntegral `liftM`
128 throwErrnoIfMinus1Retry "fileTruncate"
129 (c_open file_cstr (fromIntegral flags) 0o666)
133 #if defined(mingw32_TARGET_OS) || defined(__MINGW32__)
134 closeFd :: Bool -> CInt -> IO CInt
136 | isStream = c_closesocket fd
137 | otherwise = c_close fd
139 foreign import stdcall unsafe "HsBase.h closesocket"
140 c_closesocket :: CInt -> IO CInt
143 fdGetMode :: Int -> IO IOMode
145 #if defined(mingw32_TARGET_OS) || defined(__MINGW32__)
146 flags1 <- throwErrnoIfMinus1Retry "fdGetMode"
147 (c__setmode (fromIntegral fd) (fromIntegral o_WRONLY))
148 flags <- throwErrnoIfMinus1Retry "fdGetMode"
149 (c__setmode (fromIntegral fd) (fromIntegral flags1))
151 flags <- throwErrnoIfMinus1Retry "fdGetMode"
152 (c_fcntl_read (fromIntegral fd) const_f_getfl)
155 wH = (flags .&. o_WRONLY) /= 0
156 aH = (flags .&. o_APPEND) /= 0
157 rwH = (flags .&. o_RDWR) /= 0
160 | wH && aH = AppendMode
162 | rwH = ReadWriteMode
163 | otherwise = ReadMode
167 -- ---------------------------------------------------------------------------
168 -- Terminal-related stuff
170 fdIsTTY :: Int -> IO Bool
171 fdIsTTY fd = c_isatty (fromIntegral fd) >>= return.toBool
173 #if defined(HTYPE_TCFLAG_T)
175 setEcho :: Int -> Bool -> IO ()
177 tcSetAttr fd $ \ p_tios -> do
178 c_lflag <- c_lflag p_tios :: IO CTcflag
180 | on = c_lflag .|. fromIntegral const_echo
181 | otherwise = c_lflag .&. complement (fromIntegral const_echo)
182 poke_c_lflag p_tios (new_c_lflag :: CTcflag)
184 getEcho :: Int -> IO Bool
186 tcSetAttr fd $ \ p_tios -> do
187 c_lflag <- c_lflag p_tios :: IO CTcflag
188 return ((c_lflag .&. fromIntegral const_echo) /= 0)
190 setCooked :: Int -> Bool -> IO ()
191 setCooked fd cooked =
192 tcSetAttr fd $ \ p_tios -> do
194 -- turn on/off ICANON
195 c_lflag <- c_lflag p_tios :: IO CTcflag
196 let new_c_lflag | cooked = c_lflag .|. (fromIntegral const_icanon)
197 | otherwise = c_lflag .&. complement (fromIntegral const_icanon)
198 poke_c_lflag p_tios (new_c_lflag :: CTcflag)
200 -- set VMIN & VTIME to 1/0 respectively
201 when (not cooked) $ do
202 c_cc <- ptr_c_cc p_tios
203 let vmin = (c_cc `plusPtr` (fromIntegral const_vmin)) :: Ptr Word8
204 vtime = (c_cc `plusPtr` (fromIntegral const_vtime)) :: Ptr Word8
208 tcSetAttr :: FD -> (Ptr CTermios -> IO a) -> IO a
209 tcSetAttr fd fun = do
210 allocaBytes sizeof_termios $ \p_tios -> do
211 throwErrnoIfMinus1Retry "tcSetAttr"
212 (c_tcgetattr (fromIntegral fd) p_tios)
214 #ifdef __GLASGOW_HASKELL__
215 -- Save a copy of termios, if this is a standard file descriptor.
216 -- These terminal settings are restored in hs_exit().
218 p <- get_saved_termios fd
219 when (p == nullPtr) $ do
220 saved_tios <- mallocBytes sizeof_termios
221 copyBytes saved_tios p_tios sizeof_termios
222 set_saved_termios fd saved_tios
225 -- tcsetattr() when invoked by a background process causes the process
226 -- to be sent SIGTTOU regardless of whether the process has TOSTOP set
227 -- in its terminal flags (try it...). This function provides a
228 -- wrapper which temporarily blocks SIGTTOU around the call, making it
230 allocaBytes sizeof_sigset_t $ \ p_sigset -> do
231 allocaBytes sizeof_sigset_t $ \ p_old_sigset -> do
232 c_sigemptyset p_sigset
233 c_sigaddset p_sigset const_sigttou
234 c_sigprocmask const_sig_block p_sigset p_old_sigset
235 r <- fun p_tios -- do the business
236 throwErrnoIfMinus1Retry_ "tcSetAttr" $
237 c_tcsetattr (fromIntegral fd) const_tcsanow p_tios
238 c_sigprocmask const_sig_setmask p_old_sigset nullPtr
241 #ifdef __GLASGOW_HASKELL__
242 foreign import ccall unsafe "HsBase.h __hscore_get_saved_termios"
243 get_saved_termios :: Int -> IO (Ptr CTermios)
245 foreign import ccall unsafe "HsBase.h __hscore_set_saved_termios"
246 set_saved_termios :: Int -> (Ptr CTermios) -> IO ()
251 -- 'raw' mode for Win32 means turn off 'line input' (=> buffering and
252 -- character translation for the console.) The Win32 API for doing
253 -- this is GetConsoleMode(), which also requires echoing to be disabled
254 -- when turning off 'line input' processing. Notice that turning off
255 -- 'line input' implies enter/return is reported as '\r' (and it won't
256 -- report that character until another character is input..odd.) This
257 -- latter feature doesn't sit too well with IO actions like IO.hGetLine..
258 -- consider yourself warned.
259 setCooked :: Int -> Bool -> IO ()
260 setCooked fd cooked = do
261 x <- set_console_buffering (fromIntegral fd) (if cooked then 1 else 0)
263 then ioException (ioe_unk_error "setCooked" "failed to set buffering")
266 ioe_unk_error loc msg
267 = IOError Nothing OtherError loc msg Nothing
269 -- Note: echoing goes hand in hand with enabling 'line input' / raw-ness
270 -- for Win32 consoles, hence setEcho ends up being the inverse of setCooked.
271 setEcho :: Int -> Bool -> IO ()
273 x <- set_console_echo (fromIntegral fd) (if on then 1 else 0)
275 then ioException (ioe_unk_error "setEcho" "failed to set echoing")
278 getEcho :: Int -> IO Bool
280 r <- get_console_echo (fromIntegral fd)
282 then ioException (ioe_unk_error "getEcho" "failed to get echoing")
285 foreign import ccall unsafe "consUtils.h set_console_buffering__"
286 set_console_buffering :: CInt -> CInt -> IO CInt
288 foreign import ccall unsafe "consUtils.h set_console_echo__"
289 set_console_echo :: CInt -> CInt -> IO CInt
291 foreign import ccall unsafe "consUtils.h get_console_echo__"
292 get_console_echo :: CInt -> IO CInt
296 -- ---------------------------------------------------------------------------
297 -- Turning on non-blocking for a file descriptor
299 #if !defined(mingw32_TARGET_OS) && !defined(__MINGW32__)
301 setNonBlockingFD fd = do
302 flags <- throwErrnoIfMinus1Retry "setNonBlockingFD"
303 (c_fcntl_read (fromIntegral fd) const_f_getfl)
304 -- An error when setting O_NONBLOCK isn't fatal: on some systems
305 -- there are certain file handles on which this will fail (eg. /dev/null
306 -- on FreeBSD) so we throw away the return code from fcntl_write.
307 c_fcntl_write (fromIntegral fd) const_f_setfl (flags .|. o_NONBLOCK)
310 -- bogus defns for win32
311 setNonBlockingFD fd = return ()
315 -- -----------------------------------------------------------------------------
318 foreign import ccall unsafe "HsBase.h access"
319 c_access :: CString -> CMode -> IO CInt
321 foreign import ccall unsafe "HsBase.h chmod"
322 c_chmod :: CString -> CMode -> IO CInt
324 foreign import ccall unsafe "HsBase.h chdir"
325 c_chdir :: CString -> IO CInt
327 foreign import ccall unsafe "HsBase.h close"
328 c_close :: CInt -> IO CInt
330 foreign import ccall unsafe "HsBase.h closedir"
331 c_closedir :: Ptr CDir -> IO CInt
333 foreign import ccall unsafe "HsBase.h creat"
334 c_creat :: CString -> CMode -> IO CInt
336 foreign import ccall unsafe "HsBase.h dup"
337 c_dup :: CInt -> IO CInt
339 foreign import ccall unsafe "HsBase.h dup2"
340 c_dup2 :: CInt -> CInt -> IO CInt
342 foreign import ccall unsafe "HsBase.h fstat"
343 c_fstat :: CInt -> Ptr CStat -> IO CInt
345 foreign import ccall unsafe "HsBase.h getcwd"
346 c_getcwd :: Ptr CChar -> CInt -> IO (Ptr CChar)
348 foreign import ccall unsafe "HsBase.h isatty"
349 c_isatty :: CInt -> IO CInt
351 foreign import ccall unsafe "HsBase.h lseek"
352 c_lseek :: CInt -> COff -> CInt -> IO COff
354 foreign import ccall unsafe "HsBase.h __hscore_lstat"
355 lstat :: CString -> Ptr CStat -> IO CInt
357 foreign import ccall unsafe "HsBase.h open"
358 c_open :: CString -> CInt -> CMode -> IO CInt
360 foreign import ccall unsafe "HsBase.h opendir"
361 c_opendir :: CString -> IO (Ptr CDir)
363 foreign import ccall unsafe "HsBase.h __hscore_mkdir"
364 mkdir :: CString -> CInt -> IO CInt
366 foreign import ccall unsafe "HsBase.h read"
367 c_read :: CInt -> Ptr CChar -> CSize -> IO CSsize
369 foreign import ccall unsafe "HsBase.h readdir"
370 c_readdir :: Ptr CDir -> IO (Ptr CDirent)
372 foreign import ccall unsafe "dirUtils.h __hscore_renameFile"
373 c_rename :: CString -> CString -> IO CInt
375 foreign import ccall unsafe "HsBase.h rewinddir"
376 c_rewinddir :: Ptr CDir -> IO ()
378 foreign import ccall unsafe "HsBase.h rmdir"
379 c_rmdir :: CString -> IO CInt
381 foreign import ccall unsafe "HsBase.h stat"
382 c_stat :: CString -> Ptr CStat -> IO CInt
384 foreign import ccall unsafe "HsBase.h umask"
385 c_umask :: CMode -> IO CMode
387 foreign import ccall unsafe "HsBase.h write"
388 c_write :: CInt -> Ptr CChar -> CSize -> IO CSsize
390 foreign import ccall unsafe "HsBase.h unlink"
391 c_unlink :: CString -> IO CInt
393 #if !defined(mingw32_TARGET_OS) && !defined(__MINGW32__)
394 foreign import ccall unsafe "HsBase.h fcntl"
395 c_fcntl_read :: CInt -> CInt -> IO CInt
397 foreign import ccall unsafe "HsBase.h fcntl"
398 c_fcntl_write :: CInt -> CInt -> CInt -> IO CInt
400 foreign import ccall unsafe "HsBase.h fcntl"
401 c_fcntl_lock :: CInt -> CInt -> Ptr CFLock -> IO CInt
403 foreign import ccall unsafe "HsBase.h fork"
406 foreign import ccall unsafe "HsBase.h getpid"
409 foreign import ccall unsafe "HsBase.h link"
410 c_link :: CString -> CString -> IO CInt
412 foreign import ccall unsafe "HsBase.h mkfifo"
413 c_mkfifo :: CString -> CMode -> IO CInt
415 foreign import ccall unsafe "HsBase.h pipe"
416 c_pipe :: Ptr CInt -> IO CInt
418 foreign import ccall unsafe "HsBase.h __hscore_sigemptyset"
419 c_sigemptyset :: Ptr CSigset -> IO CInt
421 foreign import ccall unsafe "HsBase.h __hscore_sigaddset"
422 c_sigaddset :: Ptr CSigset -> CInt -> IO CInt
424 foreign import ccall unsafe "HsBase.h sigprocmask"
425 c_sigprocmask :: CInt -> Ptr CSigset -> Ptr CSigset -> IO CInt
427 foreign import ccall unsafe "HsBase.h tcgetattr"
428 c_tcgetattr :: CInt -> Ptr CTermios -> IO CInt
430 foreign import ccall unsafe "HsBase.h tcsetattr"
431 c_tcsetattr :: CInt -> CInt -> Ptr CTermios -> IO CInt
433 foreign import ccall unsafe "HsBase.h utime"
434 c_utime :: CString -> Ptr CUtimbuf -> IO CMode
436 foreign import ccall unsafe "HsBase.h waitpid"
437 c_waitpid :: CPid -> Ptr CInt -> CInt -> IO CPid
439 foreign import ccall unsafe "HsBase.h _setmode"
440 c__setmode :: CInt -> CInt -> IO CInt
442 -- /* Set "stdin" to have binary mode: */
443 -- result = _setmode( _fileno( stdin ), _O_BINARY );
444 -- if( result == -1 )
445 -- perror( "Cannot set mode" );
447 -- printf( "'stdin' successfully changed to binary mode\n" );
450 -- traversing directories
451 foreign import ccall unsafe "dirUtils.h __hscore_readdir"
452 readdir :: Ptr CDir -> Ptr (Ptr CDirent) -> IO CInt
454 foreign import ccall unsafe "HsBase.h __hscore_free_dirent"
455 freeDirEnt :: Ptr CDirent -> IO ()
457 foreign import ccall unsafe "HsBase.h __hscore_end_of_dir"
460 foreign import ccall unsafe "HsBase.h __hscore_d_name"
461 d_name :: Ptr CDirent -> IO CString
464 foreign import ccall unsafe "HsBase.h __hscore_o_rdonly" o_RDONLY :: CInt
465 foreign import ccall unsafe "HsBase.h __hscore_o_wronly" o_WRONLY :: CInt
466 foreign import ccall unsafe "HsBase.h __hscore_o_rdwr" o_RDWR :: CInt
467 foreign import ccall unsafe "HsBase.h __hscore_o_append" o_APPEND :: CInt
468 foreign import ccall unsafe "HsBase.h __hscore_o_creat" o_CREAT :: CInt
469 foreign import ccall unsafe "HsBase.h __hscore_o_excl" o_EXCL :: CInt
470 foreign import ccall unsafe "HsBase.h __hscore_o_trunc" o_TRUNC :: CInt
473 foreign import ccall unsafe "HsBase.h __hscore_o_noctty" o_NOCTTY :: CInt
474 foreign import ccall unsafe "HsBase.h __hscore_o_nonblock" o_NONBLOCK :: CInt
475 foreign import ccall unsafe "HsBase.h __hscore_o_binary" o_BINARY :: CInt
477 foreign import ccall unsafe "HsBase.h __hscore_s_isreg" s_isreg :: CMode -> Bool
478 foreign import ccall unsafe "HsBase.h __hscore_s_ischr" s_ischr :: CMode -> Bool
479 foreign import ccall unsafe "HsBase.h __hscore_s_isblk" s_isblk :: CMode -> Bool
480 foreign import ccall unsafe "HsBase.h __hscore_s_isdir" s_isdir :: CMode -> Bool
481 foreign import ccall unsafe "HsBase.h __hscore_s_isfifo" s_isfifo :: CMode -> Bool
483 foreign import ccall unsafe "HsBase.h __hscore_sizeof_stat" sizeof_stat :: Int
484 foreign import ccall unsafe "HsBase.h __hscore_st_mtime" st_mtime :: Ptr CStat -> IO CTime
485 foreign import ccall unsafe "HsBase.h __hscore_st_size" st_size :: Ptr CStat -> IO COff
486 foreign import ccall unsafe "HsBase.h __hscore_st_mode" st_mode :: Ptr CStat -> IO CMode
488 foreign import ccall unsafe "HsBase.h __hscore_echo" const_echo :: CInt
489 foreign import ccall unsafe "HsBase.h __hscore_tcsanow" const_tcsanow :: CInt
490 foreign import ccall unsafe "HsBase.h __hscore_icanon" const_icanon :: CInt
491 foreign import ccall unsafe "HsBase.h __hscore_vmin" const_vmin :: CInt
492 foreign import ccall unsafe "HsBase.h __hscore_vtime" const_vtime :: CInt
493 foreign import ccall unsafe "HsBase.h __hscore_sigttou" const_sigttou :: CInt
494 foreign import ccall unsafe "HsBase.h __hscore_sig_block" const_sig_block :: CInt
495 foreign import ccall unsafe "HsBase.h __hscore_sig_setmask" const_sig_setmask :: CInt
496 foreign import ccall unsafe "HsBase.h __hscore_f_getfl" const_f_getfl :: CInt
497 foreign import ccall unsafe "HsBase.h __hscore_f_setfl" const_f_setfl :: CInt
499 #if defined(HTYPE_TCFLAG_T)
500 foreign import ccall unsafe "HsBase.h __hscore_sizeof_termios" sizeof_termios :: Int
501 foreign import ccall unsafe "HsBase.h __hscore_sizeof_sigset_t" sizeof_sigset_t :: Int
503 foreign import ccall unsafe "HsBase.h __hscore_lflag" c_lflag :: Ptr CTermios -> IO CTcflag
504 foreign import ccall unsafe "HsBase.h __hscore_poke_lflag" poke_c_lflag :: Ptr CTermios -> CTcflag -> IO ()
505 foreign import ccall unsafe "HsBase.h __hscore_ptr_c_cc" ptr_c_cc :: Ptr CTermios -> IO (Ptr Word8)
508 #if !defined(mingw32_TARGET_OS) && !defined(__MINGW32__)
509 foreign import ccall unsafe "HsBase.h __hscore_s_issock" s_issock :: CMode -> Bool
511 s_issock :: CMode -> Bool
512 s_issock cmode = False