PMCTrack v2.0

Author: jcsaezals

README.md

@@ -1,13 +1,14 @@
-PMCTrack is an open-source OS-oriented performance monitoring tool for GNU/Linux. This performance tool has been specifically designed to aid kernel developers in implementing scheduling algorithms in Linux that leverage data from performance monitoring counters (PMCs) to perform optimizations at run time. Unlike other monitoring tools, PMCTrack features and in-kernel API enabling the OS scheduler to access per-thread PMC data in an architecture-independent fashion. 
+PMCTrack is an open-source OS-oriented performance monitoring tool for GNU/Linux. This performance tool has been specifically designed to aid kernel developers in implementing scheduling algorithms or resource-management strategies on Linux that leverage data from performance monitoring counters (PMCs) to perform optimizations at run time. Unlike other monitoring tools, PMCTrack features and in-kernel API enabling the OS to access per-thread PMC data in an architecture-independent fashion. 
 
-Despite being an OS-oriented tool, PMCTrack still allows gathering PMC values from user space, enabling kernel developers to carry out the necessary offline analysis and debugging to assist them during the scheduler design process. In addition, the tool provides both the scheduler and the userspace PMCTrack components with other insightful metrics available in modern processors that are not directly exposed as PMCs, such as cache occupancy or energy consumption. 
+Despite being an OS-oriented tool, PMCTrack still allows the gathering of PMC values from user space, enabling kernel developers to carry out the necessary offline analysis and debugging to assist them during the OS-level design process. In addition, the tool provides both the OS and the userspace PMCTrack components with other insightful metrics available in modern processors that are not directly exposed as PMCs, such as cache occupancy or energy consumption. 
 
 [![Analytics](https://ga-beacon.appspot.com/UA-76163836-1/github-pmctrack/readme)](http://pmctrack.dacya.ucm.es)
 
 ## Project Contributors
 
 * Juan Carlos Saez Alcaide (<jcsaezal@ucm.es>) - Creator of PMCTrack and main maintainer 
 * Adrián García García (aka [@Mizadri](https://github.com/mizadri))
+* Lazaro Clemen Palafox (aka <lazarocl@ucm.es>)
 * Jaime Sáez de Buruaga Brouns (aka [@jaimesaez97](https://github.com/jaimesaez97))
 
 ## Past Contributors
@@ -28,10 +29,16 @@ Despite being an OS-oriented tool, PMCTrack still allows gathering PMC values fr
 
 ## System requirements
 
-To support PMCTrack, a patched Linux kernel must be installed on the machine. A number of kernel patches for various Linux versions can be found in the `src/kernel-patches` directory. The name of each patch file encodes the Linux kernel version where the patch must be applied to as well as the processor architecture supported. The format is as follows: 
+Starting from version v2.0, PMCTrack works with vanilla Linux kernels, and, in this case, Linux kernel v5.9.x and above are highly recommended to enjoy the full functionality of the tool. For earlier versions of PMCTrack, a patched Linux kernel must be installed on the machine. A number of kernel patches for various Linux versions can be found in the `src/kernel-patches` directory. The name of each patch file encodes the Linux kernel version where the patch must be applied to as well as the processor architecture supported. The format is as follows: 
 
 	pmctrack_linux-<kernel_version>_<architecture>.patch 
 
+To apply the patch run the following command from the root directory of the kernel sources:
+
+```
+patch -p1 < <path_to_patch_file> 
+```
+
 To build the kernel for PMCTrack, the following option must be enabled when configuring the kernel:
 
 	CONFIG_PMCTRACK=y
@@ -48,9 +55,9 @@ We also created PMCTrack-GUI, a Python front-end for the `pmctrack` command-line
 * sshpass (command)
 * WxPython v3.0
 
-On Debian or Ubuntu the necessary software can be installed as follows:
+On Debian or Ubuntu the necessary software to run PMCTrack-GUI can be installed as follows:
 
-	$ sudo apt-get install python2.7 python-matplotlib python-wxgtk3.0 sshpass 
+	$ sudo apt install python2.7 python-matplotlib python-wxgtk3.0 sshpass 
 
 On Mac OS X, PMCTrack-GUI has been succesfully tested after installing the above software dependencies using MacPorts as follows:
 
@@ -68,7 +75,7 @@ On Mac OS X, PMCTrack-GUI has been succesfully tested after installing the above
 
 ## Building PMCTrack from source for ARM and x86 processors
 
-The `PMCTRACK_ROOT` environment variable must be defined for a successful execution of the various PMCTrack command-line tools. The `shrc` script found in the repository's root directory can be used to set the `PMCTRACK_ROOT` variable appropriately as well as to add command-line tools' directories to the PATH. To make this possible, run the following command in the root directory of the repository:
+Before building PMCTrack make sure a compatible kernel is running (it must be a patched one for PMCTrack versions earlier than 2.0!), and the associated kernel header files are installed on the system. The `PMCTRACK_ROOT` environment variable must be defined for a successful execution of the various PMCTrack command-line tools. The `shrc` script found in the repository's root directory can be used to set the `PMCTRACK_ROOT` variable appropriately as well as to add command-line tools' directories to the PATH. To make this possible, run the following command in the root directory of the repository:
 
 	$ . shrc
 
@@ -187,7 +194,7 @@ The following table summarizes the properties of the various flavors of the kern
 | arm64 | `src/modules/pmcs/arm64/mchw_arm64.ko` | This module has been successfully tested on ARM systems featuring 64-bit big.LITTLE processors, which combine ARM Cortex A57 cores with and ARM Cortex A53 cores. Specifically, tests were performed on the ARM Juno Development Board. |
 | xeon-phi | `src/modules/pmcs/xeon-phi/mchw_phi.ko` | Intel Xeon Phi Coprocessor |
 | core2 | `src/modules/pmcs/phi/mchw_core2.ko` | This module has been specifically designed for the Intel QuickIA prototype system. The Intel QuickIA is a dual-socket asymmetric multicore system that features a quad-core Intel Xeon E5450 processor and a dual-core Intel Atom N330. The module also works with Intel Atom processors as well as "old" Intel multicore processors, such as the Intel Core 2 Duo. Nevertheless, given the numerous existing hacks for the QuickIA in this module, users are advised to use the more general "intel-core" flavor.  |
-| perf | `src/modules/pmcs/perf/mchw_perf.ko` | Experimental backend that uses Perf Events's kernel API to access performance monitoring counters |
+| perf | `src/modules/pmcs/perf/mchw_perf.ko` | Backend that uses Perf Events's kernel API to access performance monitoring counters. It currently works for Intel, AMD, ARMv7 and ARMv8 processors, only. |
 
 
 Once the most suitable kernel model for the system has been identified, the module can be loaded in the running PMCTrack-enabled kernel as follows:

bin/pmctrack-manager

@@ -106,24 +106,31 @@ function figure_out_kernel_HZ_setting(){
 function update_compatible_modules(){
 	local vendor_str=$1
 	local bitw=$2
-	if [ "$vendor_str" == "Intel" ]; then
+
+	grep 'CONFIG_PMCTRACK=y' /boot/config-$(uname -r)
+	patched_kernel=$?	
+	
+	if [ "$FORCE_LEGACY" != "yes" ] && [ ${patched_kernel} -ne 0 ]; then
+		compatible_modules=(perf)
+		module_names=(mchw_perf)
+	elif [ "$vendor_str" == "Intel" ]; then
 		compatible_modules=(intel-core core2 perf)
 		module_names=(mchw_intel_core mchw_core2 mchw_perf)
 	elif [ "$vendor_str" == "AMD" ]; then
-		compatible_modules=(amd)
-		module_names=(mchw_amd.ko)
+		compatible_modules=(amd perf)
+		module_names=(mchw_amd.ko mchw_perf)
 	else # ARM
 		if [ $bitw -eq 32 ]; then
 			if [ "$ODROID" == "yes" ]; then
-				compatible_modules=(odroid-xu)		
-				module_names=(mchw_odroid_xu)
+				compatible_modules=(odroid-xu perf)		
+				module_names=(mchw_odroid_xu mchw_perf)
 			else
-				compatible_modules=(arm odroid-xu)
-				module_names=(mchw_arm mchw_odroid_xu)			
+				compatible_modules=(arm odroid-xu perf)
+				module_names=(mchw_arm mchw_odroid_xu mchw_perf)			
 			fi	
 		else
-			compatible_modules=(arm64)	
-			module_names=(mchw_arm64)
+			compatible_modules=(arm64 perf)	
+			module_names=(mchw_arm64 mchw_perf)
 		fi
 	fi	
 }
@@ -300,8 +307,8 @@ function do_clean(){
 	i=0
 	for module in ${compatible_modules[*]}
 	do
-		modname=${module_names[$i]}
-		dir_module="${PMCTRACK_ROOT}/src/modules/pmcs/${module}"
+		modname="${module_names[$i]}.ko"
+        dir_module="${PMCTRACK_ROOT}/src/modules/pmcs/${module}"
 
 		if [ ! -d ${dir_module} ]; then
 			echo "Module directory not found in the source tree: ${dir_module}"

etc/events/armv7.cortex_a7.csv

@@ -22,3 +22,14 @@ bus_accesses,-,0x19,-,-
 data_mem_access,-,0x13,-,-
 instr_cache_access,-,0x14,-,-
 data_cache_eviction,-,0x15,-,-
+a7_cycles,-,0x11,-,pmu=6
+a7_instr,-,0x8,-,pmu=6
+a7_instr_arch_executed,-,0x8,-,pmu=6
+a7_l2_cache_accesses,-,0x16,-,pmu=6
+a7_l2_cache_refills,-,0x17,-,pmu=6
+a7_l2_cache_writebacks,-,0x18,-,pmu=6
+a7_l1_data_refills,-,0x03,-,pmu=6
+a7_l1_data_accesses,-,0x04,-,pmu=6
+a7_llc_accesses,-,0x16,-,pmu=6
+a7_llc_misses,-,0x17,-,pmu=6
+

etc/events/x86_amd.epyc.csv

@@ -0,0 +1,25 @@
+event_name,subevent_name,event_code,description,flags
+instr_retired,-,0xc0,-,-
+uops_retired,-,0xc1,-,-
+unhalted_core_cycles,-,0x76,-,-
+instr,-,0xc0,-,-
+cycles,-,0x76,-,-
+instr_retired,-,0xc0,-,-
+branch_instr_retired,-,0xc2,-,-
+branch_misses_retired,-,0xc3,-,-
+cache_misses,-,0x64,-,-,umask=0x09
+cache_accesses,-,0x60,-,umask=0xff
+stalled_cycles_frontend,-,0x87,-,umask=0x02
+stalled_cycles_backend,-,0x87,-,umask=0x01
+l2_cache_accesses,dc_misses,0x60,-,umask=0xc8
+l2_cache_misses,dc_misses,0x64,-,umask=0xc8
+l2_pf_miss_l2_hit_l3,-,0x71,-,umask=0xff
+l2_pf_miss_l2_l3,-,0x72,-,umask=0xff
+l3_misses_core0,-,0x030f000000000106,-,pmu=9;systemwide
+l3_misses_core1,-,0x0c0f000000000106,-,pmu=9;systemwide
+l3_misses_core2,-,0x300f000000000106,-,pmu=9;systemwide
+l3_misses_core3,-,0xc00f000000000106,-,pmu=9;systemwide=1
+l3_accesses_core0,-,0x030f000000008001,-,pmu=9;systemwide
+l3_accesses_core1,-,0x0c0f000000008001,-,pmu=9;systemwide
+l3_accesses_core2,-,0x300f000000008001,-,pmu=9;systemwide
+l3_accesses_core3,-,0xc00f000000008001,-,pmu=9;systemwide

etc/version

@@ -1 +1 @@
-1.5
+2.0

src/cmdtools/pmctrack/pmctrack.c

@@ -1095,8 +1095,9 @@ void sigchld_handler(int signo)
 
 void sigint_handler(int signo)
 {
-	if (kill(pid,SIGTERM))
-		fprintf(stderr,"Could not send signal %d to PID %d\n",signo,pid);
+	if (pid>0)
+		if (kill(pid,SIGTERM))
+			fprintf(stderr,"Could not send signal %d to PID %d\n",signo,pid);
 
 	/* Finish immediately */
 	stop_profiling=1;

src/lib/libpmctrack/include/pmctrack_internal.h

@@ -293,7 +293,7 @@ int pmct_syswide_start_counting( void );
 
 #define MAX_CORE_TYPES 2
 #define NAME_HW_EVENT_SIZE 50
-#define CODE_HW_EVENT_SIZE 10
+#define CODE_HW_EVENT_SIZE 22
 #define NAME_KEY_PMC_PROPERTY_SIZE 30
 #define VALUE_PMC_PROPERTY_SIZE 50
 #define MAX_NR_PROPERTIES 10

src/lib/libpmctrack/src/pmu_info.c

@@ -175,6 +175,10 @@ static int parse_csv_file(pmu_info_t *pmu_info)
 		strcpy(hw_subevt->name, subevt_name);
 		hw_subevt->nr_properties = 0;
 
+		/* Remove linebreak */
+		if (flags && flags[strlen(flags)-1]=='\n')
+			flags[strlen(flags)-1]='\0';
+
 		while((flag = strsep(&flags, ";")) != NULL) {
 			key = strsep(&flag, "=");
 			value = strsep(&flag, "=");

src/modules/pmcs/amd/Makefile

@@ -1,6 +1,7 @@
 MODULE_NAME=mchw_amd
 obj-m += $(MODULE_NAME).o 
-$(MODULE_NAME)-objs +=  mchw_core.o mc_experiments.o pmu_config_x86.o cbuffer.o monitoring_mod.o syswide.o ipc_sampling_sf_mm.o 
+$(MODULE_NAME)-objs +=  mchw_core.o mc_experiments.o pmu_config_x86.o cbuffer.o monitoring_mod.o syswide.o \
+						ipc_sampling_sf_mm.o pmctrack_stub.o
 SYMLINKS=$(patsubst %.o,%.c,$($(MODULE_NAME)-objs))
 SOURCES=$(patsubst %.o,../%.c,$($(MODULE_NAME)-objs))
 

src/modules/pmcs/arm/Makefile

@@ -1,7 +1,7 @@
 MODULE_NAME=mchw_arm
 obj-m += $(MODULE_NAME).o 
 $(MODULE_NAME)-objs +=  mchw_core.o mc_experiments.o pmu_config_arm.o cbuffer.o monitoring_mod.o syswide.o ipc_sampling_sf_mm.o \
-				vexpress_sensors_core.o vexpress_sensors_mm.o
+				vexpress_sensors_core.o vexpress_sensors_mm.o edp_core.o pmctrack_stub.o
 SYMLINKS=$(patsubst %.o,%.c,$($(MODULE_NAME)-objs))
 SOURCES=$(patsubst %.o,../%.c,$($(MODULE_NAME)-objs))