Pacemaker Development

Working with the Pacemaker Code Base

Abstract

This document has guidelines and tips for developers interested in editing Pacemaker source code and submitting changes for inclusion in the project. Start with the FAQ; the rest is optional detail.

Table of Contents

• 1. Frequently Asked Questions
• 2. General Guidelines for All Languages
  • 2.1. Copyright
• 3. Python Coding Guidelines
  • 3.1. Python Boilerplate
  • 3.2. Python Version Compatibility
  • 3.3. Formatting Python Code
• 4. C Coding Guidelines
  • 4.1. Code Organization
  • 4.2. Pacemaker Libraries
    • 4.2.1. Public versus Internal APIs
    • 4.2.2. API Symbol Naming
    • 4.2.3. API Header File Naming
    • 4.2.4. API Documentation
    • 4.2.5. Public API Deprecation
  • 4.3. C Boilerplate
  • 4.4. Line Formatting
  • 4.5. Comments
  • 4.6. Operators
  • 4.7. Control Statements (if, else, while, for, switch)
  • 4.8. Macros
  • 4.9. Memory Management
  • 4.10. Structures
  • 4.11. Variables
    • 4.11.1. Pointers
    • 4.11.2. Globals
    • 4.11.3. Variable Naming
    • 4.11.4. Booleans
  • 4.12. String Handling
    • 4.12.1. Define Constants for Magic Strings
    • 4.12.2. String-Related Library Functions
    • 4.12.3. char*, gchar*, and GString
    • 4.12.4. Regular Expressions
  • 4.13. Enumerations
    • 4.13.1. Flag groups
  • 4.14. Functions
    • 4.14.1. Function Naming
    • 4.14.2. Function Definitions
    • 4.14.3. Return Values
    • 4.14.4. Public API Functions
  • 4.15. Logging and Output
    • 4.15.1. Logging Vs. Output
    • 4.15.2. Common Guidelines for All Messages
    • 4.15.3. Logging
    • 4.15.4. Output
  • 4.16. Makefiles
  • 4.17. vim Settings
• 5. Coding Particular Pacemaker Components
  • 5.1. Controller
    • 5.1.1. Join sequence
  • 5.2. Fencer
    • 5.2.1. Initiating a fencing request
    • 5.2.2. Fencing queries
    • 5.2.3. Fencing operations
    • 5.2.4. Fencing replies
    • 5.2.5. Fencing History
  • 5.3. Scheduler
    • 5.3.1. Challenges
    • 5.3.2. Cluster Working Set
    • 5.3.3. Resources
    • 5.3.4. Nodes
    • 5.3.5. Actions
    • 5.3.6. Colocations
    • 5.3.7. Orderings
• 6. C Development Helpers
  • 6.1. Refactoring
  • 6.2. Sanitizers
  • 6.3. Unit Testing
    • 6.3.1. Organization
    • 6.3.2. Adding a test
    • 6.3.3. Writing the test
    • 6.3.4. Assertions
    • 6.3.5. Running
  • 6.4. Code Coverage
  • 6.5. Debugging
    • 6.5.1. gdb
• 7. Evolution of the project
  • 7.1. Origin in Heartbeat project
    • 7.1.1. Influence of Heartbeat on Pacemaker
  • 7.2. Notable Restructuring Steps in the Codebase

Index

• Index
• Search Page