Pacemaker 2.0 API Changes

Updated 386 Days AgoPublic

Actions

This page describes backward-incompatible changes in Pacemaker's public C API made between the Pacemaker 1.x and 2.0 release series.

For most of these, the old symbols can be used by including <crm/compatibility.h>. However, that should be used only to allow a gradual transition to using the newer names. The old symbols will be removed from compatibility.h at the next major version (3.0).

The C API headers are now compatible with being used in C++ programs.

All applications linking against the Pacemaker libraries will need to be recompiled. Some may need code changes, but these should be minimal.

Removed with no replacement

These relate to things for which support was removed entirely, such as the heartbeat and corosync 1 cluster stacks. Any code using these should simply be removed.

Simple search-and-replace changes

Changes in function interfaces

• libcrmcommon
  • The write_xml_fd() and write_xml_file() functions now consistently return -errno on error, and the number of bytes written (whether compressed or uncompressed) on success.
  • guin is now consistently used as the type for representing a milliseconds interval. The return value of crm_parse_interval_spec() (formerly crm_get_interval()) and the interval arguments of crm_action_str(), generate_op_key(), parse_op_key(), resources_action_create(), services_action_create()>, services_action_cancel(), services_action_kick(), and the lrmd_api_operations_t exec() and cancel() members now use guint instead of int or unsigned long long.
• libcrmcluster
  • The first argument of send_cluster_text() is now enum crm_ais_msg_class rather than int (no change in usage)

Changes in structs

• crm_client_t: event_queue member is now a GQueue* instead of GList*
• crm_node_t: int votes member is now time_t when_lost
• lrmd_event_data_t, svc_action_t, and crm_action_t: int interval member is now guint interval_ms
• pe_resource_t: int remote_reconnect_interval member (in seconds) is now guint remote_reconnect_ms (in milliseconds)
• stonith_history_t: completed member is now time_t instead of int

Exit status codes

Pacemaker daemons and command-line tools now return a well-defined set of exit status codes at the end of execution. These are defined via the crm_exit_t type (an enumeration) in crm/crm.h, with all values beginning with CRM_EX_. Related new API functions:

• crm_errno2exit() maps a function return value to a similar exit code
• crm_exit_name() returns a string representation of the CRM_EX_ constant name
• crm_exit_str() returns a human-readable string describing the exit condition

The existing API functions crm_exit() and crm_help() now have arguments and/or return values of crm_exit_t, but are backward-compatible.

New deprecations

The following are deprecated in 2.0.0. They are still available in the usual headers, but will be moved to compatibility.h in a future release.