BeagleBoard/GSoC/2021 Proposal/simpPRU Improvements

From eLinux.org
< BeagleBoard‎ | GSoC
Revision as of 12:48, 6 April 2021 by Archisman (talk | contribs)
Jump to: navigation, search


Proposal for Improvements to simpPRU

===== About =====
Student: Archisman Dey
Mentors: Abhisekh
Code: https://github.com/VedantParanjape/simpPRU
Wiki: https://elinux.org/index.php?title=BeagleBoard/GSoC/2021_Proposal/simpPRU_Improvements
GSoC: [N/A]

Status

This project is currently just a proposal.

Proposal

I have completed all the requirements listed on the ideas page. The code for the cross-compilation task can be found here, submitted through the pull request #146

About you

IRC: archismandey (@archismandey:matrix.org)
GitHub: GitHub Account
School: Indian Institute of Technology Guwahati
Country: India
Primary language: English, Bengali, Hindi
Typical work hours: 10:30 AM - 8:30 PM Indian Standard Time
Previous GSoC participation: This is the first time I am participating in GSoC.

About your project

Project name: Improvements to simpPRU

Description

This project aims to add tests, features, and more compatibility for simpPRU, the simple python-like language developed during GSoC 2020 to make programming the PRU easier. The following things are to be done:

Add suport for BeagleBone Blue
Currently, simpPRU supports the following boards: PocketBeagle, BeagleBone Black, BeagleBone Black Wireless and BeagleBone AI. This project will add support for the BeagleBone Blue (solving issue#4). Adding support for other boards in the BeagleBone family like the SeedStudio boards can also be done depending upon availability. This will be done by adding the pin mappings for the BeagleBone Blue in include/pin_config.h, and setting the device model in src/pin_config.c.

Add unit tests
Currently, simpPRU lacks any testing apart from making sure the examples work. This project will add unit tests for every feature present in simpPRU. There are two possible ways of adding unit tests:
End-to-end unit testing:
For example, a test case for digital read, digital write, and if statement would look like:

int ERROR := 1; 
init_message_channel();

digital_write(P1_29, true); /*Pin numbers can be changed depending on which board tests are running*/

if : not digital_read(P1_29) {
    send_message(ERROR);
}

We would build and run this on the PRU and check that 1 (ERROR) never gets sent to the host.

Unit testing with stubs and mocks:
For example, a test case for variable assignment, equality checking, and if statement would look like:

int a := 5;
if : a != 5 {
    error();
}
return 0;

Then we would build and run using the host C compiler and make sure that error() never gets called.

For the PRU specific functions, a stub function will have to be provided to satisfy the linker, for example:

void digital_write(pin_number, value) {
    printf("Digital Write called");
}

For both kinds of tests, running the unit tests would be automated into the CI pipeline.

Update the grammar so that control statements (break/continue) can only be called inside loops
Currently, they can be called inside any compound statement such as conditionals, which will throw an error while compiling the generated C code.
For example, after updating the grammar, a piece of code such as this would give an error in the bison parser itself.

int a := 10;
if: a <= 10 {
    break;
}

Update the grammar so that return statements can be called anywhere in the function
Currently they can be called only at the end of a function, which is less flexible.
For example, a function like this will now work:

def func: int: int a {
    if: a < 22 {
        return 1;
    } else {
        return 0;
    }
}

Add support for char/uint8 data type
Currently, simpPRU has support for two data types - int (32 bit) and bool. This project would add a char data type, which can also be used as an unsigned 8-bit integer.
This would be helpful in two ways:

  • Having a 8-bit unisgned integer data type would reduce memory usage, which is helpful since PRU has limited memory.
  • char can be used in arrays to implement strings.

Declaration and Assignment:

char c; /* declaration without assignment */
c := 'A'; /* assignment from single quoted character */
c := 65; /* assignment from numeric */

int a := 65;
c := a; /* assignment from integer smaller than 255 will work */

int a := 282982;
c := a; /* assignment from integer larger than 255 is undefined behavior */

Arithmetic and Comparison operators:

  • All comparison operators (>, <, ==, !=, >=, <=) will work correctly between char/char, char/int and int/char.
char i := 65;
int j := 65;
if: i == j { ... } /* true */
  • Arithmetic operators (+, -, *, /) will work with char/char, but result in undefined behavior if the result is negative or above 255.
char c1 := 45;
char c2 := 62;
char c3 := c1 + c2; /* 107 */
char c3 := c1 * c2; /* undefined behavior */
  • Arithmetic operators will work with char/int or int/char, but the char will be automatically converted to an int. If the result is assigned to a char, rules for assigning to char from int applies.

Add support for C style static arrays
Right now, simpPRU does not have any support for arrays. This project will add support for C-style static arrays:

Declaration and Assignment:

  • Arrays can be used with bool, int and char.
  • The data type has to be specified as data_type[size].
  • Array of char can be initialized from a double quoted string, where the length of the array would be at least the length of the string plus 1.
int[16] a; /* array of 16 integers */
char[20] string1 := "I love BeagleBoards";

Indexing:

  • Arrays are zero-indexed.
  • The index can be either a char or an int or an expression involving chars and ints.
  • Accessing elements of an array:
int a := arr[4]; /* Copy the 5th element of arr to a */
  • Changing elements of an array:
arr[4] := 5; /* The 5th element of arr is now 5 */

int i := 4;
arr[i] := 6; /* The 5th element of arr is now 6 */

char j := 4;
arr[j] := 7; /* The 5th element of arr is now 7 */

arr[i+j] := 1; /* The 9th element of arr is now 1 */
/* Declaring and initializing an array with all zeros */
int[16] arr;
for: i in 0:16 {
    arr[i] := 0;
}

Add a more flexible for loop
Currently the for loop in simpPRU can only handle loops of the form

for : var in range_1:range_2 {...}, where range_2 > range_1

This project will add support for more flexible for loops of the form

for : var in range_1:range_2:increment {...}, where range_1, range_2, and increment can be any integers.

Better error handling in the parser
simpPRU has some error handling in the bison parser, but it is not comprehensive. This project will add more comprehensive error handling.

Timeline

(will make a more detailed timeline later)

Mar 29 Applications open, Students register with GSoC, work on proposal with mentors
Apr 13 Proposal complete, Submitted to https://summerofcode.withgoogle.com
May 17 Proposal accepted or rejected Go through course on parsers, lexers, compilers, documentation of flex and bison, build a compiler for a toy simpPRU like programming language, play around with simpPRU. Also go through best practices for unit testing.
Jun 07 Pre-work complete Coding Officially begins!
Jun 17 Milestone #1 Introductory YouTube video, setup the hardware received, add support for BeagleBone Blue, setup infrastructure for automated unit testing into the build process and finish writing unit tests for the PRU specific functions (input. output, delay, counters).
June 24 Milestone #2 Finish writing unit tests for the language features - variables, control statements, loops and functions. Fix any bug that are caught and fix them.
June 30 Milestone #3 Update the grammar so that control statements can only be called inside loops, write tests and documentation for this.
July 12 18:00 UTC Milestone #4 Mentors and students can begin submitting Phase 1 evaluations.
Add the more flexible for loop, write tests, documentation and examples for this.
July 16 18:00 UTC Phase 1 Evaluation deadline Add more error handling in the bison parser.
July 23 Milestone #5 TBD
July 30 Milestone #6 TBD
Aug 06 Milestone #7 TBD
August 10 Milestone #8 Completion YouTube video
TBD
August 16 - 26 18:00 UTC Final week Students submit their final work product and their final mentor evaluation
August 23 - 30 18:00 UTC End of sesssion Mentors submit final student evaluations

Experience and approach

I have some experience with building stuff using arduinos and other controllers before (github). I also have programming experience with C, C++, and Python. I got interested in how parsers and compilers work while trying to build a symbolic differentiator (github) as a personal project. I have learned the basics of how flex and bison work and looked at the repository for simpPRU and I understand how it works. So I think I am qualified to work on this project.

Contingency

BeagleBoard is a very active community and it is unlikely that none of the mentors would be willing to help. That said, everything I am going to be working on is an open source project with good documentation, so I will use all the resources available to help myself.

Benefit

  • quotes

Misc

Link to pull request: #146