clean up

Author: 1a1a11a

example/plugin_v2/CMakeLists.txt

@@ -1,7 +1,8 @@
 cmake_minimum_required(VERSION 3.12)
 
 # Set the project name
-project(plugin_lru_hooks)
+project(plugin_lru_example)
+
 
 # Set C++ standard
 set(CMAKE_CXX_STANDARD 17)
@@ -55,14 +56,6 @@ target_link_libraries(plugin_lru_hooks
     ${LIBCACHESIM_LIBRARY}
 )
 
-# Set library properties
-# set_target_properties(plugin_lru_hooks PROPERTIES
-#     VERSION 1.0.0
-#     SOVERSION 1
-#     OUTPUT_NAME "plugin_lru_hooks"
-# )
-
-# Optional: Add test executable if test file exists
 if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/test_hooks_plugin.c")
     add_executable(test_hooks_plugin test_hooks_plugin.c)
     target_include_directories(test_hooks_plugin PRIVATE

example/plugin_v2/README.md

@@ -1,13 +1,12 @@
-# Plugin LRU Hooks Example
+# Plugin V2 Example - LRU Cache with Hooks
 
-This example demonstrates how to create a plugin for libCacheSim using the hook-based system implemented in `plugin_cache.c`.
+This example demonstrates how to create a plugin for libCacheSim using the v2 hook-based plugin system. The plugin implements a standalone LRU (Least Recently Used) cache algorithm that integrates with libCacheSim's plugin_cache.c framework.
 
 ## Files
 
-- `plugin_lru_hooks.cpp` - The main LRU cache plugin implementation with hooks
-- `plugin_func.cpp` - Additional plugin functions
-- `test_hooks_plugin.c` - Test program for the plugin
-- `CMakeLists.txt` - Build configuration for creating a shared library
+- `plugin_lru.cpp` - The main LRU cache plugin implementation using hooks
+- `test_hooks_plugin.c` - Comprehensive test program for the plugin
+- `CMakeLists.txt` - Build configuration for creating the shared library
 
 ## Building
 
@@ -21,29 +20,68 @@ make
 ```
 
 This will create:
-- `libplugin_lru_hooks.so` - The shared library containing the plugin
-- `test_hooks_plugin` - A test executable (if test file exists)
+- `libplugin_lru_hooks.so` - Shared library
+- `test_hooks_plugin` - Test executable for validation
 
-## Plugin Interface
+## Plugin Architecture
 
-The plugin implements the following hook functions expected by libCacheSim's plugin system:
+The plugin implements a standalone LRU cache using C++ with a C interface for compatibility with libCacheSim. It uses:
 
-- `cache_init_hook()` - Initialize the cache data structure
-- `cache_hit_hook()` - Handle cache hits (move to head of LRU list)
+- **StandaloneLRU Class**: C++ implementation with doubly-linked list and hash map
+- **Hook Functions**: C interface functions that plugin_cache.c calls
+
+### Hook Functions
+
+The plugin implements these required hook functions:
+
+- `cache_init_hook()` - Initialize the LRU cache data structure
+- `cache_hit_hook()` - Handle cache hits (move object to head of LRU list)
 - `cache_miss_hook()` - Handle cache misses (insert new object)
-- `cache_eviction_hook()` - Evict least recently used object
+- `cache_eviction_hook()` - Evict least recently used object and return its ID
 - `cache_remove_hook()` - Remove specific object from cache
 
 ## Usage
 
+### With cachesim Binary
 
+```bash
+# Run cachesim with the plugin
+./bin/cachesim ../data/cloudPhysicsIO.vscsi vscsi lru,pluginCache 0.01,0.1 \
+  -e "plugin_path=/path/to/libCacheSim/example/plugin_v2/build/libplugin_lru_hooks.so"
 ```
-./bin/cachesim ../data/cloudPhysicsIO.vscsi vscsi lru,pluginCache 0.01,0.1 -e "plugin=/proj/cache-PG0/jason/libCacheSim/example/pluginv2/_build/libplugin_lru_hooks.so.1.0.0"
+
+### Testing the Plugin
+
+Run the included test to verify plugin functionality:
+
+```bash
+cd build
+./test_hooks_plugin
 ```
 
+The test compares the plugin LRU implementation against libCacheSim's built-in LRU to ensure identical behavior.
+
 ## Dependencies
 
-- libCacheSim headers
-- GLib (for basic data types)
-- C++17 compiler
-- CMake 3.12 or higher 
+- **libCacheSim**: Headers and libraries from the main project
+- **CMake 3.12+**: Build system
+
+## Plugin Parameter Format
+
+When using the plugin with cachesim or other libCacheSim tools, use the format:
+```
+plugin_path=/full/path/to/libplugin_lru_hooks.so
+```
+
+## Implementation Notes
+
+- The plugin uses C++ internally but exports C functions for compatibility
+- Memory management is handled automatically by the StandaloneLRU destructor
+- The implementation maintains the same LRU semantics as libCacheSim's built-in LRU
+- Thread safety is not implemented - suitable for single-threaded use cases
+
+## Troubleshooting
+
+- Ensure the plugin path uses the `plugin_path=` prefix format
+- Verify all dependencies are available (check with `ldd libplugin_lru_hooks.so`)
+- Use absolute paths when specifying the plugin location