alloc.c 136 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
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
int cons_cells_consed;
int floats_consed;
int vector_cells_consed;
int symbols_consed;
int string_chars_consed;
int misc_objects_consed;
int intervals_consed;
132 133 134
int strings_consed;

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

136
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

Jim Blandy's avatar
Jim Blandy committed
158 159
int undo_limit;
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 184
Lisp_Object Vpurify_flag;

#ifndef HAVE_SHM
185 186 187 188

/* Force it into data space! */

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

191
#else /* HAVE_SHM */
192

Jim Blandy's avatar
Jim Blandy committed
193 194
#define pure PURE_SEG_BITS   /* Use shared memory segment */
#define PUREBEG (char *)PURE_SEG_BITS
Jim Blandy's avatar
Jim Blandy committed
195

196
#endif /* HAVE_SHM */
197

198
/* Pointer to the pure area, and its size.  */
199

200 201 202 203 204 205 206
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
207

208 209 210 211
/* Value is non-zero if P points into pure space.  */

#define PURE_POINTER_P(P)					\
     (((PNTR_COMPARISON_TYPE) (P)				\
212
       < (PNTR_COMPARISON_TYPE) ((char *) purebeg + pure_size))	\
213
      && ((PNTR_COMPARISON_TYPE) (P)				\
214
	  >= (PNTR_COMPARISON_TYPE) purebeg))
215

216 217
/* Index in pure at which next pure object will be allocated.. */

218
int pure_bytes_used;
Jim Blandy's avatar
Jim Blandy committed
219

220 221 222
/* If nonzero, this is a warning delivered by malloc and not yet
   displayed.  */

Jim Blandy's avatar
Jim Blandy committed
223 224
char *pending_malloc_warning;

225
/* Pre-computed signal argument for use when memory is exhausted.  */
226

227
Lisp_Object memory_signal_data;
228

Jim Blandy's avatar
Jim Blandy committed
229 230 231 232 233 234 235 236 237 238 239
/* 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;

240 241 242
/* Non-zero means ignore malloc warnings.  Set during initialization.
   Currently not used.  */

Jim Blandy's avatar
Jim Blandy committed
243
int ignore_warnings;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
244

245
Lisp_Object Qgc_cons_threshold, Qchar_table_extra_slots;
246

247 248 249 250
/* Hook run after GC has finished.  */

Lisp_Object Vpost_gc_hook, Qpost_gc_hook;

251 252 253
static void mark_buffer P_ ((Lisp_Object));
static void mark_kboards P_ ((void));
static void gc_sweep P_ ((void));
254 255 256 257 258 259 260 261
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 */

262 263 264 265
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
266 267

extern int message_enable_multibyte;
268 269 270 271 272 273 274 275 276 277 278 279 280 281

/* 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,
282 283 284 285 286 287 288 289
  /* 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
290 291
};

292
#if GC_MARK_STACK || defined GC_MALLOC_CHECK
293 294 295 296 297 298 299 300 301 302

#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;

303 304 305 306 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
#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;

356 357 358 359
/* Lowest and highest known address in the heap.  */

static void *min_heap_address, *max_heap_address;

360 361 362 363 364
/* Sentinel node of the tree.  */

static struct mem_node mem_z;
#define MEM_NIL &mem_z

365
static POINTER_TYPE *lisp_malloc P_ ((size_t, enum mem_type));
366
static struct Lisp_Vector *allocate_vectorlike P_ ((EMACS_INT, enum mem_type));
367
static void lisp_free P_ ((POINTER_TYPE *));
368 369 370 371 372 373 374 375
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 *));
376
static void mark_maybe_object P_ ((Lisp_Object));
377 378 379 380 381 382 383 384 385 386 387 388 389 390
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

391
#endif /* GC_MARK_STACK || GC_MALLOC_CHECK */
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
/* Recording what needs to be marked for gc.  */

struct gcpro *gcprolist;

/* Addresses of staticpro'd variables.  */

#define NSTATICS 1024
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))

415

Jim Blandy's avatar
Jim Blandy committed
416

417 418 419 420 421 422
/************************************************************************
				Malloc
 ************************************************************************/

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

Jim Blandy's avatar
Jim Blandy committed
424 425 426 427 428 429 430 431 432 433 434
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;
}

435 436 437

/* Function malloc calls this if it finds we are near exhausting
   storage.  */
438 439

void
Jim Blandy's avatar
Jim Blandy committed
440 441 442 443 444 445
malloc_warning (str)
     char *str;
{
  pending_malloc_warning = str;
}

446 447 448

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

449
void
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453 454 455 456 457 458
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);
}

459

460
#ifdef DOUG_LEA_MALLOC
461
#  define BYTES_USED (mallinfo ().arena)
462
#else
463
#  define BYTES_USED _bytes_used
464 465
#endif

466

467
/* Called if malloc returns zero.  */
468

469
void
Jim Blandy's avatar
Jim Blandy committed
470 471
memory_full ()
{
472
#ifndef SYSTEM_MALLOC
473
  bytes_used_when_full = BYTES_USED;
474 475 476 477 478 479 480 481 482
#endif

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

483 484
  /* This used to call error, but if we've run out of memory, we could
     get infinite recursion trying to build the string.  */
485
  while (1)
486
    Fsignal (Qnil, memory_signal_data);
487 488
}

489

490 491 492 493 494
/* Called if we can't allocate relocatable space for a buffer.  */

void
buffer_memory_full ()
{
495 496 497 498 499 500
  /* 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.  */
501 502 503 504 505

#ifndef REL_ALLOC
  memory_full ();
#endif

506 507
  /* This used to call error, but if we've run out of memory, we could
     get infinite recursion trying to build the string.  */
508 509
  while (1)
    Fsignal (Qerror, memory_signal_data);
Jim Blandy's avatar
Jim Blandy committed
510 511
}

512 513

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

515
POINTER_TYPE *
Jim Blandy's avatar
Jim Blandy committed
516
xmalloc (size)
517
     size_t size;
Jim Blandy's avatar
Jim Blandy committed
518
{
519
  register POINTER_TYPE *val;
Jim Blandy's avatar
Jim Blandy committed
520

521
  BLOCK_INPUT;
522
  val = (POINTER_TYPE *) malloc (size);
523
  UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
524

525 526
  if (!val && size)
    memory_full ();
Jim Blandy's avatar
Jim Blandy committed
527 528 529
  return val;
}

530 531 532

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

533
POINTER_TYPE *
Jim Blandy's avatar
Jim Blandy committed
534
xrealloc (block, size)
535
     POINTER_TYPE *block;
536
     size_t size;
Jim Blandy's avatar
Jim Blandy committed
537
{
538
  register POINTER_TYPE *val;
Jim Blandy's avatar
Jim Blandy committed
539

540
  BLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
541 542 543
  /* We must call malloc explicitly when BLOCK is 0, since some
     reallocs don't do this.  */
  if (! block)
544
    val = (POINTER_TYPE *) malloc (size);
Noah Friedman's avatar
Noah Friedman committed
545
  else
546
    val = (POINTER_TYPE *) realloc (block, size);
547
  UNBLOCK_INPUT;
Jim Blandy's avatar
Jim Blandy committed
548 549 550 551

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

553 554 555

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

556 557
void
xfree (block)
558
     POINTER_TYPE *block;
559 560 561 562 563 564
{
  BLOCK_INPUT;
  free (block);
  UNBLOCK_INPUT;
}

565

566 567 568 569 570 571
/* Like strdup, but uses xmalloc.  */

char *
xstrdup (s)
     char *s;
{
572
  size_t len = strlen (s) + 1;
573 574 575 576 577 578
  char *p = (char *) xmalloc (len);
  bcopy (s, p, len);
  return p;
}


579 580 581 582
/* 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, ...).  */

583
static POINTER_TYPE *
584
lisp_malloc (nbytes, type)
585
     size_t nbytes;
586
     enum mem_type type;
587
{
588
  register void *val;
589 590

  BLOCK_INPUT;
591 592 593 594 595

#ifdef GC_MALLOC_CHECK
  allocated_mem_type = type;
#endif
  
596
  val = (void *) malloc (nbytes);
597

598
#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
599
  if (val && type != MEM_TYPE_NON_LISP)
600 601
    mem_insert (val, (char *) val + nbytes, type);
#endif
602
   
603 604 605
  UNBLOCK_INPUT;
  if (!val && nbytes)
    memory_full ();
606 607 608
  return val;
}

609 610 611 612 613 614 615

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

struct buffer *
allocate_buffer ()
{
616 617 618 619 620
  struct buffer *b 
    = (struct buffer *) lisp_malloc (sizeof (struct buffer),
				     MEM_TYPE_BUFFER);
  VALIDATE_LISP_STORAGE (b, sizeof *b);
  return b;
621 622 623 624 625 626
}


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

627
static void
628
lisp_free (block)
629
     POINTER_TYPE *block;
630 631 632
{
  BLOCK_INPUT;
  free (block);
633
#if GC_MARK_STACK && !defined GC_MALLOC_CHECK
634 635
  mem_delete (mem_find (block));
#endif
636 637
  UNBLOCK_INPUT;
}
638

639 640 641 642 643 644 645 646 647 648 649 650

/* 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
651 652 653 654 655 656
#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 */
657 658 659
static void * (*old_malloc_hook) ();
static void * (*old_realloc_hook) ();
static void (*old_free_hook) ();
660

661 662
/* This function is used as the hook for free to call.  */

663 664 665 666 667
static void
emacs_blocked_free (ptr)
     void *ptr;
{
  BLOCK_INPUT;
668 669

#ifdef GC_MALLOC_CHECK
670 671 672
  if (ptr)
    {
      struct mem_node *m;
673
  
674 675 676 677 678 679 680 681 682 683 684 685 686
      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);
	}
    }
687 688
#endif /* GC_MALLOC_CHECK */
  
689 690
  __free_hook = old_free_hook;
  free (ptr);
691
  
692 693 694 695 696 697 698 699 700
  /* 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
701
	  > BYTES_USED + max (malloc_hysteresis, 4) * SPARE_MEMORY))
702
    spare_memory = (char *) malloc ((size_t) SPARE_MEMORY);
703

704
  __free_hook = emacs_blocked_free;
705 706 707
  UNBLOCK_INPUT;
}

708

709 710 711 712 713 714 715 716 717 718
/* 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)
719
    spare_memory = (char *) malloc ((size_t) SPARE_MEMORY);
720 721
}

722

723 724
/* This function is the malloc hook that Emacs uses.  */

725 726
static void *
emacs_blocked_malloc (size)
727
     size_t size;
728 729 730 731 732
{
  void *value;

  BLOCK_INPUT;
  __malloc_hook = old_malloc_hook;
733
#ifdef DOUG_LEA_MALLOC
734
    mallopt (M_TOP_PAD, malloc_hysteresis * 4096);
735
#else
736
    __malloc_extra_blocks = malloc_hysteresis;
737
#endif
738

739
  value = (void *) malloc (size);
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761

#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 */
  
762
  __malloc_hook = emacs_blocked_malloc;
763 764
  UNBLOCK_INPUT;

765
  /* fprintf (stderr, "%p malloc\n", value); */
766 767 768
  return value;
}

769 770 771

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

772 773 774
static void *
emacs_blocked_realloc (ptr, size)
     void *ptr;
775
     size_t size;
776 777 778 779 780
{
  void *value;

  BLOCK_INPUT;
  __realloc_hook = old_realloc_hook;
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802

#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 */

803
  value = (void *) realloc (ptr, size);
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822

#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 */
  
823
  __realloc_hook = emacs_blocked_realloc;
824 825 826 827 828
  UNBLOCK_INPUT;

  return value;
}

829 830 831

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

832 833 834
void
uninterrupt_malloc ()
{
835 836
  if (__free_hook != emacs_blocked_free)
    old_free_hook = __free_hook;
837
  __free_hook = emacs_blocked_free;
838

839 840
  if (__malloc_hook != emacs_blocked_malloc)
    old_malloc_hook = __malloc_hook;
841
  __malloc_hook = emacs_blocked_malloc;
842

843 844
  if (__realloc_hook != emacs_blocked_realloc)
    old_realloc_hook = __realloc_hook;
845
  __realloc_hook = emacs_blocked_realloc;
846
}
847 848 849 850

#endif /* not SYSTEM_MALLOC */


Jim Blandy's avatar
Jim Blandy committed
851

852 853 854
/***********************************************************************
			 Interval Allocation
 ***********************************************************************/
855

856 857 858
/* Number of intervals allocated in an interval_block structure.
   The 1020 is 1024 minus malloc overhead.  */

859 860 861
#define INTERVAL_BLOCK_SIZE \
  ((1020 - sizeof (struct interval_block *)) / sizeof (struct interval))

862 863 864
/* Intervals are allocated in chunks in form of an interval_block
   structure.  */

865
struct interval_block
866 867 868 869
{
  struct interval_block *next;
  struct interval intervals[INTERVAL_BLOCK_SIZE];
};
870

871 872 873
/* Current interval block.  Its `next' pointer points to older
   blocks.  */

874
struct interval_block *interval_block;
875 876 877 878

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

879
static int interval_block_index;
880 881 882

/* Number of free and live intervals.  */

883
static int total_free_intervals, total_intervals;
884

885 886
/* List of free intervals.  */

887 888
INTERVAL interval_free_list;

889
/* Total number of interval blocks now in use.  */
890

891 892
int n_interval_blocks;

893 894 895

/* Initialize interval allocation.  */

896 897 898 899
static void
init_intervals ()
{
  interval_block
900 901
    = (struct interval_block *) lisp_malloc (sizeof *interval_block,
					     MEM_TYPE_NON_LISP);
902
  interval_block->next = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
903
  bzero ((char *) interval_block->intervals, sizeof interval_block->intervals);
904 905
  interval_block_index = 0;
  interval_free_list = 0;
906
  n_interval_blocks = 1;
907 908
}

909 910

/* Return a new interval.  */
911 912 913 914 915 916 917 918 919

INTERVAL
make_interval ()
{
  INTERVAL val;

  if (interval_free_list)
    {
      val = interval_free_list;
920
      interval_free_list = INTERVAL_PARENT (interval_free_list);
921 922 923 924 925
    }
  else
    {
      if (interval_block_index == INTERVAL_BLOCK_SIZE)
	{
Karl Heuer's avatar
Karl Heuer committed
926 927
	  register struct interval_block *newi;

928 929
	  newi = (struct interval_block *) lisp_malloc (sizeof *newi,
							MEM_TYPE_NON_LISP);
930 931 932 933 934

	  VALIDATE_LISP_STORAGE (newi, sizeof *newi);
	  newi->next = interval_block;
	  interval_block = newi;
	  interval_block_index = 0;
935
	  n_interval_blocks++;
936 937 938 939
	}
      val = &interval_block->intervals[interval_block_index++];
    }
  consing_since_gc += sizeof (struct interval);
940
  intervals_consed++;
941 942 943 944
  RESET_INTERVAL (val);
  return val;
}

945 946

/* Mark Lisp objects in interval I. */
947 948

static void
949
mark_interval (i, dummy)
950
     register INTERVAL i;
951
     Lisp_Object dummy;
952 953 954 955 956 957 958
{
  if (XMARKBIT (i->plist))
    abort ();
  mark_object (&i->plist);
  XMARK (i->plist);
}

959 960 961 962

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

963 964 965 966
static void
mark_interval_tree (tree)
     register INTERVAL tree;
{
967 968 969 970 971 972
  /* 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.  */
973
  XMARK (tree->up.obj);
974

975
  traverse_intervals (tree, 1, 0, mark_interval, Qnil);
976 977
}

978 979 980

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

981 982 983
#define MARK_INTERVAL_TREE(i)				\
  do {							\
    if (!NULL_INTERVAL_P (i)				\
984
	&& ! XMARKBIT (i->up.obj))			\
985 986
      mark_interval_tree (i);				\
  } while (0)
987

988

989
/* The oddity in the call to XUNMARK is necessary because XUNMARK
990 991 992 993 994 995 996
   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))				\
     {							\
997
       XUNMARK ((i)->up.obj);				\
998 999 1000
       (i) = balance_intervals (i);			\
     }							\
  } while (0)
1001

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

/* 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
1016

1017 1018 1019
/***********************************************************************
			  String Allocation
 ***********************************************************************/
1020

1021 1022 1023 1024 1025 1026
/* Lisp_Strings are allocated in string_block structures.  When a new
   string_block is allocated, all the Lisp_Strings it contains are
   added to a free-list stiing_free_list.  When a new Lisp_String is
   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
1027

1028 1029 1030
   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
1031