Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update heap checker doc with note to not strictly follow example #321

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _docs/malloc.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ Now, you can place calls to heap_check at the beginning and end of every functio

To reiterate, **course staff will ask you to demonstrate your heap checker if you are asking for help in office hours!**

**!! Important Note**: In the above heap checker example, the `metadata` struct was implemented with its `next` pointer pointing to the next _physically adjacent_ block. This does NOT mean that you must implement your `metdata` struct or `next` pointer in this way - this was a simple example we created to demonstrate how you may use a heap checker. You are allowed (and encouraged) to design and implement a different implementation of the `metadata` struct to improve performance.

## Testing Your Code

In order to run your solution on the testers, run `./mcontest` with the tester you want. You __must__ do this, or your code will be run with the glibc implementation!
Expand Down