sleeping_kangaroo12 0.0.1

data/ext/xkcp/support/Build/ToVCXProj.xsl

@@ -0,0 +1,198 @@
+<?xml version='1.0' encoding="UTF-8"?>
+<!--
+The eXtended Keccak Code Package (XKCP)
+https://github.com/XKCP/XKCP
+
+Implementation by Gilles Van Assche, hereby denoted as "the implementer".
+
+For more information, feedback or questions, please refer to the Keccak Team website:
+https://keccak.team/
+
+To the extent possible under law, the implementer has waived all copyright
+and related or neighboring rights to the source code in this file.
+http://creativecommons.org/publicdomain/zero/1.0/
+-->
+<xsl:stylesheet
+    xmlns="http://schemas.microsoft.com/developer/msbuild/2003"
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+    version='1.0'>
+
+<xsl:key name="I" match="I" use="."/>
+<xsl:key name="h" match="h" use="."/>
+<xsl:key name="c" match="c|s" use="."/>
+<xsl:key name="inc" match="inc" use="."/>
+
+<xsl:template name="ConfigurationType">
+    <xsl:param name="name"/>
+    <xsl:choose>
+        <xsl:when test="substring($name, string-length($name)-1, 2)='.a'">
+            <ConfigurationType>StaticLibrary</ConfigurationType>
+        </xsl:when>
+        <xsl:when test="substring($name, string-length($name)-2, 3)='.so'">
+            <ConfigurationType>DynamicLibrary</ConfigurationType>
+        </xsl:when>
+        <xsl:otherwise>
+            <ConfigurationType>Application</ConfigurationType>
+        </xsl:otherwise>
+    </xsl:choose>
+</xsl:template>
+
+<xsl:template match="target">
+	<xsl:variable name="name" select="translate(@name, '/', '\')"/>
+<Project DefaultTargets="Build" ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ItemGroup Label="ProjectConfigurations">
+    <ProjectConfiguration Include="Debug|Win32">
+      <Configuration>Debug</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug|x64">
+      <Configuration>Debug</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Debug|ARM64">
+      <Configuration>Debug</Configuration>
+      <Platform>ARM64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|Win32">
+      <Configuration>Release</Configuration>
+      <Platform>Win32</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|x64">
+      <Configuration>Release</Configuration>
+      <Platform>x64</Platform>
+    </ProjectConfiguration>
+    <ProjectConfiguration Include="Release|ARM64">
+      <Configuration>Release</Configuration>
+      <Platform>ARM64</Platform>
+    </ProjectConfiguration>
+  </ItemGroup>
+  <PropertyGroup Label="Globals">
+    <ProjectGuid>{6F1C9407-7A01-444D-A07B-7DAE147F22A1}</ProjectGuid>
+    <RootNamespace>XKCP</RootNamespace>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
+  <PropertyGroup Condition="'$(RuntimeLibrary)'==''">
+    <RuntimeLibrary Condition="'$(Configuration)'=='Debug'">MultiThreadedDebugDll</RuntimeLibrary>
+    <RuntimeLibrary Condition="'$(Configuration)'=='Release'">MultiThreadedDll</RuntimeLibrary>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)'=='Debug'" Label="Configuration">
+    <xsl:call-template name="ConfigurationType"><xsl:with-param name="name" select="$name"/></xsl:call-template>
+    <UseDebugLibraries>true</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)'=='Release'" Label="Configuration">
+    <xsl:call-template name="ConfigurationType"><xsl:with-param name="name" select="$name"/></xsl:call-template>
+    <UseDebugLibraries>false</UseDebugLibraries>
+    <PlatformToolset>v142</PlatformToolset>
+    <WholeProgramOptimization>true</WholeProgramOptimization>
+    <CharacterSet>MultiByte</CharacterSet>
+  </PropertyGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
+  <ImportGroup Label="ExtensionSettings">
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
+    <Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
+  </ImportGroup>
+  <PropertyGroup Label="UserMacros" />
+  <PropertyGroup Condition="'$(Configuration)'=='Debug'">
+    <OutDir>$(ProjectDir)\<xsl:value-of select="$name"/>\$(Configuration)_$(Platform)\</OutDir>
+    <IntDir>$(ProjectDir)\<xsl:value-of select="$name"/>\$(Configuration)_$(Platform)\</IntDir>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)'=='Release'">
+    <OutDir>$(ProjectDir)\<xsl:value-of select="$name"/>\$(Configuration)_$(Platform)\</OutDir>
+    <IntDir>$(ProjectDir)\<xsl:value-of select="$name"/>\$(Configuration)_$(Platform)\</IntDir>
+  </PropertyGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)'=='Debug'">
+    <ClCompile>
+      <RuntimeLibrary>$(RuntimeLibrary)</RuntimeLibrary>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>Disabled</Optimization>
+      <AdditionalIncludeDirectories>$(ProjectDir)\<xsl:value-of select="$name"/>\config;<xsl:apply-templates select="I"/></AdditionalIncludeDirectories>
+	  <PreprocessorDefinitions><xsl:apply-templates select="define"/>%(PreprocessorDefinitions)</PreprocessorDefinitions>
+	  <xsl:apply-templates select="msvc"/>
+    </ClCompile>
+    <Link>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup Condition="'$(Configuration)'=='Release'">
+    <ClCompile>
+      <RuntimeLibrary>$(RuntimeLibrary)</RuntimeLibrary>
+      <WarningLevel>Level3</WarningLevel>
+      <Optimization>MaxSpeed</Optimization>
+      <FunctionLevelLinking>true</FunctionLevelLinking>
+      <IntrinsicFunctions>true</IntrinsicFunctions>
+      <AdditionalIncludeDirectories>$(ProjectDir)\<xsl:value-of select="$name"/>\config;<xsl:apply-templates select="I"/></AdditionalIncludeDirectories>
+	  <PreprocessorDefinitions><xsl:apply-templates select="define"/>%(PreprocessorDefinitions)</PreprocessorDefinitions>
+	  <xsl:apply-templates select="msvc"/>
+    </ClCompile>
+    <Link>
+      <GenerateDebugInformation>true</GenerateDebugInformation>
+      <EnableCOMDATFolding>true</EnableCOMDATFolding>
+      <OptimizeReferences>true</OptimizeReferences>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemGroup>
+    <xsl:apply-templates select="h|inc"/>
+  </ItemGroup>
+  <ItemGroup>
+    <xsl:apply-templates select="c|s"/>
+  </ItemGroup>
+  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
+  <ImportGroup Label="ExtensionTargets">
+  </ImportGroup>
+</Project>
+</xsl:template>
+
+<xsl:template match="I">
+    <xsl:if test="generate-id()=generate-id(key('I', .)[1])">
+        <xsl:text>$(ProjectDir)..\..\</xsl:text>
+        <xsl:value-of select="translate(., '/', '\')"/>
+        <xsl:text>;</xsl:text>
+    </xsl:if>
+</xsl:template>
+
+<xsl:template match="h">
+    <xsl:if test="generate-id()=generate-id(key('h', .)[1])">
+        <ClInclude Include="{concat('..\..\', translate(., '/', '\'))}"/>
+        <xsl:text>
+</xsl:text>
+    </xsl:if>
+</xsl:template>
+
+<xsl:template match="inc">
+    <xsl:if test="generate-id()=generate-id(key('inc', .)[1])">
+        <ClInclude Include="{concat('..\..\', translate(., '/', '\'))}"/>
+        <xsl:text>
+</xsl:text>
+    </xsl:if>
+</xsl:template>
+
+<xsl:template match="c">
+    <xsl:if test="generate-id()=generate-id(key('c', .)[1])">
+        <ClCompile Include="{concat('..\..\', translate(., '/', '\'))}"/>
+        <xsl:text>
+</xsl:text>
+    </xsl:if>
+</xsl:template>
+
+<xsl:template match="s">
+    <xsl:message terminate="yes">The file '<xsl:value-of select="."/>' is a GCC assembly file and cannot be included in a Microsoft Visual Studio project.</xsl:message>
+</xsl:template>
+
+<xsl:template match="msvc">
+	<AdditionalOptions><xsl:value-of select="."/></AdditionalOptions>
+</xsl:template>
+
+<xsl:template match="define">
+	<xsl:value-of select="."/>
+	<xsl:text>;</xsl:text>
+</xsl:template>
+
+<xsl:template match="*|text()"/>
+
+</xsl:stylesheet>

data/ext/xkcp/support/Kernel-PMU/Kernel-pmu.md

@@ -0,0 +1,133 @@
+# XKCP ARM cycle count extension with a Cortex-A57 / RPIB3+ example
+
+**By Bruno Pairault, 2019**
+
+![MacDown logo](https://www.enggwave.com/wp-content/uploads/2015/06/ARM-Logo-150x127.png)
+
+**ARM** allow the counting of cycles via few techniques :
+**DWT** or nowdays **Performance Monitor Unit** (PMU). There is several versions of PMU for the different
+Cortex processor.
+
+The **ARM cycle count implementation** is Linux Kernel dependant to allow the PMU managment for User.
+Enabling the PMU on user-mode is provided per **Kernel-PMU** and is independent of XKCP.
+
+The XKCP PMU implementation supports two architectures yet **Aarch64** and **ARMv7-A**. The two XKCP
+PMU implementations to read cycles are coded in the XKCP file `tests/UnitTest/Timing.h` This file
+is only updated using the several native preprocessor compilation options. **Performance Monitors Cycle
+Counters** are then read when required.
+
+
+
+## Principle of Kernel-PMU
+**Kernel-PMU** is a Linux dependant module that has to be loaded to allow the PMU user-mode.
+XKCP `tests/UnitTest/Timing.h` will then be abble to read the register.
+
+The [Cortex-A57](https://en.wikipedia.org/wiki/ARM_Cortex-A57)
+documentation can be found on the ARM site for details on the [PMU](https://developer.arm.com/docs/ddi0488/latest/preface) . The Chapter 11
+describes the Performance Monitor Unit. For all the **Cortex A**, you can reach the [Cortex-A](https://developer.arm.com/products/processors/cortex-a) technical library.
+##Principle of the computation
+When the  **Kernel-PMU** is loaded, the processor is likely to answer with the current cycle count for PMU 32
+or 64 Architecture. Obviously similar PMU thread exist on Internet however this integration in XKCP follow exactly the principle introduced initially in `Timing.h` by **Doug Whiting**
+for Intel via `RTDSC`. Minimal changes are required in **XKCP**. We added the few ASM instructions to read the PMU according to the precompilations options.
+The number of cycles of an operation is the difference between the cycle counter before and the cycle
+counter after.
+
+## Install
+
+1. Install the kernel-header version for your kernel release number given per the command `#uname -r`.
+The method is dependant on your Packet Manager (zypper, apt-get, dpkg).
+
+	* Raspbian  (32 bits): `sudo apt-get install raspberrypi-kernel-headers`
+
+	* OpenSuse Leap 15 (64 bits): Likely on a fresh install `nothing to do` or if the OS has been updated you will have probably to run  `sudo zypper in kernel-dev`.
+
+2. Compile Kernel-PMU
+
+		#cd Kernel-PMU
+		#make
+			
+3. Load Kernel-PMU and Check
+
+
+		#sudo ./load-module
+		#dmesg
+	
+	
+	The expect result for **Cortex-a57** is similar to :
+	
+	
+	
+		[ 6014.689804] ENABLE_ARM_PMU enabling user PMU access on CPU-Core #0
+		[ 6014.689809] ENABLE_ARM_PMU enabling user PMU access on CPU-Core #2
+		[ 6014.689813] ENABLE_ARM_PMU enabling user PMU access on CPU-Core #3
+		[ 6014.689820] ENABLE_ARM_PMU enabling user PMU access on CPU-Core #1
+	
+###Know-Issues	
+* Depending on your Linux OS (Raspbian, Ubuntu Mate, OpenSuse) and your OS release you may also
+be required to download from source the kernel files to compile the module. The module will not load if
+the matching is not correct. Modify the path in the makefile if required.
+
+* The module must be reload after rebooting if you do not implement auto-load @reboot.
+
+
+##Check the CPU configuration and the native GCC options
+* The objective is to understand the compilation you need to added if you use `-mnative`.
+* Sanity check the CPU configuration and check all the native `-mXXX` compilations options like `march`,`
+mtune`.
+
+		# lscpu
+		# cat /proc/cpuinfo
+		# gcc -v
+		
+###Know-Issues Raspbian case with Updated system OS on 2019-01-01
+* On Raspbian the Cortex-a53 is declared as an ARMv7l with 4 cores as per `lscpu`. GCC [(gcc
+version 6.3.0 20170516 (Raspbian 6.3.0-18+rpi1+deb9u1)] come with native ARMv6 `-march`
+option. This is due to the implementation. Type `cat /proc/cpuinfo` and you will discover the
+**BCM2835** CPU which is the ARMv6 of the first RPI1(2010). It looks like it’s an ARMv6 for each of the 4
+cores. The impact is that we have to force the precompiler options to use the PMU 32 bits for ARM.
+
+* **Cortex-a53** RPIB3+ is an **ARMV8-a 64 bits** running mostly 32 bits as most OS for RPI are 32 bits.
+
+
+* The preprocessor options `-D__ARM_xx` have to be consistent with the processor and the OS. On a
+32 bits implementation the PMU register is the 32 bits PMU while the 64 bits PMU counter will be used
+on Aarch64.
+
+##XKCP Compilation options tips for Cortex-a53 and RPIB3+
+
+Depending on what you are trying to achieve you may like to check the compilation options for gcc or
+modify the XKCP `lib/LowLevel.build`. Below some suggestions.
+
+For 32 bits OS on ARM PMU on target
+
+The RPI3 on 32Bits OS is declared as a ARMv6 per GCC precompilation options. We have then to force
+the `ARM_ARCH_7A` option to read the 32 bit Cycle counter.
+
+
+	▪ <gcc>-v</gcc> This option add verbose
+	▪ <gcc>-D__ARM_ARCH_7A_</gcc>
+	
+For 64 bits OS on ARM on target : `-mnative` will likely implement natively `__aarch64` . it is
+suggested per GCC as good practice to enable `fix-cortex-a53-835769` and
+`fix-cortex-a53-843419`.
+
+For Cross Compilation 32 bits
+
+	▪ <gcc>-march=armv8-a+crc</gcc>
+	▪ <gcc>-mtune=cortex-a53</gcc>
+	▪ <gcc>-mlittle-endian</gcc>
+
+For Cross Compilation 64 bits using aarch64-linux-gnu-gcc
+
+	▪ <gcc>-march=armv8-a+crc</gcc>
+	▪ <gcc>-mtune=cortex-a53</gcc>
+	▪ <gcc>-mlittle-endian</gcc>
+	▪ <gcc>-mabi=lp64</gcc>
+
+
+Finally compile **KeccakTests**.
+
+
+##License
+This code is for GNU General Public License (GNU GPL or GPL) which guarantees end users the freedom
+to run, study, share and modify the Kernel-PMU.

data/ext/xkcp/support/Kernel-PMU/Makefile

@@ -0,0 +1,8 @@
+obj-m	:= enable_arm_pmu.o
+KDIR	:= /lib/modules/$(shell uname -r)/build
+PWD	:= $(shell pwd)
+
+all:
+	$(MAKE) -C $(KDIR) SUBDIRS=$(PWD) modules
+clean:
+	$(MAKE) -C $(KDIR) SUBDIRS=$(PWD) clean

data/ext/xkcp/support/Kernel-PMU/enable_arm_pmu.c

@@ -0,0 +1,129 @@
+/*
+    Kernel-PMU
+    Enabling user-mode access to the performance monitor unit (PMU) on ARMv8 Aarch64 and ARMv7
+    Copyright (C) 2019 Bruno Pairault
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/* Inspired with
+        https://community.arm.com/dev-platforms/f/discussions/10366/help-configuring-pmu-s
+        https://patchwork.kernel.org/patch/5217341/
+*/
+
+/* Enable user-mode ARM performance counter access on ARMv7 & Armv8 Aarch64 */
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/smp.h>
+
+
+#if !defined(__arm__) && !defined(__aarch64__)
+#error Module can only be compiled on ARM.
+#endif
+
+/* #define from /lib/modules/uname-r/source/arch/arm64/include/asm/perf_event.h in ASM Aarch 64 */
+#define ARMV8_PMCR_MASK         0x3f
+#define ARMV8_PMCR_E            (1 << 0) /*  Enable all counters */
+#define ARMV8_PMCR_P            (1 << 1) /*  Reset all counters */
+#define ARMV8_PMCR_C            (1 << 2) /*  Cycle counter reset */
+#define ARMV8_PMCR_N_MASK       0x1f
+
+#define ARMV8_PMUSERENR_EN_EL0  (1 << 0) /*  EL0 access enable */
+#define ARMV8_PMUSERENR_CR      (1 << 2) /*  Cycle counter read enable */
+#define ARMV8_PMUSERENR_ER      (1 << 3) /*  Event counter read enable */
+
+#define ARMV8_PMCNTENSET_EL0_ENABLE (1<<31) /* *< Enable Perf count reg */
+
+#define PERF_DEF_OPTS (1 | 16)
+
+static inline u32 armv8pmu_read(void)
+{
+        u64 val=0;
+        asm volatile("MRS %0, pmcr_el0" : "=r" (val));
+        return (u32)val;
+}
+static inline void armv8pmu_write(u32 val)
+{
+        val &= ARMV8_PMCR_MASK;
+        asm volatile("isb" : : : "memory");
+        asm volatile("MSR pmcr_el0, %0" : : "r" ((u64)val));
+}
+
+static void
+enable_cpu_counters(void* data)
+{
+    printk(KERN_INFO "ENABLE_ARM_PMU enabling user PMU access on CPU-Core #%d", smp_processor_id());
+#if __aarch64__
+        /* Enable user-mode access to counters. */
+        asm volatile("MSR pmuserenr_el0, %0" : : "r"((u64)ARMV8_PMUSERENR_EN_EL0|ARMV8_PMUSERENR_ER|ARMV8_PMUSERENR_CR));
+        /* Initialize & Reset PMNC: C and P bits. */
+        armv8pmu_write(ARMV8_PMCR_P | ARMV8_PMCR_C);
+        asm volatile("MSR pmintenset_el1, %0" : : "r" ((u64)(0 << 31)));
+        /* Count Enable Set register bit  31 enable */
+        asm volatile("MSR pmcntenset_el0, %0" : : "r" (ARMV8_PMCNTENSET_EL0_ENABLE));
+        armv8pmu_write(armv8pmu_read() | ARMV8_PMCR_E);
+
+#elif defined(__ARM_ARCH_7A__)
+
+        /* Enable user-mode access to counters. */
+        asm volatile("MCR p15, 0, %0, c9, c14, 0" :: "r"(1));
+        /* Program PMU and enable all counters */
+        asm volatile("MCR p15, 0, %0, c9, c12, 0" :: "r"(PERF_DEF_OPTS));
+        asm volatile("MCR p15, 0, %0, c9, c12, 1" :: "r"(0x8000000f));
+#else
+#error Module Does Not Support your ARM
+#endif
+}
+
+static void
+disable_cpu_counters(void* data)
+{
+        printk(KERN_INFO "ENABLE_ARM_PMU disabling user PMU access on CPU-Core #%d", smp_processor_id());
+
+#if __aarch64__
+        /*  Performance Monitors Count Enable Set register bit 31:0 disable */
+        asm volatile("MSR pmcntenset_el0, %0" : : "r" (0<<31));
+        /*  Disable all counters and user-mode access to counters. */
+        armv8pmu_write(armv8pmu_read() |~ ARMV8_PMCR_E);
+        asm volatile("MSR pmuserenr_el0, %0" : : "r"((u64)0));
+#elif defined(__ARM_ARCH_7A__)
+        asm volatile("MCR p15, 0, %0, c9, c12, 0" :: "r"(0));
+        /*  Disable all counters and user-mode access to counters. */
+        asm volatile("MCR p15, 0, %0, c9, c12, 2" :: "r"(0x8000000f));
+        asm volatile("MCR p15, 0, %0, c9, c14, 0" :: "r"(0));
+#else
+#error Module Does Not Support your ARM
+#endif
+}
+
+static int __init
+init(void)
+{
+        on_each_cpu(enable_cpu_counters, NULL, 1);
+        printk(KERN_INFO "ENABLE_ARM_PMU Initialized");
+        return 0;
+}
+
+static void __exit
+leave(void)
+{
+        on_each_cpu(disable_cpu_counters, NULL, 1);
+        printk(KERN_INFO "ENABLE_ARM_PMU Unloaded");
+}
+
+MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("Enables user-mode access to ARMv7A-v8 Aarch64 PMU counters");
+MODULE_VERSION("1:0.0-dev");
+module_init(init);
+module_exit(leave);

data/ext/xkcp/support/Kernel-PMU/load-module

@@ -0,0 +1 @@
+sudo insmod ./enable_arm_pmu.ko