annotate src/puresize.h @ 75486:b477debfe297

Revert previous change while we figure out if it was correct.
author Glenn Morris <rgm@gnu.org>
date Sun, 28 Jan 2007 21:40:03 +0000
parents e90d04cd455a
children 922696f363b0 b8d9a391daf3 95d0cdf160ea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* How much read-only Lisp storage a dumped Emacs needs.
75227
e90d04cd455a Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 72306
diff changeset
2 Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005,
e90d04cd455a Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 72306
diff changeset
3 2006, 2007 Free Software Foundation, Inc.
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5 This file is part of GNU Emacs.
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 GNU Emacs is free software; you can redistribute it and/or modify
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 it under the terms of the GNU General Public License as published by
12244
ac7375e60931 Update GPL to version 2.
Karl Heuer <kwzh@gnu.org>
parents: 11236
diff changeset
9 the Free Software Foundation; either version 2, or (at your option)
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10 any later version.
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 GNU Emacs is distributed in the hope that it will be useful,
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 GNU General Public License for more details.
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 along with GNU Emacs; see the file COPYING. If not, write to
64084
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 57111
diff changeset
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 57111
diff changeset
20 Boston, MA 02110-1301, USA. */
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
8933
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
22 /* Define PURESIZE, the number of bytes of pure Lisp code to leave space for.
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
23
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
24 At one point, this was defined in config.h, meaning that changing
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
25 PURESIZE would make Make recompile all of Emacs. But only a few
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 355
diff changeset
26 files actually use PURESIZE, so we split it out to its own .h file.
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 355
diff changeset
27
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 355
diff changeset
28 Make sure to include this file after config.h, since that tells us
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 355
diff changeset
29 whether we are running X windows, which tells us how much pure
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 355
diff changeset
30 storage to allocate. */
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31
8933
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
32 /* First define a measure of the amount of data we have. */
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
33
9572
b36d5e88cccc *** empty log message ***
Morten Welinder <terra@diku.dk>
parents: 9514
diff changeset
34 /* A system configuration file may set this to request a certain extra
b36d5e88cccc *** empty log message ***
Morten Welinder <terra@diku.dk>
parents: 9514
diff changeset
35 amount of storage. This is a lot more update-robust that defining
b36d5e88cccc *** empty log message ***
Morten Welinder <terra@diku.dk>
parents: 9514
diff changeset
36 BASE_PURESIZE or even PURESIZE directly. */
b36d5e88cccc *** empty log message ***
Morten Welinder <terra@diku.dk>
parents: 9514
diff changeset
37 #ifndef SYSTEM_PURESIZE_EXTRA
b36d5e88cccc *** empty log message ***
Morten Welinder <terra@diku.dk>
parents: 9514
diff changeset
38 #define SYSTEM_PURESIZE_EXTRA 0
b36d5e88cccc *** empty log message ***
Morten Welinder <terra@diku.dk>
parents: 9514
diff changeset
39 #endif
b36d5e88cccc *** empty log message ***
Morten Welinder <terra@diku.dk>
parents: 9514
diff changeset
40
12986
180f04639e71 (SITELOAD_PURESIZE_EXTRA): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 12612
diff changeset
41 #ifndef SITELOAD_PURESIZE_EXTRA
180f04639e71 (SITELOAD_PURESIZE_EXTRA): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 12612
diff changeset
42 #define SITELOAD_PURESIZE_EXTRA 0
180f04639e71 (SITELOAD_PURESIZE_EXTRA): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 12612
diff changeset
43 #endif
180f04639e71 (SITELOAD_PURESIZE_EXTRA): New macro.
Richard M. Stallman <rms@gnu.org>
parents: 12612
diff changeset
44
8933
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
45 #ifndef BASE_PURESIZE
72306
60cebde75072 (BASE_PURESIZE): Increase to 1120000.
Andreas Schwab <schwab@suse.de>
parents: 72115
diff changeset
46 #define BASE_PURESIZE (1120000 + SYSTEM_PURESIZE_EXTRA + SITELOAD_PURESIZE_EXTRA)
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 355
diff changeset
47 #endif
8933
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
48
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
49 /* Increase BASE_PURESIZE by a ratio depending on the machine's word size. */
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
50 #ifndef PURESIZE_RATIO
57111
722f614e880a (PURESIZE_RATIO): Define based on BITS_PER_EMACS_INT.
Kim F. Storm <storm@cua.dk>
parents: 54822
diff changeset
51 #if BITS_PER_EMACS_INT > 32
70035
479ddf150263 (PURESIZE_RATIO): Reduce to 10/6.
Andreas Schwab <schwab@suse.de>
parents: 70031
diff changeset
52 #define PURESIZE_RATIO 10/6 /* Don't surround with `()'. */
8933
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
53 #else
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
54 #define PURESIZE_RATIO 1
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
55 #endif
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
56 #endif
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
57
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
58 /* This is the actual size in bytes to allocate. */
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
59 #ifndef PURESIZE
f060ee7326c5 (PURESIZE_RATIO, BASE_PURESIZE): Defined.
Richard M. Stallman <rms@gnu.org>
parents: 8832
diff changeset
60 #define PURESIZE (BASE_PURESIZE * PURESIZE_RATIO)
484
3165b2697c78 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 355
diff changeset
61 #endif
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
62
13778
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
63 /* Signal an error if OBJ is pure. */
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
64 #define CHECK_IMPURE(obj) \
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
65 { if (PURE_P (obj)) \
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
66 pure_write_error (); }
21515
fb4c986db0e2 Add more prototypes.
Andreas Schwab <schwab@suse.de>
parents: 21060
diff changeset
67
69883
a21d00510558 * puresize.h (pure_write_error): Mark as NO_RETURN.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 68976
diff changeset
68 extern void pure_write_error P_ ((void)) NO_RETURN;
13778
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
69
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
70 /* Define PURE_P. */
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
71
54822
09d9fc390321 Set up PURE_P() for Cygwin unexec() support.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
72 #if defined(VIRT_ADDR_VARIES) || defined(CYGWIN)
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
73 /* For machines like APOLLO where text and data can go anywhere
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
74 in virtual memory. */
13778
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
75
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
76 extern EMACS_INT pure[];
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
77
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
78 #define PURE_P(obj) \
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
79 ((PNTR_COMPARISON_TYPE) XPNTR (obj) < (PNTR_COMPARISON_TYPE) ((char *) pure + PURESIZE) \
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
80 && (PNTR_COMPARISON_TYPE) XPNTR (obj) >= (PNTR_COMPARISON_TYPE) pure)
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
81
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
82 #else /* not VIRT_ADDR_VARIES */
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
83 #ifdef PNTR_COMPARISON_TYPE
13778
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
84 /* When PNTR_COMPARISON_TYPE is not the default (unsigned int). */
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
85
13778
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
86 extern char my_edata[];
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
87
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
88 #define PURE_P(obj) \
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
89 ((PNTR_COMPARISON_TYPE) XPNTR (obj) < (PNTR_COMPARISON_TYPE) my_edata)
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
90
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
91 #else /* not VIRT_ADDRESS_VARIES, not PNTR_COMPARISON_TYPE */
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
92
13778
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
93 extern char my_edata[];
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46842
diff changeset
94
13778
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
95 #define PURE_P(obj) \
7b2f71009e4c (PURE_P): New macro (three definitions).
Karl Heuer <kwzh@gnu.org>
parents: 12986
diff changeset
96 (XPNTR (obj) < (unsigned int) my_edata)
355
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
97
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
98 #endif /* PNTR_COMPARISON_TYPE */
ec5e971707d6 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
99 #endif /* VIRT_ADDRESS_VARIES */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52255
diff changeset
100
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52255
diff changeset
101 /* arch-tag: fd9b0a91-a70e-4729-a75a-6bb4ca1ce14f
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52255
diff changeset
102 (do not change this comment) */