codegreen 0.2.1__tar.gz → 0.3.0__tar.gz

{codegreen-0.2.1 → codegreen-0.3.0}/CMakeLists.txt

@@ -16,7 +16,7 @@ set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 
 # Find required packages
-find_package(PkgConfig REQUIRED)
+find_package(PkgConfig)
 find_package(Threads REQUIRED)
 
 # Optional GPU library support
@@ -47,10 +47,16 @@ else()
     set(HAVE_ROCM_SMI OFF)
 endif()
 
-# Find system libraries
-pkg_check_modules(JSONCPP REQUIRED jsoncpp)
-pkg_check_modules(CURL REQUIRED libcurl)
-pkg_check_modules(SQLITE3 REQUIRED sqlite3)
+# System libraries (required for legacy core on Linux, not for NEMB-only macOS builds)
+if(NOT APPLE)
+    pkg_check_modules(JSONCPP REQUIRED jsoncpp)
+    pkg_check_modules(CURL REQUIRED libcurl)
+    pkg_check_modules(SQLITE3 REQUIRED sqlite3)
+else()
+    pkg_check_modules(JSONCPP jsoncpp)
+    pkg_check_modules(CURL libcurl)
+    pkg_check_modules(SQLITE3 sqlite3)
+endif()
 
 # Global include directories
 include_directories(${CMAKE_SOURCE_DIR}/codegreen/measurement/include)
@@ -114,37 +120,33 @@ endif()
 # Instrumentation is now Python-based, no C++ build needed
 # add_subdirectory(codegreen/instrumentation)
 
-# Main executable
-add_executable(codegreen 
-    codegreen/measurement/main.cpp
-)
-
-# Ensure instrumentation files are synced before building main executable
-add_dependencies(codegreen sync_instrumentation)
-
-# Link all libraries
-target_link_libraries(codegreen PRIVATE
-    codegreen-core
-    codegreen-nemb
-    ${JSONCPP_LIBRARIES}
-    ${CURL_LIBRARIES}
-    Threads::Threads
-)
-
-target_include_directories(codegreen PRIVATE
-    ${CMAKE_SOURCE_DIR}/codegreen/measurement/include
-    ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/include
-    ${JSONCPP_INCLUDE_DIRS}
-    ${CURL_INCLUDE_DIRS}
-)
-
-# Compiler-specific options
-if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
-    target_compile_options(codegreen PRIVATE 
-        -Wall -Wextra -Wno-unused-parameter
-        $<$<CONFIG:Debug>:-g -O0>
-        $<$<CONFIG:Release>:-O3 -DNDEBUG>
+# Main executable (requires jsoncpp/curl/sqlite -- Linux only)
+# On macOS, only codegreen-nemb is built; the Python CLI handles everything.
+if(NOT APPLE)
+    add_executable(codegreen
+        codegreen/measurement/main.cpp
+    )
+    add_dependencies(codegreen sync_instrumentation)
+    target_link_libraries(codegreen PRIVATE
+        codegreen-core
+        codegreen-nemb
+        ${JSONCPP_LIBRARIES}
+        ${CURL_LIBRARIES}
+        Threads::Threads
+    )
+    target_include_directories(codegreen PRIVATE
+        ${CMAKE_SOURCE_DIR}/codegreen/measurement/include
+        ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/include
+        ${JSONCPP_INCLUDE_DIRS}
+        ${CURL_INCLUDE_DIRS}
     )
+    if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+        target_compile_options(codegreen PRIVATE
+            -Wall -Wextra -Wno-unused-parameter
+            $<$<CONFIG:Debug>:-g -O0>
+            $<$<CONFIG:Release>:-O3 -DNDEBUG>
+        )
+    endif()
 endif()
 
 # Copy runtime modules to build directory with dependency tracking
@@ -236,30 +238,44 @@ if(EXISTS "${CMAKE_SOURCE_DIR}/config/codegreen.json")
     )
 endif()
 
-# Installation
-install(TARGETS codegreen
-    RUNTIME DESTINATION bin
-    COMPONENT runtime
-)
+# Installation (binary only on Linux where codegreen-core is built)
+if(NOT APPLE)
+    install(TARGETS codegreen
+        RUNTIME DESTINATION bin
+        COMPONENT runtime
+    )
+endif()
 
-# Create development bin directory and copy binary for CLI integration
-add_custom_target(dev-install ALL
-    DEPENDS codegreen
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/bin
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/codegreen ${CMAKE_SOURCE_DIR}/bin/
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/lib
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/lib/libcodegreen-nemb.so ${CMAKE_SOURCE_DIR}/lib/
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/lib/libcodegreen-core.a ${CMAKE_SOURCE_DIR}/lib/
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/bin/python/instrumentation
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/bridge_analyze.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/bridge_instrument.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_engine.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/ast_processor.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_configs.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
-    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_runtimes ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/language_runtimes
-    COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/configs ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/configs
-    COMMENT "Copying binary and instrumentation files to development bin directory for CLI integration"
-)
+# Dev-install: copy NEMB library + instrumentation files for local development
+if(APPLE)
+    add_custom_target(dev-install ALL
+        DEPENDS codegreen-nemb
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/lib
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/lib/libcodegreen-nemb.dylib ${CMAKE_SOURCE_DIR}/lib/
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/bin/python/instrumentation
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_runtimes ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/language_runtimes
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/configs ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/configs
+        COMMENT "Dev-install: NEMB dylib + instrumentation (macOS)"
+    )
+else()
+    add_custom_target(dev-install ALL
+        DEPENDS codegreen
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/bin
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/codegreen ${CMAKE_SOURCE_DIR}/bin/
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/lib
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/lib/libcodegreen-nemb.so ${CMAKE_SOURCE_DIR}/lib/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/lib/libcodegreen-core.a ${CMAKE_SOURCE_DIR}/lib/
+        COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_SOURCE_DIR}/bin/python/instrumentation
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/bridge_analyze.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/bridge_instrument.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_engine.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/ast_processor.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
+        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_configs.py ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_runtimes ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/language_runtimes
+        COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/configs ${CMAKE_SOURCE_DIR}/bin/python/instrumentation/configs
+        COMMENT "Dev-install: binary + NEMB + instrumentation (Linux)"
+    )
+endif()
 
 # Install runtime modules
 install(FILES ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_runtimes/python/codegreen_runtime.py

{codegreen-0.2.1/codegreen.egg-info → codegreen-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codegreen
-Version: 0.2.1
+Version: 0.3.0
 Summary: Energy-aware software development tool for measuring and optimizing code energy consumption
 Author-email: Saurabhsingh Rajput <saurabh@dal.ca>
 Maintainer-email: Saurabhsingh Rajput <saurabh@dal.ca>
@@ -399,6 +399,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: C++
 Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Environment :: Console
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
@@ -447,7 +448,7 @@ CodeGreen is a comprehensive tool for fine-grained energy profiling and optimiza
 pip install codegreen
 ```
 
-Requires Linux with RAPL support. The wheel includes the pre-built C++ measurement backend.
+Pre-built wheels available for Linux x86_64 and macOS ARM64 (Apple Silicon). Includes the native NEMB energy measurement backend.
 
 ### From source (recommended for development)
 
@@ -456,18 +457,28 @@ git clone https://github.com/SMART-Dal/codegreen.git
 cd codegreen
 ./install.sh
 
-# For RAPL sensor access (one-time, requires sudo):
+# Linux: RAPL sensor access (one-time, requires sudo):
 sudo ./install.sh   # or: sudo codegreen init-sensors
-# Then log out and back in for group permissions
+
+# macOS: energy measurement requires sudo (IOReport access):
+sudo codegreen run -- python script.py
 ```
 
+### Platform support
+
+| Platform | pip install | Energy measurement | Backend |
+|----------|------------|-------------------|---------|
+| Linux x86_64 (Intel/AMD) | Pre-built wheel | Full | RAPL via NEMB |
+| macOS ARM64 (Apple Silicon) | Pre-built wheel | Full | IOReport + kpc via NEMB |
+| macOS Intel | From source | Full | IOReport via NEMB |
+| Other | From source | Time-only | Fallback |
+
 ### Requirements
 
-- Linux (kernel 5.0+, Ubuntu 20.04+, Debian 11+, Fedora 35+, MacOS)
 - Python 3.9+
-- CMake 3.16+, g++ 9+ (for source builds only)
-- Intel or AMD CPU with RAPL support
-- `perf` (for `codegreen run` and benchmark validation)
+- Linux: kernel 5.0+, Intel/AMD CPU with RAPL support
+- macOS: Apple Silicon (M1-M5) or Intel, sudo for energy measurement
+- Source builds: CMake 3.16+, C++17 compiler
 
 ## Usage
 
@@ -510,7 +521,7 @@ JSON (default for `--json`), CSV, Markdown table, and text summary. The JSON out
 
 ## Language support
 
-Adding a new language requires only a JSON config file in `src/instrumentation/configs/` plus the tree-sitter grammar. No Python code changes needed.
+Adding a new language requires only a JSON config file in `codegreen/instrumentation/configs/` plus the tree-sitter grammar. No Python code changes needed.
 
 Currently supported: Python, C, C++, JavaScript, Java.
 
@@ -529,7 +540,7 @@ bash scripts/generate_comparison_artifacts.sh docs/benchmarks/
 
 ## Energy Flow Graph (EFG)
 
-CodeGreen includes an Energy Flow Graph module (`src/analysis/cfg/`) that builds energy-annotated control flow graphs from source code:
+CodeGreen includes an Energy Flow Graph module (`codegreen/analysis/cfg/`) that builds energy-annotated control flow graphs from source code:
 
 ```python
 from codegreen.analysis.cfg.builder import build_per_method_cfgs
@@ -544,7 +555,7 @@ Features: Ball & Larus branch heuristics, SCC-based hot path computation, three-
 
 ## Architecture
 
-- **C++ NEMB backend**: RAPL energy reading with sub-microsecond timestamping, configurable polling interval
+- **C++ NEMB backend**: platform-aware energy measurement (RAPL on Linux, IOReport on macOS), sub-microsecond timestamping, background polling with lock-free ring buffers
 - **Python instrumentation**: tree-sitter AST analysis, config-driven checkpoint insertion
 - **Energy Flow Graph**: CFG + energy annotation for path-dependent analysis
 - **Benchmark harness**: multi-suite support (benchmarksgame, PerfOpt), statistical analysis with t-distribution CI, IQR outlier detection, profiler comparison

{codegreen-0.2.1 → codegreen-0.3.0}/README.md

@@ -17,7 +17,7 @@ CodeGreen is a comprehensive tool for fine-grained energy profiling and optimiza
 pip install codegreen
 ```
 
-Requires Linux with RAPL support. The wheel includes the pre-built C++ measurement backend.
+Pre-built wheels available for Linux x86_64 and macOS ARM64 (Apple Silicon). Includes the native NEMB energy measurement backend.
 
 ### From source (recommended for development)
 
@@ -26,18 +26,28 @@ git clone https://github.com/SMART-Dal/codegreen.git
 cd codegreen
 ./install.sh
 
-# For RAPL sensor access (one-time, requires sudo):
+# Linux: RAPL sensor access (one-time, requires sudo):
 sudo ./install.sh   # or: sudo codegreen init-sensors
-# Then log out and back in for group permissions
+
+# macOS: energy measurement requires sudo (IOReport access):
+sudo codegreen run -- python script.py
 ```
 
+### Platform support
+
+| Platform | pip install | Energy measurement | Backend |
+|----------|------------|-------------------|---------|
+| Linux x86_64 (Intel/AMD) | Pre-built wheel | Full | RAPL via NEMB |
+| macOS ARM64 (Apple Silicon) | Pre-built wheel | Full | IOReport + kpc via NEMB |
+| macOS Intel | From source | Full | IOReport via NEMB |
+| Other | From source | Time-only | Fallback |
+
 ### Requirements
 
-- Linux (kernel 5.0+, Ubuntu 20.04+, Debian 11+, Fedora 35+, MacOS)
 - Python 3.9+
-- CMake 3.16+, g++ 9+ (for source builds only)
-- Intel or AMD CPU with RAPL support
-- `perf` (for `codegreen run` and benchmark validation)
+- Linux: kernel 5.0+, Intel/AMD CPU with RAPL support
+- macOS: Apple Silicon (M1-M5) or Intel, sudo for energy measurement
+- Source builds: CMake 3.16+, C++17 compiler
 
 ## Usage
 
@@ -80,7 +90,7 @@ JSON (default for `--json`), CSV, Markdown table, and text summary. The JSON out
 
 ## Language support
 
-Adding a new language requires only a JSON config file in `src/instrumentation/configs/` plus the tree-sitter grammar. No Python code changes needed.
+Adding a new language requires only a JSON config file in `codegreen/instrumentation/configs/` plus the tree-sitter grammar. No Python code changes needed.
 
 Currently supported: Python, C, C++, JavaScript, Java.
 
@@ -99,7 +109,7 @@ bash scripts/generate_comparison_artifacts.sh docs/benchmarks/
 
 ## Energy Flow Graph (EFG)
 
-CodeGreen includes an Energy Flow Graph module (`src/analysis/cfg/`) that builds energy-annotated control flow graphs from source code:
+CodeGreen includes an Energy Flow Graph module (`codegreen/analysis/cfg/`) that builds energy-annotated control flow graphs from source code:
 
 ```python
 from codegreen.analysis.cfg.builder import build_per_method_cfgs
@@ -114,7 +124,7 @@ Features: Ball & Larus branch heuristics, SCC-based hot path computation, three-
 
 ## Architecture
 
-- **C++ NEMB backend**: RAPL energy reading with sub-microsecond timestamping, configurable polling interval
+- **C++ NEMB backend**: platform-aware energy measurement (RAPL on Linux, IOReport on macOS), sub-microsecond timestamping, background polling with lock-free ring buffers
 - **Python instrumentation**: tree-sitter AST analysis, config-driven checkpoint insertion
 - **Energy Flow Graph**: CFG + energy annotation for path-dependent analysis
 - **Benchmark harness**: multi-suite support (benchmarksgame, PerfOpt), statistical analysis with t-distribution CI, IQR outlier detection, profiler comparison

{codegreen-0.2.1 → codegreen-0.3.0}/codegreen/__init__.py

@@ -5,7 +5,7 @@ A comprehensive energy measurement and code optimization tool for developers
 and researchers who need precise, fine-grained energy consumption analysis.
 """
 
-__version__ = "0.2.1"
+__version__ = "0.3.0"
 __author__ = "Saurabhsingh Rajput"
 __email__ = "saurabh@dal.ca"
 __description__ = "Energy-aware software development tool"