Thread info and process visualization (#10)

* added multithread functionality and better readability

* testing added, unit and e2e

* refactor

* e2e testing with multithread support

* visualization with bar added and perfected

* tests added

* moved the pre-commit script

* refactored the scripts folder to e2e testing

* refactoring done with more helpers

* thread state fixed

* updated README

Author: navidpadid

.devcontainer/devcontainer.json

@@ -13,7 +13,7 @@
     "source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/ubuntu/.ssh,type=bind,consistency=cached"
   ],
   "features": {},
-  "postCreateCommand": "bash -c 'echo \"Setting up development environment...\" && make --version && gcc --version && clang-format --version && echo \"Installing Git hooks...\" && mkdir -p .git/hooks && if [ -f scripts/pre-commit.sh ]; then cp scripts/pre-commit.sh .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit && echo \"✓ Git pre-commit hook installed\"; fi && echo \"✓ Dev environment ready!\"'",
+  "postCreateCommand": "bash -c 'echo \"Setting up development environment...\" && make --version && gcc --version && clang-format --version && echo \"Installing Git hooks...\" && mkdir -p .git/hooks && if [ -f .github/pre-commit.sh ]; then cp .github/pre-commit.sh .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit && echo \"✓ Git pre-commit hook installed\"; fi && echo \"✓ Dev environment ready!\"'",
   "customizations": {
     "vscode": {
       "extensions": [

scripts/pre-commit.sh .github/pre-commit.shscripts/pre-commit.sh renamed to .github/pre-commit.sh

@@ -49,7 +49,7 @@ core.*
 *.backup
 
 # QEMU testing environment
-scripts/qemu-env/
+e2e/qemu-env/
 *~
 
 # Static analysis output

.gitignore

@@ -39,6 +39,13 @@ user:
 	gcc -Wall -o $(BUILD_DIR)/$(USER_PROG) $(SRC_DIR)/$(USER_PROG).c
 	@echo "User program built successfully!"
 
+# Build multi-threaded test program (for E2E testing)
+test-multithread:
+	@echo "Building multi-threaded test program..."
+	@mkdir -p $(BUILD_DIR)
+	gcc -Wall -pthread -o $(BUILD_DIR)/test_multithread $(SRC_DIR)/test_multithread.c
+	@echo "Multi-threaded test program built successfully!"
+
 # Function-level unit tests (user-space)
 unit:
 	@echo "Building function-level unit tests..."
@@ -172,6 +179,7 @@ help:
 	@echo "  make all        - Build both kernel module and user program (default)"
 	@echo "  make module     - Build kernel module only"
 	@echo "  make user       - Build user program only"
+	@echo "  make test-multithread - Build multi-threaded test program"
 	@echo "  make unit       - Build and run function-level unit tests"
 	@echo "  make install    - Install kernel module (requires root)"
 	@echo "  make uninstall  - Remove kernel module (requires root)"

Makefile

@@ -4,17 +4,76 @@
 [![Last Commit](https://img.shields.io/github/last-commit/navidpadid/process-info-kernel-module?style=for-the-badge&logo=git&logoColor=white)](https://github.com/navidpadid/process-info-kernel-module/commits/main)
 [![License](https://img.shields.io/badge/License-Dual%20BSD%2FGPL-blue?style=for-the-badge)](LICENSE)
 
-> A Linux kernel module that extracts detailed process information including memory layout, CPU usage, and ELF sections via `/proc` filesystem.
+> A Linux kernel module that extracts detailed process and it's thread information including memory layout, CPU usage, and ELF sections via `/proc` filesystem.
 
 ## Features
 
 - **Process Memory Layout**: Code, Data, BSS, Heap, and Stack addresses
-- **CPU Usage Tracking**: Real-time CPU percentage calculation
+- **Visual Memory Map**: Proportional bar chart visualization of memory regions
+- **Thread Information**: List all threads with TID, state, CPU usage, priority, and CPU affinity
+- **CPU Usage Tracking**: Real-time CPU percentage calculation per process and thread
 - **ELF Section Analysis**: Binary base address and section boundaries
 - **Proc Interface**: Easy access through `/proc/elf_det/`
 - **Comprehensive Testing**: Unit tests and QEMU-based E2E testing
 - **Code Quality**: Pre-configured static analysis (sparse, cppcheck, checkpatch)
 
+### Example Output
+
+```
+>> Enter process ID (or Ctrl+C to exit): 3115
+
+================================================================================
+                          PROCESS INFORMATION                                   
+================================================================================
+Command line:   ./build/test_multithread 
+Process ID:      3115
+Name:            test_multithrea
+CPU Usage:       2.06%
+
+Memory Layout:
+--------------------------------------------------------------------------------
+  Code Section:    0x0000643f5b8f5000 - 0x0000643f5b8f5459
+  Data Section:    0x0000643f5b8f7d78 - 0x0000643f5b8f8010
+  BSS Section:     0x0000643f5b8f8010 - 0x0000643f87d3b000
+  Heap:            0x0000643f87d3b000 - 0x0000643f87d5c000
+  Stack:           0x00007ffcdf141220 - 0x00007ffcdf121000
+  ELF Base:        0x0000643f5b8f4000
+
+Memory Layout Visualization:
+--------------------------------------------------------------------------------
+Low:  0x0000643f5b8f5000
+
+CODE  (1 KB)
+      [=                                                 ]
+
+DATA  (664 B)
+      [=                                                 ]
+
+BSS   (708 MB)
+      [================================================= ]
+
+HEAP  (132 KB)
+      [=                                                 ]
+
+STACK (128 KB)
+      [=                                                 ]
+
+High: 0x00007ffcdf141220
+--------------------------------------------------------------------------------
+
+================================================================================
+                          THREAD INFORMATION                                    
+================================================================================
+TID    NAME             CPU(%)   STATE  PRIORITY  NICE  CPU_AFFINITY
+-----  ---------------  -------  -----  --------  ----  ----------------
+3115   test_multithrea     2.06   S         0         0  0,1
+3117   test_multithrea     0.32   S         0         0  0,1
+3118   test_multithrea     0.29   S         0         0  0,1
+3119   test_multithrea     0.26   S         0         0  0,1
+3120   test_multithrea     0.14   S         0         0  0,1
+--------------------------------------------------------------------------------
+```
+
 ## Quick Start
 
 ### Prerequisites
@@ -38,42 +97,35 @@
    ./build/proc_elf_ctrl
    ```
 
+### Uninstall the Module
+
+```bash
+sudo make uninstall
+```
+
 ## Project Structure
 
 ```
 kernel_module/
 ├── .devcontainer/      # Dev container config (Docker + VS Code setup)
 ├── .github/            # CI/CD workflows (GitHub Actions)
 ├── docs/               # Detailed documentation
-├── scripts/            # Testing scripts (QEMU setup, E2E testing automation)
+├── e2e/                # End-to-end testing scripts (QEMU setup, automation)
 ├── src/                # Source code (kernel module, user program, tests, helpers)
 ├── build/              # Build artifacts (generated by make)
 └── Makefile            # Build system with quality checks
 ```
 
-The program will prompt you to enter a process ID (PID). You can find PIDs using:
+**Notes**: 
+- **Memory Visualization**: Each region's bar length is proportional to its actual size
+- Sizes are automatically displayed in appropriate units (B, KB, or MB)
+- Low/High addresses show the memory address range of the process
+- BSS_START and BSS_END may be equal (zero-length BSS) in modern ELF binaries. This is normal.
+- Thread STATE: R=Running, S=Sleeping, D=Uninterruptible, T=Stopped, t=Traced, Z=Zombie, X=Dead
+- PRIORITY: Shown as nice value (-20 to 19, where lower is higher priority)
+- CPU_AFFINITY: Shows which CPUs the thread can run on
 
-```bash
-ps aux | grep <process_name>
-```
 
-### 3. Example Output
-
-```
-************enter the process id: 1234
-
-the process info is here:
-PID     NAME    CPU(%)  START_CODE      END_CODE        START_DATA      END_DATA        BSS_START       BSS_END         HEAP_START      HEAP_END        STACK_START     STACK_END       ELF_BASE
-01234   bash    0.50    0x0000563a1234  0x0000563a5678  0x0000563a9abc  0x0000563adef0  0x0000563adef0  0x0000563adef0  0x0000563b0000  0x0000563b8000  0x00007ffd12345000  0x00007ffd12340000  0x0000563a1000
-```
-
-**Note**: BSS_START and BSS_END may be equal (zero-length BSS) in modern ELF binaries. This is normal.
-
-### 4. Uninstall the Module
-
-```bash
-sudo make uninstall
-```
 
 ## Safe Testing with QEMU
 
@@ -83,28 +135,36 @@ For maximum safety, test the kernel module in an isolated QEMU virtual machine t
 
 ```bash
 # One-time setup
-./scripts/qemu-setup.sh
+./e2e/qemu-setup.sh
 
 # Start VM
-./scripts/qemu-run.sh
+./e2e/qemu-run.sh
 
 # In another terminal, run automated tests
-./scripts/qemu-test.sh
+./e2e/qemu-test.sh
 ```
 
 
 ## Makefile Targets
 
 ```bash
-make all            # Build kernel module and user program
-make install        # Install kernel module (requires root)
-make uninstall      # Remove kernel module
-make unit           # Run unit tests (no kernel required)
-make test           # Install module and run user program
-
-make format         # Format all source files
-make check          # Run all static analysis
-make clean          # Remove build artifacts
+make all              # Build kernel module and user program
+make module           # Build kernel module only
+make user             # Build user program only
+make test-multithread # Build multi-threaded test program
+make install          # Install kernel module (requires root)
+make uninstall        # Remove kernel module
+make unit             # Run unit tests (no kernel required)
+make test             # Install module and run user program
+
+make format           # Format all source files
+make format-check     # Check formatting (CI-friendly)
+make check            # Run all static analysis
+make checkpatch        # Check kernel coding style
+make sparse           # Run sparse static analyzer
+make cppcheck         # Run cppcheck static analyzer
+make clean            # Remove build artifacts
+make help             # Show help message
 ```
 
 ## Testing
@@ -117,9 +177,9 @@ Runs pure function tests without kernel dependencies.
 
 ### QEMU Testing (Safe Kernel Testing)
 ```bash
-./scripts/qemu-setup.sh    # One-time setup
-./scripts/qemu-run.sh      # Start VM
-./scripts/qemu-test.sh     # Run automated tests
+./e2e/qemu-setup.sh    # One-time setup
+./e2e/qemu-run.sh      # Start VM
+./e2e/qemu-test.sh     # Run automated tests
 ```
 
 See [docs/TESTING.md](docs/TESTING.md) for detailed testing documentation.

README.md

@@ -6,13 +6,13 @@ Scripts for testing the Linux Process Information Kernel Module in isolated QEMU
 
 ```bash
 # QEMU Testing
-./scripts/qemu-setup.sh      # One-time setup
-./scripts/qemu-run.sh         # Start VM
-./scripts/qemu-test.sh        # Automated tests (run from host in another terminal)
+./e2e/qemu-setup.sh      # One-time setup
+./e2e/qemu-run.sh         # Start VM
+./e2e/qemu-test.sh        # Automated tests (run from host in another terminal)
 
 # Other utilities
-./scripts/pre-commit.sh       # Pre-commit hook (auto-installed in dev container)
-./scripts/quick-reference.sh  # Display quick reference guide
+./.github/pre-commit.sh       # Pre-commit hook (auto-installed in dev container)
+./e2e/quick-reference.sh      # Display quick reference guide
 ```
 
 ## Script Descriptions
@@ -69,15 +69,15 @@ Scripts for testing the Linux Process Information Kernel Module in isolated QEMU
 **Usage**:
 ```bash
 # Start VM in one terminal
-./scripts/qemu-run.sh
+./e2e/qemu-run.sh
 
 # Run tests from another terminal
-./scripts/qemu-test.sh
+./e2e/qemu-test.sh
 ```
 
 **Output**: Shows build process, module loading, test results, and kernel logs.
 
-### `pre-commit.sh`
+### `.github/pre-commit.sh`
 **Purpose**: Git pre-commit hook for code quality
 
 **What it does**:
@@ -105,7 +105,7 @@ git commit --no-verify -m "message"
 
 **Usage**:
 ```bash
-./scripts/quick-reference.sh
+./e2e/quick-reference.sh
 ```
 
 ## QEMU VM Details
@@ -160,13 +160,13 @@ rsync -avz --exclude='.git' --exclude='build' \
 
 ### Remove QEMU Environment
 ```bash
-rm -rf scripts/qemu-env/
+rm -rf e2e/qemu-env/
 ```
 
 ### Reinstall Fresh VM
 ```bash
-rm -rf scripts/qemu-env/
-./scripts/qemu-setup.sh
+rm -rf e2e/qemu-env/
+./e2e/qemu-setup.sh
 ```
 
 ### Check VM Status

docs/SCRIPTS.md

@@ -5,10 +5,12 @@
 The kernel module creates entries in `/proc/elf_det/`:
 - `/proc/elf_det/pid` - Write-only file to specify target PID
 - `/proc/elf_det/det` - Read-only file to retrieve process information
+- `/proc/elf_det/threads` - Read-only file to retrieve thread information
 
 ### Key Functions
 
 - `elfdet_show()` - Main function to gather and format process information
+- `elfdet_threads_show()` - Gathers thread information for all threads in a process
 - `find_stack_vma_end()` - Finds stack VMA lower boundary by iterating VMAs
 - `procfile_write()` - Handles PID input from user space
 - `procfile_read()` - Returns formatted process data
@@ -58,13 +60,13 @@ Simple C program that supports two modes:
 ```bash
 ./build/proc_elf_ctrl
 ```
-Prompts for a PID, writes to `/proc/elf_det/pid`, then reads `/proc/elf_det/det` and prints output.
+Prompts for a PID, writes to `/proc/elf_det/pid`, then reads `/proc/elf_det/det` and `/proc/elf_det/threads` and prints output.
 
 ### Argument Mode
 ```bash
 ./build/proc_elf_ctrl <PID>
 ```
-Non-interactive mode - write PID and print exactly two lines.
+Non-interactive mode - write PID and print both process and thread information.
 
 ### Environment Override
 
@@ -78,21 +80,22 @@ Internally, path construction is handled via `build_proc_path()`.
 
 ## Helper Libraries
 
-### `src/elf_helpers.h`
-Pure functions for CPU usage, BSS range, heap range, and address range checking:
+### `src/elf_det.h`
+Pure functions for CPU usage, BSS range, heap range, thread state, and address range checking:
 - `compute_usage_permyriad()` - CPU usage calculation
 - `compute_bss_range()` - BSS boundary validation
 - `compute_heap_range()` - Heap boundary validation
 - `is_address_in_range()` - Address containment check
 
 Works in both kernel and user space contexts.
 
-### `src/user_helpers.h`
+### `src/proc_elf_ctrl.h`
 Path building with environment override:
 - `build_proc_path()` - Constructs `/proc/elf_det/` paths with `ELF_DET_PROC_DIR` support
 
 ## Output Format
 
+### Process Information (`/proc/elf_det/det`)
 ```
 PID     NAME    CPU(%)  START_CODE      END_CODE        START_DATA      END_DATA        
 BSS_START       BSS_END         HEAP_START      HEAP_END        STACK_START     
@@ -106,4 +109,35 @@ Example:
 0x0000563b8000  0x00007ffd12345000  0x00007ffd12340000  0x0000563a1000
 ```
 
+### Thread Information (`/proc/elf_det/threads`)
+```
+TID     NAME    CPU(%)  STATE   PRIORITY        NICE    CPU_AFF
+```
+
+Example:
+```
+01234   bash    0.50    S       0       0       0,1,2,3
+01235   worker  0.01    R       0       0       0,1
+
+Total threads: 2
+```
+
+#### Thread State Codes
+- **R** - Running or runnable (on run queue)
+- **S** - Interruptible sleep (waiting for an event)
+- **D** - Uninterruptible sleep (usually I/O)
+- **T** - Stopped (by job control signal)
+- **t** - Tracing stop (by debugger)
+- **Z** - Zombie (terminated but not reaped)
+- **X** - Dead (should never be seen)
+
+#### Thread Fields
+- **TID** - Thread ID (same as PID for main thread)
+- **NAME** - Thread name (typically same as process name)
+- **CPU(%)** - Per-thread CPU usage since thread start
+- **STATE** - Current thread state (see codes above)
+- **PRIORITY** - Shown as nice value (-20 to 19, lower = higher priority)
+- **NICE** - Nice value for the thread
+- **CPU_AFF** - CPU affinity mask (which CPUs thread can run on)
+
 **Note**: BSS_START and BSS_END may be equal (zero-length BSS) in modern ELF binaries. This is normal.