codegreen 0.2.2__tar.gz → 0.3.1__tar.gz

codegreen-0.3.1/CMakeLists.txt

@@ -0,0 +1,113 @@
+cmake_minimum_required(VERSION 3.16)
+project(CodeGreen VERSION 0.3.0 LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+if(NOT CMAKE_BUILD_TYPE)
+    set(CMAKE_BUILD_TYPE Release)
+endif()
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+
+find_package(PkgConfig)
+find_package(Threads REQUIRED)
+
+# Optional GPU library detection
+find_library(NVML_LIBRARY nvidia-ml PATHS /usr/local/cuda/lib64 /usr/lib/x86_64-linux-gnu)
+find_path(NVML_INCLUDE_DIR nvml.h PATHS /usr/local/cuda/include /usr/include/nvidia/gdk)
+find_library(ROCM_SMI_LIBRARY rocm_smi64 PATHS /opt/rocm/lib)
+find_path(ROCM_SMI_INCLUDE_DIR rocm_smi.h PATHS /opt/rocm/include/rocm_smi)
+
+if(NVML_LIBRARY AND NVML_INCLUDE_DIR)
+    message(STATUS "NVML found: ${NVML_LIBRARY}")
+    set(HAVE_NVML ON)
+else()
+    set(HAVE_NVML OFF)
+endif()
+
+if(ROCM_SMI_LIBRARY AND ROCM_SMI_INCLUDE_DIR)
+    message(STATUS "ROCm SMI found: ${ROCM_SMI_LIBRARY}")
+    set(HAVE_ROCM_SMI ON)
+else()
+    set(HAVE_ROCM_SMI OFF)
+endif()
+
+# Global include directories
+include_directories(${CMAKE_SOURCE_DIR}/codegreen/measurement/include)
+
+# Tree-sitter (for C++ instrumentation runtime, if submodules present)
+if(EXISTS "${CMAKE_SOURCE_DIR}/third_party/tree-sitter/lib/CMakeLists.txt")
+    include_directories(${CMAKE_SOURCE_DIR}/third_party/tree-sitter/lib/include)
+    add_subdirectory(third_party/tree-sitter/lib)
+    if(EXISTS "${CMAKE_SOURCE_DIR}/third_party/tree-sitter-python/CMakeLists.txt")
+        add_subdirectory(third_party/tree-sitter-python EXCLUDE_FROM_ALL)
+    endif()
+endif()
+
+# NEMB -- the only native component
+add_subdirectory(codegreen/measurement)
+
+# Sync instrumentation files to build dir (for C/C++/Java runtime headers)
+file(MAKE_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/runtime)
+file(MAKE_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/python/instrumentation)
+
+add_custom_target(sync_instrumentation
+    COMMAND ${CMAKE_COMMAND} -E copy
+        ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_runtimes/python/codegreen_runtime.py
+        ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/runtime/codegreen_runtime.py
+    COMMAND ${CMAKE_COMMAND} -E copy_directory
+        ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_runtimes
+        ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/python/instrumentation/language_runtimes
+    COMMAND ${CMAKE_COMMAND} -E copy_directory
+        ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/configs
+        ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/python/instrumentation/configs
+    COMMENT "Syncing instrumentation files to build directory"
+)
+
+add_dependencies(codegreen-nemb sync_instrumentation)
+
+# Copy config to build dir
+if(EXISTS "${CMAKE_SOURCE_DIR}/config/codegreen.json")
+    file(MAKE_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/config)
+    configure_file(
+        ${CMAKE_SOURCE_DIR}/config/codegreen.json
+        ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/config/codegreen.json
+        COPYONLY
+    )
+endif()
+
+# Dev-install: copy NEMB library to project root for pip editable installs
+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${CMAKE_SHARED_LIBRARY_SUFFIX}
+        ${CMAKE_SOURCE_DIR}/lib/
+    COMMENT "Dev-install: copying NEMB to ${CMAKE_SOURCE_DIR}/lib/"
+)
+
+# Install
+install(TARGETS codegreen-nemb
+    LIBRARY DESTINATION lib
+    ARCHIVE DESTINATION lib
+    RUNTIME DESTINATION bin
+)
+
+install(FILES
+    ${CMAKE_SOURCE_DIR}/codegreen/instrumentation/language_runtimes/python/codegreen_runtime.py
+    DESTINATION bin/runtime
+)
+
+if(EXISTS "${CMAKE_SOURCE_DIR}/config/codegreen.json")
+    install(FILES ${CMAKE_SOURCE_DIR}/config/codegreen.json
+        DESTINATION bin/config
+    )
+endif()
+
+set(CPACK_PACKAGE_NAME "CodeGreen")
+set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Energy-aware software development tool")
+include(CPack)

{codegreen-0.2.2/codegreen.egg-info → codegreen-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codegreen
-Version: 0.2.2
+Version: 0.3.1
 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,8 @@ 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: Operating System :: Microsoft :: Windows :: Windows 11
 Classifier: Environment :: Console
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
@@ -447,7 +449,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 +458,33 @@ 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) | Pre-built wheel | Full (PKG, core, iGPU, DRAM) | RAPL via NEMB |
+| Linux x86_64 (AMD) | Pre-built wheel | Full (PKG, no DRAM counter) | RAPL via NEMB |
+| macOS ARM64 (Apple Silicon) | Pre-built wheel | Full (CPU, GPU, ANE, DRAM) | IOReport + kpc via NEMB |
+| macOS Intel | From source | Full | IOReport via NEMB |
+| Windows 11 (Intel) | From source | Full (PKG, core, iGPU, DRAM) | EMI via intelpep.sys |
+| Windows 11 (AMD) | From source | Unverified | EMI may not expose AMD RAPL |
+| NVIDIA GPU (any OS) | Automatic | Full (cumulative mJ) | NVML |
+| 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
+- Windows 11: Intel/AMD CPU (EMI via inbox intelpep.sys driver, zero install)
+- Source builds: CMake 3.16+, C++17 compiler
 
 ## Usage
 
@@ -510,7 +527,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 +546,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 +561,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, EMI on Windows), 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.2 → codegreen-0.3.1}/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,33 @@ 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) | Pre-built wheel | Full (PKG, core, iGPU, DRAM) | RAPL via NEMB |
+| Linux x86_64 (AMD) | Pre-built wheel | Full (PKG, no DRAM counter) | RAPL via NEMB |
+| macOS ARM64 (Apple Silicon) | Pre-built wheel | Full (CPU, GPU, ANE, DRAM) | IOReport + kpc via NEMB |
+| macOS Intel | From source | Full | IOReport via NEMB |
+| Windows 11 (Intel) | From source | Full (PKG, core, iGPU, DRAM) | EMI via intelpep.sys |
+| Windows 11 (AMD) | From source | Unverified | EMI may not expose AMD RAPL |
+| NVIDIA GPU (any OS) | Automatic | Full (cumulative mJ) | NVML |
+| 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
+- Windows 11: Intel/AMD CPU (EMI via inbox intelpep.sys driver, zero install)
+- Source builds: CMake 3.16+, C++17 compiler
 
 ## Usage
 
@@ -80,7 +95,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 +114,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 +129,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, EMI on Windows), 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.2 → codegreen-0.3.1}/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.2"
+__version__ = "0.3.1"
 __author__ = "Saurabhsingh Rajput"
 __email__ = "saurabh@dal.ca"
 __description__ = "Energy-aware software development tool"