Data Lab -- Manipulating Bits

Due: 5:00am, Saturday September 28, 2024

Overview

The purpose of this assignment is to become more familiar with bit-level representations of integers and floating point numbers. You will do this by solving a series of programming “puzzles.” Many of these puzzles are quite artificial, but you’ll find yourself thinking much more about bits in working your way through them.

Handout Instructions

The starter code for this assignment is on Linux server here:

/export/home/public/schwesin/cpsc235/assignments/datalab-handout.tar

Copy the datalab-handout.tar to a (protected) directory on the Linux server. Then execute the command:

    tar xvf datalab-handout.tar

This will cause a number of files to be unpacked in the directory. The only file you will be modifying and turning in is bits.c.

The bits.c file contains a skeleton for each of the 11 programming puzzles. Your assignment is to complete each function skeleton using only straightline code for the integer puzzles (i.e., no loops or conditionals) and a limited number of C arithmetic and logical operators. Specifically, you are only allowed to use the following eight operators:

! ~ & ^ | + << >>

A few of the functions further restrict this list. Also, you are not allowed to use any constants longer than 8 bits. See the comments in bits.c for detailed rules and a discussion of the desired coding style.

The Puzzles

This section describes the puzzles that you will be solving in bits.c.

The table below lists the puzzles in rough order of difficulty from easiest to hardest. The “Rating” field gives the difficulty rating (the number of points) for the puzzle, and the “Max ops” field gives the maximum number of operators you are allowed to use to implement each function. See the comments in bits.c for more details on the desired behavior of the functions. You may also refer to the test functions in tests.c. These are used as reference functions to express the correct behavior of your functions, although they don’t satisfy the coding rules for your functions.

Name	Description	Rating	Max ops
`bitXor(x,y)`	xor using only `&` and `~`	1	14
`isZero(x)`	true if `x == 0` otherwise 0.	1	2
`minusOne()`	return a value of `-`.	1	2
`oddBits()`	return word with all odd-numbered bits set to 1.	1	8
`allEvenBits(x)`	true only if all even-numbered bits in set to 1.	2	12
`implication(x, y)`	return `x -> y` in propositional logic.	2	5
`byteSwap(x, n, m)`	swaps the nth byte and the mth byte.	2	25
`isLessOrEqual(x,y)`	if `x < y` return 1, else return 0.	3	24
`logicalShift(x, y)`	shift `x` to the right by `n` using a logical shift	3	20
`rotateLeft(x, n)`	rotate `x` to the left by `n`.	3	25
`satAdd(x, y)`	sum of x and y, but saturates to the min an max values.	4	30

Building and Testing

We have included some autograding tools in the handout directory — btest, dlc, and driver.pl — to help you check the correctness of your work.

All the autograding can be run with following command:

    make test

Descriptions of the individual test programs follow.

btest: This program checks the functional correctness of the functions in bits.c. To build and use it, type the following two commands:

    make
    ./btest

Notice that you must rebuild btest each time you modify your bits.c file.

You’ll find it helpful to work through the functions one at a time, testing each one as you go. You can use the -f flag to instruct btest to test only a single function:

    ./btest -f bitXor

You can feed it specific function arguments using the option flags -1, -2, and -3:

    ./btest -f bitXor -1 4 -2 5

Check the file README for documentation on running the btest program.

dlc: This is a modified version of an ANSI C compiler from the MIT CILK group that you can use to check for compliance with the coding rules for each puzzle. The typical usage is:

    ./dlc bits.c

The program runs silently unless it detects a problem, such as an illegal operator, too many operators, or non-straightline code in the integer puzzles. Running with the -e switch:

   ./dlc -e bits.c

causes dlc to print counts of the number of operators used by each function. Type ./dlc -help for a list of command line options.

driver.pl: This is a driver program that uses btest and dlc to compute the correctness and performance points for your solution. It takes no arguments:

    ./driver.pl

Your instructor will use driver.pl to evaluate your solution.

Advice

Don’t include the <stdio.h> header file in your bits.c file, as it confuses dlc and results in some non-intuitive error messages. You will still be able to use printf in your bits.c file for debugging without including the <stdio.h> header, although gcc will print a warning that you can ignore.
The dlc program enforces a stricter form of C declarations than is the case for C++ or that is enforced by gcc. In particular, any declaration must appear in a block (what you enclose in curly braces) before any statement that is not a declaration. For example, it will complain about the following code:
```
   int foo(int x)
   {
     int a = x;
     a *= 3;     /* Statement that is not a declaration */
     int b = a;  /* ERROR: Declaration not allowed here */
   }
```

Handin Instructions

The provided makefile has a target named submit. To submit your assignment execute the command

    linux> make submit

This will copy the appropriate files to a protected directory owned by your instructor.

Grading Criteria

Your score will be computed out of a maximum of 45 points based on the following distribution:

23 Correctness points.

22 Performance points.

Correctness points. The puzzles you must solve have been given a difficulty rating between 1 and 4, such that their weighted sum totals to 23. We will evaluate your functions using the btest program, which is described above. You will get full credit for a puzzle if it passes all of the tests performed by btest, and no credit otherwise.

Performance points. Our main concern at this point in the course is that you can get the right answer. However, we want to instill in you a sense of keeping things as short and simple as you can. Furthermore, some of the puzzles can be solved by brute force, but we want you to be more clever. Thus, for each function we’ve established a maximum number of operators that you are allowed to use for each function. This limit is very generous and is designed only to catch egregiously inefficient solutions. You will receive two points for each correct function that satisfies the operator limit.