MP 4: Resource Manager
Overview
A classic game of the Internet-era is the game “Cookie Clicker”. Cookie Clicker is the “genre-defining” game of “incremental games”, where you have something that generates a resource in the background. With tasks being done in the background, this sounds like a perfect fit for CS 240!
For this MP, you will program a wallet that will hold a collection of resources. A user will interact with your wallet by adding or subtracting resources from it, except that you must not allow the wallet to ever go negative – debt is not allowed!
We’ll theme this wallet around building a degree (🎓), but these resources may be CPUs needed for a cluster job, available RAM for a large compute job, or other system resources. However, it’s both simpler and more fun with emojis!
Initial Files
In your CS 240 directory, merge the initial starting files with the following commands:
git fetch release
git merge release/mp4 -m "Merging initial files"
Requirements
You will implement the “wallet library”, which has only a few basic requirements:
- Your wallet initially starts empty, with 0 of all resources.
- Your wallet can accept any resource (identified by a string). The user of your library will call
wallet_change_resource
and supply adelta
to change your resource by a certaindelta
. - You must NEVER let your wallet go negative. You must not return from
wallet_change_resource
until you can satisfy the request (another thread must add to your wallet). - You may have multiple wallets at once. All state of your wallet must be maintained in your
wallet_t
. - Finally, and most importantly, many threads will be accessing your wallet(s) at the same time. You must ensure the data in your wallet is correct by ensuring accesses to your wallet are properly synchronized.
Implementation
You will find your four functions – wallet_init
, wallet_get
, wallet_change_resource
, and wallet_destroy
– in lib/wallet.c
. Additionally, the wallet_t
struct is defined in lib/wallet.h
.
Running Sample Implementations
A simple implementation using a wallet is provided for you as hedgehog-simple.c
and compiles into hedgehog-simple
. If you run ./hedgehog-simple
, you will see two threads run that do the following:
- A hedgehog food generator that constantly generates 🐛,
- A hedgehog generator that consumes 🐛 to generate 🦔!
A more complex implementation (provided in degree.c
and can be run with ./degree
), builds your degree by a series of worker threads including:
- A clover field that constantly produces ☘️ (and an occasional 🍀),
- A workshop that constantly produces 🧰 (and an occasional 💎),
- An orchard that constantly produces 🍏,
- A research job that consumes 🧰 and 🧬 to create a 📙,
- And a bunch of other jobs (you can check out the
degree.c
) to eventually create just a single 🎓!
Running Tests
- Run
make test
to compile and build the test suite. - Run
./test "[part=1]"
to test the correctness of your solution. - Run
./test "[part=2]"
to test that your solution does not use busy-waiting and properly synchronizes your threads.
The test cases in the part1
test basic functionalities of the wallet including initial count of any resource should be 0, you cannot let the wallet balance go negative, test whether you can properly build a Degree (provided in degree.c) and Hedge-Hogs (provided in hedgehog-simple.c).
The test cases in the part2
test whether your wallet can handle large number of additions and deletion requests from multiple threads in parallel. Also, in part2
, we test whether your implementation consumes CPU resources (i.e. Busy Waiting) or not when waiting for a producer to generate resources.
Submit
When you have completed your program, double-check your code works and submit it:
git add -A
git commit -m "MP4 submission"
git push origin master
You can verify your code was successfully submitted by viewing your git repo on github.com