1#!/usr/bin/env python 2# -*- coding: utf-8 -*- 3# Copyright (c) 2021 Huawei Device Co., Ltd. 4# Licensed under the Apache License, Version 2.0 (the "License"); 5# you may not use this file except in compliance with the License. 6# You may obtain a copy of the License at 7# 8# http://www.apache.org/licenses/LICENSE-2.0 9# 10# Unless required by applicable law or agreed to in writing, software 11# distributed under the License is distributed on an "AS IS" BASIS, 12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13# See the License for the specific language governing permissions and 14# limitations under the License. 15 16import os 17import time 18import argparse 19import subprocess 20from hiperf_utils import HdcInterface 21from hiperf_utils import get_build_id 22from hiperf_utils import get_architecture 23from hiperf_utils import PerformanceProfile 24from hiperf_utils import dir_check 25from hiperf_utils import get_hiperf_binary_path 26from hiperf_utils import bytes_to_str 27from hiperf_utils import str_to_bytes 28from hiperf_utils import remove 29 30 31def check_args(args): 32 if (not args.package_name) and args.ability: 33 raise Exception('-a can only be used when profiling an OHOS ' 34 'package_name.') 35 return True 36 37 38def get_module(args): 39 if args.prepare: 40 return "prepare" 41 elif args.start: 42 return "start" 43 elif args.pause: 44 return "pause" 45 elif args.resume: 46 return "resume" 47 elif args.stop: 48 return "stop" 49 50 51def parser_add_argument(): 52 description = "Collect performance sampling information of" \ 53 " running [command]." 54 parser = argparse.ArgumentParser(description=description) 55 56 control_group = parser.add_argument_group( 57 'Select Control options').add_mutually_exclusive_group(required=True) 58 control_group.add_argument('--prepare', action='store_true', 59 help='prepare need to add profiling target to ' 60 'execute record .' 61 'Like --prepare -p 121') 62 control_group.add_argument('--start', action='store_true', 63 help='start execute hiperf record') 64 control_group.add_argument('--pause', action='store_true', 65 help='pause execute hiperf record') 66 control_group.add_argument('--resume', action='store_true', 67 help='pause execute hiperf record') 68 control_group.add_argument('--stop', action='store_true', 69 help='stop execute hiperf record' 70 'and file recv data file to local') 71 72 target_group = parser.add_argument_group(title='Select profiling target') \ 73 .add_mutually_exclusive_group(required=False) 74 target_group.add_argument('-app', '--package_name', 75 help="""Collect profile info for an OHOS app""") 76 77 target_group.add_argument('-lp', '--local_program', 78 help="""Collect profile info 79 for an local program.""") 80 81 target_group.add_argument('-cmd', 82 help="""Running a command on the OHOS device. 83 like as : -cmd "'ps -ef'". 84 the ps will open as child process of hiperf 85 and sample this process.""") 86 87 target_group.add_argument('-p', '--pid', nargs='*', 88 help="""Limit the process id of the collection 89 target.""") 90 91 target_group.add_argument('-t', '--tid', nargs='*', 92 help="""Limit the thread id of the collection 93 target.""") 94 95 target_group.add_argument('-sw', '--system_wide', action='store_true', 96 help="""Collect system-wide information. 97 This requires CAP_PERFMON (since Linux 5.8) or 98 CAP_SYS_ADMIN capability or a 99 /proc/sys/kernel/perf_event_paranoid 100 value of less than 1.""") 101 102 record_group = parser.add_argument_group('Select recording options') 103 record_group.add_argument('-a', '--ability', 104 help="""Used with -p. Profile the launch time of 105 an ability in an OHOS app. The app will be started or 106 restarted to run the ability. 107 Like : -a .MainAbility """) 108 109 record_group.add_argument('-r', '--record_options', 110 default='-f 1000 -s dwarf', 111 help="""Set recording options for `hiperf record` 112 command. Default is "'-f 1000 -s dwarf'".""") 113 114 record_group.add_argument('-lib', '--local_lib_dir', type=dir_check, 115 help="""When profiling an OHOS app containing 116 local thelocal libraries are usually stripped and lake 117 of symbols and debug information to provide good 118 profiling result. By using -lib, you tell 119 command_script.py the path storing unstripped local 120 libraries, and script will search all shared libraries 121 with suffix .so in the directory. Then the local 122 libraries will be downloaded on device and collected 123 in build_cache.""") 124 125 record_group.add_argument('-o', '--output_perf_data', default='perf.data', 126 help='The path to store profiling data. ' 127 'Default is perf.data.') 128 129 other_group = parser.add_argument_group('Other options') 130 131 other_group.add_argument('--not_hdc_root', action='store_true', 132 help="""Force hdc to run in non root mode. """) 133 134 args = parser.parse_args() 135 return args 136 137 138def main(args): 139 check_args(args) 140 args_mark = [args.package_name, args.local_program, args.cmd, 141 args.pid, args.tid, args.system_wide] 142 any_args = any(args_mark) 143 if args.prepare and not any_args: 144 print("prepare need one of -app/-lp/-cmd/-p/-t/-sw " 145 "argument to execute record") 146 return False 147 profiler = PerformanceProfile(args, control_module=get_module(args)) 148 profiler.profile() 149 return True 150 151 152if __name__ == '__main__': 153 main(parser_add_argument()) 154