2 # gc.a - builds basic library
3 # libgc.a - builds library for use with g++ "-fgc-keyword" extension
4 # c++ - adds C++ interface to library
5 # cords - adds cords (heavyweight strings) to library
6 # test - prints porting information, then builds basic version of gc.a,
7 # and runs some tests of collector and cords. Does not add cords or
8 # c++ interface to gc.a
9 # cord/de - builds dumb editor based on cords.
14 # The above doesn't work with gas, which doesn't run cpp.
15 # Define AS as `gcc -c -x assembler-with-cpp' instead.
16 # Under Irix 6, you will have to specify the ABI for as if you specify
17 # it for the C compiler.
19 CFLAGS= -O -DATOMIC_UNCOLLECTABLE -DNO_SIGNALS -DALL_INTERIOR_POINTERS -DNO_EXECUTE_PERMISSION -DSILENT
21 # Setjmp_test may yield overly optimistic results when compiled
22 # without optimization.
23 # -DSILENT disables statistics printing, and improves performance.
24 # -DCHECKSUMS reports on erroneously clear dirty bits, and unexpectedly
25 # altered stubborn objects, at substantial performance cost.
26 # Use only for incremental collector debugging.
27 # -DFIND_LEAK causes the collector to assume that all inaccessible
28 # objects should have been explicitly deallocated, and reports exceptions.
29 # Finalization and the test program are not usable in this mode.
30 # -DSOLARIS_THREADS enables support for Solaris (thr_) threads.
31 # (Clients should also define SOLARIS_THREADS and then include
32 # gc.h before performing thr_ or dl* or GC_ operations.)
33 # Must also define -D_REENTRANT
34 # -D_SOLARIS_PTHREADS enables support for Solaris pthreads.
35 # Define SOLARIS_THREADS as well.
36 # -DIRIX_THREADS enables support for Irix pthreads. See README.irix.
37 # -DALL_INTERIOR_POINTERS allows all pointers to the interior
38 # of objects to be recognized. (See gc_priv.h for consequences.)
39 # -DSMALL_CONFIG tries to tune the collector for small heap sizes,
40 # usually causing it to use less space in such situations.
41 # Incremental collection no longer works in this case.
42 # -DLARGE_CONFIG tunes the collector for unusually large heaps.
43 # Necessary for heaps larger than about 500 MB on most machines.
44 # Recommended for heaps larger than about 64 MB.
45 # -DDONT_ADD_BYTE_AT_END is meaningful only with
46 # -DALL_INTERIOR_POINTERS. Normally -DALL_INTERIOR_POINTERS
47 # causes all objects to be padded so that pointers just past the end of
48 # an object can be recognized. This can be expensive. (The padding
49 # is normally more than one byte due to alignment constraints.)
50 # -DDONT_ADD_BYTE_AT_END disables the padding.
51 # -DNO_SIGNALS does not disable signals during critical parts of
52 # the GC process. This is no less correct than many malloc
53 # implementations, and it sometimes has a significant performance
54 # impact. However, it is dangerous for many not-quite-ANSI C
55 # programs that call things like printf in asynchronous signal handlers.
56 # -DNO_EXECUTE_PERMISSION may cause some or all of the heap to not
57 # have execute permission, i.e. it may be impossible to execute
58 # code from the heap. Currently this only affects the incremental
59 # collector on UNIX machines. It may greatly improve its performance,
60 # since this may avoid some expensive cache synchronization.
61 # -DOPERATOR_NEW_ARRAY declares that the C++ compiler supports the
62 # new syntax "operator new[]" for allocating and deleting arrays.
63 # See gc_cpp.h for details. No effect on the C part of the collector.
64 # This is defined implicitly in a few environments.
65 # -DREDIRECT_MALLOC=X causes malloc, realloc, and free to be defined
66 # as aliases for X, GC_realloc, and GC_free, respectively.
67 # Calloc is redefined in terms of the new malloc. X should
68 # be either GC_malloc or GC_malloc_uncollectable.
69 # The former is occasionally useful for working around leaks in code
70 # you don't want to (or can't) look at. It may not work for
71 # existing code, but it often does. Neither works on all platforms,
72 # since some ports use malloc or calloc to obtain system memory.
73 # (Probably works for UNIX, and win32.)
74 # -DIGNORE_FREE turns calls to free into a noop. Only useful with
76 # -DNO_DEBUGGING removes GC_dump and the debugging routines it calls.
77 # Reduces code size slightly at the expense of debuggability.
78 # -DJAVA_FINALIZATION makes it somewhat safer to finalize objects out of
79 # order by specifying a nonstandard finalization mark procedure (see
80 # finalize.c). Objects reachable from finalizable objects will be marked
81 # in a sepearte postpass, and hence their memory won't be reclaimed.
82 # Not recommended unless you are implementing a language that specifies
84 # -DFINALIZE_ON_DEMAND causes finalizers to be run only in response
85 # to explicit GC_invoke_finalizers() calls.
86 # -DATOMIC_UNCOLLECTABLE includes code for GC_malloc_atomic_uncollectable.
87 # This is useful if either the vendor malloc implementation is poor,
88 # or if REDIRECT_MALLOC is used.
89 # -DHBLKSIZE=ddd, where ddd is a power of 2 between 512 and 16384, explicitly
90 # sets the heap block size. Each heap block is devoted to a single size and
91 # kind of object. For the incremental collector it makes sense to match
92 # the most likely page size. Otherwise large values result in more
93 # fragmentation, but generally better performance for large heaps.
94 # -DUSE_MMAP use MMAP instead of sbrk to get new memory.
95 # Works for Solaris and Irix.
96 # -DMMAP_STACKS (for Solaris threads) Use mmap from /dev/zero rather than
97 # GC_scratch_alloc() to get stack memory.
98 # -DPRINT_BLACK_LIST Whenever a black list entry is added, i.e. whenever
99 # the garbage collector detects a value that looks almost, but not quite,
100 # like a pointer, print both the address containing the value, and the
101 # value of the near-bogus-pointer. Can be used to identifiy regions of
102 # memory that are likely to contribute misidentified pointers.
103 # -DOLD_BLOCK_ALLOC Use the old, possibly faster, large block
104 # allocation strategy. The new strategy tries harder to minimize
105 # fragmentation, sometimes at the expense of spending more time in the
106 # large block allocator and/or collecting more frequently.
111 LIBGC_CFLAGS= -O -DNO_SIGNALS -DSILENT \
112 -DREDIRECT_MALLOC=GC_malloc_uncollectable \
113 -DDONT_ADD_BYTE_AT_END -DALL_INTERIOR_POINTERS
114 # Flags for building libgc.a -- the last two are required.
121 # Redefining srcdir allows object code for the nonPCR version of the collector
122 # to be generated in different directories. In this case, the destination directory
123 # should contain a copy of the original include directory.
127 OBJS= alloc.o reclaim.o allchblk.o misc.o mach_dep.o os_dep.o mark_rts.o headers.o mark.o obj_map.o blacklst.o finalize.o new_hblk.o dbg_mlc.o malloc.o stubborn.o checksums.o solaris_threads.o irix_threads.o linux_threads.o typd_mlc.o ptr_chck.o mallocx.o solaris_pthreads.o
129 CSRCS= reclaim.c allchblk.c misc.c alloc.c mach_dep.c os_dep.c mark_rts.c headers.c mark.c obj_map.c pcr_interface.c blacklst.c finalize.c new_hblk.c real_malloc.c dyn_load.c dbg_mlc.c malloc.c stubborn.c checksums.c solaris_threads.c irix_threads.c linux_threads.c typd_mlc.c ptr_chck.c mallocx.c solaris_pthreads.c
131 CORD_SRCS= cord/cordbscs.c cord/cordxtra.c cord/cordprnt.c cord/de.c cord/cordtest.c cord/cord.h cord/ec.h cord/private/cord_pos.h cord/de_win.c cord/de_win.h cord/de_cmds.h cord/de_win.ICO cord/de_win.RC cord/SCOPTIONS.amiga cord/SMakefile.amiga
133 CORD_OBJS= cord/cordbscs.o cord/cordxtra.o cord/cordprnt.o
135 SRCS= $(CSRCS) mips_sgi_mach_dep.s rs6000_mach_dep.s alpha_mach_dep.s \
136 sparc_mach_dep.s gc.h gc_typed.h gc_hdrs.h gc_priv.h gc_private.h \
137 config.h gc_mark.h include/gc_inl.h include/gc_inline.h gc.man \
138 threadlibs.c if_mach.c if_not_there.c gc_cpp.cc gc_cpp.h weakpointer.h \
139 gcc_support.c mips_ultrix_mach_dep.s include/gc_alloc.h gc_alloc.h \
140 sparc_sunos4_mach_dep.s solaris_threads.h $(CORD_SRCS)
142 OTHER_FILES= Makefile PCR-Makefile OS2_MAKEFILE NT_MAKEFILE BCC_MAKEFILE \
143 README test.c test_cpp.cc setjmp_t.c SMakefile.amiga \
144 SCoptions.amiga README.amiga README.win32 cord/README \
145 cord/gc.h include/gc.h include/gc_typed.h include/cord.h \
146 include/ec.h include/private/cord_pos.h include/private/config.h \
147 include/private/gc_hdrs.h include/private/gc_priv.h \
148 include/gc_cpp.h README.rs6000 \
149 include/weakpointer.h README.QUICK callprocs pc_excludes \
150 barrett_diagram README.OS2 README.Mac MacProjects.sit.hqx \
151 MacOS.c EMX_MAKEFILE makefile.depend README.debugging \
152 include/gc_cpp.h Mac_files/datastart.c Mac_files/dataend.c \
153 Mac_files/MacOS_config.h Mac_files/MacOS_Test_config.h \
154 add_gc_prefix.c README.solaris2 README.sgi README.hp README.uts \
155 win32_threads.c NT_THREADS_MAKEFILE gc.mak README.dj Makefile.dj \
156 README.alpha README.linux version.h Makefile.DLLs gc_watcom.asm \
159 CORD_INCLUDE_FILES= $(srcdir)/gc.h $(srcdir)/cord/cord.h $(srcdir)/cord/ec.h \
160 $(srcdir)/cord/private/cord_pos.h
162 UTILS= if_mach if_not_there threadlibs
164 # Libraries needed for curses applications. Only needed for de.
165 CURSES= -lcurses -ltermlib
167 # The following is irrelevant on most systems. But a few
168 # versions of make otherwise fork the shell specified in
169 # the SHELL environment variable.
173 # Alternative flags to the C compiler for mach_dep.c.
174 # Mach_dep.c often doesn't like optimization, and it's
175 # not time-critical anyway.
176 # Set SPECIALCFLAGS to -q nodirect_code on Encore.
180 pcr: PCR-Makefile gc_private.h gc_hdrs.h gc.h config.h mach_dep.o $(SRCS)
181 make -f PCR-Makefile depend
184 $(OBJS) test.o dyn_load.o dyn_load_sunos53.o: $(srcdir)/gc_priv.h $(srcdir)/gc_hdrs.h $(srcdir)/gc.h \
185 $(srcdir)/config.h $(srcdir)/gc_typed.h Makefile
186 # The dependency on Makefile is needed. Changing
187 # options such as -DSILENT affects the size of GC_arrays,
188 # invalidating all .o files that rely on gc_priv.h
190 mark.o typd_mlc.o finalize.o: $(srcdir)/gc_mark.h
192 base_lib gc.a: $(OBJS) dyn_load.o $(UTILS)
194 rm -f on_sparc_sunos5
195 ./if_mach SPARC SUNOS5 touch on_sparc_sunos5
196 ./if_mach SPARC SUNOS5 $(AR) rus gc.a $(OBJS) dyn_load.o
197 ./if_not_there on_sparc_sunos5 $(AR) ru gc.a $(OBJS) dyn_load.o
198 ./if_not_there on_sparc_sunos5 $(RANLIB) gc.a || cat /dev/null
199 # ignore ranlib failure; that usually means it doesn't exist, and isn't needed
202 make CFLAGS="$(LIBGC_CFLAGS)" clean gc.a gcc_support.o
204 rm -f on_sparc_sunos5
205 ./if_mach SPARC SUNOS5 touch on_sparc_sunos5
206 ./if_mach SPARC SUNOS5 $(AR) rus libgc.a gcc_support.o
207 ./if_not_there on_sparc_sunos5 $(AR) ru libgc.a gcc_support.o
208 ./if_not_there on_sparc_sunos5 $(RANLIB) libgc.a || cat /dev/null
210 cords: $(CORD_OBJS) cord/cordtest $(UTILS)
211 rm -f on_sparc_sunos5
212 ./if_mach SPARC SUNOS5 touch on_sparc_sunos5
213 ./if_mach SPARC SUNOS5 $(AR) rus gc.a $(CORD_OBJS)
214 ./if_not_there on_sparc_sunos5 $(AR) ru gc.a $(CORD_OBJS)
215 ./if_not_there on_sparc_sunos5 $(RANLIB) gc.a || cat /dev/null
217 gc_cpp.o: $(srcdir)/gc_cpp.cc $(srcdir)/gc_cpp.h $(srcdir)/gc.h Makefile
218 $(CXX) -c $(CXXFLAGS) $(srcdir)/gc_cpp.cc
220 test_cpp: $(srcdir)/test_cpp.cc $(srcdir)/gc_cpp.h gc_cpp.o $(srcdir)/gc.h \
223 ./if_mach HP_PA "" $(CXX) $(CXXFLAGS) -o test_cpp $(srcdir)/test_cpp.cc gc_cpp.o gc.a -ldld
224 ./if_not_there test_cpp $(CXX) $(CXXFLAGS) -o test_cpp $(srcdir)/test_cpp.cc gc_cpp.o gc.a `./threadlibs`
226 c++: gc_cpp.o $(srcdir)/gc_cpp.h test_cpp
227 rm -f on_sparc_sunos5
228 ./if_mach SPARC SUNOS5 touch on_sparc_sunos5
229 ./if_mach SPARC SUNOS5 $(AR) rus gc.a gc_cpp.o
230 ./if_not_there on_sparc_sunos5 $(AR) ru gc.a gc_cpp.o
231 ./if_not_there on_sparc_sunos5 $(RANLIB) gc.a || cat /dev/null
235 dyn_load_sunos53.o: dyn_load.c
236 $(CC) $(CFLAGS) -DSUNOS53_SHARED_LIB -c $(srcdir)/dyn_load.c -o $@
238 # SunOS5 shared library version of the collector
239 libgc.so: $(OBJS) dyn_load_sunos53.o
240 $(CC) -G -o libgc.so $(OBJS) dyn_load_sunos53.o -ldl
242 # Alpha/OSF shared library version of the collector
243 libalphagc.so: $(OBJS)
244 ld -shared -o libalphagc.so $(OBJS) dyn_load.o -lc
245 ln libalphagc.so libgc.so
247 # IRIX shared library version of the collector
248 libirixgc.so: $(OBJS) dyn_load.o
249 ld -shared $(ABI_FLAG) -o libirixgc.so $(OBJS) dyn_load.o -lc
250 ln libirixgc.so libgc.so
252 mach_dep.o: $(srcdir)/mach_dep.c $(srcdir)/mips_sgi_mach_dep.s $(srcdir)/mips_ultrix_mach_dep.s $(srcdir)/rs6000_mach_dep.s $(UTILS)
254 ./if_mach MIPS IRIX5 $(AS) -o mach_dep.o $(srcdir)/mips_sgi_mach_dep.s
255 ./if_mach MIPS RISCOS $(AS) -o mach_dep.o $(srcdir)/mips_ultrix_mach_dep.s
256 ./if_mach MIPS ULTRIX $(AS) -o mach_dep.o $(srcdir)/mips_ultrix_mach_dep.s
257 ./if_mach RS6000 "" $(AS) -o mach_dep.o $(srcdir)/rs6000_mach_dep.s
258 ./if_mach ALPHA "" $(AS) -o mach_dep.o $(srcdir)/alpha_mach_dep.s
259 ./if_mach SPARC SUNOS5 $(AS) -o mach_dep.o $(srcdir)/sparc_mach_dep.s
260 ./if_mach SPARC SUNOS4 $(AS) -o mach_dep.o $(srcdir)/sparc_sunos4_mach_dep.s
261 ./if_not_there mach_dep.o $(CC) -c $(SPECIALCFLAGS) $(srcdir)/mach_dep.c
263 mark_rts.o: $(srcdir)/mark_rts.c if_mach if_not_there $(UTILS)
265 -./if_mach ALPHA OSF1 $(CC) -c $(CFLAGS) -Wo,-notail $(srcdir)/mark_rts.c
266 ./if_not_there mark_rts.o $(CC) -c $(CFLAGS) $(srcdir)/mark_rts.c
267 # Work-around for DEC optimizer tail recursion elimination bug.
268 # The ALPHA-specific line should be removed if gcc is used.
272 cord/cordbscs.o: $(srcdir)/cord/cordbscs.c $(CORD_INCLUDE_FILES)
273 $(CC) $(CFLAGS) -c $(srcdir)/cord/cordbscs.c
274 mv cordbscs.o cord/cordbscs.o
275 # not all compilers understand -o filename
277 cord/cordxtra.o: $(srcdir)/cord/cordxtra.c $(CORD_INCLUDE_FILES)
278 $(CC) $(CFLAGS) -c $(srcdir)/cord/cordxtra.c
279 mv cordxtra.o cord/cordxtra.o
281 cord/cordprnt.o: $(srcdir)/cord/cordprnt.c $(CORD_INCLUDE_FILES)
282 $(CC) $(CFLAGS) -c $(srcdir)/cord/cordprnt.c
283 mv cordprnt.o cord/cordprnt.o
285 cord/cordtest: $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a $(UTILS)
287 ./if_mach SPARC DRSNX $(CC) $(CFLAGS) -o cord/cordtest $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a -lucb
288 ./if_mach HP_PA "" $(CC) $(CFLAGS) -o cord/cordtest $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a -ldld
289 ./if_not_there cord/cordtest $(CC) $(CFLAGS) -o cord/cordtest $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a `./threadlibs`
291 cord/de: $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(UTILS)
293 ./if_mach SPARC DRSNX $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(CURSES) -lucb
294 ./if_mach HP_PA "" $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(CURSES) -ldld
295 ./if_mach RS6000 "" $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a -lcurses
296 ./if_mach I386 LINUX $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a -lcurses
297 ./if_mach ALPHA LINUX $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a -lcurses
298 ./if_not_there cord/de $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(CURSES) `./threadlibs`
300 if_mach: $(srcdir)/if_mach.c $(srcdir)/config.h
301 $(CC) $(CFLAGS) -o if_mach $(srcdir)/if_mach.c
303 threadlibs: $(srcdir)/threadlibs.c $(srcdir)/config.h Makefile
304 $(CC) $(CFLAGS) -o threadlibs $(srcdir)/threadlibs.c
306 if_not_there: $(srcdir)/if_not_there.c
307 $(CC) $(CFLAGS) -o if_not_there $(srcdir)/if_not_there.c
310 rm -f gc.a *.o gctest gctest_dyn_link test_cpp \
311 setjmp_test mon.out gmon.out a.out core if_not_there if_mach \
312 threadlibs $(CORD_OBJS) cord/cordtest cord/de
315 gctest: test.o gc.a if_mach if_not_there
317 ./if_mach SPARC DRSNX $(CC) $(CFLAGS) -o gctest test.o gc.a -lucb
318 ./if_mach HP_PA "" $(CC) $(CFLAGS) -o gctest test.o gc.a -ldld
319 ./if_not_there gctest $(CC) $(CFLAGS) -o gctest test.o gc.a `./threadlibs`
321 # If an optimized setjmp_test generates a segmentation fault,
322 # odds are your compiler is broken. Gctest may still work.
323 # Try compiling setjmp_t.c unoptimized.
324 setjmp_test: $(srcdir)/setjmp_t.c $(srcdir)/gc.h if_mach if_not_there
325 $(CC) $(CFLAGS) -o setjmp_test $(srcdir)/setjmp_t.c
327 test: KandRtest cord/cordtest
330 # Those tests that work even with a K&R C compiler:
331 KandRtest: setjmp_test gctest
335 add_gc_prefix: add_gc_prefix.c
336 $(CC) -o add_gc_prefix $(srcdir)/add_gc_prefix.c
338 gc.tar: $(SRCS) $(OTHER_FILES) add_gc_prefix
339 ./add_gc_prefix $(SRCS) $(OTHER_FILES) > /tmp/gc.tar-files
340 (cd $(srcdir)/.. ; tar cvfh - `cat /tmp/gc.tar-files`) > gc.tar
342 pc_gc.tar: $(SRCS) $(OTHER_FILES)
343 tar cvfX pc_gc.tar pc_excludes $(SRCS) $(OTHER_FILES)
349 -mmd a:/include/private
351 cat pc_gc.tar | (cd /tmp/pc_gc; tar xvf -)
352 -mcopy -tmn /tmp/pc_gc/* a:
353 -mcopy -tmn /tmp/pc_gc/cord/* a:/cord
354 -mcopy -mn /tmp/pc_gc/cord/de_win.ICO a:/cord
355 -mcopy -tmn /tmp/pc_gc/cord/private/* a:/cord/private
356 -mcopy -tmn /tmp/pc_gc/include/* a:/include
357 -mcopy -tmn /tmp/pc_gc/include/private/* a:/include/private
366 lint: $(CSRCS) test.c
367 lint -DLINT $(CSRCS) test.c | egrep -v "possible pointer alignment problem|abort|exit|sbrk|mprotect|syscall"
369 # BTL: added to test shared library version of collector.
370 # Currently works only under SunOS5. Requires GC_INIT call from statically
371 # loaded client code.
373 gctest_dyn_link: test.o libgc.so
374 $(CC) -L$(ABSDIR) -R$(ABSDIR) -o gctest_dyn_link test.o -lgc -ldl -lthread
376 gctest_irix_dyn_link: test.o libirixgc.so
377 $(CC) -L$(ABSDIR) -o gctest_irix_dyn_link test.o -lirixgc
379 test_dll.o: test.c libgc_globals.h
380 $(CC) $(CFLAGS) -DGC_USE_DLL -c test.c -o test_dll.o
382 test_dll: test_dll.o libgc_dll.a libgc.dll
383 $(CC) test_dll.o -L$(ABSDIR) -lgc_dll -o test_dll
387 # Uncomment the following line to build a GNU win32 DLL
388 # include Makefile.DLLs
390 reserved_namespace: $(SRCS)
391 for file in $(SRCS) test.c test_cpp.cc; do \
392 sed s/GC_/_GC_/g < $$file > tmp; \
396 user_namespace: $(SRCS)
397 for file in $(SRCS) test.c test_cpp.cc; do \
398 sed s/_GC_/GC_/g < $$file > tmp; \