SPO600 Framework Project

From CDOT Wiki
Revision as of 13:20, 23 October 2015 by Dmytro Yegorov (talk | contribs) (API Specifications)
Jump to: navigation, search

Who's Doing What

The driver for each piece is in bold. Please don't be confined by this list -- contribute to any section as you see fit.

  1. Config file format - Miguel, Andy, Shirwa
  2. Initial option lists for config file - James, Andy
  3. Config file parser - Gaurav, Miguel, Shirwa
  4. Permute test cases - Ramanan, Donald, Han
  5. Build - Yehoshua, Jayme, Nitish, Joel
  6. Test (Sanity Check/Successful Build Test) - Nitish, Dmytro, Ramanan
  7. Benchmark - Jayme, Yehoshua, Nitish
  8. Analysis tools/reporting - Kirill, Gaurav
  9. Code wrangler/git repo maintainer/QA - Joel, Jayme, James
  10. Inter-module API Coordination - Donald, Kirill, Dmytro
  11. Top-level bash script - Chris Tyler

API Specifications

             config file -> name of package write to file (analys.txt) for benchmark 
parse config -> one group per line, options delimited by "|" (STDOUT)
permute options -> one permutation per line (STDOUT) + ID of groups and group itself to analys.txt
build -> status code and location of start up script + build time, memory used, load of CPU (or it can be called in main) and status code to analys.txt
test -> status code + status code to analys.txt

analys.txt -> benchmark -> SQL Database

Basically, analys.txt would look like this:

Replace items in angle braces with your values
// denotes a comment

<package name - file name of the archive>
#<permutation number, starting with 1>|<compiler options> // # symbol delimits a complete result set
<build exit code>|<build wall clock time>|<build CPU + system time>|<binary size in bytes> // from build step - time is in seconds
<test exit code> // from test step
$<benchmark run number, start with 1>|<benchmark speed performance score>|<benchmark memory score> // from benchmark step, both are integers >= 0, higher is better
// repeat above line for each benchmark run


apache2.2.31.tgz // package name
#1|-fbuiltin -falign-loops -fforward-propagade -fipa-cp // options
0|30|90|1024    // build
0           // test
$1|1334|4532   // benchmark run 1
$2|1543|54354  // benchmark run 2
#2|-O3          // permutation 2
0|20|60|2048       // etc.

GitHub Repository

Here's the link to the Github repo: SPO600-Build-Framework

Config file name: ./monkeys10k.config

Instructions for Submitting a Pull Request

  1. Create a Github account.
  2. Navigate to the project repo by the link above.
  3. In the top right of the page make sure that you are "Watching" the repo: https://i.gyazo.com/f887e6199af0f73453556ca0e96dc2bb.png
  4. Click the Fork button.
  5. This should create a your own version of the repo.
  6. Clone the newly forked repo and begin adding your additions/changes.
  7. Once you have committed and pushed your changes to your own repo, submit a Pull Request, by clicking on the link on the right side of the repo page.
  8. Click New Pull Request.
  9. Click Create Pull Request, and add any comments about the pull request that you would like the Code Wranglers to know about (be descriptive about what is going on in your submission).
  10. The Code Wranglers will manage all pull requests and comment on any that might conflict with the main repo.

If you are still having trouble, GitHub's Using pull requests article might be helpful also.