Description
1 Introduction
Welcome to yet another C programming project. In this project, you will develop a transpiler that translates input in the form of assignment statements and expressions of the AdvCalc++ language into LLVM IR
code that can compute and output those statements.
A transpiler, also known as a source-to-source compiler, is a type of compiler that translates source code
from one programming language to another. In this case, our program will translate the input code into
LLVM IR code, which is a low-level intermediate representation that can be used to generate code for various
target architectures.
2 Details
In this project, you will develop a translator called ADVCALC2IR that will take input in the form of
assignment statements and expressions -one on each line- and generate low-level LLVM IR code that can
compute and output these statements. The LLVM IR code generated will be in the form of static single
assignment (SSA) based representation, where variables are assigned a value once.
The LLVM IR code generated by the ADVCALC2IR translator will use the alloca keyword to allocate
space for variables and return the address of allocation. Variables in the LLVM IR code will start with the
’%’ sign. The project will only use 8-bit, 16-bit, and 32-bit integer operations, and you can assume only
binary operations.
The generated IR code will include a module name and a prototype for the printf output statement,
which will be used to print the value of a variable using the printf function. Example code can be used
directly in translations.
Errors should be reported if there is a syntax error or if an undefined variable is used. Additionally, all
errors should be reported together with the line numbers. The specific format for error reporting is detailed
below.
You can assume that only binary operations will be used in the expressions. The project provides a set
of operations that can be used in the expressions, including addition, multiplication, subtraction, division,
bitwise operations, modulus, and several bitwise shift and rotation operations. All variables and operations
are integer operations.
1
Use the following commands to compile, run, and test the generated code:
Example Command Explanation
./advcalc2ir file.adv Runs ADVCALC2IR on file.adv and produces IR code in file.ll.
lli file.ll
Runs the LLVM interpreter and dynamic compiler. This command produces the output
based on the given example code.
llc file.ll -o file.s Invokes the llc compiler to produce the assembly code.
clang file.s -o myexec Compiles the assembly code to produce the
executable.
./myexec Runs the executable.
As a summary the information above note the following about the IR code:
• LLVM IR uses static single assignment (SSA) based representation. In assignment statements, variables
are assigned a value once.
• alloca is used to allocate space for variables and return address of allocation.
• Variables start with the % sign.
• The i8, i16, and i32 keywords mean 8 bit, 16 bit, and 32 bit types, respectively.
• The * character denotes a pointer, just as in C.
• Integer variable names denote temporary variables.
• The IR contains the following piece of code, which defines the module name and the prototype for the
printf function. You should use & generate this part as is in your translated IR files.
; ModuleID = ‘advcalc2ir’
declare i32 @printf(i8*, …)
@print.str = constant [4 x i8] c”%d\0A\00″
• To print the value of a variable you can can use the printf function we’ve defined above.
call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* \
@print.str, i32 0, i32 0), i32 %7 )
The IR line above prints the value of variable %7. Lines 20 and 37 on example 1, 15 and 29 on example
2 use this function to print variable values. Also the line of code above is a single line, the ’\’ breaks
the line into two lines for aesthetic purposes.
2
The input .adv files will use a language that has the following properties:
• Every value and every calculation will be integer-valued (divisions should be rounded as it is done in
C – i.e. 8 / 3 should be equal to 2).
• There will be no expressions or assignments with a result that exceeds a 32-bit number.
• Similarly, every bit-wise intermediate operation will abide by the 32-bit limit.
• The language does not support the unary minus (-) operator (i.e x = -5 or a = -b is not valid). However,
as can be seen above, the subtraction operation is allowed.
• The variable names will consist of lowercase and uppercase Latin characters in the English alphabet
[a-zA-Z].
• Expressions or assignments will consist of 256 characters at most.
• ’%’ characters denote comments. Any characters after ’%’ will be considered as a comment, not code.
• You must run and test your code on an Ubuntu Linux machine before submitting. You can use a Linux
virtual machine or WSL in this context.
• The input advcalc++ language may include all sorts of syntax errors.
• Unlike advcalc, undefined variables cause an error in advcalc++.
• In case of syntax errors or undefined variables in the files, your output(s) should report them to the
terminal in following form:
Error on line 8!
Error on line 13!
• All of the following can be given as an input – and all of them are valid: a + b, a+ b, a + b, a+b, a +b,
(((a))) + (b)
Operation Explanation
a + b Returns summation of a and b.
a * b Returns multiplication of a and b.
a – b Returns the subtraction of b from a. No unary minus.
a / b Returns the quotient of the division.
a & b Returns bitwise a and b.
a | b Returns bitwise a or b.
a % b Returns a modulo of b.
xor(a, b) Returns bitwise a xor b.
ls(a, i) Returns the result of a shifted i bits to the left.
rs(a, i) Returns the result of a shifted i bits to the right.
lr(a, i) Returns the result of a rotated i times to the left.
rr(a, i) Returns the result of a rotated i times to the right.
not(a) Returns bitwise complement of a.
3
3 Submission
Your project will be tested automatically. Thus, it’s important that you carefully follow the submission
instructions. The root folder for the project should be named according to your student id numbers. If you
submit individually, name your root folder with your student id. If you submit as a group of two, name your
root folder with both student ids separated by an underscore. You will compress this root folder and submit
it with the .zip file format. Other archive formats will not be accepted. The final submission file should be
in the form of either 2020400039.zip or 2019400046_2020400039.zip.
Submissions will be done through
Moodle.
You must create a Makefile in your root folder which creates a advcalc2ir executable in the root folder,
do not include this executable in your submission, it will be generated with the make command using the
Makefile. The make command should not run the executable, it should only compile your program and create
the executable.
Late Submission
If the project is submitted late, the following penalties will be applied:
Hours Late Penalty
0 < hours late ≤ 24 25%
24 < hours late ≤ 48 50%
48 < hours late 100%
4 Grading
Your project will be graded according to the following criteria:
• Code Comments (8%): Write code comments for discrete code behavior and method comments.
This sub-grading evaluates the quality and quantity of comments included in the code. Comments are
essential for understanding the code’s purpose, structure, logic, and any complex algorithms or data
structures used. The code should be easily readable and maintainable for future developers.
• Documentation (12%): A written document describing how you implemented your project. This
sub-grading assesses the quality and completeness of the written documentation accompanying the
project. Good documentation should describe the purpose, design, and implementation details of the
project, as well as any challenges encountered and how they were addressed. The documentation
should also include examples of input/output and how to use the program. Students should aim to
write clear, concise, and well-organized documentation that effectively communicates the project’s
functionality and design decisions.
• Implementation and Tests (80%): The submitted project should be implemented following
the guidelines in this description and should pass testing. This sub-grading assesses the quality and
correctness of the implemented project, including its functionality and accuracy in handling expressions
and assignment statements.
4
5 Warnings
• You can submit this project either individually or as a group of two.
• All source codes are checked automatically for similarity with other submissions and exercises from
previous years. Make sure you write and submit your own code. Any sign of cheating will be penalized
with an F grade.
• Do not use content from external AI tools directly in your code and documentation. Doing so will be
viewed as plagiarism and thoroughly investigated.
• Project documentation should be structured in a proper manner. The documentation must be submitted as a .pdf file. Also include a .txt file which has the same contents as the .pdf file. This text file
should have the same file name as the pdf, and the same content, just a different file extension.
• Make sure you document your code with necessary inline comments and use meaningful variable names.
Do not over-comment, or make your variable names unnecessarily long. This is very important for
partial grading.
• Do not start coding right away. Think about the structure of your program and the possible complications resulting from it before coding.
• Questions about the project should be sent through the discussion forum on Piazza.
• Only use the C programming language for the transpiler source code.
• Your programs will be tested in a Linux Ubuntu environment.
• There will be a time limit of 30 seconds for your advcalc2ir program execution. Program execution
consists of the total amount of time for all queries. This is not a strict time limit and the execution
times may vary for each run. Thus, objections regarding time limits will be considered if necessary.
Figure 1: Random Cat Picture
5
6 Examples
Below are some examples that may be useful.
Example 1:
advcalc++:
1 x=3
2 y=5
3 zvalue=23+x*(1+y)
4 zvalue
5 k=x-y-zvalue
6 k=x+3*y*(1*(2+5))
7 k + 1
Translated file in IR form:
1 ; ModuleID = ‘advcalc2ir’
2 declare i32 @printf(i8*, …)
3 @print.str = constant [4 x i8] c”%d\0A\00″
4
5 define i32 @main() {
6 %k = alloca i32
7 %x = alloca i32
8 %y = alloca i32
9 %zvalue = alloca i32
10 store i32 3, i32* %x
11 store i32 5, i32* %y
12 %1 = load i32, i32* %x
13 %2 = load i32, i32* %y
14 %3 = add i32 1,%2
15 %4 = mul i32 %1,%3
16 %5 = add i32 23,%4
17 store i32 %5, i32* %zvalue
18 %6 = load i32, i32* %zvalue
19 call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %6 )
20 %8 = load i32, i32* %x
21 %9 = load i32, i32* %y
22 %10 = sub i32 %8,%9
23 %11 = load i32, i32* %zvalue
24 %12 = sub i32 %10,%11
25 store i32 %12, i32* %k
26 %13 = load i32, i32* %x
27 %14 = load i32, i32* %y
28 %15 = mul i32 3,%14
29 %16 = add i32 2,5
30 %17 = mul i32 1,%16
31 %18 = mul i32 %15,%17
32 %19 = add i32 %13,%18
33 store i32 %19, i32* %k
34 %20 = load i32, i32* %k
35 %21 = add i32 %20,1
36 call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %21 )
37 ret i32 0
38 }
Both executing the lli command with the IR file and running the executable generated by using llc and
clang commands should give the following output:
1 41
2 109
6
Example 2:
advcalc++:
1 siu = 11
2 siuuu = 7
3 siu / siuuu
4 siu = siu * siuuu
5 siu – siu + siu * siu / siu
Translated file in IR form:
1 ; ModuleID = ‘advcalc2ir’
2 declare i32 @printf(i8*, …)
3 @print.str = constant [4 x i8] c”%d\0A\00″
4
5 define i32 @main() {
6 %siuuu = alloca i32
7 %siu = alloca i32
8 store i32 0, i32* %siuuu
9 store i32 0, i32* %siu
10 store i32 11, i32* %siu
11 store i32 7, i32* %siuuu
12 %sad1 = load i32, i32* %siu
13 %sad3 = load i32, i32* %siuuu
14 %sad2 = sdiv i32 %sad1, %sad3
15 call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %sad2 )
16 %sad4 = load i32, i32* %siu
17 %sad6 = load i32, i32* %siuuu
18 %sad5 = mul i32 %sad4, %sad6
19 store i32 %sad5, i32* %siu
20 %sad7 = load i32, i32* %siu
21 %sad9 = load i32, i32* %siu
22 %sad10 = sub i32 %sad7, %sad9
23 %sad11 = load i32, i32* %siu
24 %sad13 = load i32, i32* %siu
25 %sad14 = mul i32 %sad11, %sad13
26 %sad15 = load i32, i32* %siu
27 %sad12 = sdiv i32 %sad14, %sad15
28 %sad8 = add i32 %sad10, %sad12
29 call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %sad8 )
30
31 ret i32 0
32 }
Executing lli file.ll or ./file.exe should give the following:
1 1
2 77
7
Example 3:
advcalc++:
1 a = 8
2 b = 8 * (a – 6)
3 c = b + 6
4 ls(a, 2)
5 xor(b – a + 1, 17)
6 y = 2 * b – c
7 xor(rs(y, 2), not(c))
Translated file in IR form:
1 ; ModuleID = ‘advcalc2ir’
2 declare i32 @printf(i8*, …)
3 @print.str = constant [4 x i8] c”%d\0A\00″
4
5 define i32 @main() {
6 %1 = alloca i32
7 %a = alloca i32
8 %b = alloca i32
9 %c = alloca i32
10 %y = alloca i32
11 store i32 0, i32* %1
12 store i32 8, i32* %a
13 %2 = load i32, i32* %a
14 %3 = sub i32 %2, 6
15 %4 = mul i32 8, %3
16 store i32 %4, i32* %b
17 %5 = load i32, i32* %b
18 %6 = add i32 %5, 6
19 store i32 %6, i32* %c
20 %7 = load i32, i32* %a
21 %8 = shl i32 %7, 2
22 call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %8 )
23 %10 = load i32, i32* %b
24 %11 = load i32, i32* %a
25 %12 = sub i32 %10, %11
26 %13 = add i32 %12, 1
27 %14 = xor i32 %13, 17
28 call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %14)
29 %16 = load i32, i32* %b
30 %17 = mul i32 2, %16
31 %18 = load i32, i32* %c
32 %19 = sub i32 %17, %18
33 store i32 %19, i32* %y
34 %20 = load i32, i32* %y
35 %21 = ashr i32 %20, 2
36 %22 = load i32, i32* %c
37 %23 = xor i32 %22, -1
38 %24 = xor i32 %21, %23
39 call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %24)
40 ret i32 0
41 }
Executing lli file.ll or ./file.exe should give the following:
1 32
2 24
3 -21
8
Example 4:
advcalc++:
1 x = 1
2 y = x + 3
3 z = x * y * y*y
4 z
5 xor(((x)), x)
6 xor(((x)), x) | z + y
7 rs(xor(((x)), x) | z + y, 1)
8 ls(rs(xor(((x)), x) | z + y, 1), (((1))))
Translated file in IR form:
1 ; ModuleID = ‘advcalc2ir’
2 declare i32 @printf(i8*, …)
3 @print.str = constant [4 x i8] c”%d\0A\00″
4
5 define i32 @main() {
6 %1 = alloca i32
7 %x = alloca i32
8 %y = alloca i32
9 %z = alloca i32
10 store i32 0, i32* %1
11 store i32 1, i32* %x
12 %2 = load i32, i32* %x
13 %3 = add i32 %2, 3
14 store i32 %3, i32* %y
15 %4 = load i32, i32* %x
16 %5 = load i32, i32* %y
17 %6 = mul i32 %4, %5
18 %7 = load i32, i32* %y
19 %8 = mul i32 %6, %7
20 %9 = load i32, i32* %y
21 %10 = mul i32 %8, %9
22 store i32 %10, i32* %z
23 %11 = load i32, i32* %z
24 %12 = call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %11 )
25 %13 = load i32, i32* %x
26 %14 = load i32, i32* %x
27 %15 = xor i32 %13, %14
28 %16 = call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %15 )
29 %17 = load i32, i32* %x
30 %18 = load i32, i32* %x
31 %19 = xor i32 %17, %18
32 %20 = load i32, i32* %z
33 %21 = load i32, i32* %y
34 %22 = add i32 %20, %21
35 %23 = or i32 %19, %22
36 %24 = call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %23 )
37 %25 = load i32, i32* %x
38 %26 = load i32, i32* %x
39 %27 = xor i32 %25, %26
40 %28 = load i32, i32* %z
41 %29 = load i32, i32* %y
42 %30 = add i32 %28, %29
43 %31 = or i32 %27, %30
44 %32 = ashr i32 %31, 1
45 %33 = call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %32 )
46 %34 = load i32, i32* %x
47 %35 = load i32, i32* %x
48 %36 = xor i32 %34, %35
49 %37 = load i32, i32* %z
50 %38 = load i32, i32* %y
9
51 %39 = add i32 %37, %38
52 %40 = or i32 %36, %39
53 %41 = ashr i32 %40, 1
54 %42 = shl i32 %41, 1
55 %43 = call i32 (i8*, …) @printf(i8* getelementptr ([4 x i8], [4 x i8]* @print.str, i32 0, i32 0), i32 %42 )
56 ret i32 0
57 }
Executing lli file.ll or ./file.exe should give the following:
1 64
2 0
3 68
4 34
5 68
10
