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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
|
from __future__ import print_function
import ast
import warnings
with warnings.catch_warnings():
warnings.simplefilter("ignore")
# deprecated in python 3.4, but still works as of python 3.7.6
import imp
import os.path
import re
import sys
from glob import glob
_verbose = 0
# We want everything that isn't actual results to go to
# stderr. _eprint() is just like print(), but all output automatically
# goes to stderr.
def _eprint(*args, **kwargs):
print(*args, file=sys.stderr, **kwargs)
def _remove_ext(fullname):
return os.path.splitext(fullname)[0]
_alphanum = frozenset(
"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
_regexp_chars = frozenset("*?[]")
def _stapre_escape(pattern):
"Escape all unallowed wildcard characters in pattern."
s = list(pattern)
alphanum = _alphanum
for i, c in enumerate(pattern):
if c not in alphanum and c not in _regexp_chars:
if c == "\000":
s[i] = "\\000"
else:
s[i] = "\\" + c
for i, c in enumerate(pattern):
# Convert '*' into '.*', a real regexp.
if c == '*':
s[i] = '[^.]*'
# Convert '?' into '.', a real regexp.
elif c == '?':
s[i] = '.'
return pattern[:0].join(s)
def _stapre_name_has_wildcard(pattern):
for i, c in enumerate(pattern):
if c in _regexp_chars:
return True
return False
def _get_default_search_path():
path = sys.path
# The first element of sys.path is the current directory of this
# script, not the user's current directory. So, insert the empty
# string (standing in for the current directory) at the start of
# the list.
path.insert(0, '')
return path
def _find_wildcarded_modules(modpattern, path=None):
"""Version of imp.find_module() that handles hierarchical module
names and wildcards.
Try to find the module name. If path is omitted or None, the
default search path is used. Otherwise, path must be a list of
directory names; each directory is searched for files. Invalid
names in the list are silently ignored (but all list items must be
strings).
If search is successful, the return value is a 4-element tuple
(modname, file, pathname, description):
modname is the module name, file is an open file object positioned
at the beginning, pathname is the pathname of the file found, and
description is a 3-element tuple as contained in the list returned
by get_suffixes() describing the kind of module found.
If the module does not live in a file, ImportError is raised.
If the search is unsuccessful, ImportError is raised. Other
exceptions indicate problems with the arguments or environment.
If the module is a package, '__init__.py' is opened.
"""
global _verbose
results = []
if path is None:
path = _get_default_search_path()
# Convert '.' to '/', since 'foo.bar' gets loaded from
# 'foo/bar.py'.
modules = []
mp_path = modpattern.replace('.', '/')
# Resolve wildcards if needed.
if _stapre_name_has_wildcard(modpattern):
# Now that we've got 'foo/bar', try to find it in the path.
for component in path:
if len(component):
path_prefix = component + '/'
else:
path_prefix = ''
# FIXME: We're going to be searching directories in the
# path multiple times. To speed things up, we could cache
# full directory results, then do matching against the
# cached results.
pathname = path_prefix + mp_path + '.py'
if _verbose:
_eprint("globbing '%s'" % pathname)
glob_results = glob(pathname)
if len(glob_results) > 0:
if _verbose:
_eprint("glob(%s) found: %s" % (pathname, glob_results))
for g in glob_results:
# First get the part of the path past the prefix.
full_modname = _remove_ext(g[len(path_prefix):])
# Convert "a/b/c" to "a.b.c".
full_modname = full_modname.replace('/', '.')
modules.append((full_modname,
_remove_ext(os.path.basename(g)),
[os.path.dirname(g)]))
if _verbose:
_eprint("module list 1: %s" % modules)
# We also need to check for package directories containing
# an '__init__.py' file.
pathname = path_prefix + mp_path + '/__init__.py'
glob_results = glob(pathname)
if len(glob_results) > 0:
if _verbose:
_eprint("glob(%s) found: %s" % (pathname, glob_results))
for g in glob_results:
# First remove the '/__init__.py'
full_modname = os.path.dirname(g)
# Now get the part of the path past the prefix.
full_modname = full_modname[len(path_prefix):]
# Convert "a/b/c" to "a.b.c".
full_modname = full_modname.replace('/', '.')
modules.append((full_modname,
_remove_ext(os.path.basename(g)),
[os.path.dirname(g)]))
if _verbose:
_eprint("module list 2: %s" % modules)
else:
# Handle paths without wildcards.
# Now that we've got 'foo/bar', try to find it in the path.
for component in path:
if len(component):
path_prefix = component + '/'
else:
path_prefix = ''
if _verbose:
_eprint("looking for '%s'" % (path_prefix + mp_path + '.py'))
# FIXME: We're going to be searching directories in the
# path multiple times. To speed things up, we could cache
# full directory results, then do matching against the
# cached results.
pathname = path_prefix + mp_path + '.py'
if os.path.isfile(pathname):
if _verbose:
_eprint("found: %s" % pathname)
# First get the part of the path past the prefix.
full_modname = mp_path
# Convert "a/b/c" to "a.b.c".
full_modname = full_modname.replace('/', '.')
modules.append((full_modname,
os.path.basename(mp_path),
[os.path.dirname(pathname)]))
if _verbose:
_eprint("module list 1: %s" % modules)
# We also need to check for package directories containing
# an '__init__.py' file.
pathname = path_prefix + mp_path + '/__init__.py'
if os.path.isfile(pathname):
if _verbose:
_eprint("found: %s" % pathname)
full_modname = mp_path
# Convert "a/b/c" to "a.b.c".
full_modname = full_modname.replace('/', '.')
modules.append((full_modname, '__init__',
[os.path.dirname(pathname)]))
if _verbose:
_eprint("module list 2: %s" % modules)
if len(modules) == 0:
return results
if _verbose:
_eprint("module list: %s" % modules)
for (fm, m, p) in modules:
if _verbose:
_eprint("trying to load '%s'..." % fm)
(fh, filename, descr) = imp.find_module(m, p)
if descr[2] == imp.PY_SOURCE:
if _verbose:
_eprint("found module '%s'" % fm)
results.append((fm, fh, filename, descr))
elif descr[2] == imp.PKG_DIRECTORY:
# We've found a package directory, which we shouldn't have
# since the loop above should only return full paths.
raise ImportError('Unhandled package directory ' + fm)
elif descr[2] == imp.C_BUILTIN:
# Just ignore
continue
elif descr[2] == imp.C_EXTENSION:
# Just ignore
continue
else:
raise ImportError('Unknown descr: %d for module' %
descr[2], fm)
return results
def _parse_function_pattern(function_pattern):
"""Parse the FUNCTION_PATTERN into its parts. See the
resolve_pattern docstring for a description of FUNCTION_PATTERN.
Returns a tuple of: (FUNCTION_PATTERN, PATH, LINENO_TYPE, RANGE)
"""
filename = None
lineno_type = None
lineno = None
# First, look for a '@', indicating we've got a filename in
# the function pattern.
function_pattern = function_pattern.strip()
ampersand = function_pattern.find('@')
if ampersand > 0:
filename = function_pattern[ampersand+1:].strip()
function_pattern = function_pattern[:ampersand].strip()
# Does the filename have a ':' or '+' in it, indicating a line
# number?
colon = filename.find(':')
plus = filename.find('+')
if colon > 0 and plus > 0:
raise SyntaxError("Error: both ':' and '+' specified in '%s'."
% filename)
elif colon > 0 or plus > 0:
if colon > 0:
lineno_type = ':'
pos = colon
elif plus > 0 and colon < 0:
lineno_type = '+'
pos = plus
lineno = filename[pos+1:].strip()
filename = filename[:pos].strip()
return (function_pattern, filename, lineno_type, lineno)
def resolve_patterns(module_pattern, function_pattern):
"""Resolve the MODULE_PATTERN and FUNCTION_PATTERN into actual
python module name, function name, source file and lines.
MODULE_PATTERN is the name of the python module. This part may
use the "*" and "?" wildcarding operators to match multiple
names.
FUNCTION_PATTERN is made up of 3 parts: FUNCTION[@PATH[[:+]RANGE]]
where:
- The first part is the name of a python function. This part may
use the "*" and "?" wildcarding operators to match multiple
names.
- The second part is optinal and begins with the "@" character. It
is followed by the path to the python source file containing the
function, and may include a wildcard pattern.
- Finally, the third part is optional if the path to the python
source was given, and identifies the line number in the source
file preceded by a ":" or a "+". The line number is assumed to
be an absolute line number if preceded by a ":", or relative to
the declaration line of the function if preceded by a "+". All
the lines in the function can be matched with ":*". A range of
lines x through y can be matched with ":x-y". Ranges and
specific lines can be mixed using commas, e.g. ":x,y-z".
"""
global _verbose
if _verbose:
_eprint("Resolving patterns '%s' '%s'"
% (module_pattern, function_pattern))
# Parse the function pattern into its parts.
(function_pattern, filename, lineno_type, lineno) \
= _parse_function_pattern(function_pattern)
# If we've got a filename (which could have wildcards), try to
# handle it.
modpattern_list = []
if filename:
filename_list = []
# If we've got an absolute path, we don't need to search
# for the file.
if os.path.isabs(filename):
if _stapre_name_has_wildcard(filename):
filename_list = glob(filename)
elif os.path.isfile(filename):
filename_list.append(filename)
else:
for component in _get_default_search_path():
if len(component):
path_prefix = component + '/'
else:
path_prefix = ''
if _stapre_name_has_wildcard(filename):
if _verbose:
_eprint("globbing '%s'"
% (path_prefix + filename))
filename_list.extend(glob(path_prefix + filename))
elif os.path.isfile(path_prefix + filename):
filename_list.append(path_prefix + filename)
# If we had a explicit filename, but couldn't find it, we've
# got an error.
if len(filename_list) == 0:
raise IOError("filename '%s' can't be found." % filename)
# OK, a filename was specified and we found it. Now we need to
# mangle the module part of the pattern to include the
# path of the file we found.
#
# FIXME: Note we aren't validating the module name against the
# filename. So, 'module("a*").function("b*@foo.py")' is going
# to match, even though module 'foo' doesn't match 'a*'.
for f in filename_list:
abspath = os.path.abspath(f)
# We want the same number of 'levels' in the answer as in
# the input. If the module pattern contains 'f*.b*', we
# want the module name to be 'foo.bar'.
levels = module_pattern.count('.') + 1
parts = _remove_ext(abspath).split('/')
if os.path.basename(abspath) != '__init__.py':
mod_name = '.'.join(parts[(len(parts) - levels):])
mod_path = '/'.join(parts[:(len(parts) - levels)])
else:
mod_name = '.'.join(parts[(len(parts) - levels - 1):-1])
mod_path = '/'.join(parts[:(len(parts) - levels) - 1])
modpattern_list.append((mod_name, [mod_path]))
else:
modpattern_list.append((module_pattern, None))
if _verbose:
_eprint("modpattern_list: %s" % modpattern_list)
ret_list = []
ret_list_format = '%s %s@%s:%d'
ret_list_flag_format = '%s %s@%s:%d %s'
for (mp, p) in modpattern_list:
# Try to load the source for the module(s).
if _verbose:
_eprint("using _find_wildcarded_modules(%s, %s)..." % (mp, p))
results = _find_wildcarded_modules(mp, p)
if _verbose:
_eprint('_find_wildcarded_modules() returned %s' % results)
for (module, f, filename, descr) in results:
if _verbose:
_eprint("Loading source for module '%s'" % module)
try:
source = f.read()
finally:
f.close()
if filename is None or source is None:
raise IOError("Couldn't find module '%s'" % module)
# Parse the source, turning it into a AST (Abstract Syntax
# Tree). This doesn't actually load the file (which would run
# it).
tree = ast.parse(source, filename, "exec")
# Walk the AST, looking for function definitions, line number, etc.
walker = _AstWalker(module, filename)
modinfo = walker.visit(tree)
esc_pattern = (_stapre_escape(mp) + '.'
+ _stapre_escape(function_pattern) + '$')
re_obj = re.compile(esc_pattern)
for (func, lines) in modinfo.functions:
if _verbose:
_eprint("matching %s against '%s'" % (func, esc_pattern))
if re_obj.match(func):
if _verbose:
_eprint("%s matches %s" % (func, esc_pattern))
bare_func = func[len(module) + 1:]
# No line numbers were specified. So, report the
# function definition line (the # first line
# number). Add the 'call' specifier so that
# systemtap knows what's going on.
if lineno_type is None and lineno is None:
ret_list.append(ret_list_flag_format
% (module, bare_func,
modinfo.path, lines[0], 'call'))
continue
# We do line matching here. First, handle wildcard.
if lineno == '*':
for l in lines[1:]:
ret_list.append(ret_list_format
% (module, bare_func,
modinfo.path, l))
continue
# Handle absolute or relative line numbers
# here. Try to parse N, N-M, or N,M,O,P, or a
# combination thereof...
for lrange in lineno.split(','):
# Handle 'N-M'
dash = lrange.find('-')
if dash:
low = lrange[:dash]
high = lrange[dash + 1:]
# Normalize relative line numbers.
if lineno_type == '+':
low += lines[0]
high += lines[0]
# Look for lines that are between low and
# high.
for l in lines[1:]:
if l >= low and l >= high:
ret_list.append(ret_list_format
% (module, bare_func,
modinfo.path, l))
# Handle 'N'
elif lrange in lines[1:]:
ret_list.append(ret_list_format
% (module, bare_func,
modinfo.path, l))
if _verbose:
_eprint('returning %s' % ret_list)
return ret_list
class _ModuleInfo(object):
def __init__(self, name=None, path=None):
self.name = name
self.path = path
self.functions = []
self.lines = []
def dump(self):
_eprint('Name: %s' % self.name)
_eprint('Path: %s' % self.path)
for (func, lines) in self.functions:
_eprint('%s: %s' % (func, lines))
_eprint('%s: %s' % (self.name, self.lines))
def add_function(self, funcname, linelist):
self.functions.append((funcname, linelist))
def add_linelist(self, linelist):
self.lines = linelist
class _AstWalker(ast.NodeVisitor):
def __init__(self, mod_name, mod_path, verbose=False):
self.lastline = -1
self.names = []
self.names.append(mod_name)
self.indent = 0
self.indent_with = ' '
self.linelist = []
self.verbose = verbose
self.modinfo = _ModuleInfo(mod_name, mod_path)
def visit_Module(self, node):
if self.verbose:
_eprint("found module")
self.generic_visit(node)
self.modinfo.add_linelist(self.linelist)
return self.modinfo
def body(self, statements):
for stmt in statements:
self.visit(stmt)
def visit_ClassDef(self, node):
if self.verbose:
_eprint("%sfound class %s (%d)"
% (self.indent_with * self.indent, node.name,
node.lineno))
self.names.append(node.name)
self.indent += 1
self.body(node.body)
self.indent -= 1
self.names.pop()
def visit_FunctionDef(self, node):
self.names.append(node.name)
funcname = '.'.join(self.names)
if self.verbose:
_eprint("%sfound FunctionDef %s (%d)"
% (self.indent_with * self.indent, funcname,
node.lineno))
self.indent += 1
saved_linelist = self.linelist
self.linelist = []
self.linelist.append(node.lineno)
self.body(node.body)
self.indent -= 1
self.modinfo.add_function(funcname, self.linelist)
self.linelist = saved_linelist
self.names.pop()
def generic_visit(self, node):
try:
if self.lastline < node.lineno:
self.lastline = node.lineno
if self.verbose:
_eprint("%sstmt: %d"
% (self.indent_with * self.indent,
node.lineno))
self.linelist.append(node.lineno)
except AttributeError:
pass
ast.NodeVisitor.generic_visit(self, node)
def _usage():
_eprint("Usage: %s [-v] MODULE_PATTERN FUNCTION_PATTERN" % sys.argv[0])
sys.exit(1)
if __name__ == '__main__':
import getopt
if len(sys.argv) < 3:
_usage()
try:
(opts, pargs) = getopt.getopt(sys.argv[1:], 'v')
except getopt.GetoptError as e:
_eprint("Error: %s" % e)
_usage()
for (opt, value) in opts:
if opt == '-v':
_verbose += 1
if len(pargs) != 2:
_usage()
try:
results = resolve_patterns(pargs[0], pargs[1])
if results:
for s in results:
print(s)
except IOError as e:
_eprint("IOError: %s" % e)
sys.exit(1)
except SyntaxError as e:
_eprint("SyntaxError: %s" % e)
sys.exit(1)
|