Skip to content

Code auditing and profiling tool based on gcc for C programs to adhere to NASA's JPL Rule of 10 πŸš€

Notifications You must be signed in to change notification settings

ANG13T/astroguard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

50 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

astroguard Banner

astroguard

A simple code auditing and profiling tool based on gcc for C programs to adhere to NASA's JPL Rule of 10. C programs can be specified into the tool and is run through a sequence of gcc -> gcov -> glov to obtain code coverage and compilation information.

Usage πŸš€

git clone https://github.com/ANG13T/astroguard
cd astroguard
chmod +x astroguard.sh
astroguard.sh ./snippets/Rule_1.c

Make sure you have the following installed on your machine: gcc, gcov, and lcov

Preview πŸͺ

astroguard Image

NASA JPL Rule of 10 ✨

Rule 1: Avoid complex flow constructs, such as goto and recursion.

Rule 2: All loops must have fixed bounds. This prevents runaway code.

Rule 3: Avoid heap memory allocation.

Rule 4: Restrict functions to a single printed page.

Rule 5: Use a minimum of two runtime assertions per function.

Rule 6: Restrict the scope of data to the smallest possible.

Rule 7: Check the return value of all non-void functions, or cast to void to indicate the return value is useless.

Rule 8: Use the preprocessor sparingly.

Rule 9: Limit pointer use to a single dereference, and do not use function pointers.

Rule 10: Compile with all possible warnings active; all warnings should then be addressed before release of the software.

GCC Usage

GCC (GNU Compiler Collection) is a compiler for C programs maintained by the GNU Project. It turns your C code into binary which is then interpreted by a computer. It performs static analysis and debugging.

Optimized Compiler [astroguard.sh]:

astroguard settings should be set to the most pedantic level of operation. Run the astroguard.sh with your chosen C file to compile your selected file with those warnings.

Testing out Snippets πŸ”¨

cd snippets
gcc Rule_4.c -o Rule_4
./Rule_4

References πŸ”¬

Contributing ✨

astroguard is open to any contributions. Please fork the repository and make a pull request with the features or fixes you want to implement.

Suggested Features

  • An output directory that stores all output files from the astroguard.sh script which can be specified via path -o

Support πŸ’œ

If you enjoyed astroguard, please consider becoming a sponsor in order to fund my future projects.

To check out my other works, visit my GitHub profile.

To check out Stellaryx Labs, visit stellaryxlabs.com

About

Code auditing and profiling tool based on gcc for C programs to adhere to NASA's JPL Rule of 10 πŸš€

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published