Development Overview

​

Development Environment

• Primary Language: Java (JDK 21+)
• Secondary Languages: C++, Sleigh, Python 3, Jython 2.7
• IDE: Eclipse (recommended) or Visual Studio Code
• Build System: Gradle 8.5+
• Source Control: Git

​

Architecture Overview

​

Framework Layer

• DB - Database management for programs and traces
• Docking - Window and UI docking framework
• Generic - Common utilities and base classes
• SoftwareModeling - Program model, language specifications, and p-code
• Project - Project and domain object management
• Emulation - P-code emulation engine

​

Feature Modules

• Base - Core features including analyzers, loaders, and plugins
• Decompiler - C decompiler engine
• Debugger - Dynamic analysis and debugging support
• BSim - Binary similarity analysis
• FunctionID - Function identification database

​

Extension Points

• Analyzers - Automatic program analysis
• Loaders - Binary file format support
• Plugins - UI components and services
• File Systems - Container file format support
• Exporters - Output format generation
• Language Modules - Processor architecture support via Sleigh

​

Development Workflow

​

Creating Extensions

1. GhidraDev Eclipse Plugin - Full Eclipse integration with debugging support
2. VSCode Integration - Lightweight script and module development
3. Standalone Gradle Projects - Independent module development

​

Project Types

​

Script Projects

• Compiled by Ghidra at runtime
• Executed via Script Manager or Headless Analyzer
• Stored in ~/ghidra_scripts by default

​

Module Projects

• Built as Gradle projects
• Exported as installable extensions
• Distributed as .zip archives

​

Building Ghidra

​

Quick Build

# Download dependencies
gradle -I gradle/support/fetchDependencies.gradle

# Setup development environment
gradle prepdev

# Build Ghidra distribution
gradle buildGhidra

​

Common Gradle Tasks

​

Eclipse Setup

# Generate Eclipse projects
gradle cleanEclipse eclipse

# Build natives
gradle buildNatives

1. File → Import → General → Existing Projects into Workspace
2. Select Ghidra source repository
3. Check “Search for nested projects”
4. Click Finish

​

Extension Development

​

Module Structure

MyExtension/
├── Module.manifest          # Module metadata
├── extension.properties     # Extension configuration
├── build.gradle            # Gradle build script
├── src/
│   └── main/
│       └── java/          # Java source files
├── data/                   # Resources and data files
└── lib/                    # External dependencies

​

Extension Properties

name=@extname@
description=Brief description of the extension
author=Your Name
createdOn=01/01/2024
version=@extversion@

​

Build Configuration

apply from: "$rootProject.projectDir/gradle/javaProject.gradle"
apply from: "$rootProject.projectDir/gradle/distributableGhidraModule.gradle"

apply plugin: 'eclipse'

eclipse.project.name = 'Extensions MyExtension'

dependencies {
    // Add dependencies here
}

​

Class Naming Conventions

​

Licensing

• Prefer Apache License 2.0 for new code
• GPL code must reside in top-level GPL/ directory
• Use Git commit authorship for credit (not source comments)
• Ensure Git credentials link to your GitHub account

​

Resources

• DevGuide.md - Complete developer’s guide
• GhidraClass - Training materials
• API Documentation - Javadoc reference
• Ghidra Repository - Source code

​

Next Steps