From 36f20a9c3deb4f5315ae70dc39baa47771b4756a Mon Sep 17 00:00:00 2001 From: hollings Date: Thu, 24 Mar 1994 17:26:07 +0000 Subject: [PATCH] Initial revision --- README | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..0d0db60 --- /dev/null +++ b/README @@ -0,0 +1,61 @@ +# +# README - Description of the "core" directory of the paradyn system. +# +# $log$ +# +# + +This directory contains the "core" source code for the paradyn performance +tools. It is divided into subdirectories that represent major functional +units of the system: + +Each of these directories contain source code that gets compiled into a single +UNIX executable: + + bininst - binary instrumentor + igen - interface generator + paradyn - paradyn GUI/controller + paradynd - paradynd (i.e. instrumentation manager) + paradyndIPS2 - paradynd for processing IPS-2 trace files + paradyndPVM - paradynd for PVM (Parallel Virtual Machine) + paradyndSIM - paradynd to generate simulated data (used in testing). + +There are also several libraries that get used in building the executables: + + rtinst - runtime instrumentation (linked into the application) + thread - a thread package used by paradyn + util - utility library + visi - external visualization interface + +There are also two Makefile's at this level: + + Makefile A top level makefile to build the entire system + make.config A Makefile that defines global lists, flags, etc that + will be included into all other Makefiles in the system. + + +The subdirectories of the "core" directory are organized to promote modularity +and support compiling the system for multiple platforms in a single source +tree. + +Each directory contains the following files: + h - a directory describing the exported interface of this + component. This typically consists of one or more C++ header + files, and one or more interface generator specifications + (files ending in .I). + + src - a directory containing the source files for the component. + Header files that are not part of the exported interface + are in this directory. + + docs - a directory containing the documentation for this component + of the system. This generally consists of several man pages + and a README file. + + compilation directories: -- + There is one of these for each supported platform. The + contents of this directory consist of a Makefile and the + machine derived files that are built as part of the process + of building the component. These might includes .C and .h + files generated by igen, flex, and bison as well as object + files (.o's). -- 1.8.3.1