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= -O2 -DATOMIC_UNCOLLECTABLE -DNO_SIGNALS -DALL_INTERIOR_POINTERS -DNO_EXECUTE_PERMISSION -DSILENT
21 # For dynamic library builds, it may be necessary to add flags to generate
22 # PIC code, e.g. -fPIC on Linux.
24 # Setjmp_test may yield overly optimistic results when compiled
25 # without optimization.
26 # -DSILENT disables statistics printing, and improves performance.
27 # -DCHECKSUMS reports on erroneously clear dirty bits, and unexpectedly
28 # altered stubborn objects, at substantial performance cost.
29 # Use only for incremental collector debugging.
30 # -DFIND_LEAK causes the collector to assume that all inaccessible
31 # objects should have been explicitly deallocated, and reports exceptions.
32 # Finalization and the test program are not usable in this mode.
33 # -DSOLARIS_THREADS enables support for Solaris (thr_) threads.
34 # (Clients should also define SOLARIS_THREADS and then include
35 # gc.h before performing thr_ or dl* or GC_ operations.)
36 # Must also define -D_REENTRANT.
37 # -D_SOLARIS_PTHREADS enables support for Solaris pthreads.
38 # Define SOLARIS_THREADS as well.
39 # -DIRIX_THREADS enables support for Irix pthreads. See README.irix.
40 # _DLINUX_THREADS enables support for Xavier Leroy's Linux threads.
41 # see README.linux. -D_REENTRANT may also be required.
42 # -DALL_INTERIOR_POINTERS allows all pointers to the interior
43 # of objects to be recognized. (See gc_priv.h for consequences.)
44 # -DSMALL_CONFIG tries to tune the collector for small heap sizes,
45 # usually causing it to use less space in such situations.
46 # Incremental collection no longer works in this case.
47 # -DLARGE_CONFIG tunes the collector for unusually large heaps.
48 # Necessary for heaps larger than about 500 MB on most machines.
49 # Recommended for heaps larger than about 64 MB.
50 # -DDONT_ADD_BYTE_AT_END is meaningful only with
51 # -DALL_INTERIOR_POINTERS. Normally -DALL_INTERIOR_POINTERS
52 # causes all objects to be padded so that pointers just past the end of
53 # an object can be recognized. This can be expensive. (The padding
54 # is normally more than one byte due to alignment constraints.)
55 # -DDONT_ADD_BYTE_AT_END disables the padding.
56 # -DNO_SIGNALS does not disable signals during critical parts of
57 # the GC process. This is no less correct than many malloc
58 # implementations, and it sometimes has a significant performance
59 # impact. However, it is dangerous for many not-quite-ANSI C
60 # programs that call things like printf in asynchronous signal handlers.
61 # -DNO_EXECUTE_PERMISSION may cause some or all of the heap to not
62 # have execute permission, i.e. it may be impossible to execute
63 # code from the heap. Currently this only affects the incremental
64 # collector on UNIX machines. It may greatly improve its performance,
65 # since this may avoid some expensive cache synchronization.
66 # -DOPERATOR_NEW_ARRAY declares that the C++ compiler supports the
67 # new syntax "operator new[]" for allocating and deleting arrays.
68 # See gc_cpp.h for details. No effect on the C part of the collector.
69 # This is defined implicitly in a few environments.
70 # -DREDIRECT_MALLOC=X causes malloc, realloc, and free to be defined
71 # as aliases for X, GC_realloc, and GC_free, respectively.
72 # Calloc is redefined in terms of the new malloc. X should
73 # be either GC_malloc or GC_malloc_uncollectable.
74 # The former is occasionally useful for working around leaks in code
75 # you don't want to (or can't) look at. It may not work for
76 # existing code, but it often does. Neither works on all platforms,
77 # since some ports use malloc or calloc to obtain system memory.
78 # (Probably works for UNIX, and win32.)
79 # -DIGNORE_FREE turns calls to free into a noop. Only useful with
81 # -DNO_DEBUGGING removes GC_dump and the debugging routines it calls.
82 # Reduces code size slightly at the expense of debuggability.
83 # -DJAVA_FINALIZATION makes it somewhat safer to finalize objects out of
84 # order by specifying a nonstandard finalization mark procedure (see
85 # finalize.c). Objects reachable from finalizable objects will be marked
86 # in a sepearte postpass, and hence their memory won't be reclaimed.
87 # Not recommended unless you are implementing a language that specifies
89 # -DFINALIZE_ON_DEMAND causes finalizers to be run only in response
90 # to explicit GC_invoke_finalizers() calls.
91 # -DATOMIC_UNCOLLECTABLE includes code for GC_malloc_atomic_uncollectable.
92 # This is useful if either the vendor malloc implementation is poor,
93 # or if REDIRECT_MALLOC is used.
94 # -DHBLKSIZE=ddd, where ddd is a power of 2 between 512 and 16384, explicitly
95 # sets the heap block size. Each heap block is devoted to a single size and
96 # kind of object. For the incremental collector it makes sense to match
97 # the most likely page size. Otherwise large values result in more
98 # fragmentation, but generally better performance for large heaps.
99 # -DUSE_MMAP use MMAP instead of sbrk to get new memory.
100 # Works for Solaris and Irix.
101 # -DMMAP_STACKS (for Solaris threads) Use mmap from /dev/zero rather than
102 # GC_scratch_alloc() to get stack memory.
103 # -DPRINT_BLACK_LIST Whenever a black list entry is added, i.e. whenever
104 # the garbage collector detects a value that looks almost, but not quite,
105 # like a pointer, print both the address containing the value, and the
106 # value of the near-bogus-pointer. Can be used to identifiy regions of
107 # memory that are likely to contribute misidentified pointers.
108 # -DOLD_BLOCK_ALLOC Use the old, possibly faster, large block
109 # allocation strategy. The new strategy tries harder to minimize
110 # fragmentation, sometimes at the expense of spending more time in the
111 # large block allocator and/or collecting more frequently.
112 # If you expect the allocator to promtly use an explicitly expanded
113 # heap, this is highly recommended.
118 LIBGC_CFLAGS= -O -DNO_SIGNALS -DSILENT \
119 -DREDIRECT_MALLOC=GC_malloc_uncollectable \
120 -DDONT_ADD_BYTE_AT_END -DALL_INTERIOR_POINTERS
121 # Flags for building libgc.a -- the last two are required.
128 # Redefining srcdir allows object code for the nonPCR version of the collector
129 # to be generated in different directories. In this case, the destination directory
130 # should contain a copy of the original include directory.
134 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
136 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
138 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
140 CORD_OBJS= cord/cordbscs.o cord/cordxtra.o cord/cordprnt.o
142 SRCS= $(CSRCS) mips_sgi_mach_dep.s rs6000_mach_dep.s alpha_mach_dep.s \
143 sparc_mach_dep.s gc.h gc_typed.h gc_hdrs.h gc_priv.h gc_private.h \
144 gcconfig.h gc_mark.h include/gc_inl.h include/gc_inline.h gc.man \
145 threadlibs.c if_mach.c if_not_there.c gc_cpp.cc gc_cpp.h weakpointer.h \
146 gcc_support.c mips_ultrix_mach_dep.s include/gc_alloc.h gc_alloc.h \
147 include/new_gc_alloc.h include/javaxfc.h sparc_sunos4_mach_dep.s \
148 solaris_threads.h $(CORD_SRCS)
150 OTHER_FILES= Makefile PCR-Makefile OS2_MAKEFILE NT_MAKEFILE BCC_MAKEFILE \
151 README test.c test_cpp.cc setjmp_t.c SMakefile.amiga \
152 SCoptions.amiga README.amiga README.win32 cord/README \
153 cord/gc.h include/gc.h include/gc_typed.h include/cord.h \
154 include/ec.h include/private/cord_pos.h include/private/gcconfig.h \
155 include/private/gc_hdrs.h include/private/gc_priv.h \
156 include/gc_cpp.h README.rs6000 \
157 include/weakpointer.h README.QUICK callprocs pc_excludes \
158 barrett_diagram README.OS2 README.Mac MacProjects.sit.hqx \
159 MacOS.c EMX_MAKEFILE makefile.depend README.debugging \
160 include/gc_cpp.h Mac_files/datastart.c Mac_files/dataend.c \
161 Mac_files/MacOS_config.h Mac_files/MacOS_Test_config.h \
162 add_gc_prefix.c README.solaris2 README.sgi README.hp README.uts \
163 win32_threads.c NT_THREADS_MAKEFILE gc.mak README.dj Makefile.dj \
164 README.alpha README.linux version.h Makefile.DLLs gc_watcom.asm \
167 CORD_INCLUDE_FILES= $(srcdir)/gc.h $(srcdir)/cord/cord.h $(srcdir)/cord/ec.h \
168 $(srcdir)/cord/private/cord_pos.h
170 UTILS= if_mach if_not_there threadlibs
172 # Libraries needed for curses applications. Only needed for de.
173 CURSES= -lcurses -ltermlib
175 # The following is irrelevant on most systems. But a few
176 # versions of make otherwise fork the shell specified in
177 # the SHELL environment variable.
181 # Alternative flags to the C compiler for mach_dep.c.
182 # Mach_dep.c often doesn't like optimization, and it's
183 # not time-critical anyway.
184 # Set SPECIALCFLAGS to -q nodirect_code on Encore.
188 pcr: PCR-Makefile gc_private.h gc_hdrs.h gc.h gcconfig.h mach_dep.o $(SRCS)
189 make -f PCR-Makefile depend
192 $(OBJS) test.o dyn_load.o dyn_load_sunos53.o: $(srcdir)/gc_priv.h $(srcdir)/gc_hdrs.h $(srcdir)/gc.h \
193 $(srcdir)/gcconfig.h $(srcdir)/gc_typed.h Makefile
194 # The dependency on Makefile is needed. Changing
195 # options such as -DSILENT affects the size of GC_arrays,
196 # invalidating all .o files that rely on gc_priv.h
198 mark.o typd_mlc.o finalize.o: $(srcdir)/gc_mark.h
200 base_lib gc.a: $(OBJS) dyn_load.o $(UTILS)
202 rm -f on_sparc_sunos5_1
203 ./if_mach SPARC SUNOS5 touch on_sparc_sunos5_1
204 ./if_mach SPARC SUNOS5 $(AR) rus gc.a $(OBJS) dyn_load.o
205 ./if_not_there on_sparc_sunos5_1 $(AR) ru gc.a $(OBJS) dyn_load.o
206 ./if_not_there on_sparc_sunos5_1 $(RANLIB) gc.a || cat /dev/null
207 # ignore ranlib failure; that usually means it doesn't exist, and isn't needed
209 cords: $(CORD_OBJS) cord/cordtest $(UTILS)
210 rm -f on_sparc_sunos5_3
211 ./if_mach SPARC SUNOS5 touch on_sparc_sunos5_3
212 ./if_mach SPARC SUNOS5 $(AR) rus gc.a $(CORD_OBJS)
213 ./if_not_there on_sparc_sunos5_3 $(AR) ru gc.a $(CORD_OBJS)
214 ./if_not_there on_sparc_sunos5_3 $(RANLIB) gc.a || cat /dev/null
216 gc_cpp.o: $(srcdir)/gc_cpp.cc $(srcdir)/gc_cpp.h $(srcdir)/gc.h Makefile
217 $(CXX) -c $(CXXFLAGS) $(srcdir)/gc_cpp.cc
219 test_cpp: $(srcdir)/test_cpp.cc $(srcdir)/gc_cpp.h gc_cpp.o $(srcdir)/gc.h \
222 ./if_mach HP_PA "" $(CXX) $(CXXFLAGS) -o test_cpp $(srcdir)/test_cpp.cc gc_cpp.o gc.a -ldld
223 ./if_not_there test_cpp $(CXX) $(CXXFLAGS) -o test_cpp $(srcdir)/test_cpp.cc gc_cpp.o gc.a `./threadlibs`
225 c++: gc_cpp.o $(srcdir)/gc_cpp.h test_cpp
226 rm -f on_sparc_sunos5_4
227 ./if_mach SPARC SUNOS5 touch on_sparc_sunos5_4
228 ./if_mach SPARC SUNOS5 $(AR) rus gc.a gc_cpp.o
229 ./if_not_there on_sparc_sunos5_4 $(AR) ru gc.a gc_cpp.o
230 ./if_not_there on_sparc_sunos5_4 $(RANLIB) gc.a || cat /dev/null
234 dyn_load_sunos53.o: dyn_load.c
235 $(CC) $(CFLAGS) -DSUNOS53_SHARED_LIB -c $(srcdir)/dyn_load.c -o $@
237 # SunOS5 shared library version of the collector
238 sunos5gc.so: $(OBJS) dyn_load_sunos53.o
239 $(CC) -G -o sunos5gc.so $(OBJS) dyn_load_sunos53.o -ldl
240 ln sunos5gc.so libgc.so
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 # Linux shared library version of the collector
253 liblinuxgc.so: $(OBJS) dyn_load.o
254 gcc -shared -o liblinuxgc.so $(OBJS) dyn_load.o -lo
255 ln liblinuxgc.so libgc.so
257 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)
259 ./if_mach MIPS IRIX5 $(AS) -o mach_dep.o $(srcdir)/mips_sgi_mach_dep.s
260 ./if_mach MIPS RISCOS $(AS) -o mach_dep.o $(srcdir)/mips_ultrix_mach_dep.s
261 ./if_mach MIPS ULTRIX $(AS) -o mach_dep.o $(srcdir)/mips_ultrix_mach_dep.s
262 ./if_mach RS6000 "" $(AS) -o mach_dep.o $(srcdir)/rs6000_mach_dep.s
263 ./if_mach ALPHA "" $(AS) -o mach_dep.o $(srcdir)/alpha_mach_dep.s
264 ./if_mach SPARC SUNOS5 $(AS) -o mach_dep.o $(srcdir)/sparc_mach_dep.s
265 ./if_mach SPARC SUNOS4 $(AS) -o mach_dep.o $(srcdir)/sparc_sunos4_mach_dep.s
266 ./if_not_there mach_dep.o $(CC) -c $(SPECIALCFLAGS) $(srcdir)/mach_dep.c
268 mark_rts.o: $(srcdir)/mark_rts.c if_mach if_not_there $(UTILS)
270 -./if_mach ALPHA OSF1 $(CC) -c $(CFLAGS) -Wo,-notail $(srcdir)/mark_rts.c
271 ./if_not_there mark_rts.o $(CC) -c $(CFLAGS) $(srcdir)/mark_rts.c
272 # Work-around for DEC optimizer tail recursion elimination bug.
273 # The ALPHA-specific line should be removed if gcc is used.
277 cord/cordbscs.o: $(srcdir)/cord/cordbscs.c $(CORD_INCLUDE_FILES)
278 $(CC) $(CFLAGS) -c $(srcdir)/cord/cordbscs.c
279 mv cordbscs.o cord/cordbscs.o
280 # not all compilers understand -o filename
282 cord/cordxtra.o: $(srcdir)/cord/cordxtra.c $(CORD_INCLUDE_FILES)
283 $(CC) $(CFLAGS) -c $(srcdir)/cord/cordxtra.c
284 mv cordxtra.o cord/cordxtra.o
286 cord/cordprnt.o: $(srcdir)/cord/cordprnt.c $(CORD_INCLUDE_FILES)
287 $(CC) $(CFLAGS) -c $(srcdir)/cord/cordprnt.c
288 mv cordprnt.o cord/cordprnt.o
290 cord/cordtest: $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a $(UTILS)
292 ./if_mach SPARC DRSNX $(CC) $(CFLAGS) -o cord/cordtest $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a -lucb
293 ./if_mach HP_PA "" $(CC) $(CFLAGS) -o cord/cordtest $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a -ldld
294 ./if_not_there cord/cordtest $(CC) $(CFLAGS) -o cord/cordtest $(srcdir)/cord/cordtest.c $(CORD_OBJS) gc.a `./threadlibs`
296 cord/de: $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(UTILS)
298 ./if_mach SPARC DRSNX $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(CURSES) -lucb `./threadlibs`
299 ./if_mach HP_PA "" $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(CURSES) -ldld
300 ./if_mach RS6000 "" $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a -lcurses
301 ./if_mach I386 LINUX $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a -lcurses `./threadlibs`
302 ./if_mach ALPHA LINUX $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a -lcurses
303 ./if_not_there cord/de $(CC) $(CFLAGS) -o cord/de $(srcdir)/cord/de.c cord/cordbscs.o cord/cordxtra.o gc.a $(CURSES) `./threadlibs`
305 if_mach: $(srcdir)/if_mach.c $(srcdir)/gcconfig.h
306 $(CC) $(CFLAGS) -o if_mach $(srcdir)/if_mach.c
308 threadlibs: $(srcdir)/threadlibs.c $(srcdir)/gcconfig.h Makefile
309 $(CC) $(CFLAGS) -o threadlibs $(srcdir)/threadlibs.c
311 if_not_there: $(srcdir)/if_not_there.c
312 $(CC) $(CFLAGS) -o if_not_there $(srcdir)/if_not_there.c
315 rm -f gc.a *.o gctest gctest_dyn_link test_cpp \
316 setjmp_test mon.out gmon.out a.out core if_not_there if_mach \
317 threadlibs $(CORD_OBJS) cord/cordtest cord/de
320 gctest: test.o gc.a if_mach if_not_there
322 ./if_mach SPARC DRSNX $(CC) $(CFLAGS) -o gctest test.o gc.a -lucb
323 ./if_mach HP_PA "" $(CC) $(CFLAGS) -o gctest test.o gc.a -ldld
324 ./if_not_there gctest $(CC) $(CFLAGS) -o gctest test.o gc.a `./threadlibs`
326 # If an optimized setjmp_test generates a segmentation fault,
327 # odds are your compiler is broken. Gctest may still work.
328 # Try compiling setjmp_t.c unoptimized.
329 setjmp_test: $(srcdir)/setjmp_t.c $(srcdir)/gc.h if_mach if_not_there
330 $(CC) $(CFLAGS) -o setjmp_test $(srcdir)/setjmp_t.c
332 test: KandRtest cord/cordtest
335 # Those tests that work even with a K&R C compiler:
336 KandRtest: setjmp_test gctest
340 add_gc_prefix: add_gc_prefix.c
341 $(CC) -o add_gc_prefix $(srcdir)/add_gc_prefix.c
343 gc.tar: $(SRCS) $(OTHER_FILES) add_gc_prefix
344 ./add_gc_prefix $(SRCS) $(OTHER_FILES) > /tmp/gc.tar-files
345 (cd $(srcdir)/.. ; tar cvfh - `cat /tmp/gc.tar-files`) > gc.tar
347 pc_gc.tar: $(SRCS) $(OTHER_FILES)
348 tar cvfX pc_gc.tar pc_excludes $(SRCS) $(OTHER_FILES)
354 -mmd a:/include/private
356 cat pc_gc.tar | (cd /tmp/pc_gc; tar xvf -)
357 -mcopy -tmn /tmp/pc_gc/* a:
358 -mcopy -tmn /tmp/pc_gc/cord/* a:/cord
359 -mcopy -mn /tmp/pc_gc/cord/de_win.ICO a:/cord
360 -mcopy -tmn /tmp/pc_gc/cord/private/* a:/cord/private
361 -mcopy -tmn /tmp/pc_gc/include/* a:/include
362 -mcopy -tmn /tmp/pc_gc/include/private/* a:/include/private
371 lint: $(CSRCS) test.c
372 lint -DLINT $(CSRCS) test.c | egrep -v "possible pointer alignment problem|abort|exit|sbrk|mprotect|syscall"
374 # BTL: added to test shared library version of collector.
375 # Currently works only under SunOS5. Requires GC_INIT call from statically
376 # loaded client code.
378 gctest_dyn_link: test.o libgc.so
379 $(CC) -L$(ABSDIR) -R$(ABSDIR) -o gctest_dyn_link test.o -lgc -ldl -lthread
381 gctest_irix_dyn_link: test.o libirixgc.so
382 $(CC) -L$(ABSDIR) -o gctest_irix_dyn_link test.o -lirixgc
384 test_dll.o: test.c libgc_globals.h
385 $(CC) $(CFLAGS) -DGC_USE_DLL -c test.c -o test_dll.o
387 test_dll: test_dll.o libgc_dll.a libgc.dll
388 $(CC) test_dll.o -L$(ABSDIR) -lgc_dll -o test_dll
392 # Uncomment the following line to build a GNU win32 DLL
393 # include Makefile.DLLs
395 reserved_namespace: $(SRCS)
396 for file in $(SRCS) test.c test_cpp.cc; do \
397 sed s/GC_/_GC_/g < $$file > tmp; \
401 user_namespace: $(SRCS)
402 for file in $(SRCS) test.c test_cpp.cc; do \
403 sed s/_GC_/GC_/g < $$file > tmp; \