Warning: This document is for the development version of Bareos Documentation. The main version is bareos-21.

Developer Guide

• Bareos Developer Notes
  • History
  • Contributions
  • Patches
    • Commit message guideline
  • Bug Database
    • Reporting security issues
  • Developing Bareos
    • Building the testenvironment
    • Building the documentation
    • Memory Leaks
    • Guiding Principles
    • Formatting Standards
    • Do’s
    • Don’ts
• Message Classes
  • Memory Messages
  • Debug Messages
  • Job Messages
    • Special Cases
  • Queued Job Messages
  • Error Messages
• Bareos FD Plugin API
  • Normal vs Command vs Options Plugins
  • Loading Plugins
  • loadPlugin
  • Plugin Entry Points
    • newPlugin(bpContext *ctx)
    • freePlugin(bpContext *ctx)
    • getPluginValue(bpContext *ctx, pVariable var, void *value)
    • setPluginValue(bpContext *ctx, pVariable var, void *value)
    • handlePluginEvent(bpContext *ctx, bEvent *event, void *value)
    • startBackupFile(bpContext *ctx, struct save_pkt *sp)
    • endBackupFile(bpContext *ctx)
    • startRestoreFile(bpContext *ctx, const char *cmd)
    • createFile(bpContext *ctx, struct restore_pkt *rp)
    • setFileAttributes(bpContext *ctx, struct restore_pkt *rp)
    • endRestoreFile(bpContext *ctx)
    • pluginIO(bpContext *ctx, struct io_pkt *io)
    • bool checkFile(bpContext *ctx, char *fname)
  • Bareos Plugin Entrypoints
    • bRC registerBareosEvents(bpContext *ctx, …)
    • bRC getBareosValue(bpContext *ctx, bVariable var, void *value)
    • bRC setBareosValue(bpContext *ctx, bVariable var, void *value)
    • bRC JobMessage(bpContext *ctx, const char *file, int line, int type, utime_t mtime, const char *fmt, …)
    • bRC DebugMessage(bpContext *ctx, const char *file, int line, int level, const char *fmt, …)
    • void bareosMalloc(bpContext *ctx, const char *file, int line, size_t size)
    • void bareosFree(bpContext *ctx, const char *file, int line, void *mem)
  • Building Bareos Plugins
• Platform Support
  • General
  • Requirements to become a Supported Platform
• Daemon Protocol
  • General
  • Low Level Network Protocol
  • General Daemon Protocol
  • The Protocol Used Between the Director and the Storage Daemon
  • The Protocol Used Between the Director and the File Daemon
  • The Save Protocol Between the File Daemon and the Storage Daemon
    • Command and Control Information
    • Data Information
• File Services Daemon
  • Commands Received from the Director for a Backup
  • Commands Received from the Director for a Restore
• Storage Daemon Design
  • SD Design Introduction
  • SD Development Outline
  • SD Connections and Sessions
    • SD Append Requests
    • SD Read Requests
  • SD Data Structures
• Catalog Services
  • General
    • Filenames and Maximum Filename Length
    • Database Table Design
  • Sequence of Creation of Records for a Save Job
  • Database Tables
    • Filename
    • Path
    • File
    • Job / JobHisto
    • FileSet
    • JobMedia
      • Tape Volume
      • Other Volume
    • Volume (Media)
    • Pool
    • Client
    • Storage
    • Counter
    • Log
    • Location
    • LocationLog
    • Version
    • BaseFiles
• Storage Media Output Format
  • General
  • Definitions
  • Overall Format
    • Storage Daemon File Output Format
  • Serialization
  • Block Header
  • Record Header
  • Volume Label Format
  • Session Label
  • Overall Storage Format
  • Examine Volumes
    • bls command
  • Unix File Attributes
  • Old Deprecated Tape Format
• Bareos Porting Notes
  • Porting Requirements
  • Steps to Take for Porting
• API
  • General
    • Minimal Code in Console Program
    • GUI Interface is Difficult
  • dot commands
  • API Modes
    • API mode 0 (off)
    • API mode 1 (on)
    • API mode 2 (json)
      • Examples
        • Example of a JSON-RPC Error Response
  • Bvfs API
    • General notes
    • Get dependent jobs from a given JobId
    • Generating Bvfs cache
    • List directories
    • List files
      • API mode 0
      • API mode 1
      • API mode 2
    • Get all versions of a specific file
    • Restore set of files
    • Cleanup after Restore
    • Clearing the BVFS Cache
    • Example for directory browsing using bvfs
• TLS
  • Introduction
  • TLS Handshake before Bareos 18.2
  • TLS Configuration Implementation
  • TLS API Implementation
• PAM
• Bareos Regression Testing
  • Setting up Regession Testing
  • Running the Regression Script
    • Setting the Configuration Parameters
    • Building the Test Bareos
    • Setting up your SQL engine
    • Running the Disk Only Regression
    • Other Tests
    • If a Test Fails
  • Testing a Binary Installation
  • Running a Single Test
  • Writing a Regression Test
    • Running the Tests by Hand
    • Directory Structure
    • Adding a New Test
    • Running a Test Under The Debugger
• Bareos Memory Management
  • General
    • Statically Allocated Memory
    • Dynamically Allocated Memory
    • Pooled and Non-pooled Memory
      • Types of Memory Pool:
      • Getting Memory:
      • Releasing Memory:
      • Determining the Memory Size:
      • Resizing Pool Memory:
      • Automatic Size Adjustment:
      • Releasing All Pooled Memory:
      • Pooled Memory Statistics:
• TCP/IP Network Protocol
  • General
  • bnet and Threads
  • bnet_open
  • bnet_send
  • bnet_fsend
  • is_bnet_error
  • is_bnet_stop
  • bnet_recv
  • bnet_sig
  • bnet_strerror
  • bnet_close
  • Becoming a Server
  • Higher Level Conventions
  • Network startup activity
• Director Console Output
  • object_key_value
  • decoration
  • messages
  • Objects and Arrays
    • named objects
    • nameless objects
    • arrays
  • Example
  • Example with 3 level structure
• Smart Memory Allocation
  • Installing SMARTALLOC
  • Squelching a SMARTALLOC
  • Living with Libraries
  • SMARTALLOC Details
  • When SMARTALLOC is Disabled
  • The alloc() Function
  • Overlays and Underhandedness
  • Test and Demonstration Program
  • Invitation to the Hack
• Reservation
  • Introduction
    • Diagram Conventions
    • UseDeviceCmd
    • ReserveDevice
• Job Execution
  • Introduction
  • Job setup and start
  • Simple backup job
    • Overview simple backup job
    • Detailed View simple backup job
  • Local copy or migrate job
    • Overview local copy job
    • Detailed View local copy job
  • Remote copy or migrate job
    • Overview remote copy job
    • Detailed View remote copy job