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
|
## helpers.py
## Implement policies required for the sos system support tool
## Copyright (C) 2006 Steve Conklin <sconklin@redhat.com>
### This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
## Some code adapted from "Python Cookbook, 2nd ed", by Alex
## Martelli, Anna Martelli Ravenscroft, and David Ascher
## (O'Reilly Media, 2005) 0-596-00797-3
##
"""
helper functions used by sosreport and plugins
"""
import os, popen2, fcntl, select, itertools, sys, commands, logging, signal
from time import time, sleep
from tempfile import mkdtemp
def importPlugin(pluginname, name):
""" Import a plugin to extend capabilities of sosreport
"""
try:
plugin = __import__(pluginname, globals(), locals(), [name])
except ImportError:
return None
return getattr(plugin, name)
def sosFindTmpDir():
"""Find a temp directory to form the root for our gathered information
and reports.
"""
workingBase = mkdtemp("","sos_")
return workingBase
def makeNonBlocking(afd):
""" Make the file descriptor non-blocking. This prevents deadlocks.
"""
fl = fcntl.fcntl(afd, fcntl.F_GETFL)
try:
fcntl.fcntl(afd, fcntl.F_SETFL, fl | os.O_NDELAY)
except AttributeError:
fcntl.fcntl(afd, fcntl.F_SETFL, fl | os.FNDELAY)
def sosGetCommandOutput(command, timeout = 300):
""" Execute a command and gather stdin, stdout, and return status.
"""
soslog = logging.getLogger('sos')
# Log if binary is not runnable or does not exist
for path in os.environ["PATH"].split(":"):
cmdfile = command.strip("(").split()[0]
# handle both absolute or relative paths
if ( ( not os.path.isabs(cmdfile) and os.access(os.path.join(path,cmdfile), os.X_OK) ) or \
( os.path.isabs(cmdfile) and os.access(cmdfile, os.X_OK) ) ):
break
else:
soslog.log(logging.VERBOSE, "binary '%s' does not exist or is not runnable" % cmdfile)
return (127, "", 0)
# these are file descriptors, not file objects
r, w = os.pipe()
pid = os.fork()
if pid:
# we are the parent
os.close(w) # use os.close() to close a file descriptor
oldr = r
r = os.fdopen(r) # turn r into a file object
stime=time()
txt = ""
sts = -1
while True:
# read output from pipe
ready = select.select([oldr],[],[],1)
if len(ready[0]):
txt = txt + r.read()
# is child still running ?
try: os.waitpid(pid, os.WNOHANG)
except:
# not running, make sure the child process gets cleaned up
try: sts = os.waitpid(pid, 0)[1]
except: pass
break
# has timeout passed ?
if time() - stime > timeout:
soslog.log(logging.VERBOSE, 'killing hung child with pid %s after %d seconds (command was "%s")' % (pid,timeout,command) )
os.kill(pid, signal.SIGKILL)
break
if txt[-1:] == '\n': txt = txt[:-1]
return (sts, txt, time()-stime)
else:
# we are the child
os.dup2(r, 0)
os.dup2(w, 1)
os.dup2(w, 2)
import resource
maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1]
if (maxfd == resource.RLIM_INFINITY):
maxfd = MAXFD
for fd in range(3, maxfd):
try: os.close(fd)
except OSError: pass
os.execl("/bin/sh", "/bin/sh", "-c", command)
os._exit(127)
# FIXME: this needs to be made clean and moved to the plugin tools, so
# that it prints nice color output like sysreport if the progress bar
# is not enabled.
def sosStatus(stat):
""" Complete a status line that has been output to the console,
providing pass/fail indication.
"""
if not stat:
print " [ OK ]"
else:
print " [ FAILED ]"
sys.stdout.flush()
return
def allEqual(elements):
''' return True if all the elements are equal, otherwise False. '''
first_element = elements[0]
for other_element in elements[1:]:
if other_element != first_element:
return False
return True
def commonPrefix(*sequences):
''' return a list of common elements at the start of all sequences,
then a list of lists that are the unique tails of each sequence. '''
# if there are no sequences at all, we're done
if not sequences:
return [], []
# loop in parallel on the sequences
common = []
for elements in itertools.izip(*sequences):
# unless all elements are equal, bail out of the loop
if not allEqual(elements):
break
# got one more common element, append it and keep looping
common.append(elements[0])
# return the common prefix and unique tails
return common, [ sequence[len(common):] for sequence in sequences ]
def sosRelPath(path1, path2, sep=os.path.sep, pardir=os.path.pardir):
''' return a relative path from path1 equivalent to path path2.
In particular: the empty string, if path1 == path2;
path2, if path1 and path2 have no common prefix.
'''
try:
common, (u1, u2) = commonPrefix(path1.split(sep), path2.split(sep))
except AttributeError:
return path2
if not common:
return path2 # leave path absolute if nothing at all in common
return sep.join( [pardir]*len(u1) + u2 )
def sosReadFile(fname):
''' reads a file and returns its contents'''
fp = open(fname,"r")
content = fp.read()
fp.close()
return content
|
