Functions
def	main (argv=None)

def	parse_line (line)

def	print_objects (objects, prefix="")

def	process_file (options)

Detailed Description

Process a ref debug log

 This file will process a log file created by enabling
 the refdebug config option in asterisk.conf.

 See http://www.asterisk.org for more information about
 the Asterisk project. Please do not directly contact
 any of the maintainers of this project for assistance;
 the project provides a web site, mailing lists and IRC
 channels for your use.

 This program is free software, distributed under the terms of
 the GNU General Public License Version 2. See the LICENSE file
 at the top of the source tree.

 Copyright (C) 2014, Digium, Inc.
 Matt Jordan <[email protected]>

Function Documentation

◆ main()

def refcounter.main ( argv = None )

Main entry point for the script

Definition at line 175 of file refcounter.py.

References len(), print_objects(), and process_file().

 def main(argv=None):
     """Main entry point for the script"""
 
     ret_code = 0
 
     if argv is None:
         argv = sys.argv
 
     parser = OptionParser()
 
     parser.add_option("-f", "--file", action="store", type="string",
                       dest="filepath", default="/var/log/asterisk/refs",
                       help="The full path to the refs file to process")
     parser.add_option("-i", "--suppress-invalid", action="store_false",
                       dest="invalid", default=True,
                       help="If specified, don't output invalid object "
                            "references")
     parser.add_option("-l", "--suppress-leaks", action="store_false",
                       dest="leaks", default=True,
                       help="If specified, don't output leaked objects")
     parser.add_option("-n", "--suppress-normal", action="store_false",
                       dest="normal", default=True,
                       help="If specified, don't output objects with a "
                            "complete lifetime")
     parser.add_option("-s", "--suppress-skewed", action="store_false",
                       dest="skewed", default=True,
                       help="If specified, don't output objects with a "
                            "skewed lifetime")
 
     (options, args) = parser.parse_args(argv)
 
     if not options.invalid and not options.leaks and not options.normal \
             and not options.skewed:
         print("All options disabled", file=sys.stderr)
         return -1
 
     if not os.path.isfile(options.filepath):
         print("File not found: %s" % options.filepath, file=sys.stderr)
         return -1
 
     try:
         (finished_objects,
          invalid_objects,
          leaked_objects,
          skewed_objects) = process_file(options)
 
         if options.invalid and len(invalid_objects):
             print_objects(invalid_objects, "Invalid Referenced")
             ret_code |= 4
 
         if options.leaks and len(leaked_objects):
             print_objects(leaked_objects, "Leaked")
             ret_code |= 1
 
         if options.skewed and len(skewed_objects):
             print_objects(skewed_objects, "Skewed")
             ret_code |= 2
 
         if options.normal:
             print_objects(finished_objects, "Finalized")
 
     except (KeyboardInterrupt, SystemExit, IOError):
         print("File processing cancelled", file=sys.stderr)
         return -1
 
     return ret_code
 
 

◆ parse_line()

def refcounter.parse_line ( line )

Parse out a line into its constituent parts.

Keyword Arguments:
line The line from a ref debug log to parse out

Returns:
A dictionary containing the options, or None

Definition at line 28 of file refcounter.py.

References len().

Referenced by process_file().

 def parse_line(line):
     """Parse out a line into its constituent parts.
 
     Keyword Arguments:
     line The line from a ref debug log to parse out
 
     Returns:
     A dictionary containing the options, or None
     """
     tokens = line.strip().split(',', 7)
     if len(tokens) < 8:
         print("ERROR: ref debug line '%s' contains fewer tokens than "
               "expected: %d" % (line.strip(), len(tokens)))
         return None
 
     processed_line = {'addr': tokens[0],
                       'delta': tokens[1],
                       'thread_id': tokens[2],
                       'file': tokens[3],
                       'line': tokens[4],
                       'function': tokens[5],
                       'state': tokens[6],
                       'tag': tokens[7],
                       }
     return processed_line
 
 

◆ print_objects()

def refcounter.print_objects	(	objects,
		prefix = `""`
	)

Prints out the objects that were processed

Keyword Arguments:
objects A list of objects to print
prefix  A prefix to print that specifies something about
        this object

Definition at line 157 of file refcounter.py.

Referenced by main().

 def print_objects(objects, prefix=""):
     """Prints out the objects that were processed
 
     Keyword Arguments:
     objects A list of objects to print
     prefix  A prefix to print that specifies something about
             this object
     """
 
     print("======== %s Objects ========" % prefix)
     print("\n")
     for obj in objects:
         print("==== %s Object %s history ====" % (prefix, obj[0]))
         for line in obj[1]['log']:
             print(line)
         print("\n")
 
 

◆ process_file()

def refcounter.process_file ( options )

The routine that kicks off processing a ref file

Keyword Arguments:
filename The full path to the file to process

Returns:
A tuple containing:
    - A list of objects whose lifetimes were completed
        (i.e., finished objects)
    - A list of objects referenced after destruction
        (i.e., invalid objects)
    - A list of objects whose lifetimes were not completed
        (i.e., leaked objects)
    - A list of objects whose lifetimes are skewed
        (i.e., Object history starting with an unusual ref count)

Definition at line 55 of file refcounter.py.

References parse_line().