aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: c8351a843313c20705796500e038e5ea7fab36d1 (plain) (blame)
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
                             TOP
                         Version 3.5

                       William LeFebvre
		     and a cast of dozens


If you do not want to read this entire file, then at least read
the section at the end entitled "KNOWN PROBLEMS".

If you are having any problems getting top to work, please read the
file "FAQ" *before* contacting me.  Thank you.

"top" is a program that will give continual reports about the state of
the system, including a list of the top cpu using processes.  Version 3
of "top" has three primary design goals: provide an accurate snapshot of
the system and process state, not be one of the top processes itself, be
as portable as possible.

Version 3 has many bug fixes from version 2.5, and it has also been
reorganized in a major way to make it easy to port to other platforms.
All system dependent code is now contained in one file.

Top now includes a configuration script called "Configure".  It helps
the installer choose the correct parameters for this particular
installation.  This script MUST be run before attempting to compile top.

Top requires read access to the memory files "/dev/kmem" and "/dev/mem"
as well as the system image "/vmunix".  Some installations have these
files protected from general access.  These sites would have to install
this program in the same way that programs such as "ps" are installed.
In addition, on those Unix variants that support the proc filesystem
(such as SVR4 and Solaris 2), top requires read access to all the files
in /proc: typically dictating that top be installed setuid to root.

CAVEAT: version 3 of top has internal commands that kill and renice
processes.  Although I have taken steps to insure that top makes
appropriate checks with these commands, I cannot guarantee that these
internal commands are totally secure.  IF YOU INSTALL top as a SETUID
program, you do so AT YOUR OWN RISK!  I realize that some operating
systems will require top to run setuid, and I will do everything I can
to make sure that top is a secure setuid program.

Configure will ask you to input values for certain parameters.  Before
each parameter, Configure will display a description of what the
parameter does.  Read the description and choose an appropriate value.
Sometimes a default will appear in brackets.  Typing just return will
choose the default.

System support now takes the form of "modules".  Adding support for
a different architecture requires only adding a module.  Configure
asks which module to use when it is configuring top.  See the file
"Porting" for a description of how to write your own module.

To compile and install "top", read the file "INSTALL" and follow the
directions and advice contained therein.

Once you have created a binary for one particular type of machine, you
can reconfigure for another type with "./Configure modulename" where
"modulename" is replaced with the appropriate module name.  All other
parameter values are kept the same.  Note that in some cases this may
not be appropriate.

If you make any kind of change to "top" that you feel would be
beneficial to others who use this program, or if you find and fix a bug,
please send me the change.

Be sure to read the FAQ enclosed with the distrubution.  It contains
answers to the most commonly asked questions about the configuration,
installation, and operation of top.


AVAILABILITY

The latest version of "top" is now being made available via anonymous
FTP from the host "ftp.groupsys.com" in the directory "/pub/top".
Additional modules will be made available in the directory
"/pub/top/m".  The site "eecs.nwu.edu" will continue to house copies
of the distribution as well.

Here are HTML links for the four best "top" archive sites:

<A HREF="ftp://ftp.groupsys.com/pub/top">Top archive (groupsys.com)</A>
<A HREF="ftp://eecs.nwu.edu/pub/top">Top archive (eecs.nwu.edu)</A>
<A HREF="ftp://pharos.dgim.doc.ca/packages/top"> Top mirror (dgim.doc.ca)</A>
<A HREF="ftp://uiarchive.uiuc.edu/pub/packages/top/">Top mirror (uiuc.edu)</A>

New releases will be posted to comp.sources.unix as they become
available.  Sites which arhive that newsgroup will also contain copies
of the distribution.

Announcements about availability will be made to the mailing list
"top-announce@groupsys.com".  This is an open list maintained by
majordomo.  To join the list, send a message containing the word
"subscribe" to "top-announce-request@groupsys.com".  Addresses of
subscribers to this list are kept confidential and will never be used
for any purpose other than as recipients of announements concerning
this software.


KNOWN PROBLEMS:

Gnu CC

Compiling via Gnu CC continued to be the source of most of the
questions I receive.  By far the most common mistake made by those
attempting to compile top with Gnu CC is out of date include files.
When the operating system is upgraded, the include files that are part
of the gcc package MUST also be updated.  Gcc maintains its own
include files.  Even a minor OS upgrade can involve changes to some of
the kernel's internal data structures, which are defined in include
files in "sys".  Top is very sensitive to these changes.  If you are
compiling with gcc and experience any sort of strange problems, please
make sure the include files you are using are up to date BEFORE
sending me a bug report.  Look in the gcc source distribution for the
shell script "fixincludes".

HP/UX 10.10

In their infinite wisdom, the folks at HP have decided that mere mortals
such as you and I don't need to know what the kernel's proc structure looks
like.  To that end, they have removed all useful content from the include
file <sys/proc.h> in version 10.10.  As a result, top will not compile
under 10.10.  What HP is trying to accomplish with this move is to force
iconoclasts such as myself to use "pstat" for collecting all process
information.  I have no immediate solution for this problem, but hope to
obtain a sufficiently complete definition of "struct proc" at some point in
the near future.  Stay tuned.

DIGITAL UNIX 4.0 (DECOSF/1 V4.0)

A user has reported that idle processes are not displayed regardless
of the flags used when invoking top.  We have not had time to track
this problem down.

DECOSF/1 V3.0

There is a bug either in the module, in utils.c, or in DEC's optimizer that
is tickled by the decosf1 module when compiled under V3.0 (and perhaps
earlier versions).  Top compiled using DEC's compiler with optimization
will consistently produce a segmentation fault (in format_next_process
while calling sprintf).  To work around this problem, either compile top
with gcc or turn off optimization (compile without -O).  We think that
one of the bugs fixed in utils.c fixed this problem as well, but we are
not certain.


System V R 4.2

Load average and memory displays do not work.  The problem has been
traced down to a potential bug in the "mem" driver.  The author
of the svr42 module is working on a fix.



GRATITUDE

My perpetual thanks to all the people who have helped me support top
on so many platforms.  Without these people, top would not be what it
is.  Here is a partial list of contributors and other individuals.

	Robert Boucher		<boucher@sofkin.ca>
	Marc Cohen 		<marc@aai.com>
	David Cutter		<dpc@grail.com>
	Casper Dik		<Casper.Dik@Sun.COM>
	Charles Hedrick 	<hedrick@geneva.rutgers.edu>
	Andrew Herbert		<andrew@werple.apana.org.au>
	Jeff Janvrin		<jeff.janvrin@columbiasc.ncr.com>
	Torsten Kasch 		<torsten@techfak.uni-bielefeld.de>
	Petri Kutvonen		<kutvonen@cs.helsinki.fi>
	William L. Jones 	<jones@chpc>
	Tim Pugh 		<tpugh@oce.orst.edu>
	Steve Scherf		<scherf@swdc.stratus.com>
	Phillip Wu		<pwu01@qantek.com.au>

(My apologies if I missed anyone.)


AUTHOR

		William LeFebvre
		Group sys Consulting
		wnl@groupsys.com


		U.S. Mail address:
		    William LeFebvre
		    Group sys Consulting
		    11585 Jones Bridge Road
		    Suite 420-139
		    Alpharetta, GA  30022
		    (770) 813-3224