(Writing): Add write, revise display.
[bpt/guile.git] / libguile / inline.h
index ea6b512..3938652 100644 (file)
@@ -3,86 +3,79 @@
 #ifndef SCM_INLINE_H
 #define SCM_INLINE_H
 
-/* Copyright (C) 2001 Free Software Foundation, Inc.
+/* Copyright (C) 2001, 2002 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 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 program is distributed in the hope that it will be useful,
+ * 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 General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser 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 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.
- *
- * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
 
 /* This file is for inline functions.  On platforms that don't support
    inlining functions, they are turned into ordinary functions.  See
    "inline.c".
 */
 
+#include "libguile/__scm.h"
+
+#if (SCM_DEBUG_CELL_ACCESSES == 1)
+#include <stdio.h>
+#endif
 
 #include "libguile/pairs.h"
 #include "libguile/gc.h"
+#include "libguile/threads.h"
 
 
 SCM_API SCM scm_cell (scm_t_bits car, scm_t_bits cdr);
 SCM_API SCM scm_double_cell (scm_t_bits car, scm_t_bits cbr,
                             scm_t_bits ccr, scm_t_bits cdr);
 
-#ifdef HAVE_INLINE
 
-#ifndef EXTERN_INLINE
-#define EXTERN_INLINE extern inline
-#endif
+
+#if defined SCM_C_INLINE || defined SCM_INLINE_C_INCLUDING_INLINE_H
+/* either inlining, or being included from inline.c.  We use (and
+   repeat) this long #if test here and below so that we don't have to
+   introduce any extraneous symbols into the public namespace.  We
+   only need SCM_C_INLINE to be seen publically . */
 
 extern unsigned scm_newcell2_count;
 extern unsigned scm_newcell_count;
 
-
-
-EXTERN_INLINE
+#if defined SCM_C_INLINE && ! defined SCM_INLINE_C_INCLUDING_INLINE_H
+/* definitely inlining */
+extern SCM_C_INLINE
+#endif
 SCM
 scm_cell (scm_t_bits car, scm_t_bits cdr)
 {
   SCM z;
+  /* We retrieve the SCM pointer only once since the call to
+     SCM_FREELIST_LOC will be slightly expensive when we support
+     preemptive multithreading.  SCM_FREELIST_DOC will then retrieve
+     the thread specific freelist.
+   
+     Until then, SCM_FREELIST_DOC expands to (&scm_i_freelist) and the
+     following code will compile to the same as if we had worked
+     directly on the scm_i_freelist variable.
+   */
+  SCM *freelist = SCM_FREELIST_LOC (scm_i_freelist);
 
-  if (SCM_NULLP (scm_i_freelist))
-    {
-      z = scm_gc_for_newcell (&scm_i_master_freelist, &scm_i_freelist);
-    }
+  if (SCM_NULLP (*freelist))
+    z = scm_gc_for_newcell (&scm_i_master_freelist, freelist);
   else
     {
-      z = scm_i_freelist;
-      scm_i_freelist = SCM_FREE_CELL_CDR (scm_i_freelist);
+      z = *freelist;
+      *freelist = SCM_FREE_CELL_CDR (*freelist);
     }
 
   /*
@@ -94,20 +87,31 @@ scm_cell (scm_t_bits car, scm_t_bits cdr)
 
 #if (SCM_DEBUG_CELL_ACCESSES == 1)
     if (scm_debug_cell_accesses_p)
-    {
-      if (SCM_GC_MARK_P (z))
-       {
-         fprintf(stderr, "scm_cell tried to allocate a marked cell.\n");
-         abort();
-       }
-      else if (SCM_GC_CELL_TYPE(z) != scm_tc_free_cell)
-       {
-         fprintf(stderr, "cell from freelist is not a free cell.\n");
-         abort();
-       }
+      {
+       if (SCM_GC_MARK_P (z))
+         {
+           fprintf(stderr, "scm_cell tried to allocate a marked cell.\n");
+           abort();
+         }
+       else if (SCM_GC_CELL_TYPE(z) != scm_tc_free_cell)
+         {
+           fprintf(stderr, "cell from freelist is not a free cell.\n");
+           abort();
+         }
+      }
+
+    /*
+      Always set mark. Otherwise cells that are alloced before
+      scm_debug_cell_accesses_p is toggled seem invalid.
+    */
+    SCM_SET_GC_MARK (z);
+
+    /*
+      TODO: figure out if this use of mark bits is valid with
+      threading. What if another thread is doing GC at this point
+      ... ?
+     */
       
-      SCM_SET_GC_MARK (z);
-    }
 #endif
 
   
@@ -120,9 +124,9 @@ scm_cell (scm_t_bits car, scm_t_bits cdr)
   SCM_GC_SET_CELL_WORD (z, 1, cdr);
   SCM_GC_SET_CELL_WORD (z, 0, car);
 
-#ifdef USE_THREADS
-#ifndef USE_COOP_THREADS
-  /* When we are using non-cooperating threads, we might need to make
+#if 0 /*fixme* Hmm... let's consider this later. */
+#if !defined(SCM_USE_COOP_THREADS) && !defined(SCM_USE_NULL_THREADS) && !defined(SCM_USE_COPT_THREADS)
+  /* When we are using preemtive threads, we might need to make
      sure that the initial values for the slots are protected until
      the cell is completely initialized.
   */
@@ -131,7 +135,6 @@ scm_cell (scm_t_bits car, scm_t_bits cdr)
 #endif
 #endif
 
-
 #if (SCM_DEBUG_CELL_ACCESSES == 1)
   if (scm_expensive_debug_cell_accesses_p )
     scm_i_expensive_validation_check (z);
@@ -140,22 +143,23 @@ scm_cell (scm_t_bits car, scm_t_bits cdr)
   return z;
 }
 
-EXTERN_INLINE
+#if defined SCM_C_INLINE && ! defined SCM_INLINE_C_INCLUDING_INLINE_H
+/* definitely inlining */
+extern SCM_C_INLINE
+#endif
 SCM
 scm_double_cell (scm_t_bits car, scm_t_bits cbr,
                 scm_t_bits ccr, scm_t_bits cdr)
 {
   SCM z;
+  SCM *freelist = SCM_FREELIST_LOC (scm_i_freelist2);
 
-
-  if (SCM_NULLP (scm_i_freelist2))
-    {
-      z = scm_gc_for_newcell (&scm_i_master_freelist2, &scm_i_freelist2);
-    }
+  if (SCM_NULLP (*freelist))
+    z = scm_gc_for_newcell (&scm_i_master_freelist2, freelist);
   else
     {
-      z = scm_i_freelist2;
-      scm_i_freelist2 = SCM_FREE_CELL_CDR (scm_i_freelist2);
+      z = *freelist;
+      *freelist = SCM_FREE_CELL_CDR (*freelist);
     }
 
   scm_cells_allocated += 2;
@@ -171,8 +175,8 @@ scm_double_cell (scm_t_bits car, scm_t_bits cbr,
   SCM_GC_SET_CELL_WORD (z, 3, cdr);
   SCM_GC_SET_CELL_WORD (z, 0, car);
 
-#ifdef USE_THREADS
-#ifndef USE_COOP_THREADS
+#if 0 /*fixme* Hmm... let's consider this later. */
+#if !defined(SCM_USE_COOP_THREADS) && !defined(SCM_USE_NULL_THREADS) && !defined(SCM_USE_COPT_THREADS)
   /* When we are using non-cooperating threads, we might need to make
      sure that the initial values for the slots are protected until
      the cell is completely initialized.
@@ -192,9 +196,31 @@ scm_double_cell (scm_t_bits car, scm_t_bits cbr,
                  "scm_double_cell tried to allocate a marked cell.\n");
          abort();
        }
-
-      SCM_SET_GC_MARK (z);
     }
+
+  /* see above. */
+  SCM_SET_GC_MARK (z);
+
+#endif
+
+  /* When this function is inlined, it's possible that the last
+     SCM_GC_SET_CELL_WORD above will be adjacent to a following
+     initialization of z.  E.g., it occurred in scm_make_real.  GCC
+     from around version 3 (e.g., certainly 3.2) began taking
+     advantage of strict C aliasing rules which say that it's OK to
+     interchange the initialization above and the one below when the
+     pointer types appear to differ sufficiently.  We don't want that,
+     of course.  GCC allows this behaviour to be disabled with the
+     -fno-strict-aliasing option, but would also need to be supplied
+     by Guile users.  Instead, the following statements prevent the
+     reordering.
+   */
+#ifdef __GNUC__
+  asm volatile ("" : : : "memory");
+#else
+  /* portable version, just in case any other compiler does the same
+     thing.  */
+  scm_remember_upto_here_1 (z);
 #endif
 
   return z;