From cff3628798c33eac20bf9cf7f8d8000e3c4c959d Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Tue, 4 Jun 2024 12:13:12 +0900 Subject: [PATCH] ADD README.md and LICENSE --- LICENSE | 21 +++++++++++++++++++++ README.md | 16 ++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c45e955 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Stephen Seo + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ffe6123 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# AnotherMemCheck + +This software was created as an alternative to valgrind/memcheck. + +## Usage + +1. Build this software with cmake. +2. Assuming the output library is called `libAnotherMemCheck.so`, run your + program with the `LD_PRELOAD` environment variable set to this library. + + LD_PRELOAD=path/libAnotherMemCheck.so ./myProgram + +3. When the program exits, there should be diagnostic output from this library + showing all memory that has been `malloc`ed and not `free`ed. Note that some + memory will always be shown as having been not `free`ed (e.g. initializing + heap stuff for the program at start).