1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
2 * 2004, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 #define _LARGEFILE64_SOURCE /* ask for stat64 etc */
23 #define _GNU_SOURCE /* ask for LONG_LONG_MAX/LONG_LONG_MIN */
41 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
46 #include <sys/types.h>
48 #include <sys/select.h>
50 #include <full-write.h>
52 #include "libguile/_scm.h"
53 #include "libguile/strings.h"
54 #include "libguile/validate.h"
55 #include "libguile/gc.h"
56 #include "libguile/posix.h"
57 #include "libguile/dynwind.h"
58 #include "libguile/hashtab.h"
60 #include "libguile/fports.h"
62 #if SIZEOF_OFF_T == SIZEOF_INT
63 #define OFF_T_MAX INT_MAX
64 #define OFF_T_MIN INT_MIN
65 #elif SIZEOF_OFF_T == SIZEOF_LONG
66 #define OFF_T_MAX LONG_MAX
67 #define OFF_T_MIN LONG_MIN
68 #elif SIZEOF_OFF_T == SIZEOF_LONG_LONG
69 #define OFF_T_MAX LONG_LONG_MAX
70 #define OFF_T_MIN LONG_LONG_MIN
72 #error Oops, unknown OFF_T size
75 scm_t_bits scm_tc16_fport
;
78 /* default buffer size, used if the O/S won't supply a value. */
79 static const size_t default_buffer_size
= 1024;
81 /* create FPORT buffer with specified sizes (or -1 to use default size or
84 scm_fport_buffer_add (SCM port
, long read_size
, int write_size
)
85 #define FUNC_NAME "scm_fport_buffer_add"
87 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
89 if (read_size
== -1 || write_size
== -1)
92 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
94 scm_t_fport
*fp
= SCM_FSTREAM (port
);
96 default_size
= (fstat (fp
->fdes
, &st
) == -1) ? default_buffer_size
99 default_size
= default_buffer_size
;
102 read_size
= default_size
;
103 if (write_size
== -1)
104 write_size
= default_size
;
107 if (SCM_INPUT_PORT_P (port
) && read_size
> 0)
109 pt
->read_buf
= scm_gc_malloc_pointerless (read_size
, "port buffer");
110 pt
->read_pos
= pt
->read_end
= pt
->read_buf
;
111 pt
->read_buf_size
= read_size
;
115 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
116 pt
->read_buf_size
= 1;
119 if (SCM_OUTPUT_PORT_P (port
) && write_size
> 0)
121 pt
->write_buf
= scm_gc_malloc_pointerless (write_size
, "port buffer");
122 pt
->write_pos
= pt
->write_buf
;
123 pt
->write_buf_size
= write_size
;
127 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
128 pt
->write_buf_size
= 1;
131 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
132 if (read_size
> 0 || write_size
> 0)
133 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) & ~SCM_BUF0
);
135 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) | SCM_BUF0
);
139 SCM_DEFINE (scm_setvbuf
, "setvbuf", 2, 1, 0,
140 (SCM port
, SCM mode
, SCM size
),
141 "Set the buffering mode for @var{port}. @var{mode} can be:\n"
148 "block buffered, using a newly allocated buffer of @var{size} bytes.\n"
149 "If @var{size} is omitted, a default size will be used.\n"
151 #define FUNC_NAME s_scm_setvbuf
159 port
= SCM_COERCE_OUTPORT (port
);
161 SCM_VALIDATE_OPFPORT (1,port
);
162 cmode
= scm_to_int (mode
);
163 if (cmode
!= _IONBF
&& cmode
!= _IOFBF
&& cmode
!= _IOLBF
)
164 scm_out_of_range (FUNC_NAME
, mode
);
168 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) | SCM_BUFLINE
);
173 SCM_SET_CELL_WORD_0 (port
, SCM_CELL_WORD_0 (port
) & ~(scm_t_bits
)SCM_BUFLINE
);
176 if (SCM_UNBNDP (size
))
185 csize
= scm_to_int (size
);
186 if (csize
< 0 || (cmode
== _IONBF
&& csize
> 0))
187 scm_out_of_range (FUNC_NAME
, size
);
190 pt
= SCM_PTAB_ENTRY (port
);
192 if (SCM_INPUT_PORT_P (port
))
194 /* Drain pending input from PORT. Don't use `scm_drain_input' since
195 it returns a string, whereas we want binary input here. */
196 ndrained
= pt
->read_end
- pt
->read_pos
;
197 if (pt
->read_buf
== pt
->putback_buf
)
198 ndrained
+= pt
->saved_read_end
- pt
->saved_read_pos
;
202 drained
= scm_gc_malloc_pointerless (ndrained
, "file port");
203 scm_take_from_input_buffers (port
, drained
, ndrained
);
209 if (SCM_OUTPUT_PORT_P (port
))
212 if (pt
->read_buf
== pt
->putback_buf
)
214 pt
->read_buf
= pt
->saved_read_buf
;
215 pt
->read_pos
= pt
->saved_read_pos
;
216 pt
->read_end
= pt
->saved_read_end
;
217 pt
->read_buf_size
= pt
->saved_read_buf_size
;
219 if (pt
->read_buf
!= &pt
->shortbuf
)
220 scm_gc_free (pt
->read_buf
, pt
->read_buf_size
, "port buffer");
221 if (pt
->write_buf
!= &pt
->shortbuf
)
222 scm_gc_free (pt
->write_buf
, pt
->write_buf_size
, "port buffer");
224 scm_fport_buffer_add (port
, csize
, csize
);
227 /* Put DRAINED back to PORT. */
228 scm_unget_bytes ((unsigned char *) drained
, ndrained
, port
);
230 return SCM_UNSPECIFIED
;
234 /* Move ports with the specified file descriptor to new descriptors,
235 * resetting the revealed count to 0.
238 scm_i_evict_port (void *closure
, SCM port
)
240 int fd
= * (int*) closure
;
242 if (SCM_FPORTP (port
))
247 /* XXX: In some cases, we can encounter a port with no associated ptab
249 p
= SCM_PTAB_ENTRY (port
);
250 fp
= (p
!= NULL
) ? (scm_t_fport
*) p
->stream
: NULL
;
252 if ((fp
!= NULL
) && (fp
->fdes
== fd
))
256 scm_syserror ("scm_evict_ports");
257 scm_set_port_revealed_x (port
, scm_from_int (0));
263 scm_evict_ports (int fd
)
265 scm_c_port_for_each (scm_i_evict_port
, (void *) &fd
);
269 SCM_DEFINE (scm_file_port_p
, "file-port?", 1, 0, 0,
271 "Determine whether @var{obj} is a port that is related to a file.")
272 #define FUNC_NAME s_scm_file_port_p
274 return scm_from_bool (SCM_FPORTP (obj
));
279 static SCM sys_file_port_name_canonicalization
;
280 SCM_SYMBOL (sym_relative
, "relative");
281 SCM_SYMBOL (sym_absolute
, "absolute");
284 fport_canonicalize_filename (SCM filename
)
286 SCM mode
= scm_fluid_ref (sys_file_port_name_canonicalization
);
288 if (!scm_is_string (filename
))
292 else if (scm_is_eq (mode
, sym_relative
))
296 path
= scm_variable_ref (scm_c_module_lookup (scm_the_root_module (),
298 rel
= scm_i_relativize_path (filename
, path
);
300 return scm_is_true (rel
) ? rel
: filename
;
302 else if (scm_is_eq (mode
, sym_absolute
))
306 str
= scm_to_locale_string (filename
);
307 canon
= canonicalize_file_name (str
);
310 return canon
? scm_take_locale_string (canon
) : filename
;
320 * Return a new port open on a given file.
322 * The mode string must match the pattern: [rwa+]** which
323 * is interpreted in the usual unix way.
325 * Return the new port.
327 SCM_DEFINE (scm_open_file
, "open-file", 2, 0, 0,
328 (SCM filename
, SCM mode
),
329 "Open the file whose name is @var{filename}, and return a port\n"
330 "representing that file. The attributes of the port are\n"
331 "determined by the @var{mode} string. The way in which this is\n"
332 "interpreted is similar to C stdio. The first character must be\n"
333 "one of the following:\n"
336 "Open an existing file for input.\n"
338 "Open a file for output, creating it if it doesn't already exist\n"
339 "or removing its contents if it does.\n"
341 "Open a file for output, creating it if it doesn't already\n"
342 "exist. All writes to the port will go to the end of the file.\n"
343 "The \"append mode\" can be turned off while the port is in use\n"
344 "@pxref{Ports and File Descriptors, fcntl}\n"
346 "The following additional characters can be appended:\n"
349 "Open the underlying file in binary mode, if supported by the system.\n"
350 "Also, open the file using the binary-compatible character encoding\n"
351 "\"ISO-8859-1\", ignoring the default port encoding.\n"
353 "Open the port for both input and output. E.g., @code{r+}: open\n"
354 "an existing file for both input and output.\n"
356 "Create an \"unbuffered\" port. In this case input and output\n"
357 "operations are passed directly to the underlying port\n"
358 "implementation without additional buffering. This is likely to\n"
359 "slow down I/O operations. The buffering mode can be changed\n"
360 "while a port is in use @pxref{Ports and File Descriptors,\n"
363 "Add line-buffering to the port. The port output buffer will be\n"
364 "automatically flushed whenever a newline character is written.\n"
366 "In theory we could create read/write ports which were buffered\n"
367 "in one direction only. However this isn't included in the\n"
368 "current interfaces. If a file cannot be opened with the access\n"
369 "requested, @code{open-file} throws an exception.")
370 #define FUNC_NAME s_scm_open_file
373 int fdes
, flags
= 0, binary
= 0;
374 unsigned int retries
;
375 char *file
, *md
, *ptr
;
377 scm_dynwind_begin (0);
379 file
= scm_to_locale_string (filename
);
380 scm_dynwind_free (file
);
382 md
= scm_to_locale_string (mode
);
383 scm_dynwind_free (md
);
391 flags
|= O_WRONLY
| O_CREAT
| O_TRUNC
;
394 flags
|= O_WRONLY
| O_CREAT
| O_APPEND
;
397 scm_out_of_range (FUNC_NAME
, mode
);
405 flags
= (flags
& ~(O_RDONLY
| O_WRONLY
)) | O_RDWR
;
409 #if defined (O_BINARY)
413 case '0': /* unbuffered: handled later. */
414 case 'l': /* line buffered: handled during output. */
417 scm_out_of_range (FUNC_NAME
, mode
);
422 for (retries
= 0, fdes
= -1;
423 fdes
< 0 && retries
< 2;
426 SCM_SYSCALL (fdes
= open_or_open64 (file
, flags
, 0666));
431 if (en
== EMFILE
&& retries
== 0)
432 /* Run the GC in case it collects open file ports that are no
433 longer referenced. */
434 scm_i_gc (FUNC_NAME
);
436 SCM_SYSERROR_MSG ("~A: ~S",
437 scm_cons (scm_strerror (scm_from_int (en
)),
438 scm_cons (filename
, SCM_EOL
)), en
);
442 /* Create a port from this file descriptor. The port's encoding is initially
443 %default-port-encoding. */
444 port
= scm_i_fdes_to_port (fdes
, scm_i_mode_bits (mode
),
445 fport_canonicalize_filename (filename
));
448 /* Use the binary-friendly ISO-8859-1 encoding. */
449 scm_i_set_port_encoding_x (port
, NULL
);
458 /* Building Guile ports from a file descriptor. */
460 /* Build a Scheme port from an open file descriptor `fdes'.
461 MODE indicates whether FILE is open for reading or writing; it uses
462 the same notation as open-file's second argument.
463 NAME is a string to be used as the port's filename.
466 scm_i_fdes_to_port (int fdes
, long mode_bits
, SCM name
)
467 #define FUNC_NAME "scm_fdes_to_port"
472 /* Test that fdes is valid. */
474 int flags
= fcntl (fdes
, F_GETFL
, 0);
479 && ((flags
!= O_WRONLY
&& (mode_bits
& SCM_WRTNG
))
480 || (flags
!= O_RDONLY
&& (mode_bits
& SCM_RDNG
))))
482 SCM_MISC_ERROR ("requested file mode not available on fdes", SCM_EOL
);
485 /* If we don't have F_GETFL, as on mingw, at least we can test that
486 it is a valid file descriptor. */
488 if (fstat (fdes
, &st
) != 0)
492 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
494 port
= scm_new_port_table_entry (scm_tc16_fport
);
495 SCM_SET_CELL_TYPE(port
, scm_tc16_fport
| mode_bits
);
496 pt
= SCM_PTAB_ENTRY(port
);
499 = (scm_t_fport
*) scm_gc_malloc_pointerless (sizeof (scm_t_fport
),
503 pt
->rw_random
= SCM_FDES_RANDOM_P (fdes
);
504 SCM_SETSTREAM (port
, fp
);
505 if (mode_bits
& SCM_BUF0
)
506 scm_fport_buffer_add (port
, 0, 0);
508 scm_fport_buffer_add (port
, -1, -1);
510 SCM_SET_FILENAME (port
, name
);
511 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
517 scm_fdes_to_port (int fdes
, char *mode
, SCM name
)
519 return scm_i_fdes_to_port (fdes
, scm_mode_bits (mode
), name
);
522 /* Return a lower bound on the number of bytes available for input. */
524 fport_input_waiting (SCM port
)
526 int fdes
= SCM_FSTREAM (port
)->fdes
;
528 struct pollfd pollfd
= { fdes
, POLLIN
, 0 };
530 if (poll (&pollfd
, 1, 0) < 0)
531 scm_syserror ("fport_input_waiting");
533 return pollfd
.revents
& POLLIN
? 1 : 0;
538 fport_print (SCM exp
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
540 scm_puts ("#<", port
);
541 scm_print_port_mode (exp
, port
);
542 if (SCM_OPFPORTP (exp
))
545 SCM name
= SCM_FILENAME (exp
);
546 if (scm_is_string (name
) || scm_is_symbol (name
))
547 scm_display (name
, port
);
549 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp
)), port
);
550 scm_putc (' ', port
);
551 fdes
= (SCM_FSTREAM (exp
))->fdes
;
553 #if (defined HAVE_TTYNAME) && (defined HAVE_POSIX)
555 scm_display (scm_ttyname (exp
), port
);
557 #endif /* HAVE_TTYNAME */
558 scm_intprint (fdes
, 10, port
);
562 scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp
)), port
);
563 scm_putc (' ', port
);
564 scm_uintprint ((scm_t_bits
) SCM_PTAB_ENTRY (exp
), 16, port
);
566 scm_putc ('>', port
);
570 static void fport_flush (SCM port
);
572 /* fill a port's read-buffer with a single read. returns the first
573 char or EOF if end of file. */
575 fport_fill_input (SCM port
)
578 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
579 scm_t_fport
*fp
= SCM_FSTREAM (port
);
581 SCM_SYSCALL (count
= read (fp
->fdes
, pt
->read_buf
, pt
->read_buf_size
));
583 scm_syserror ("fport_fill_input");
585 return (scm_t_wchar
) EOF
;
588 pt
->read_pos
= pt
->read_buf
;
589 pt
->read_end
= pt
->read_buf
+ count
;
590 return *pt
->read_buf
;
595 fport_seek (SCM port
, scm_t_off offset
, int whence
)
597 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
598 scm_t_fport
*fp
= SCM_FSTREAM (port
);
600 off_t_or_off64_t result
;
602 if (pt
->rw_active
== SCM_PORT_WRITE
)
604 if (offset
!= 0 || whence
!= SEEK_CUR
)
607 result
= rv
= lseek_or_lseek64 (fp
->fdes
, offset
, whence
);
611 /* read current position without disturbing the buffer. */
612 rv
= lseek_or_lseek64 (fp
->fdes
, offset
, whence
);
613 result
= rv
+ (pt
->write_pos
- pt
->write_buf
);
616 else if (pt
->rw_active
== SCM_PORT_READ
)
618 if (offset
!= 0 || whence
!= SEEK_CUR
)
620 /* could expand to avoid a second seek. */
621 scm_end_input (port
);
622 result
= rv
= lseek_or_lseek64 (fp
->fdes
, offset
, whence
);
626 /* read current position without disturbing the buffer
627 (particularly the unread-char buffer). */
628 rv
= lseek_or_lseek64 (fp
->fdes
, offset
, whence
);
629 result
= rv
- (pt
->read_end
- pt
->read_pos
);
631 if (pt
->read_buf
== pt
->putback_buf
)
632 result
-= pt
->saved_read_end
- pt
->saved_read_pos
;
635 else /* SCM_PORT_NEITHER */
637 result
= rv
= lseek_or_lseek64 (fp
->fdes
, offset
, whence
);
641 scm_syserror ("fport_seek");
647 fport_truncate (SCM port
, scm_t_off length
)
649 scm_t_fport
*fp
= SCM_FSTREAM (port
);
651 if (ftruncate (fp
->fdes
, length
) == -1)
652 scm_syserror ("ftruncate");
656 fport_write (SCM port
, const void *data
, size_t size
)
657 #define FUNC_NAME "fport_write"
659 /* this procedure tries to minimize the number of writes/flushes. */
660 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
662 if (pt
->write_buf
== &pt
->shortbuf
663 || (pt
->write_pos
== pt
->write_buf
&& size
>= pt
->write_buf_size
))
665 /* Unbuffered port, or port with empty buffer and data won't fit in
667 if (full_write (SCM_FPORT_FDES (port
), data
, size
) < size
)
674 scm_t_off space
= pt
->write_end
- pt
->write_pos
;
678 /* data fits in buffer. */
679 memcpy (pt
->write_pos
, data
, size
);
680 pt
->write_pos
+= size
;
681 if (pt
->write_pos
== pt
->write_end
)
684 /* we can skip the line-buffering check if nothing's buffered. */
690 memcpy (pt
->write_pos
, data
, space
);
691 pt
->write_pos
= pt
->write_end
;
694 const void *ptr
= ((const char *) data
) + space
;
695 size_t remaining
= size
- space
;
697 if (size
>= pt
->write_buf_size
)
699 if (full_write (SCM_FPORT_FDES (port
), ptr
, remaining
)
706 memcpy (pt
->write_pos
, ptr
, remaining
);
707 pt
->write_pos
+= remaining
;
712 /* handle line buffering. */
713 if ((SCM_CELL_WORD_0 (port
) & SCM_BUFLINE
) && memchr (data
, '\n', size
))
720 fport_flush (SCM port
)
723 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
724 scm_t_fport
*fp
= SCM_FSTREAM (port
);
725 size_t count
= pt
->write_pos
- pt
->write_buf
;
727 written
= full_write (fp
->fdes
, pt
->write_buf
, count
);
729 scm_syserror ("scm_flush");
731 pt
->write_pos
= pt
->write_buf
;
732 pt
->rw_active
= SCM_PORT_NEITHER
;
735 /* clear the read buffer and adjust the file position for unread bytes. */
737 fport_end_input (SCM port
, int offset
)
739 scm_t_fport
*fp
= SCM_FSTREAM (port
);
740 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
742 offset
+= pt
->read_end
- pt
->read_pos
;
746 pt
->read_pos
= pt
->read_end
;
747 /* will throw error if unread-char used at beginning of file
748 then attempting to write. seems correct. */
749 if (lseek (fp
->fdes
, -offset
, SEEK_CUR
) == -1)
750 scm_syserror ("fport_end_input");
752 pt
->rw_active
= SCM_PORT_NEITHER
;
756 fport_close (SCM port
)
758 scm_t_fport
*fp
= SCM_FSTREAM (port
);
759 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
763 SCM_SYSCALL (rv
= close (fp
->fdes
));
764 if (rv
== -1 && errno
!= EBADF
)
766 if (scm_gc_running_p
)
767 /* silently ignore the error. scm_error would abort if we
771 scm_syserror ("fport_close");
773 if (pt
->read_buf
== pt
->putback_buf
)
774 pt
->read_buf
= pt
->saved_read_buf
;
775 if (pt
->read_buf
!= &pt
->shortbuf
)
776 scm_gc_free (pt
->read_buf
, pt
->read_buf_size
, "port buffer");
777 if (pt
->write_buf
!= &pt
->shortbuf
)
778 scm_gc_free (pt
->write_buf
, pt
->write_buf_size
, "port buffer");
779 scm_gc_free (fp
, sizeof (*fp
), "file port");
784 fport_free (SCM port
)
793 scm_t_bits tc
= scm_make_port_type ("file", fport_fill_input
, fport_write
);
795 scm_set_port_free (tc
, fport_free
);
796 scm_set_port_print (tc
, fport_print
);
797 scm_set_port_flush (tc
, fport_flush
);
798 scm_set_port_end_input (tc
, fport_end_input
);
799 scm_set_port_close (tc
, fport_close
);
800 scm_set_port_seek (tc
, fport_seek
);
801 scm_set_port_truncate (tc
, fport_truncate
);
802 scm_set_port_input_waiting (tc
, fport_input_waiting
);
810 scm_tc16_fport
= scm_make_fptob ();
812 scm_c_define ("_IOFBF", scm_from_int (_IOFBF
));
813 scm_c_define ("_IOLBF", scm_from_int (_IOLBF
));
814 scm_c_define ("_IONBF", scm_from_int (_IONBF
));
816 sys_file_port_name_canonicalization
= scm_make_fluid ();
817 scm_c_define ("%file-port-name-canonicalization",
818 sys_file_port_name_canonicalization
);
820 #include "libguile/fports.x"