Lab 1: Data Lab

Aaron Bauer

April 7, 2022

Lab 1: Manipulating Bits1

Introduction

The purpose of this assignment is to become more familiar with bit-level representations of integers and how to use bitwise operators. You’ll 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.

Logistics

To test your solution for this lab on your own computer, you will need to have Perl installed. Fortunately, Perl is included by default on both Linux and MacOS.

You can get the files you need for this lab from the course web page here or by running
  wget http://cs.carleton.edu/faculty/awb/cs208/s22/handouts/lab1-handout.tar
If you are doing the lab on a Mac, use this version of the handout instead:
  wget http://cs.carleton.edu/faculty/awb/cs208/s22/handouts/lab1-handout-mac.tar
An error message like
  ./dlc: cannot execute binary file
means you have the wrong version of the handout. Extract the starter files with
  tar xvf lab1-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 8 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 number of points the puzzle is worth, 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
sign(x) Return 1 if x is positive, 0 if zero, and -1 if negative. 6 10
getByte(x,n) Extract byte n from x. 5 12
bitXor(x,y) x ^ y using only | and ~. 5 14
bitAnd(x,y) x | y using only | and ~. 5 14
conditional(x,y,z) Compute if (x) { return y; } else { return z; }. 5 12
logicalNeg(x) Compute !x without using ! operator. 5 12
isLessOrEqual(x,y) Return 1 if x <= y, 0 otherwise 5 24
absValue(x) Return the absolute value of x. 2 10
isPower2(x) Return 1 if x is a power of 2, 0 otherwise. 1 20

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. As with Lab 0, you can run
  make test

to run the complete autograding of your work. Details on the specific autograding components are below.

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:
  perl driver.pl

Implementation Advice

Grading

Your program will be evaluated out of 60 points using the following distribution.

Correctness points

The puzzles you must solve have been given a rating of 1, 2, 5, or 6, such that their weighted sum totals to 39. We will evaluate your functions using the btest program, which is described in the next section. You will get full credit for a puzzle if it passes all of the tests performed by btest. Partial credit may be awarded for solutions that do not pass the tests.

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 2 points for each correct function that satisfies the operator limit.

The “Beat the Prof” Contest

For fun, I am offering an optional “Beat the Prof” contest that allows you to compete with other students and the nefarious Mr. Dr. The Professor to develop the most efficient puzzles. The goal is to solve each Data Lab puzzle using the fewest number of operators. See if you can match or beat Mr. Dr. The Professor’s operator count for each puzzle!

To submit your entry to the contest, type:
  ./driver.pl -u "Your Nickname"
Nicknames are limited to 35 characters and can contain alphanumerics, apostrophes, commas, periods, dashes, underscores, and ampersands. You can submit as often as you like. Your most recent submission will appear on a real-time scoreboard, identified only by your nickname. You can view the scoreboard by pointing your browser at
  http://awb66333.mathcs.carleton.edu:8080

You will need to be on campus or connected to the Carleton VPN to submit an entry and view the scoreboard.


  1. This lab is adapted from the Data Lab developed for Computer Systems: A Programmer’s Perspective by Randal E. Bryant and David R. O’Hallaron, Carnegie Mellon University, available here.↩︎