Functional Specification

• Data Structures
• Interfaces
• Constructors and Destructors
• Accessors and Invariants
• Operational Interfaces
• Recipes

Functional Specification

Data Structures

• The m0_cm represents a copy machine replica.
• The m0_cm_ops provides copy machine specific routines for
  • Starting a copy machine.
  • Handling a copy machine specific operation.
  • Handling copy machine operation completion.
  • Aborting a copy machine operation.
  • Handling a copy machine failure.
  • Stopping a copy machine.
• The m0_cm_type represents a copy machine type that a copy machine is an instance of.

Interfaces

Every copy machine type implements its own set of routines for type-specific operations, although there may exist few operations common to all the copy machine types.

Constructors and Destructors

This section describes the sub-routines which act as constructors and destructors for various copy machine related data structures.

• m0_cm_init() Initialises a copy machine.
• m0_cm_fini() Finalises a copy machine.
• m0_cm_type_register() Registers a new copy machine type.
• m0_cm_type_deregister() Deregisters a new copy machine type.
• M0_CM_TYPE_DECLARE() Declares a copy machine type.

Accessors and Invariants

The invariants would be implemented in source files.

Operational Interfaces

Lists the various external interfaces exported by the copy machine.

• m0_cm_setup() Setup a copy machine.
• m0_cm_prepare() Initialises local sliding window.
• m0_cm_ready() Synchronizes copy machine with remote replicas.
• m0_cm_start() Starts copy machine operation.
• m0_cm_fail() Handles a copy machine failure.
• m0_cm_stop() Completes and aborts a copy machine operation.

External operational Interfaces

Todo:

This would be re-written when configuration api's would be implemented.

• m0_confc_open() Opens an individual confc object. processing.

Recipes

Todo:

This section would be re-written when the other copy machine functionalities would be implemented.