gc-benchmarks: Adapt `gcold.scm' so that if conforms to the framework.
[bpt/guile.git] / libguile / fports.c
index 2fe0bee..5e4e6df 100644 (file)
@@ -1,46 +1,27 @@
-/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2004, 2006, 2007, 2008 Free Software Foundation, Inc.
  * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
 
 
 \f
+#define _LARGEFILE64_SOURCE      /* ask for stat64 etc */
+
+#ifdef HAVE_CONFIG_H
+#  include <config.h>
+#endif
 
 #include <stdio.h>
 #include <fcntl.h>
@@ -48,6 +29,9 @@
 #include "libguile/strings.h"
 #include "libguile/validate.h"
 #include "libguile/gc.h"
+#include "libguile/posix.h"
+#include "libguile/dynwind.h"
+#include "libguile/hashtab.h"
 
 #include "libguile/fports.h"
 
@@ -56,8 +40,6 @@
 #endif
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
-#else
-size_t fwrite ();
 #endif
 #ifdef HAVE_IO_H
 #include <io.h>
@@ -67,6 +49,7 @@ size_t fwrite ();
 #endif
 
 #include <errno.h>
+#include <sys/types.h>
 
 #include "libguile/iselect.h"
 
@@ -74,9 +57,33 @@ size_t fwrite ();
 #ifdef __MINGW32__
 # include <sys/stat.h>
 # include <winsock2.h>
-# define ftruncate(fd, size) chsize (fd, size)
 #endif /* __MINGW32__ */
 
+/* Mingw (version 3.4.5, circa 2006) has ftruncate as an alias for chsize
+   already, but have this code here in case that wasn't so in past versions,
+   or perhaps to help other minimal DOS environments.
+
+   gnulib ftruncate.c has code using fcntl F_CHSIZE and F_FREESP, which
+   might be possibilities if we've got other systems without ftruncate.  */
+
+#if HAVE_CHSIZE && ! HAVE_FTRUNCATE
+# define ftruncate(fd, size) chsize (fd, size)
+#undef HAVE_FTRUNCATE
+#define HAVE_FTRUNCATE 1
+#endif
+
+#if SIZEOF_OFF_T == SIZEOF_INT
+#define OFF_T_MAX  INT_MAX
+#define OFF_T_MIN  INT_MIN
+#elif SIZEOF_OFF_T == SIZEOF_LONG
+#define OFF_T_MAX  LONG_MAX
+#define OFF_T_MIN  LONG_MIN
+#elif SIZEOF_OFF_T == SIZEOF_LONG_LONG
+#define OFF_T_MAX  LONG_LONG_MAX
+#define OFF_T_MIN  LONG_LONG_MIN
+#else
+#error Oops, unknown OFF_T size
+#endif
 
 scm_t_bits scm_tc16_fport;
 
@@ -112,7 +119,7 @@ scm_fport_buffer_add (SCM port, long read_size, int write_size)
 
   if (SCM_INPUT_PORT_P (port) && read_size > 0)
     {
-      pt->read_buf = scm_gc_malloc (read_size, "port buffer");
+      pt->read_buf = scm_gc_malloc_pointerless (read_size, "port buffer");
       pt->read_pos = pt->read_end = pt->read_buf;
       pt->read_buf_size = read_size;
     }
@@ -124,7 +131,7 @@ scm_fport_buffer_add (SCM port, long read_size, int write_size)
 
   if (SCM_OUTPUT_PORT_P (port) && write_size > 0)
     {
-      pt->write_buf = scm_gc_malloc (write_size, "port buffer");
+      pt->write_buf = scm_gc_malloc_pointerless (write_size, "port buffer");
       pt->write_pos = pt->write_buf;
       pt->write_buf_size = write_size;
     }
@@ -163,7 +170,7 @@ SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
   port = SCM_COERCE_OUTPORT (port);
 
   SCM_VALIDATE_OPFPORT (1,port);
-  SCM_VALIDATE_INUM_COPY (2,mode,cmode);
+  cmode = scm_to_int (mode);
   if (cmode != _IONBF && cmode != _IOFBF && cmode != _IOLBF)
     scm_out_of_range (FUNC_NAME, mode);
 
@@ -174,7 +181,7 @@ SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
     }
   else
     {
-      SCM_SET_CELL_WORD_0 (port, SCM_CELL_WORD_0 (port) SCM_BUFLINE);
+      SCM_SET_CELL_WORD_0 (port, SCM_CELL_WORD_0 (port) & ~(scm_t_bits)SCM_BUFLINE);
     }
 
   if (SCM_UNBNDP (size))
@@ -186,7 +193,7 @@ SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
     }
   else
     {
-      SCM_VALIDATE_INUM_COPY (3,size,csize);
+      csize = scm_to_int (size);
       if (csize < 0 || (cmode == _IONBF && csize > 0))
        scm_out_of_range (FUNC_NAME, size);
     }
@@ -212,40 +219,46 @@ SCM_DEFINE (scm_setvbuf, "setvbuf", 2, 1, 0,
 #undef FUNC_NAME
 
 /* Move ports with the specified file descriptor to new descriptors,
- * reseting the revealed count to 0.
+ * resetting the revealed count to 0.
  */
-
-void
-scm_evict_ports (int fd)
+static void
+scm_i_evict_port (void *closure, SCM port)
 {
-  long i;
+  int fd = * (int*) closure;
 
-  for (i = 0; i < scm_port_table_size; i++)
+  if (SCM_FPORTP (port))
     {
-      SCM port = scm_port_table[i]->port;
+      scm_t_port *p;
+      scm_t_fport *fp;
 
-      if (SCM_FPORTP (port))
-       {
-         scm_t_fport *fp = SCM_FSTREAM (port);
+      /* XXX: In some cases, we can encounter a port with no associated ptab
+        entry.  */
+      p = SCM_PTAB_ENTRY (port);
+      fp = (p != NULL) ? (scm_t_fport *) p->stream : NULL;
 
-         if (fp->fdes == fd)
-           {
-             fp->fdes = dup (fd);
-             if (fp->fdes == -1)
-               scm_syserror ("scm_evict_ports");
-             scm_set_port_revealed_x (port, SCM_MAKINUM (0));
-           }
+      if ((fp != NULL) && (fp->fdes == fd))
+       {
+         fp->fdes = dup (fd);
+         if (fp->fdes == -1)
+           scm_syserror ("scm_evict_ports");
+         scm_set_port_revealed_x (port, scm_from_int (0));
        }
     }
 }
 
+void
+scm_evict_ports (int fd)
+{
+  scm_c_port_for_each (scm_i_evict_port, (void *) &fd);
+}
+
 
 SCM_DEFINE (scm_file_port_p, "file-port?", 1, 0, 0,
            (SCM obj),
            "Determine whether @var{obj} is a port that is related to a file.")
 #define FUNC_NAME s_scm_file_port_p
 {
-  return SCM_BOOL (SCM_FPORTP (obj));
+  return scm_from_bool (SCM_FPORTP (obj));
 }
 #undef FUNC_NAME
 
@@ -279,6 +292,8 @@ SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
            "@end table\n"
            "The following additional characters can be appended:\n"
            "@table @samp\n"
+           "@item b\n"
+           "Open the underlying file in binary mode, if supported by the operating system. "
            "@item +\n"
            "Open the port for both input and output.  E.g., @code{r+}: open\n"
            "an existing file for both input and output.\n"
@@ -306,11 +321,13 @@ SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
   char *md;
   char *ptr;
 
-  SCM_VALIDATE_STRING (1, filename);
-  SCM_VALIDATE_STRING (2, mode);
+  scm_dynwind_begin (0);
 
-  file = SCM_STRING_CHARS (filename);
-  md = SCM_STRING_CHARS (mode);
+  file = scm_to_locale_string (filename);
+  scm_dynwind_free (file);
+
+  md = scm_to_locale_string (mode);
+  scm_dynwind_free (md);
 
   switch (*md)
     {
@@ -347,16 +364,19 @@ SCM_DEFINE (scm_open_file, "open-file", 2, 0, 0,
        }
       ptr++;
     }
-  SCM_SYSCALL (fdes = open (file, flags, 0666));
+  SCM_SYSCALL (fdes = open_or_open64 (file, flags, 0666));
   if (fdes == -1)
     {
       int en = errno;
 
       SCM_SYSERROR_MSG ("~A: ~S",
-                       scm_cons (scm_makfrom0str (strerror (en)),
+                       scm_cons (scm_strerror (scm_from_int (en)),
                                  scm_cons (filename, SCM_EOL)), en);
     }
-  port = scm_fdes_to_port (fdes, md, filename);
+  port = scm_i_fdes_to_port (fdes, scm_i_mode_bits (mode), filename);
+
+  scm_dynwind_end ();
+
   return port;
 }
 #undef FUNC_NAME
@@ -412,10 +432,9 @@ static int getflags (int fdes)
    NAME is a string to be used as the port's filename.
 */
 SCM
-scm_fdes_to_port (int fdes, char *mode, SCM name)
+scm_i_fdes_to_port (int fdes, long mode_bits, SCM name)
 #define FUNC_NAME "scm_fdes_to_port"
 {
-  long mode_bits = scm_mode_bits (mode);
   SCM port;
   scm_t_port *pt;
   int flags;
@@ -436,15 +455,15 @@ scm_fdes_to_port (int fdes, char *mode, SCM name)
       SCM_MISC_ERROR ("requested file mode not available on fdes", SCM_EOL);
     }
 
-  port = scm_cell (scm_tc16_fport, 0);
-  SCM_DEFER_INTS;
-  pt = scm_add_to_port_table (port);
-  SCM_SETPTAB_ENTRY (port, pt);
-  SCM_SET_CELL_TYPE (port, (scm_tc16_fport | mode_bits));
+  scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex);
 
+  port = scm_new_port_table_entry (scm_tc16_fport);
+  SCM_SET_CELL_TYPE(port, scm_tc16_fport | mode_bits);
+  pt = SCM_PTAB_ENTRY(port);
   {
     scm_t_fport *fp
-      = (scm_t_fport *) scm_gc_malloc (sizeof (scm_t_fport), "file port");
+      = (scm_t_fport *) scm_gc_malloc_pointerless (sizeof (scm_t_fport),
+                                                  "file port");
 
     fp->fdes = fdes;
     pt->rw_random = SCM_FDES_RANDOM_P (fdes);
@@ -455,18 +474,23 @@ scm_fdes_to_port (int fdes, char *mode, SCM name)
       scm_fport_buffer_add (port, -1, -1);
   }
   SCM_SET_FILENAME (port, name);
-  SCM_ALLOW_INTS;
+  scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex);
   return port;
 }
 #undef FUNC_NAME
 
+SCM
+scm_fdes_to_port (int fdes, char *mode, SCM name)
+{
+  return scm_i_fdes_to_port (fdes, scm_mode_bits (mode), name);
+}
+
 /* Return a lower bound on the number of bytes available for input.  */
 static int
 fport_input_waiting (SCM port)
 {
-  int fdes = SCM_FSTREAM (port)->fdes;
-
 #ifdef HAVE_SELECT
+  int fdes = SCM_FSTREAM (port)->fdes;
   struct timeval timeout;
   SELECT_TYPE read_set;
   SELECT_TYPE write_set;
@@ -486,10 +510,15 @@ fport_input_waiting (SCM port)
       < 0)
     scm_syserror ("fport_input_waiting");
   return FD_ISSET (fdes, &read_set) ? 1 : 0;
-#elif defined (FIONREAD)
+
+#elif HAVE_IOCTL && defined (FIONREAD)
+  /* Note: cannot test just defined(FIONREAD) here, since mingw has FIONREAD
+     (for use with winsock ioctlsocket()) but not ioctl().  */
+  int fdes = SCM_FSTREAM (port)->fdes;
   int remir;
   ioctl(fdes, FIONREAD, &remir);
   return remir;
+
 #else    
   scm_misc_error ("fport_input_waiting",
                  "Not fully implemented on this platform",
@@ -507,7 +536,7 @@ fport_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
     {
       int fdes;
       SCM name = SCM_FILENAME (exp);
-      if (SCM_STRINGP (name) || SCM_SYMBOLP (name))
+      if (scm_is_string (name) || scm_is_symbol (name))
        scm_display (name, port);
       else
        scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
@@ -516,7 +545,7 @@ fport_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
       
 #ifdef HAVE_TTYNAME
       if (isatty (fdes))
-       scm_puts (ttyname (fdes), port);
+       scm_display (scm_ttyname (exp), port);
       else
 #endif /* HAVE_TTYNAME */
        scm_intprint (fdes, 10, port);
@@ -525,13 +554,13 @@ fport_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
     {
       scm_puts (SCM_PTOBNAME (SCM_PTOBNUM (exp)), port);
       scm_putc (' ', port);
-      scm_intprint ((scm_t_bits) SCM_PTAB_ENTRY (exp), 16, port);
+      scm_uintprint ((scm_t_bits) SCM_PTAB_ENTRY (exp), 16, port);
     }
   scm_putc ('>', port);
   return 1;
 }
 
-#ifdef GUILE_ISELECT
+#ifndef __MINGW32__
 /* thread-local block for input on fport's fdes.  */
 static void
 fport_wait_for_input (SCM port)
@@ -551,12 +580,12 @@ fport_wait_for_input (SCM port)
          {
            FD_ZERO (&readfds);
            FD_SET (fdes, &readfds);
-           n = scm_internal_select (fdes + 1, &readfds, NULL, NULL, NULL);
+           n = scm_std_select (fdes + 1, &readfds, NULL, NULL, NULL);
          }
        while (n == -1 && errno == EINTR);
     }
 }
-#endif
+#endif /* !__MINGW32__ */
 
 static void fport_flush (SCM port);
 
@@ -569,9 +598,9 @@ fport_fill_input (SCM port)
   scm_t_port *pt = SCM_PTAB_ENTRY (port);
   scm_t_fport *fp = SCM_FSTREAM (port);
 
-#ifdef GUILE_ISELECT
+#ifndef __MINGW32__
   fport_wait_for_input (port);
-#endif
+#endif /* !__MINGW32__ */
   SCM_SYSCALL (count = read (fp->fdes, pt->read_buf, pt->read_buf_size));
   if (count == -1)
     scm_syserror ("fport_fill_input");
@@ -585,25 +614,25 @@ fport_fill_input (SCM port)
     }
 }
 
-static off_t
-fport_seek (SCM port, off_t offset, int whence)
+static off_t_or_off64_t
+fport_seek_or_seek64 (SCM port, off_t_or_off64_t offset, int whence)
 {
   scm_t_port *pt = SCM_PTAB_ENTRY (port);
   scm_t_fport *fp = SCM_FSTREAM (port);
-  off_t rv;
-  off_t result;
+  off_t_or_off64_t rv;
+  off_t_or_off64_t result;
 
   if (pt->rw_active == SCM_PORT_WRITE)
     {
       if (offset != 0 || whence != SEEK_CUR)
        {
          fport_flush (port);
-         result = rv = lseek (fp->fdes, offset, whence);
+         result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
        }
       else
        {
          /* read current position without disturbing the buffer.  */
-         rv = lseek (fp->fdes, offset, whence);
+         rv = lseek_or_lseek64 (fp->fdes, offset, whence);
          result = rv + (pt->write_pos - pt->write_buf);
        }
     }
@@ -613,13 +642,13 @@ fport_seek (SCM port, off_t offset, int whence)
        {
          /* could expand to avoid a second seek.  */
          scm_end_input (port);
-         result = rv = lseek (fp->fdes, offset, whence);
+         result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
        }
       else
        {
          /* read current position without disturbing the buffer
             (particularly the unread-char buffer).  */
-         rv = lseek (fp->fdes, offset, whence);
+         rv = lseek_or_lseek64 (fp->fdes, offset, whence);
          result = rv - (pt->read_end - pt->read_pos);
 
          if (pt->read_buf == pt->putback_buf)
@@ -628,7 +657,7 @@ fport_seek (SCM port, off_t offset, int whence)
     }
   else /* SCM_PORT_NEITHER */
     {
-      result = rv = lseek (fp->fdes, offset, whence);      
+      result = rv = lseek_or_lseek64 (fp->fdes, offset, whence);
     }
 
   if (rv == -1)
@@ -637,6 +666,39 @@ fport_seek (SCM port, off_t offset, int whence)
   return result;
 }
 
+/* If we've got largefile and off_t isn't already off64_t then
+   fport_seek_or_seek64 needs a range checking wrapper to be fport_seek in
+   the port descriptor.
+
+   Otherwise if no largefile, or off_t is the same as off64_t (which is the
+   case on NetBSD apparently), then fport_seek_or_seek64 is right to be
+   fport_seek already.  */
+
+#if GUILE_USE_64_CALLS && HAVE_STAT64 && SIZEOF_OFF_T != SIZEOF_OFF64_T
+static off_t
+fport_seek (SCM port, off_t offset, int whence)
+{
+  off64_t rv = fport_seek_or_seek64 (port, (off64_t) offset, whence);
+  if (rv > OFF_T_MAX || rv < OFF_T_MIN)
+    {
+      errno = EOVERFLOW;
+      scm_syserror ("fport_seek");
+    }
+  return (off_t) rv;
+
+}
+#else
+#define fport_seek   fport_seek_or_seek64
+#endif
+
+/* `how' has been validated and is one of SEEK_SET, SEEK_CUR or SEEK_END */
+SCM
+scm_i_fport_seek (SCM port, SCM offset, int how)
+{
+  return scm_from_off_t_or_off64_t
+    (fport_seek_or_seek64 (port, scm_to_off_t_or_off64_t (offset), how));
+}
+
 static void
 fport_truncate (SCM port, off_t length)
 {
@@ -646,6 +708,13 @@ fport_truncate (SCM port, off_t length)
     scm_syserror ("ftruncate");
 }
 
+int
+scm_i_fport_truncate (SCM port, SCM length)
+{
+  scm_t_fport *fp = SCM_FSTREAM (port);
+  return ftruncate_or_ftruncate64 (fp->fdes, scm_to_off_t_or_off64_t (length));
+}
+
 /* helper for fport_write: try to write data, using multiple system
    calls if required.  */
 #define FUNC_NAME "write_all"
@@ -727,7 +796,7 @@ fport_write (SCM port, const void *data, size_t size)
 
 /* becomes 1 when process is exiting: normal exception handling won't
    work by this time.  */
-extern int terminating; 
+extern int scm_i_terminating; 
 
 static void
 fport_flush (SCM port)
@@ -759,7 +828,7 @@ fport_flush (SCM port)
                }
              pt->write_pos = pt->write_buf + remaining;
            }
-         if (terminating)
+         if (scm_i_terminating)
            {
              const char *msg = "Error: could not flush file-descriptor ";
              char buf[11];
@@ -863,13 +932,11 @@ scm_init_fports ()
 {
   scm_tc16_fport = scm_make_fptob ();
 
-  scm_c_define ("_IOFBF", SCM_MAKINUM (_IOFBF));
-  scm_c_define ("_IOLBF", SCM_MAKINUM (_IOLBF));
-  scm_c_define ("_IONBF", SCM_MAKINUM (_IONBF));
+  scm_c_define ("_IOFBF", scm_from_int (_IOFBF));
+  scm_c_define ("_IOLBF", scm_from_int (_IOLBF));
+  scm_c_define ("_IONBF", scm_from_int (_IONBF));
 
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/fports.x"
-#endif
 }
 
 /*