alloc.c 139 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Storage allocation and gc for GNU Emacs Lisp interpreter.
2
   Copyright (C) 1985, 86, 88, 93, 94, 95, 97, 98, 1999, 2000, 2001, 2002
Richard M. Stallman's avatar
Richard M. Stallman committed
3
      Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs 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 GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
#include <config.h>
23
#include <stdio.h>
24

25
/* Note that this declares bzero on OSF/1.  How dumb.  */
26

27
#include <signal.h>
28

29 30 31 32 33 34 35
/* GC_MALLOC_CHECK defined means perform validity checks of malloc'd
   memory.  Can do this only if using gmalloc.c.  */

#if defined SYSTEM_MALLOC || defined DOUG_LEA_MALLOC
#undef GC_MALLOC_CHECK
#endif

36 37 38
/* This file is part of the core Lisp implementation, and thus must
   deal with the real data structures.  If the Lisp implementation is
   replaced, this file likely will not be used.  */
39

40
#undef HIDE_LISP_IMPLEMENTATION
Jim Blandy's avatar
Jim Blandy committed
41
#include "lisp.h"
42
#include "process.h"
43
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
44
#include "puresize.h"
Jim Blandy's avatar
Jim Blandy committed
45 46
#include "buffer.h"
#include "window.h"
47
#include "keyboard.h"
Jim Blandy's avatar
Jim Blandy committed
48
#include "frame.h"
49
#include "blockinput.h"
50
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
51
#include "syssignal.h"
52
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
53

54 55 56 57 58
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#else
extern POINTER_TYPE *sbrk ();
#endif
Karl Heuer's avatar
Karl Heuer committed
59

60
#ifdef DOUG_LEA_MALLOC
61

62
#include <malloc.h>
63 64
/* malloc.h #defines this as size_t, at least in glibc2.  */
#ifndef __malloc_size_t
65
#define __malloc_size_t int
66
#endif
67

68 69 70
/* Specify maximum number of areas to mmap.  It would be nice to use a
   value that explicitly means "no limit".  */

71 72
#define MMAP_MAX_AREAS 100000000

73 74
#else /* not DOUG_LEA_MALLOC */

75 76 77 78
/* The following come from gmalloc.c.  */

#define	__malloc_size_t		size_t
extern __malloc_size_t _bytes_used;
79
extern __malloc_size_t __malloc_extra_blocks;
80 81

#endif /* not DOUG_LEA_MALLOC */
82

Jim Blandy's avatar
Jim Blandy committed
83 84 85 86
/* Macro to verify that storage intended for Lisp objects is not
   out of range to fit in the space for a pointer.
   ADDRESS is the start of the block, and SIZE
   is the amount of space within which objects can start.  */
87

Jim Blandy's avatar
Jim Blandy committed
88 89 90 91
#define VALIDATE_LISP_STORAGE(address, size)			\
do								\
  {								\
    Lisp_Object val;						\
92
    XSETCONS (val, (char *) address + size);		\
Jim Blandy's avatar
Jim Blandy committed
93 94
    if ((char *) XCONS (val) != (char *) address + size)	\
      {								\
95
	xfree (address);					\
Jim Blandy's avatar
Jim Blandy committed
96 97 98 99
	memory_full ();						\
      }								\
  } while (0)

100
/* Value of _bytes_used, when spare_memory was freed.  */
101

102 103
static __malloc_size_t bytes_used_when_full;

104 105 106
/* Mark, unmark, query mark bit of a Lisp string.  S must be a pointer
   to a struct Lisp_String.  */

107 108 109
#define MARK_STRING(S)		((S)->size |= MARKBIT)
#define UNMARK_STRING(S)	((S)->size &= ~MARKBIT)
#define STRING_MARKED_P(S)	((S)->size & MARKBIT)
110 111 112 113 114 115 116 117 118 119 120

/* Value is the number of bytes/chars of S, a pointer to a struct
   Lisp_String.  This must be used instead of STRING_BYTES (S) or
   S->size during GC, because S->size contains the mark bit for
   strings.  */

#define GC_STRING_BYTES(S)	(STRING_BYTES (S) & ~MARKBIT)
#define GC_STRING_CHARS(S)	((S)->size & ~MARKBIT)

/* Number of bytes of consing done since the last gc.  */

Jim Blandy's avatar
Jim Blandy committed
121 122
int consing_since_gc;

123
/* Count the amount of consing of various sorts of space.  */
124

125 126 127 128 129 130 131 132
EMACS_INT cons_cells_consed;
EMACS_INT floats_consed;
EMACS_INT vector_cells_consed;
EMACS_INT symbols_consed;
EMACS_INT string_chars_consed;
EMACS_INT misc_objects_consed;
EMACS_INT intervals_consed;
EMACS_INT strings_consed;
133 134

/* Number of bytes of consing since GC before another GC should be done. */
135

136
EMACS_INT gc_cons_threshold;
Jim Blandy's avatar
Jim Blandy committed
137

138 139
/* Nonzero during GC.  */

Jim Blandy's avatar
Jim Blandy committed
140 141
int gc_in_progress;

142
/* Nonzero means display messages at beginning and end of GC.  */
143

144 145
int garbage_collection_messages;

Jim Blandy's avatar
Jim Blandy committed
146 147 148
#ifndef VIRT_ADDR_VARIES
extern
#endif /* VIRT_ADDR_VARIES */
149
int malloc_sbrk_used;
Jim Blandy's avatar
Jim Blandy committed
150 151 152 153

#ifndef VIRT_ADDR_VARIES
extern
#endif /* VIRT_ADDR_VARIES */
154
int malloc_sbrk_unused;
Jim Blandy's avatar
Jim Blandy committed
155

Jim Blandy's avatar
Jim Blandy committed
156
/* Two limits controlling how much undo information to keep.  */
157

158 159
EMACS_INT undo_limit;
EMACS_INT undo_strong_limit;
Jim Blandy's avatar
Jim Blandy committed
160

161 162 163 164 165
/* Number of live and free conses etc.  */

static int total_conses, total_markers, total_symbols, total_vector_size;
static int total_free_conses, total_free_markers, total_free_symbols;
static int total_free_floats, total_floats;
166

167 168 169
/* Points to memory space allocated as "spare", to be freed if we run
   out of memory.  */

170 171 172
static char *spare_memory;

/* Amount of spare memory to keep in reserve.  */
173

174 175 176
#define SPARE_MEMORY (1 << 14)

/* Number of extra blocks malloc should get when it needs more core.  */
177

178 179
static int malloc_hysteresis;

180 181
/* Non-nil means defun should do purecopy on the function definition.  */

Jim Blandy's avatar
Jim Blandy committed
182 183
Lisp_Object Vpurify_flag;

184 185 186 187
/* Non-nil means we are handling a memory-full error.  */

Lisp_Object Vmemory_full;

Jim Blandy's avatar
Jim Blandy committed
188
#ifndef HAVE_SHM
189 190 191 192

/* Force it into data space! */

EMACS_INT pure[PURESIZE / sizeof (EMACS_INT)] = {0,};
Jim Blandy's avatar
Jim Blandy committed
193
#define PUREBEG (char *) pure
194

195
#else /* HAVE_SHM */
196

Jim Blandy's avatar
Jim Blandy committed
197 198
#define pure PURE_SEG_BITS   /* Use shared memory segment */
#define PUREBEG (char *)PURE_SEG_BITS
Jim Blandy's avatar
Jim Blandy committed
199

200
#endif /* HAVE_SHM */
201

202
/* Pointer to the pure area, and its size.  */
203

204 205 206 207 208 209 210
static char *purebeg;
static size_t pure_size;

/* Number of bytes of pure storage used before pure storage overflowed.
   If this is non-zero, this implies that an overflow occurred.  */

static size_t pure_bytes_used_before_overflow;
Jim Blandy's avatar
Jim Blandy committed
211

212 213 214 215
/* Value is non-zero if P points into pure space.  */

#define PURE_POINTER_P(P)					\
     (((PNTR_COMPARISON_TYPE) (P)				\
216
       < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size))	\
217
      && ((PNTR_COMPARISON_TYPE) (P)				\
218
	  >= (PNTR_COMPARISON_TYPE) purebeg))
219

220 221
/* Index in pure at which next pure object will be allocated.. */

222
EMACS_INT pure_bytes_used;
Jim Blandy's avatar
Jim Blandy committed
223

224 225 226
/* If nonzero, this is a warning delivered by malloc and not yet
   displayed.  */

Jim Blandy's avatar
Jim Blandy committed
227 228
char *pending_malloc_warning;

229
/* Pre-computed signal argument for use when memory is exhausted.  */
230

231
Lisp_Object Vmemory_signal_data;
232

Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239 240 241 242 243
/* Maximum amount of C stack to save when a GC happens.  */

#ifndef MAX_SAVE_STACK
#define MAX_SAVE_STACK 16000
#endif

/* Buffer in which we save a copy of the C stack at each GC.  */

char *stack_copy;
int stack_copy_size;

244 245 246
/* Non-zero means ignore malloc warnings.  Set during initialization.
   Currently not used.  */

Jim Blandy's avatar
Jim Blandy committed
247
int ignore_warnings;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
248

249
Lisp_Object Qgc_cons_threshold, Qchar_table_extra_slots;
250

251 252 253 254
/* Hook run after GC has finished.  */

Lisp_Object Vpost_gc_hook, Qpost_gc_hook;

255 256 257
static void mark_buffer P_ ((Lisp_Object));
static void mark_kboards P_ ((void));
static void gc_sweep P_ ((void));
258 259 260 261 262 263 264 265
static void mark_glyph_matrix P_ ((struct glyph_matrix *));
static void mark_face_cache P_ ((struct face_cache *));

#ifdef HAVE_WINDOW_SYSTEM
static void mark_image P_ ((struct image *));
static void mark_image_cache P_ ((struct frame *));
#endif /* HAVE_WINDOW_SYSTEM */

266 267 268 269
static struct Lisp_String *allocate_string P_ ((void));
static void compact_small_strings P_ ((void));
static void free_large_strings P_ ((void));
static void sweep_strings P_ ((void));
Richard M. Stallman's avatar
Richard M. Stallman committed
270 271

extern int message_enable_multibyte;
272 273 274 275 276 277 278 279 280 281 282 283 284 285

/* When scanning the C stack for live Lisp objects, Emacs keeps track
   of what memory allocated via lisp_malloc is intended for what
   purpose.  This enumeration specifies the type of memory.  */

enum mem_type
{
  MEM_TYPE_NON_LISP,
  MEM_TYPE_BUFFER,
  MEM_TYPE_CONS,
  MEM_TYPE_STRING,
  MEM_TYPE_MISC,
  MEM_TYPE_SYMBOL,
  MEM_TYPE_FLOAT,
286 287 288 289 290 291 292 293
  /* Keep the following vector-like types together, with
     MEM_TYPE_WINDOW being the last, and MEM_TYPE_VECTOR the
     first.  Or change the code of live_vector_p, for instance.  */
  MEM_TYPE_VECTOR,
  MEM_TYPE_PROCESS,
  MEM_TYPE_HASH_TABLE,
  MEM_TYPE_FRAME,
  MEM_TYPE_WINDOW
294 295
};

296
#if GC_MARK_STACK || defined GC_MALLOC_CHECK
297 298 299 300 301 302 303 304 305 306

#if GC_MARK_STACK == GC_USE_GCPROS_CHECK_ZOMBIES
#include <stdio.h>		/* For fprintf.  */
#endif

/* A unique object in pure space used to make some Lisp objects
   on free lists recognizable in O(1).  */

Lisp_Object Vdead;

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
#ifdef GC_MALLOC_CHECK

enum mem_type allocated_mem_type;
int dont_register_blocks;

#endif /* GC_MALLOC_CHECK */

/* A node in the red-black tree describing allocated memory containing
   Lisp data.  Each such block is recorded with its start and end
   address when it is allocated, and removed from the tree when it
   is freed.

   A red-black tree is a balanced binary tree with the following
   properties:

   1. Every node is either red or black.
   2. Every leaf is black.
   3. If a node is red, then both of its children are black.
   4. Every simple path from a node to a descendant leaf contains
   the same number of black nodes.
   5. The root is always black.

   When nodes are inserted into the tree, or deleted from the tree,
   the tree is "fixed" so that these properties are always true.

   A red-black tree with N internal nodes has height at most 2
   log(N+1).  Searches, insertions and deletions are done in O(log N).
   Please see a text book about data structures for a detailed
   description of red-black trees.  Any book worth its salt should
   describe them.  */

struct mem_node
{
  struct mem_node *left, *right, *parent;

  /* Start and end of allocated region.  */
  void *start, *end;

  /* Node color.  */
  enum {MEM_BLACK, MEM_RED} color;
  
  /* Memory type.  */
  enum mem_type type;
};

/* Base address of stack.  Set in main.  */

Lisp_Object *stack_base;

/* Root of the tree describing allocated Lisp memory.  */

static struct mem_node *mem_root;

360 361 362 363
/* Lowest and highest known address in the heap.  */

static void *min_heap_address, *max_heap_address;

364 365 366 367 368
/* Sentinel node of the tree.  */

static struct mem_node mem_z;
#define MEM_NIL &mem_z

369
static POINTER_TYPE *lisp_malloc P_ ((size_t, enum mem_type));
370
static struct Lisp_Vector *allocate_vectorlike P_ ((EMACS_INT, enum mem_type));
371
static void lisp_free P_ ((POINTER_TYPE *));
372 373 374 375 376 377 378 379
static void mark_stack P_ ((void));
static int live_vector_p P_ ((struct mem_node *, void *));
static int live_buffer_p P_ ((struct mem_node *, void *));
static int live_string_p P_ ((struct mem_node *, void *));
static int live_cons_p P_ ((struct mem_node *, void *));
static int live_symbol_p P_ ((struct mem_node *, void *));
static int live_float_p P_ ((struct mem_node *, void *));
static int live_misc_p P_ ((struct mem_node *, void *));
380
static void mark_maybe_object P_ ((Lisp_Object));
381 382 383 384 385 386 387 388 389 390 391 392 393 394
static void mark_memory P_ ((void *, void *));
static void mem_init P_ ((void));
static struct mem_node *mem_insert P_ ((void *, void *, enum mem_type));
static void mem_insert_fixup P_ ((struct mem_node *));
static void mem_rotate_left P_ ((struct mem_node *));
static void mem_rotate_right P_ ((struct mem_node *));
static void mem_delete P_ ((struct mem_node *));
static void mem_delete_fixup P_ ((struct mem_node *));
static INLINE struct mem_node *mem_find P_ ((void *));

#if GC_MARK_STACK == GC_MARK_STACK_CHECK_GCPROS
static void check_gcpros P_ ((void));
#endif

395
#endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
396

397 398 399 400 401 402
/* Recording what needs to be marked for gc.  */

struct gcpro *gcprolist;

/* Addresses of staticpro'd variables.  */

Andreas Schwab's avatar
Andreas Schwab committed
403
#define NSTATICS 1280
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
Lisp_Object *staticvec[NSTATICS] = {0};

/* Index of next unused slot in staticvec.  */

int staticidx = 0;

static POINTER_TYPE *pure_alloc P_ ((size_t, int));


/* Value is SZ rounded up to the next multiple of ALIGNMENT.
   ALIGNMENT must be a power of 2.  */

#define ALIGN(SZ, ALIGNMENT) \
  (((SZ) + (ALIGNMENT) - 1) & ~((ALIGNMENT) - 1))

419

Jim Blandy's avatar
Jim Blandy committed
420

421 422 423 424 425 426
/************************************************************************
				Malloc
 ************************************************************************/

/* Write STR to Vstandard_output plus some advice on how to free some
   memory.  Called when memory gets low.  */
427

Jim Blandy's avatar
Jim Blandy committed
428 429 430 431 432 433 434 435 436 437 438
Lisp_Object
malloc_warning_1 (str)
     Lisp_Object str;
{
  Fprinc (str, Vstandard_output);
  write_string ("\nKilling some buffers may delay running out of memory.\n", -1);
  write_string ("However, certainly by the time you receive the 95% warning,\n", -1);
  write_string ("you should clean up, kill this Emacs, and start a new one.", -1);
  return Qnil;
}

439 440 441

/* Function malloc calls this if it finds we are near exhausting
   storage.  */
442 443

void
Jim Blandy's avatar
Jim Blandy committed
444 445 446 447 448 449
malloc_warning (str)
     char *str;
{
  pending_malloc_warning = str;
}

450 451 452

/* Display a malloc warning in buffer *Danger*.  */

453
void
Jim Blandy's avatar
Jim Blandy committed
454 455 456 457 458 459 460 461 462
display_malloc_warning ()
{
  register Lisp_Object val;

  val = build_string (pending_malloc_warning);
  pending_malloc_warning = 0;
  internal_with_output_to_temp_buffer (" *Danger*", malloc_warning_1, val);
}

463

464
#ifdef DOUG_LEA_MALLOC
465
#  define BYTES_USED (mallinfo ().arena)
466
#else
467
#  define BYTES_USED _bytes_used
468 469
#endif

470

471
/* Called if malloc returns zero.  */
472

473
void
Jim Blandy's avatar
Jim Blandy committed
474 475
memory_full ()
{
476 477
  Vmemory_full = Qt;

478
#ifndef SYSTEM_MALLOC
479
  bytes_used_when_full = BYTES_USED;
480 481 482 483 484 485 486 487 488
#endif

  /* The first time we get here, free the spare memory.  */
  if (spare_memory)
    {
      free (spare_memory);
      spare_memory = 0;
    }

489 490
  /* This used to call error, but if we've run out of memory, we could
     get infinite recursion trying to build the string.  */
491
  while (1)
492
    Fsignal (Qnil, Vmemory_signal_data);
493 494
}

495

496 497 498 499 500
/* Called if we can't allocate relocatable space for a buffer.  */

void
buffer_memory_full ()
{
501 502 503 504 505 506
  /* If buffers use the relocating allocator, no need to free
     spare_memory, because we may have plenty of malloc space left
     that we could get, and if we don't, the malloc that fails will
     itself cause spare_memory to be freed.  If buffers don't use the
     relocating allocator, treat this like any other failing
     malloc.  */
507 508 509 510 511

#ifndef REL_ALLOC
  memory_full ();
#endif

512 513
  Vmemory_full = Qt;

514 515
  /* This used to call error, but if we've run out of memory, we could
     get infinite recursion trying to build the string.  */
516
  while (1)
517
    Fsignal (Qnil, Vmemory_signal_data);
Jim Blandy's avatar
Jim Blandy committed
518 519
}

520 521

/* Like malloc but check for no memory and block interrupt input..  */
Jim Blandy's avatar
Jim Blandy committed
522

523
POINTER_TYPE *
Jim Blandy's avatar
Jim Blandy committed
524
xmalloc (size)
525
     size_t size;
Jim Blandy's avatar
Jim Blandy committed
526
{
527
  register POINTER_TYPE *val;
Jim Blandy's avatar
Jim Blandy committed
528

529
  BLOCK_INPUT;
530
  val = (POINTER_TYPE *) malloc (size);
531
  UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
532

533 534
  if (!val && size)
    memory_full ();
Jim Blandy's avatar
Jim Blandy committed
535 536 537
  return val;
}

538 539 540

/* Like realloc but check for no memory and block interrupt input..  */

541
POINTER_TYPE *
Jim Blandy's avatar
Jim Blandy committed
542
xrealloc (block, size)
543
     POINTER_TYPE *block;
544
     size_t size;
Jim Blandy's avatar
Jim Blandy committed
545
{
546
  register POINTER_TYPE *val;
Jim Blandy's avatar
Jim Blandy committed
547

548
  BLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
549 550 551
  /* We must call malloc explicitly when BLOCK is 0, since some
     reallocs don't do this.  */
  if (! block)
552
    val = (POINTER_TYPE *) malloc (size);
Noah Friedman's avatar
Noah Friedman committed
553
  else
554
    val = (POINTER_TYPE *) realloc (block, size);
555
  UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
556 557 558 559

  if (!val && size) memory_full ();
  return val;
}
560

561 562 563

/* Like free but block interrupt input..  */

564 565
void
xfree (block)
566
     POINTER_TYPE *block;
567 568 569 570 571 572
{
  BLOCK_INPUT;
  free (block);
  UNBLOCK_INPUT;
}

573

574 575 576 577
/* Like strdup, but uses xmalloc.  */

char *
xstrdup (s)
578
     const char *s;
579
{
580
  size_t len = strlen (s) + 1;
581 582 583 584 585 586
  char *p = (char *) xmalloc (len);
  bcopy (s, p, len);
  return p;
}


587 588 589 590
/* Like malloc but used for allocating Lisp data.  NBYTES is the
   number of bytes to allocate, TYPE describes the intended use of the
   allcated memory block (for strings, for conses, ...).  */

591
static POINTER_TYPE *
592
lisp_malloc (nbytes, type)
593
     size_t nbytes;
594
     enum mem_type type;
595
{
596
  register void *val;
597 598

  BLOCK_INPUT;
599 600 601 602 603

#ifdef GC_MALLOC_CHECK
  allocated_mem_type = type;
#endif
  
604
  val = (void *) malloc (nbytes);
605

606
#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
607
  if (val && type != MEM_TYPE_NON_LISP)
608 609
    mem_insert (val, (char *) val + nbytes, type);
#endif
610
   
611 612 613
  UNBLOCK_INPUT;
  if (!val && nbytes)
    memory_full ();
614 615 616
  return val;
}

617 618 619 620 621 622 623

/* Return a new buffer structure allocated from the heap with
   a call to lisp_malloc.  */

struct buffer *
allocate_buffer ()
{
624 625 626 627 628
  struct buffer *b 
    = (struct buffer *) lisp_malloc (sizeof (struct buffer),
				     MEM_TYPE_BUFFER);
  VALIDATE_LISP_STORAGE (b, sizeof *b);
  return b;
629 630 631 632 633 634
}


/* Free BLOCK.  This must be called to free memory allocated with a
   call to lisp_malloc.  */

635
static void
636
lisp_free (block)
637
     POINTER_TYPE *block;
638 639 640
{
  BLOCK_INPUT;
  free (block);
641
#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
642 643
  mem_delete (mem_find (block));
#endif
644 645
  UNBLOCK_INPUT;
}
646

647 648 649 650 651 652 653 654 655 656 657 658

/* Arranging to disable input signals while we're in malloc.

   This only works with GNU malloc.  To help out systems which can't
   use GNU malloc, all the calls to malloc, realloc, and free
   elsewhere in the code should be inside a BLOCK_INPUT/UNBLOCK_INPUT
   pairs; unfortunately, we have no idea what C library functions
   might call malloc, so we can't really protect them unless you're
   using GNU malloc.  Fortunately, most of the major operating can use
   GNU malloc.  */

#ifndef SYSTEM_MALLOC
659 660 661 662 663 664
#ifndef DOUG_LEA_MALLOC
extern void * (*__malloc_hook) P_ ((size_t));
extern void * (*__realloc_hook) P_ ((void *, size_t));
extern void (*__free_hook) P_ ((void *));
/* Else declared in malloc.h, perhaps with an extra arg.  */
#endif /* DOUG_LEA_MALLOC */
665 666 667
static void * (*old_malloc_hook) ();
static void * (*old_realloc_hook) ();
static void (*old_free_hook) ();
668

669 670
/* This function is used as the hook for free to call.  */

671 672 673 674 675
static void
emacs_blocked_free (ptr)
     void *ptr;
{
  BLOCK_INPUT;
676 677

#ifdef GC_MALLOC_CHECK
678 679 680
  if (ptr)
    {
      struct mem_node *m;
681
  
682 683 684 685 686 687 688 689 690 691 692 693 694
      m = mem_find (ptr);
      if (m == MEM_NIL || m->start != ptr)
	{
	  fprintf (stderr,
		   "Freeing `%p' which wasn't allocated with malloc\n", ptr);
	  abort ();
	}
      else
	{
	  /* fprintf (stderr, "free %p...%p (%p)\n", m->start, m->end, ptr); */
	  mem_delete (m);
	}
    }
695 696
#endif /* GC_MALLOC_CHECK */
  
697 698
  __free_hook = old_free_hook;
  free (ptr);
699
  
700 701 702 703 704 705 706 707 708
  /* If we released our reserve (due to running out of memory),
     and we have a fair amount free once again,
     try to set aside another reserve in case we run out once more.  */
  if (spare_memory == 0
      /* Verify there is enough space that even with the malloc
	 hysteresis this call won't run out again.
	 The code here is correct as long as SPARE_MEMORY
	 is substantially larger than the block size malloc uses.  */
      && (bytes_used_when_full
709
	  > BYTES_USED + max (malloc_hysteresis, 4) * SPARE_MEMORY))
710
    spare_memory = (char *) malloc ((size_t) SPARE_MEMORY);
711

712
  __free_hook = emacs_blocked_free;
713 714 715
  UNBLOCK_INPUT;
}

716

717 718 719 720 721 722 723 724 725 726
/* If we released our reserve (due to running out of memory),
   and we have a fair amount free once again,
   try to set aside another reserve in case we run out once more.

   This is called when a relocatable block is freed in ralloc.c.  */

void
refill_memory_reserve ()
{
  if (spare_memory == 0)
727
    spare_memory = (char *) malloc ((size_t) SPARE_MEMORY);
728 729
}

730

731 732
/* This function is the malloc hook that Emacs uses.  */

733 734
static void *
emacs_blocked_malloc (size)
735
     size_t size;
736 737 738 739 740
{
  void *value;

  BLOCK_INPUT;
  __malloc_hook = old_malloc_hook;
741
#ifdef DOUG_LEA_MALLOC
742
    mallopt (M_TOP_PAD, malloc_hysteresis * 4096);
743
#else
744
    __malloc_extra_blocks = malloc_hysteresis;
745
#endif
746

747
  value = (void *) malloc (size);
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769

#ifdef GC_MALLOC_CHECK
  {
    struct mem_node *m = mem_find (value);
    if (m != MEM_NIL)
      {
	fprintf (stderr, "Malloc returned %p which is already in use\n",
		 value);
	fprintf (stderr, "Region in use is %p...%p, %u bytes, type %d\n",
		 m->start, m->end, (char *) m->end - (char *) m->start,
		 m->type);
	abort ();
      }

    if (!dont_register_blocks)
      {
	mem_insert (value, (char *) value + max (1, size), allocated_mem_type);
	allocated_mem_type = MEM_TYPE_NON_LISP;
      }
  }
#endif /* GC_MALLOC_CHECK */
  
770
  __malloc_hook = emacs_blocked_malloc;
771 772
  UNBLOCK_INPUT;

773
  /* fprintf (stderr, "%p malloc\n", value); */
774 775 776
  return value;
}

777 778 779

/* This function is the realloc hook that Emacs uses.  */

780 781 782
static void *
emacs_blocked_realloc (ptr, size)
     void *ptr;
783
     size_t size;
784 785 786 787 788
{
  void *value;

  BLOCK_INPUT;
  __realloc_hook = old_realloc_hook;
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810

#ifdef GC_MALLOC_CHECK
  if (ptr)
    {
      struct mem_node *m = mem_find (ptr);
      if (m == MEM_NIL || m->start != ptr)
	{
	  fprintf (stderr,
		   "Realloc of %p which wasn't allocated with malloc\n",
		   ptr);
	  abort ();
	}

      mem_delete (m);
    }
  
  /* fprintf (stderr, "%p -> realloc\n", ptr); */
  
  /* Prevent malloc from registering blocks.  */
  dont_register_blocks = 1;
#endif /* GC_MALLOC_CHECK */

811
  value = (void *) realloc (ptr, size);
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830

#ifdef GC_MALLOC_CHECK
  dont_register_blocks = 0;

  {
    struct mem_node *m = mem_find (value);
    if (m != MEM_NIL)
      {
	fprintf (stderr, "Realloc returns memory that is already in use\n");
	abort ();
      }

    /* Can't handle zero size regions in the red-black tree.  */
    mem_insert (value, (char *) value + max (size, 1), MEM_TYPE_NON_LISP);
  }
  
  /* fprintf (stderr, "%p <- realloc\n", value); */
#endif /* GC_MALLOC_CHECK */
  
831
  __realloc_hook = emacs_blocked_realloc;
832 833 834 835 836
  UNBLOCK_INPUT;

  return value;
}

837 838 839

/* Called from main to set up malloc to use our hooks.  */

840 841 842
void
uninterrupt_malloc ()
{
843 844
  if (__free_hook != emacs_blocked_free)
    old_free_hook = __free_hook;
845
  __free_hook = emacs_blocked_free;
846

847 848
  if (__malloc_hook != emacs_blocked_malloc)
    old_malloc_hook = __malloc_hook;
849
  __malloc_hook = emacs_blocked_malloc;
850

851 852
  if (__realloc_hook != emacs_blocked_realloc)
    old_realloc_hook = __realloc_hook;
853
  __realloc_hook = emacs_blocked_realloc;
854
}
855 856 857 858

#endif /* not SYSTEM_MALLOC */


Jim Blandy's avatar
Jim Blandy committed
859

860 861 862
/***********************************************************************
			 Interval Allocation
 ***********************************************************************/
863

864 865 866
/* Number of intervals allocated in an interval_block structure.
   The 1020 is 1024 minus malloc overhead.  */

867 868 869
#define INTERVAL_BLOCK_SIZE \
  ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))

870 871 872
/* Intervals are allocated in chunks in form of an interval_block
   structure.  */

873
struct interval_block
874 875 876 877
{
  struct interval_block *next;
  struct interval intervals[INTERVAL_BLOCK_SIZE];
};
878

879 880 881
/* Current interval block.  Its `next' pointer points to older
   blocks.  */

882
struct interval_block *interval_block;
883 884 885 886

/* Index in interval_block above of the next unused interval
   structure.  */

887
static int interval_block_index;
888 889 890

/* Number of free and live intervals.  */

891
static int total_free_intervals, total_intervals;
892

893 894
/* List of free intervals.  */

895 896
INTERVAL interval_free_list;

897
/* Total number of interval blocks now in use.  */
898

899 900
int n_interval_blocks;

901 902 903

/* Initialize interval allocation.  */

904 905 906 907
static void
init_intervals ()
{
  interval_block
908 909
    = (struct interval_block *) lisp_malloc (sizeof *interval_block,
					     MEM_TYPE_NON_LISP);
910
  interval_block->next = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
911
  bzero ((char *) interval_block->intervals, sizeof interval_block->intervals);
912 913
  interval_block_index = 0;
  interval_free_list = 0;
914
  n_interval_blocks = 1;
915 916
}

917 918

/* Return a new interval.  */
919 920 921 922 923 924 925 926 927

INTERVAL
make_interval ()
{
  INTERVAL val;

  if (interval_free_list)
    {
      val = interval_free_list;
928
      interval_free_list = INTERVAL_PARENT (interval_free_list);
929 930 931 932 933
    }
  else
    {
      if (interval_block_index == INTERVAL_BLOCK_SIZE)
	{
Karl Heuer's avatar
Karl Heuer committed
934 935
	  register struct interval_block *newi;

936 937
	  newi = (struct interval_block *) lisp_malloc (sizeof *newi,
							MEM_TYPE_NON_LISP);
938 939 940 941 942

	  VALIDATE_LISP_STORAGE (newi, sizeof *newi);
	  newi->next = interval_block;
	  interval_block = newi;
	  interval_block_index = 0;
943
	  n_interval_blocks++;
944 945 946 947
	}
      val = &interval_block->intervals[interval_block_index++];
    }
  consing_since_gc += sizeof (struct interval);
948
  intervals_consed++;
949 950 951 952
  RESET_INTERVAL (val);
  return val;
}

953 954

/* Mark Lisp objects in interval I. */
955 956

static void
957
mark_interval (i, dummy)
958
     register INTERVAL i;
959
     Lisp_Object dummy;
960 961 962 963 964 965 966
{
  if (XMARKBIT (i->plist))
    abort ();
  mark_object (&i->plist);
  XMARK (i->plist);
}

967 968 969 970

/* Mark the interval tree rooted in TREE.  Don't call this directly;
   use the macro MARK_INTERVAL_TREE instead.  */

971 972 973 974
static void
mark_interval_tree (tree)
     register INTERVAL tree;
{
975 976 977 978 979 980
  /* No need to test if this tree has been marked already; this
     function is always called through the MARK_INTERVAL_TREE macro,
     which takes care of that.  */

  /* XMARK expands to an assignment; the LHS of an assignment can't be
     a cast.  */
981
  XMARK (tree->up.obj);
982

983
  traverse_intervals_noorder (tree, mark_interval, Qnil);
984 985
}

986 987 988

/* Mark the interval tree rooted in I.  */

989 990 991
#define MARK_INTERVAL_TREE(i)				\
  do {							\
    if (!NULL_INTERVAL_P (i)				\
992
	&& ! XMARKBIT (i->up.obj))			\
993 994
      mark_interval_tree (i);				\
  } while (0)
995

996

997
/* The oddity in the call to XUNMARK is necessary because XUNMARK
998 999 1000 1001 1002 1003 1004
   expands to an assignment to its argument, and most C compilers
   don't support casts on the left operand of `='.  */

#define UNMARK_BALANCE_INTERVALS(i)			\
  do {							\
   if (! NULL_INTERVAL_P (i))				\
     {							\
1005
       XUNMARK ((i)->up.obj);				\
1006 1007 1008
       (i) = balance_intervals (i);			\
     }							\
  } while (0)
1009

1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023

/* Number support.  If NO_UNION_TYPE isn't in effect, we
   can't create number objects in macros.  */
#ifndef make_number
Lisp_Object
make_number (n)
     int n;
{
  Lisp_Object obj;
  obj.s.val = n;
  obj.s.type = Lisp_Int;
  return obj;
}
#endif
1024

1025 1026 1027
/***********************************************************************
			  String Allocation
 ***********************************************************************/
1028

1029 1030
/* Lisp_Strings are allocated in string_block structures.  When a new
   string_block is allocated, all the Lisp_Strings it contains are
1031
   added to a free-list string_free_list.  When a new Lisp_String is
1032 1033 1034
   needed, it is taken from that list.  During the sweep phase of GC,
   string_blocks that are entirely free are freed, except two which
   we keep.
Jim Blandy's avatar
Jim Blandy committed
1035

1036 1037 1038
   String data is allocated from sblock structures.  Strings larger
   than LARGE_STRING_BYTES, get their own sblock, data for smaller
   strings is sub-allocated out of sblocks of size SBLOCK_SIZE.
Jim Blandy's avatar
Jim Blandy committed
1039

1040 1041 1042 1043
   Sblocks consist internally of sdata structures, one for each
   Lisp_String.  The sdata structure points to the Lisp_String it
   belongs to.  The Lisp_String points back to the `u.data' member of
   its sdata structure.
Jim Blandy's avatar
Jim Blandy committed
1044

1045 1046 1047 1048 1049 1050
   When a Lisp_String is freed during GC, it is put back on
   string_free_list, and its `data' member and its sdata's `string'
   pointer is set to null.  The size of the string is recorded in the
   `u.nbytes' member of the sdata.  So, sdata structures that are no
   longer used, can be easily recognized, and it's easy to compact the
   sblocks of small strings which we do in compact_small_strings.  */
Jim Blandy's avatar
Jim Blandy committed
1051

1052 1053
/* Size in bytes of an sblock structure used for small strings.  This
   is 8192 minus malloc overhead.  */
Jim Blandy's avatar
Jim Blandy committed
1054

1055
#define SBLOCK_SIZE 8188
1056

1057 1058
/* Strings larger than this are considered large strings.  String data
   for large strings is allocated from individual sblocks.  */
Jim Blandy's avatar
Jim Blandy committed
1059

1060 1061 1062 1063 1064 1065
#define LARGE_STRING_BYTES 1024

/* Structure describing string memory sub-allocated from an sblock.
   This is where the contents of Lisp strings are stored.  */

struct sdata
Jim Blandy's avatar
Jim Blandy committed
1066
{
1067 1068
  /* Back-pointer to the string this sdata belongs to.  If null, this
     structure is free, and the NBYTES member of the union below
1069
     contains the string's byte size (the same value that STRING_BYTES
1070 1071 1072 1073
     w