Merge pull request #12 from hilldani/master

adding SPR support, updating copywrite & license, streamline build

Author: karanrk

.github/workflows/build.yml

@@ -1,31 +1,23 @@
 name: Build & Test
 
-on:
-  [pull_request,push]
+on: [pull_request, push]
 
 jobs:
   build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: [3.9]
-
+    runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - uses: actions/checkout@v3
+      - name: install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install flake8 pytest
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-      - name: Edit memory config
-        run: sed -i '10 i \    --memory-swap -1                                \\' builder/build
-      - name: Build binaries
-        run: ./build.sh
-      - name: Validate with pytest
+          sudo apt update
+          sudo apt install -y python3
+          sudo snap install go --classic
+          pip3 install -r requirements.txt
+      - name: build
         run: |
-          builder/test
+          make dist
+      - name: upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: perfspect
+          path: dist/perfspect*.tgz

.gitignore

@@ -0,0 +1,4 @@
+build/*
+dist/*
+pmu-checker/pmu-checker
+src/libtsc.so

CODE_OF_CONDUCT.md

@@ -0,0 +1,131 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+CommunityCodeOfConduct AT intel DOT com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing
+
+### License
+
+PerfSpect is licensed under the terms in [LICENSE](./LICENSE). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
+
+### Sign your work
+
+Please use the sign-off line at the end of the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify
+the below (from [developercertificate.org](http://developercertificate.org/)):
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+Then you just add a line to every git commit message:
+
+    Signed-off-by: Joe Smith <[email protected]>
+
+Use your real name (sorry, no pseudonyms or anonymous contributions.)
+
+If you set your `user.name` and `user.email` git configs, you can sign your
+commit automatically with `git commit -s`.

Makefile

@@ -1,101 +1,104 @@
+COMMIT_ID := $(shell git rev-parse --short=8 HEAD)
+COMMIT_DATE := $(shell git show -s --format=%cd --date=short HEAD)
 VERSION_FILE := _version.txt
+VERSION_BASE := $(COMMIT_DATE)_$(COMMIT_ID)
 VERSION_NUMBER := $(shell cat ${VERSION_FILE})
 VERSION_PUBLIC := $(VERSION_NUMBER)
-PACKAGE := perfspect_$(VERSION_NUMBER).tgz
+PACKAGE_EXTERNAL := perfspect_$(VERSION_NUMBER).tgz
 BINARY_FINAL := perfspect
 BINARY_COLLECT := perf-collect
 BINARY_POSTPROCESS := perf-postprocess
-
 default: all
 
-.PHONY: all test default dist clean format format_check security_scan flakes mypy pytype source_check checkmake dist/$(PACKAGE)
+.PHONY: all test default dist clean format format_check security_scan flakes source_check checkmake dist/version_file dist/$(SOURCE_PACKAGE)
 
 clean_dir:
 	rm -rf build/*
 	rm -rf dist/*
-	sudo rm -rf test/perf*
+	#sudo rm -rf test/$(BINARY_FINAL)
 	rm -rf src/__pycache__
 
 build_dir: clean_dir
 	mkdir -p build
-	mkdir -p dist
 
 build/pmu-checker:
 	cd pmu-checker && make
 	cp pmu-checker/pmu-checker build/
 	strip -s -p --strip-unneeded build/pmu-checker
 
 build/libtsc:
-	cd src && gcc -shared -o libtsc.so -fPIC calibrate.c
+	gcc -fno-strict-overflow -fno-delete-null-pointer-checks -fwrapv -fPIC -shared -o src/libtsc.so src/calibrate.c
 
-build/collect:
+build-public/collect:
 	$(eval TMPDIR := $(shell mktemp -d build.XXXXXX))
 	mkdir -p $(TMPDIR)/src
 	mkdir -p $(TMPDIR)/events
 	cp src/* $(TMPDIR)/src && cp events/* $(TMPDIR)/events && cp *.py $(TMPDIR)
-	sed -i 's/PerfSpect_DEV_VERSION/$(VERSION_PUBLIC)/g' $(TMPDIR)/src/perf_helpers.py
+	sed -i 's/PerfSpect_DEV_VERSION/$(VERSION_PUBLIC)/g' $(TMPDIR)/src/perf_helpers.py 
 	cd $(TMPDIR) && pyinstaller -F perf-collect.py -n $(BINARY_COLLECT) \
 					--add-data "./src/libtsc.so:." \
 					--add-data "./events/bdx.txt:." \
 					--add-data "./events/skx.txt:." \
-					--add-data "./events/skx_aws.txt:." \
-					--add-data "./events/skx_oci.txt:." \
 					--add-data "./events/clx.txt:." \
-					--add-data "./events/clx_aws.txt:." \
 					--add-data "./events/icx.txt:." \
+					--add-data "./events/spr.txt:." \
 					--add-data "./events/icx_aws.txt:." \
-					--add-data "./events/icx_oci.txt:." \
+					--add-data "./events/spr_aws.txt:." \
+					--add-data "./events/clx_aws.txt:." \
+					--add-data "./events/skx_aws.txt:." \
 					--add-binary "../build/pmu-checker:." \
-					--runtime-tmpdir . 
+					--runtime-tmpdir . \
+					--exclude-module readline
+	
 	cp $(TMPDIR)/dist/$(BINARY_COLLECT) build/
 	rm -rf $(TMPDIR)
 
-build/postprocess:
+build-public/postprocess:
 	$(eval TMPDIR := $(shell mktemp -d build.XXXXXX))
-	git clone https://github.com/danthedeckie/simpleeval.git
-	cp simpleeval/simpleeval.py .
 	mkdir -p $(TMPDIR)/src
 	mkdir -p $(TMPDIR)/events
 	cp src/* $(TMPDIR)/src && cp events/* $(TMPDIR)/events && cp *.py $(TMPDIR)
-	sed -i 's/PerfSpect_DEV_VERSION/$(VERSION_PUBLIC)/g' $(TMPDIR)/src/perf_helpers.py
+	sed -i 's/PerfSpect_DEV_VERSION/$(VERSION_PUBLIC)/g' $(TMPDIR)/src/perf_helpers.py 
 	cd $(TMPDIR) && pyinstaller -F perf-postprocess.py -n perf-postprocess \
 					--add-data "./events/metric_skx_clx.json:." \
 					--add-data "./events/metric_bdx.json:." \
 					--add-data "./events/metric_icx.json:." \
-					--add-data="simpleeval.py:." \
-					--runtime-tmpdir .
+					--add-data "./events/metric_spr.json:." \
+					--add-data "./events/metric_icx_aws.json:." \
+					--add-data "./events/metric_spr_aws.json:." \
+					--runtime-tmpdir . \
+					--exclude-module readline
 	cp $(TMPDIR)/dist/perf-postprocess build/
-	rm -rf simpleeval && rm -f simpleeval.py
 	rm -rf $(TMPDIR)
 
-dist/$(PACKAGE): build_dir build/pmu-checker build/libtsc build/collect build/postprocess
-	rm -rf dist/*
-	cp build/$(BINARY_COLLECT) dist/$(BINARY_COLLECT)
-	cp build/$(BINARY_POSTPROCESS) dist/$(BINARY_POSTPROCESS)
-	rm -rf build
-
+dist/$(PACKAGE_EXTERNAL): build_dir build/pmu-checker build/libtsc build-public/collect build-public/postprocess
+	rm -rf dist/$(BINARY_FINAL)/
+	mkdir -p dist/$(BINARY_FINAL)
+	cp build/$(BINARY_COLLECT) dist/$(BINARY_FINAL)/$(BINARY_COLLECT)
+	cp build/$(BINARY_POSTPROCESS) dist/$(BINARY_FINAL)/$(BINARY_POSTPROCESS)
+	cp LICENSE dist/$(BINARY_FINAL)/
+	cp README.md dist/$(BINARY_FINAL)/README.md
+	cd dist && tar -czf $(PACKAGE_EXTERNAL) $(BINARY_FINAL)
+	cd dist && cp -r $(BINARY_FINAL) ../build/  
+	rm -rf dist/$(BINARY_FINAL)/
+	cd dist && md5sum $(PACKAGE_EXTERNAL) > $(PACKAGE_EXTERNAL).md5
 
 test:
-	cp dist/$(BINARY_COLLECT) dist/$(BINARY_POSTPROCESS) test/
+	cd dist && tar -xvf perfspect_$(VERSION_PUBLIC).tgz && cp -r $(BINARY_FINAL) ../test/.
 	cd test && pytest
 
-security_scan: src/*.py
-	bandit src
-	bandit *.py
-
 format:
 	black src
 	black *.py
 
 format_check:
 	black --check src
-	black --check *.py
+	black --check perf-collect.py perf-postprocess.py
 
 error_check: # ignore false positives
-	flake8 --ignore=E501,W503,F403,F405 src
-	flake8 --ignore=E203,E501,E722,W503,F403,F405 *.py
+	flake8 --ignore=E501,W503,F403,F405,E741 src
+	flake8 --ignore=E203,E501,E722,W503,F403,F405 *.py --exclude simpleeval.py,perfmon.py,average.py
 
 source_check: security_scan format_check error_check
 
-dist: source_check dist/$(PACKAGE)
-
+dist: source_check dist/$(PACKAGE_EXTERNAL)