nspr: import 3.0 RC1 cutoff from CVS
[mozilla-nspr.git] / nsprpub / pr / tests / README.TXT
blob685498a977320b8d7d340f2d5421b39b2c734fa9
1 File: pr/tests/readme
3 This document describes the test cases in the NSPR directory
4 pr/tests.
6 =====================================================================
7 There is a sub-directory here:
9 dll
10         sources for the .dll(.so) used by test dlltest.c
12 =====================================================================
13 The individual files are described here.
15 The script 'runtests.ksh' enumerates and runs test cases that are
16 expected to run on all platforms.
19 accept.c
20         Tests PR_Accept() and related socket functions.
22 acceptread.c
23         Tests PR_AcceptRead()
25 alarm.c
26         Tests alarm functions declared in obsolete/pralarm.h.
27         The alarm functions are obsolete, so is this test.
29 atomic.c
30         Tests Atomic operations defined in pratom.h
32 attach.c
33         Test PR_AttachThread()
34         Note: This is an NSPR private function.
36 bigfile.c
37         Test 64bit file offset functions declared in prio.h
39 bug1test.c
40         Demonstrates a bug on NT.
42 cleanup.c
43         Tests PR_Cleanup() declared in prinit.h
45 cltsrv.c
46         Tests many socket functions.
48 concur.c
49         Tests threading functions and concurrent operations.
51 cvar.c
52         Tests condition variables.
54 cvar2.c
55         Tests condition variables. A rather abusive test.
57 dbmalloc.c
58         Obsolete. Originally for testing debug builds of NSPR's malloc.
60 dbmalloc1.c
61         Obsolete. Originally for testing debug builds of NSPR's malloc.
63 dceemu.c
64         Tests special functions for DCE emulation.
66 depend.c
67         Obsoltet. Tests early spec for library dependency.
69 dlltest.c
70         Tests dynamic library fucntions. Used with dll/my.c
72 dtoa.c
73         Tests conversions of double to string.
75 exit.c
76         Tests PR_ProcessExit() declared in prinit.h
78 fileio.c
79         Tests NSPR semaphores a bit of file i/o and threading
80         functions.
82 foreign.c
83         Test auto-attach of a thread created by something other than
84         NSPR.
86 forktest.c
87         Limited use. Tests unix fork() and related functions.
89 fsync.c
90         Tests use of PR_Sync() declared in prio.h
92 getproto.c
93         Tests socket functions PR_GetProtoByName(), etc.
95 i2l.c
96         Tests LongLong functions for converting 32bit integer to 64bit
97         integer.
99 initclk.c
100         Tests timing on minimal use of condition variable
102 inrval.c
103         Tests interval timing functions.
105 instrumt.c
106         Tests instrumentation functions. prcountr.h prtrace.h
108 intrupt.c
109         Tests PR_Interrupt()
111 ioconthr.c
112         Tests i/o continuation mechanism in pthreads.
114 io_timeout.c
115         Test socket i/o timeouts.
117 io_timeoutk.c
118         Obsolete. Subsumed in io_timeout.c
120 io_timeoutu.c
121         Obsolete. Subsumed in io_timeout.c
123 ipv6.c
124         Tests IPv6. IPv6 is not used by NSPR clients.
126 join.c
127         Tests PR_JoinThread()
129 joinkk.c
130         Tests PR_JoinThread()
132 joinku.c
133         Tests PR_JoinThread()
135 joinuk.c
136         Tests PR_JoinThread()
138 joinuu.c
139         Tests PR_JoinThread()
141 layer.c
142         Tests layered I/O.
144 lazyinit.c
145         Tests implicit initialization.
147 lltest.c
148         Tests LongLong (64bit integer) arithmentic and conversions.
150 lock.c
151         Tests PR_Lock() in heavily threaded environment.
153 lockfile.c
154         Test PR_Lockfile().
156 logger.c
157         Tests PR_LOG()
159 makefile
160         The makefile that builds all the tests
162 many_cv.c
163         Tests aquiring a large number of condition variables.
165 multiwait.c
166         ???
168 nbconn.c
169         Test non-blocking connect.
171 nblayer.c
172         Tests NSPR's layered I/O capability.
174 nonblock.c
175         Tests operations on non-blocking socket.
177 op_2long.c
178         Tests PR_Open() where filename is too long.
180 op_filnf.c
181         Tests PR_Open() where filename is NotFound.
183 op_filok.c
184         Tests PR_Open() where filename is accessable.
186 op_noacc.c
187         Tests PR_Open() where file permissions are wrong.
188         Limited use. Windows has no concept of Unix style file permissions.
190 op_nofil.c
191         Tests PR_Open() where filename does not exist.
193 parent.c
194         Test parent/child process capability
196 perf.c
197         Tests and measures context switch times for various thread
198         syncronization functions.
200 pipeping.c
201         Tests inter-process pipes. Run with pipepong.c
203 pipepong.c
204         Tests inter-process pipes. Run with pipeping.c
206 pipeself.c
207         Tests inter-thread pipes.
209 pollable.c
210         Tests pollable events. prio.h
212 poll_er.c
213         Tests PR_Poll() where an error is expected.
215 poll_nm.c
216         Tests PR_Poll() where normal operation is expected.
218 poll_to.c
219         Tests PR_Poll() where timeout is expected.
221 prftest.c
222         Tests printf-like formatting.
224 prftest1.c
225         Obsolete. Subsumed in prftest.c
227 prftest2.c
228         Obsolete. Subsumed in prftest.c
230 priotest.c
231         Limited use. Tests NSPR thread dispatching priority.
233 provider.c
235 prpoll.c
236         Tests PR_Poll().
238 prselect.c
239         Obsolete. PR_Select() is obsolete.
241 prttools.h
242         Unused file.
244 ranfile.c
245         Tests random file access.
247 readme
248         This file.
250 runtests.ksh
251         A korn shell script that runs a set of tests that should run
252         on any of the NSPR supported platforms.
254 runtests.pl
255         A perl script to run the test cases. This srcipt runs tests
256         common to all platforms and runs tests applicable to specific
257         platforms. Uses file runtests.txt to control execution.
259 runtests.txt
260         Control file for perl script: runtests.pl
262 rwlocktest.c
263         Tests Reader/Writer lock
265 selct_er.c
266         Obsolete. PR_Select() is obsolete.
268 selct_nm.c
269         Obsolete. PR_Select() is obsolete.
271 selct_to.c
272         Obsolete. PR_Select() is obsolete.
274 select2.c
275         Obsolete. PR_Select() is obsolete.
277 sel_spd.c
278         Obsolete. PR_Select() is obsolete.
280 sem.c
281         Obsolete. Semaphores are not supported.
283 server_test.c
284         Tests sockets by simulating a server in loopback mode.
285         Makes its own client threads.
287 servr_kk.c
288         Tests client/server sockets, threads using system threads.
290 servr_ku.c
291         Tests client/server sockets, threads using system and user threads.
293 servr_uk.c
294         Tests client/server sockets, threads using system and user threads.
296 servr_uu.c
297         Tests client/server sockets, threads user threads.
299 short_thread.c
300         Tests short-running threads. Useful for testing for race conditions.
302 sigpipe.c
303         Tests NSPR's SIGPIPE handler. Unix only.
305 sleep.c
306         Limited use. Tests sleep capability of platform.
308 socket.c
309         Tests many socket functions.
311 sockopt.c
312         Tests setting and getting socket options.
314 sprintf.c
315         Tests sprintf.
317 sproc_ch.c
318         Obsolete. Tests IRIX sproc-based threads.
320 sproc_p.c
321         Obsolete. Tests IRIX sproc-based threads.
323 stack.c
324         Test atomic stack operations.
326 stat.c
327         Tests performance of getfileinfo() vs. stat()
329 stdio.c
330         Tests NSPR's handling of stdin, stdout, stderr.
332 strod.c
333         Tests formatting of double precision floating point.
335 suspend.c
336         Private interfaces PR_SuspendAll(), PR_ResumeAll(), etc.
338 switch.c
339         Tests thread switching
341 system.c
342         Tests PR_GetSystemInfo()
344 testbit.c
345         Tests bit arrays.
347 testfile.c
348         Tests many file I/O functions.
350 threads.c
351         Tests thread caching.
353 thruput.c
354         Tests socket thruput. Must be run by hand as client/server.
355         Does not self terminate.
357 time.c
358         Incomplete. Limited use.
360 timemac.c
361         Test time and date functions. Originally for Mac.
363 timetest.c
364         Tests time conversion over a wide range of dates.
366 tmoacc.c
367         Server to tmocon.c and writev.c
368         Do not run it by itself.
370 tmocon.c
371         Client thread to tmoacc.c
373 tpd.c
374         Tests thread private data.
376 udpsrv.c
377         Tests UDP socket functions.
379 ut_ttools.h
380         unused file.
382 version.c
383         Extract and print library version data.
385 vercheck.c
386         Test PR_VersionCheck().
388 writev.c
389         Tests gather-write on a socket. Requires tmoacc.c
391 xnotify.c
392         Tests cached monitors.
394 yield.c
395         Limited use
397 y2k.c
398         Test to verify NSPR's date functions as Y2K compliant.
400 dll\Makefile
401         makefile for mygetval.c, mysetval.c
403 dll\mygetval.c
404         Dynamic library test. See also dlltest.c
406 dll\mysetval.c
407         Dynamic library test. See also dlltest.c