Rename Omnitrace to ROCm Systems Profiler (#4)
The Omnitrace program is being renamed. Full name: "ROCm Systems Profiler" Package name: "rocprofiler-systems" Binary / Library names: "rocprof-sys-*" --------- Co-authored-by: Xuan Chen <xuchen@amd.com> Signed-off-by: David Galiffi <David.Galiffi@amd.com>
This commit is contained in:
David Galiffi
GitHub
@@ -0,0 +1,278 @@
|
||||
#!/usr/bin/env python@_VERSION@
|
||||
# MIT License
|
||||
#
|
||||
# Copyright (c) 2024 Advanced Micro Devices, Inc. All Rights Reserved.
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
# of this software and associated documentation files (the "Software"), to deal
|
||||
# in the Software without restriction, including without limitation the rights
|
||||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the Software is
|
||||
# furnished to do so, subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be included in all
|
||||
# copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
# SOFTWARE.
|
||||
|
||||
from __future__ import absolute_import
|
||||
|
||||
__author__ = "AMD ROCm"
|
||||
__copyright__ = "Copyright 2024, Advanced Micro Devices, Inc."
|
||||
__license__ = "MIT"
|
||||
__version__ = "@PROJECT_VERSION@"
|
||||
__maintainer__ = "AMD ROCm"
|
||||
__status__ = "Development"
|
||||
|
||||
import os
|
||||
import sys
|
||||
import threading
|
||||
from functools import wraps
|
||||
|
||||
from .common import exec_
|
||||
from .common import _initialize
|
||||
from .common import _file
|
||||
|
||||
from . import libpyrocprofsys
|
||||
from .libpyrocprofsys.profiler import (
|
||||
profiler_function as _profiler_function,
|
||||
)
|
||||
from .libpyrocprofsys.profiler import config as _profiler_config
|
||||
from .libpyrocprofsys.profiler import profiler_init as _profiler_init
|
||||
from .libpyrocprofsys.profiler import profiler_finalize as _profiler_fini
|
||||
from .libpyrocprofsys.profiler import profiler_pause as _profiler_pause
|
||||
from .libpyrocprofsys.profiler import profiler_resume as _profiler_resume
|
||||
|
||||
__all__ = [
|
||||
"profile",
|
||||
"noprofile",
|
||||
"config",
|
||||
"Profiler",
|
||||
"FakeProfiler",
|
||||
"Config",
|
||||
]
|
||||
|
||||
|
||||
config = _profiler_config
|
||||
Config = _profiler_config
|
||||
|
||||
|
||||
def _default_functor():
|
||||
return True
|
||||
|
||||
|
||||
class Profiler:
|
||||
"""Provides decorators and context-manager for the rocprof-sys profilers"""
|
||||
|
||||
global _default_functor
|
||||
|
||||
# static variable
|
||||
_conditional_functor = _default_functor
|
||||
|
||||
@staticmethod
|
||||
def condition(functor):
|
||||
"""Assign a function evaluating whether to enable the profiler"""
|
||||
Profiler._conditional_functor = functor
|
||||
|
||||
@staticmethod
|
||||
def is_enabled():
|
||||
"""Checks whether the profiler is enabled"""
|
||||
|
||||
try:
|
||||
return Profiler._conditional_functor()
|
||||
except Exception:
|
||||
pass
|
||||
return False
|
||||
|
||||
def __init__(self, **kwargs):
|
||||
""" """
|
||||
|
||||
self._original_function = (
|
||||
sys.getprofile() if sys.getprofile() != _profiler_function else None
|
||||
)
|
||||
self._unset = 0
|
||||
self._use = (
|
||||
not _profiler_config._is_running
|
||||
and Profiler.is_enabled() is True
|
||||
and not libpyrocprofsys.is_finalized()
|
||||
)
|
||||
self._file = _file()
|
||||
self.debug = kwargs["debug"] if "debug" in kwargs else False
|
||||
|
||||
def __del__(self):
|
||||
"""Make sure the profiler stops"""
|
||||
|
||||
self.stop()
|
||||
sys.setprofile(self._original_function)
|
||||
|
||||
def configure(self):
|
||||
"""Initialize, configure the bundle, store original profiler function"""
|
||||
|
||||
_initialize(self._file)
|
||||
|
||||
_profiler_init()
|
||||
|
||||
# store original
|
||||
if self.debug:
|
||||
sys.stderr.write("setting profile function...\n")
|
||||
if sys.getprofile() != _profiler_function:
|
||||
self._original_function = sys.getprofile()
|
||||
|
||||
if self.debug:
|
||||
sys.stderr.write("Tracer configured...\n")
|
||||
|
||||
def update(self):
|
||||
"""Updates whether the profiler is already running based on whether the tracer
|
||||
is not already running, is enabled, and the function is not already set
|
||||
"""
|
||||
|
||||
self._use = (
|
||||
not _profiler_config._is_running
|
||||
and Profiler.is_enabled() is True
|
||||
and sys.getprofile() == self._original_function
|
||||
and not libpyrocprofsys.is_finalized()
|
||||
)
|
||||
|
||||
def start(self):
|
||||
"""Start the profiler explicitly"""
|
||||
|
||||
self.update()
|
||||
if self._use:
|
||||
if self.debug:
|
||||
sys.stderr.write("Profiler starting...\n")
|
||||
self.configure()
|
||||
sys.setprofile(_profiler_function)
|
||||
threading.setprofile(_profiler_function)
|
||||
if self.debug:
|
||||
sys.stderr.write("Profiler started...\n")
|
||||
|
||||
self._unset = self._unset + 1
|
||||
return self._unset
|
||||
|
||||
def stop(self):
|
||||
"""Stop the profiler explicitly"""
|
||||
|
||||
self._unset = self._unset - 1
|
||||
if self._unset == 0:
|
||||
if self.debug:
|
||||
sys.stderr.write("Profiler stopping...\n")
|
||||
sys.setprofile(self._original_function)
|
||||
_profiler_fini()
|
||||
if self.debug:
|
||||
sys.stderr.write("Profiler stopped...\n")
|
||||
|
||||
return self._unset
|
||||
|
||||
def __call__(self, func):
|
||||
"""Decorator"""
|
||||
|
||||
@wraps(func)
|
||||
def function_wrapper(*args, **kwargs):
|
||||
# store whether this tracer started
|
||||
self.start()
|
||||
# execute the wrapped function
|
||||
result = func(*args, **kwargs)
|
||||
# unset the profiler if this wrapper set it
|
||||
self.stop()
|
||||
# return the result of the wrapped function
|
||||
return result
|
||||
|
||||
return function_wrapper
|
||||
|
||||
def __enter__(self, *args, **kwargs):
|
||||
"""Context manager start function"""
|
||||
|
||||
self.start()
|
||||
|
||||
def __exit__(self, exec_type, exec_value, exec_tb):
|
||||
"""Context manager stop function"""
|
||||
|
||||
self.stop()
|
||||
|
||||
if exec_type is not None and exec_value is not None and exec_tb is not None:
|
||||
import traceback
|
||||
|
||||
traceback.print_exception(exec_type, exec_value, exec_tb, limit=5)
|
||||
|
||||
def run(self, cmd):
|
||||
"""Execute and profile a command"""
|
||||
|
||||
import __main__
|
||||
|
||||
dict = __main__.__dict__
|
||||
if isinstance(cmd, str):
|
||||
return self.runctx(cmd, dict, dict)
|
||||
else:
|
||||
return self.runctx(" ".join(cmd), dict, dict)
|
||||
|
||||
def runctx(self, cmd, globals, locals):
|
||||
"""Profile a context"""
|
||||
|
||||
try:
|
||||
self.start()
|
||||
exec_(cmd, globals, locals)
|
||||
finally:
|
||||
self.stop()
|
||||
|
||||
return self
|
||||
|
||||
def runcall(self, func, *args, **kw):
|
||||
"""Profile a single function call"""
|
||||
|
||||
try:
|
||||
self.start()
|
||||
return func(*args, **kw)
|
||||
finally:
|
||||
self.stop()
|
||||
|
||||
|
||||
profile = Profiler
|
||||
|
||||
|
||||
class FakeProfiler:
|
||||
"""Provides decorators and context-manager for disabling the profiling"""
|
||||
|
||||
@staticmethod
|
||||
def condition(functor):
|
||||
pass
|
||||
|
||||
@staticmethod
|
||||
def is_enabled():
|
||||
return False
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
pass
|
||||
|
||||
def __call__(self, func):
|
||||
"""Decorator"""
|
||||
|
||||
@wraps(func)
|
||||
def function_wrapper(*args, **kwargs):
|
||||
_profiler_pause()
|
||||
ret = func(*args, **kwargs)
|
||||
_profiler_resume()
|
||||
return ret
|
||||
|
||||
return function_wrapper
|
||||
|
||||
def __enter__(self, *args, **kwargs):
|
||||
"""Context manager begin"""
|
||||
_profiler_pause()
|
||||
|
||||
def __exit__(self, exec_type, exec_value, exec_tb):
|
||||
"""Context manager end"""
|
||||
|
||||
_profiler_resume()
|
||||
import traceback
|
||||
|
||||
if exec_type is not None and exec_value is not None and exec_tb is not None:
|
||||
traceback.print_exception(exec_type, exec_value, exec_tb, limit=5)
|
||||
|
||||
|
||||
noprofile = FakeProfiler
|
||||
مرجع در شماره جدید
Block a user