summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorred031000 <rubenru09@aol.com>2020-12-23 19:21:52 +0000
committerred031000 <rubenru09@aol.com>2020-12-23 19:35:03 +0000
commit7dfef0140ad1b09d7091ffc2db958a0c00b8f215 (patch)
treedd435156c60557115b92680c81d9a544487fada0
parentbbb1fac16bc7e912410b3dc7bbfc5d3067ac19d4 (diff)
initial try of github actions instead of travis
-rw-r--r--.github/calcrom/.gitignore2
-rw-r--r--.github/calcrom/Makefile17
-rw-r--r--.github/calcrom/calcrom.cpp153
-rw-r--r--.github/calcrom/webhook.sh19
-rw-r--r--.github/workflows/build.yml47
5 files changed, 238 insertions, 0 deletions
diff --git a/.github/calcrom/.gitignore b/.github/calcrom/.gitignore
new file mode 100644
index 00000000..e4016dbe
--- /dev/null
+++ b/.github/calcrom/.gitignore
@@ -0,0 +1,2 @@
+calcrom
+*.exe
diff --git a/.github/calcrom/Makefile b/.github/calcrom/Makefile
new file mode 100644
index 00000000..e3b6ff50
--- /dev/null
+++ b/.github/calcrom/Makefile
@@ -0,0 +1,17 @@
+CXX := g++
+CXXFLAGS := -O3 -std=c++11
+
+ifeq ($(OS),Windows_NT)
+EXE := .exe
+else
+EXE :=
+endif
+
+TARGET := calcrom$(EXE)
+
+.PHONY: all
+
+all: $(TARGET)
+
+$(TARGET): calcrom.cpp
+ $(CXX) $(CXXFLAGS) -o $@ $^
diff --git a/.github/calcrom/calcrom.cpp b/.github/calcrom/calcrom.cpp
new file mode 100644
index 00000000..2947f5e7
--- /dev/null
+++ b/.github/calcrom/calcrom.cpp
@@ -0,0 +1,153 @@
+/*
+ * CALCROM.CPP
+ * © PikalaxALT 2020
+ *
+ * Simple C++ executable to measure the completion rate of Pokémon Diamond
+ * reverse engineering (decompilation).
+ *
+ * Requirements:
+ * - Must have C++11 compliant compiler.
+ * - MacOS X: Must provide elf.h on the include (-I) path.
+ * - Must be placed in ".travis/calcrom/".
+ *
+ * Changelog:
+ * - 0.1.0 (26 May 2020):
+ * Initial implementation
+ * - 0.1.1 (26 May 2020):
+ * Allow program to be run from wherever
+ * - 0.1.2 (27 May 2020):
+ * Extra security on ELF header
+ * - 0.1.3 (30 Jun 2020):
+ * Account for diamond/pearl split
+ */
+
+#include <iostream>
+#include <fstream>
+#include <sstream>
+#include <elf.h>
+#include <glob.h>
+#include <string.h>
+#include <vector>
+#include <string>
+
+using namespace std;
+
+struct Glob : public vector<char const *> {
+ glob_t glob_result;
+public:
+ Glob(string const & pattern) {
+ int result = glob(pattern.c_str(), GLOB_TILDE | GLOB_BRACE, NULL, &glob_result);
+ if (result) {
+ stringstream ss;
+ ss << "Glob(" << pattern << ") failed with error " << result << endl;
+ throw runtime_error(ss.str());
+ }
+ assign(glob_result.gl_pathv, glob_result.gl_pathv + glob_result.gl_pathc);
+ };
+ void operator~() {
+ globfree(&glob_result);
+ }
+};
+
+void analyze(string basedir, string subdir, string version) {
+ fstream elf;
+ Elf32_Ehdr ehdr;
+ vector<Elf32_Shdr> shdr;
+ stringstream pattern;
+
+ // Accumulate sizes
+ // src asm
+ // data _____|_____
+ // text |
+ unsigned sizes[2][2] = {{0, 0}, {0, 0}};
+ char * shstrtab = NULL;
+ size_t shstrsz = 0;
+ stringstream builddir;
+ builddir << subdir << "/build/" << version;
+ pattern << basedir << "/" << subdir << "/{src,asm,lib/{src,asm},modules/*/{src,asm}}/*.{c,s,cpp}";
+ for (char const * & fname : Glob(pattern.str()))
+ {
+ string fname_s(fname);
+ string ext = fname_s.substr(fname_s.rfind('.'), 4);
+ bool is_asm = ext == ".s";
+ fname_s = fname_s.replace(fname_s.find(subdir), 4, builddir.str());
+ fname_s = fname_s.replace(fname_s.rfind('.'), 4, ".o");
+ elf.open(fname_s, ios_base::in | ios_base::binary);
+ if (!elf.good()) {
+ cerr << "Error: file not found: " << fname_s << endl;
+ return;
+ }
+ elf.read((char *)&ehdr, sizeof(ehdr));
+ if (memcmp(ehdr.e_ident, ELFMAG, SELFMAG) != 0
+ || ehdr.e_ehsize != sizeof(Elf32_Ehdr)
+ || ehdr.e_shentsize != sizeof(Elf32_Shdr))
+ {
+ elf.close();
+ stringstream ss;
+ ss << "Error validating " << fname_s << " as an ELF file" << endl;
+ throw runtime_error(ss.str());
+ }
+ // Read ELF sections
+ elf.seekg(ehdr.e_shoff);
+ shdr.resize(ehdr.e_shnum);
+ elf.read((char *)shdr.data(), ehdr.e_shnum * ehdr.e_shentsize);
+
+ // Read .shstrtab
+ if (shstrsz < shdr[ehdr.e_shstrndx].sh_size) {
+ shstrtab = (char *)realloc(shstrtab, shdr[ehdr.e_shstrndx].sh_size);
+ shstrsz = shdr[ehdr.e_shstrndx].sh_size;
+ }
+ elf.seekg(shdr[ehdr.e_shstrndx].sh_offset);
+ elf.read(shstrtab, shdr[ehdr.e_shstrndx].sh_size);
+ elf.close();
+
+ // Analyze sections
+ for (Elf32_Shdr & hdr : shdr) {
+ string shname = shstrtab + hdr.sh_name;
+ bool is_text = (shname == ".text" || shname == ".init" || shname == ".itcm");
+ bool is_data = (shname == ".data" || shname == ".rodata" || shname == ".sdata" || shname == ".dtcm");
+ size_t size = hdr.sh_size + (hdr.sh_size & 3 ? 4 - (hdr.sh_size & 3) : 0);
+ if (is_text || is_data)
+ {
+ sizes[is_text][is_asm] += size;
+ }
+ }
+ }
+ free(shstrtab);
+
+ cout << "Analysis of " << (version.empty() ? subdir : version) << " binary:" << endl;
+ // Report code
+ unsigned total_text = sizes[1][0] + sizes[1][1];
+ double total_text_d = total_text;
+ double src_text_d = sizes[1][0];
+ double asm_text_d = sizes[1][1];
+ cout << " " << total_text << " total bytes of code" << endl;
+ cout << " " << sizes[1][0] << " bytes of code in src (" << (src_text_d / total_text_d * 100.0) << "%)" << endl;
+ cout << " " << sizes[1][1] << " bytes of code in asm (" << (asm_text_d / total_text_d * 100.0) << "%)" << endl;
+ cout << endl;
+ // Report data
+ unsigned total_data = sizes[0][0] + sizes[0][1];
+ double total_data_d = total_data;
+ double src_data_d = sizes[0][0];
+ double asm_data_d = sizes[0][1];
+ cout << " " << total_data << " total bytes of data" << endl;
+ cout << " " << sizes[0][0] << " bytes of data in src (" << (src_data_d / total_data_d * 100.0) << "%)" << endl;
+ cout << " " << sizes[0][1] << " bytes of data in asm (" << (asm_data_d / total_data_d * 100.0) << "%)" << endl;
+ // Let vectors fall to gc
+}
+
+int main(int argc, char ** argv)
+{
+ if (argc < 2) {
+ cout << "usage: calcrom PROJECT_DIR" << endl;
+ throw invalid_argument("missing required argument: PROJECT_DIR\n");
+ }
+
+ analyze(argv[1], "arm9", "diamond.us");
+ cout << endl;
+ analyze(argv[1], "arm9", "pearl.us");
+ cout << endl;
+ analyze(argv[1], "arm7", "");
+
+ return 0;
+}
diff --git a/.github/calcrom/webhook.sh b/.github/calcrom/webhook.sh
new file mode 100644
index 00000000..fd12b64f
--- /dev/null
+++ b/.github/calcrom/webhook.sh
@@ -0,0 +1,19 @@
+#!/bin/bash -ex
+
+# Only run this script if it's the master branch build.
+if [[ "$GITHUB_REF" != "refs/head/master" || "$GITHUB_EVENT_NAME" != "push" ]]; then
+ exit 0
+fi
+
+build_name=$1
+url=$2
+map_file=$(dirname "$0")/../../arm9/build/diamond.us/arm9.elf.xMAP
+if [ ! -f $map_file ]; then
+ echo "$map_file does not exist!"
+ exit 1
+fi
+
+make -C ${GITHUB_WORKSPACE}/.github/calcrom
+output=$(${GITHUB_WORKSPACE}/.github/calcrom/calcrom ${GITHUB_WORKSPACE} | sed -E ':a;N;$!ba;s/\r{0,1}\n/\\n/g')
+curl -d "{\"username\": \"$CALCROM_DISCORD_WEBHOOK_USERNAME\", \"avatar_url\": \"$url\", \"content\":\"\`\`\`$build_name progress:\\n$output\`\`\`\"}" -H "Content-Type: application/json" -X POST $CALCROM_DISCORD_WEBHOOK_URL
+popd
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 00000000..8d06370e
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,47 @@
+name: build
+
+on: [push, pull_request]
+
+env:
+ LM_LICENSE_FILE: "$GITHUB_WORKSPACE/tools/mwccarm/license.dat"
+ CC: gcc-8
+ CXX: g++-8
+ CALCROM_DISCORD_WEBHOOK_AVATAR_URL: "https://i.imgur.com/38BQHdd.png"
+ CALCROM_DISCORD_WEBHOOK_USERNAME: OK
+ CALCROM_WEBHOOK_URL: ${{ secrets.WebhookUrl }}
+
+
+jobs:
+ build:
+ runs-on: ubuntu-20.04
+
+ strategy:
+ matrix:
+ version: [diamond, pearl]
+
+ steps:
+ - name: Update and Install Software
+ run: |
+ sudo apt update
+ sudo apt -y upgrade
+ sudo apt -y install g++-8-multilib linux-libc-dev binutils-arm-none-eabi wine32 wine-stable
+ - name: Checkout Repo
+ uses: actions/checkout@v2
+ - name: Setup Repo
+ run: |
+ mkdir -p $HOME/download
+ cd $HOME/download
+ wget http://private.martmists.com/mwccarm.zip
+ wget http://private.martmists.com/nitro.tar.gz
+ unzip mwccarm.zip
+ mv mwccarm $GITHUB_WORKSPACE/tools
+ tar xzf nitro.tar.gz
+ mv tools/bin $GITHUB_WORKSPACE/tools
+ mv include/nitro/specfiles/ARM7-TS.lcf.template $GITHUB_WORKSPACE/arm7
+ mv include/nitro/specfiles/ARM9-TS.lcf.template $GITHUB_WORKSPACE/arm9
+ working-directory: $HOME
+ - name: Build
+ run: make ${{ matrix.version }}
+ - name: Webhook
+ run: .github/calcrom/calcrom.sh pokediamond "$CALCROM_WEBHOOK_URL"
+ continue-on-error: true