1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
|
/* Copyright (C) 1992, 1995 Aladdin Enterprises. All rights reserved.
This file is part of GNU Ghostscript.
GNU Ghostscript is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY. No author or distributor accepts responsibility to
anyone for the consequences of using it or for whether it serves any
particular purpose or works at all, unless he says so in writing. Refer
to the GNU Ghostscript General Public License for full details.
*/
/* dstack.h */
/* Definitions for the dictionary stack */
#include "istack.h"
/* Define the dictionary stack and systemdict. */
extern ref_stack d_stack;
extern ref ref_systemdict;
#define systemdict (&ref_systemdict)
/* Define the dictionary stack pointers. */
typedef s_ptr ds_ptr;
typedef const_s_ptr const_ds_ptr;
#define dsbot (d_stack.bot)
#define dsp (d_stack.p)
#define dstop (d_stack.top)
/* Macro to ensure enough room on the dictionary stack */
#define check_dstack(n)\
if ( dstop - dsp < (n) )\
{ d_stack.requested = (n); return_error(e_dictstackoverflow); }
/* Check whether a dictionary is one of the permanent ones on the d-stack. */
bool dict_is_permanent_on_dstack(P1(const ref *));
/*
* Switching between Level 1 and Level 2 involves inserting and removing
* globaldict on the dictionary stack. Instead of truly inserting and
* removing entries, we replace globaldict by a copy of systemdict in
* Level 1 mode. min_dstack_size, the minimum number of entries, does not
* change depending on language level; the countdictstack and dictstack
* operators must take this into account.
*/
extern uint min_dstack_size;
/*
* The dictionary stack is implemented as a linked list of blocks;
* operators that access the entire d-stack must take this into account.
* These are:
* countdictstack dictstack
* In addition, name lookup requires searching the entire stack, not just
* the top block, and the underflow check for the dictionary stack
* (`end' operator) is not just a check for underflowing the top block.
*/
/*
* Cache a value for fast checking of def operations.
* If the top entry on the dictionary stack is a writable dictionary,
* dsspace is the space of the dictionary; if it is a non-writable
* dictionary, dsspace = -1. Then def is legal precisely if
* r_space(pvalue) <= dsspace.
*/
extern int dsspace;
#define dtop_can_store(pvalue) (r_space(pvalue) <= dsspace)
/*
* Cache values for fast name lookup. If the top entry on the dictionary
* stack is a readable dictionary with packed keys, dtop_keys, dtop_npairs,
* and dtop_values are keys.value.packed, npairs, and values.value.refs
* for that dictionary; otherwise, these variables point to a dummy
* empty dictionary.
*/
extern const ref_packed *dtop_keys;
extern uint dtop_npairs;
extern ref *dtop_values;
/*
* Reset the cached top values. Every routine that alters the
* dictionary stack (including changing the protection or size of the
* top dictionary on the stack) must call this.
*/
void dict_set_top(P0());
/*
* Define a special fast entry for name lookup in the interpreter.
* The key is known to be a name; search the entire dict stack.
* Return the pointer to the value slot.
* If the name isn't found, just return 0.
*/
ref *dict_find_name_by_index(P1(uint nidx));
#define dict_find_name(pnref) dict_find_name_by_index(name_index(pnref))
/* Define some auxiliary macros needed for inline code. */
#define hash_mod_large(hash, size) ((hash) & ((size) - 1))
#define hash_mod_small(hash, size) ((hash) % (size))
#define dict_round_size_large(asize)\
while ( asize & (asize - 1) ) asize = (asize | (asize >> 1)) + 1
#define dict_round_size_small(asize)\
DO_NOTHING
#if arch_small_memory
# define hash_mod(h, s) hash_mod_small(h, s)
# define dict_round_size(s) dict_round_size_small(s)
#else
# ifdef DEBUG
# define hash_mod(h, s)\
(gs_debug_c('.') ? hash_mod_small(h, s) : hash_mod_large(h, s))
# define dict_round_size(s)\
if ( !gs_debug_c('.') ) dict_round_size_large(s)
# else
# define hash_mod(h, s) hash_mod_large(h, s)
# define dict_round_size(s) dict_round_size_large(s)
# endif
#endif
/* Define the hashing function for names. */
/* We don't have to scramble the index, because */
/* indices are assigned in a scattered order (see name_ref in iname.c). */
#define dict_name_index_hash(nidx) (nidx)
/*
* Define an extra-fast macro for name lookup, optimized for
* a single-probe lookup in the top dictionary on the stack.
* Amazingly enough, this seems to hit over 90% of the time
* (aside from operators, of course, which are handled either with
* the special cache pointer or with 'bind').
*/
#define dict_find_name_by_index_inline(nidx,htemp)\
(dtop_keys[htemp = hash_mod(dict_name_index_hash(nidx),\
dtop_npairs) + 1] == pt_tag(pt_literal_name) + (nidx) ?\
dtop_values + htemp : dict_find_name_by_index(nidx))
/*
* Define a similar macro that only checks the top dictionary on the stack.
*/
#define if_dict_find_name_by_index_top(nidx,htemp,pvslot)\
if ( ((dtop_keys[htemp = hash_mod(dict_name_index_hash(nidx),\
dtop_npairs) + 1] == pt_tag(pt_literal_name) + (nidx)) ?\
((pvslot) = dtop_values + (htemp), 1) :\
0)\
)
/*
Notes on "shallow binding".
We mark heavily used operations with a * below; moderately heavily used
operations with a +.
The following operations change the dictionary stack:
+begin, +end
readonly (on a dictionary that is on the stack)
noaccess (on a dictionary that is on the stack)
We implement cleardictstack as a series of ends.
The following operations change the contents of dictionaries:
*def, +put
undef
restore
.setmaxlength
We implement store in PostScript, and copy as a series of puts. Many
other operators also do puts (e.g., ScaleMatrix in makefont,
Implementation in makepattern, ...). Note that put can do an implicit
.setmaxlength (if it has to grow the dictionary).
The following operations look up keys on the dictionary stack:
*(interpreter name lookup)
load
where
We implement shallow binding with a pointer in each name that points to
the value slot that holds the name's definition. If the name is
undefined, or if we don't know where the slot is, the binding pointer
points to a ref with a special type t__invalid, which cannot occur
anywhere else. "Clearing" the pointer means setting it to point to this
ref.
We also maintain a pair of pointers that bracket the value region of the
top dictionary on the stack, for fast checking in def. If the top
dictionary is readonly or noaccess, the pointers designate an empty area.
We call this the "def region" cache.
We implement the above operations as follows:
begin - push the dictionary on the stack; set the pointers of
all name keys to point to the corresponding value slots.
end - pop the stack; clear the pointers of all name keys.
readonly - if the dictionary is the top one on the stack,
reset the def region cache.
noaccess - clear the pointers of all name keys. (This is overly
conservative, but this is a very rare operation.)
Also reset the def region cache if the dictionary is
the top one on the stack.
def - if the key is a name and its pointer points within the cached
def region, store the value through the pointer; otherwise,
look up the key in the top dictionary, store the value,
and if the key is a name, set its pointer to the value slot.
put - if the key is a name and wasn't in the dictionary before,
clear its pointer. (Conservative, but rare.)
undef - if the key is a name, clear its pointer. (Overly
conservative, but rare.)
restore - if either the old or the new value of a change is a name
(possibly in a packed array), clear its pointer. This is
conservative, but easy to detect, and probably not *too*
conservative.
.setmaxlength - clear all the pointers, like noaccess.
(name lookup) - fetch the value through the pointer and dispatch
on its type; if the type is t__invalid, do a full search
and set the pointer. This avoids a separate check for a
clear pointer in the usual case where the pointer is valid.
load - if the pointer is clear, do a search and set the pointer;
then fetch the value.
where - always do a full search and set the pointer.
(Conservative, but rare.)
One place where shallow binding will result in major new overhead is the
extra push of systemdict for loading fonts. This probably isn't a problem
in real life.
*/
|