F Oracle Clusterware C Application Program Interfaces

About the Programming Interface (C API) to Oracle Clusterware

This section contains information about using the programming interface (C API) to Oracle Clusterware (CLSCRS.

• Overview

• Operational Notes

• Deprecated CLSCRS APIs

Overview

CLSCRS is a set of C-based APIs for Oracle Clusterware. The CLSCRS APIs enable you to manage the operation of entities that are managed by Oracle Clusterware. These entities include resources, resource types, servers, and server pools. You use the APIs to register user applications with Oracle Clusterware so that the clusterware can manage them and maintain high availability. Once an application is registered, you can manage it and query the application's status. If you no longer need the application, then you can stop it and unregister it from Oracle Clusterware.

Oracle Clusterware services are provided by Cluster Ready Services that runs as part of Oracle Clusterware. The CLSCRS API uses a context that is explicitly named in all function calls. The API does not store anything at the process or thread level. You can use the callbacks for diagnostic logging.

Operational Notes

This section includes the following topics:

• Context Initialization and Persistence

• Threading Support

• CLSCRS API Data Structures

• Memory Management

• Error Handling and Tracing

• Callback Mechanism

• Filters

• Script Agent Usage

• Help Interface

Context Initialization and Persistence

To use the CLSCRS APIs, you must first initialize the clscrs context. The calls to create and terminate this context are:

• clscrs_init_crs: Initializes the clscrs context

• clscrs_term_crs: Terminates the clscrs context

The caller is responsible for terminating the context when it is no longer needed.

Threading Support

None of the CLSCRS APIs spawn threads. Every CLSCRS API function executes in the context of the calling thread. APIs are not reentrant and no thread-affinity on the part of the client is required.

CLSCRS API Data Structures

The following entities are passed into the API calls and contain return values from the API call:

• clscrs_sp: A stringpair (sp) contains a name and a value string. The value can be NULL. It is created and destroyed, and its contents can be examined and the value replaced. A stringpair can be a member of exactly one stringpair list (splist).

• clscrs_splist: A stringpair list (splist) is a list of zero or more stringpairs used in various contexts. An API can add stringpairs to or remove them from a stringpair list, or the API can iterate stringpairs.

• clscrs_res: A resource instance (res) represents an Oracle Clusterware entity, which contains the name and additional data appropriate to the context in which the Oracle Clusterware entity is used. Sometimes a resource instance contains Oracle Clusterware entity attribute data and other times it carries status and return messages about an operation. A single resource instance can be a member of exactly one clscrs_reslist.

• clscrs_reslist: A resource list (reslist) is a data structure that contains zero or more instances of clscrs_res. An API can add resources to or remove them from a resource list, or the API can iterate resources.

Memory Management

The CLSCRS APIs work on elements and lists. The elements are added to lists. The memory for both elements and lists is allocated and released through explicit API calls. It is the caller's responsibility to release the memory that they allocate. However, when elements are added to lists, only the list must be destroyed: the destruction of the list destroys its elements implicitly. The elements must be destroyed when they are not added to any list. For recursive lists, destroying the parent list also destroys any lists contained within it. The clscrs_sp and clscrs_res elements must be destroyed by the caller. If they are part of a clscrs_splist or clscrs_reslist, destroying the list destroys the respective clscrs_sp and clscrs_res entities.

For example, when a resource is created and added to a resource list, only the resource list must be destroyed, but not the individual resource. Destroying the resource list releases the memory for the individual resource, too.

Memory is allocated by the API through the following calls:

clscrs_sp_create()
clscrs_res_create()
clscrs_serverpool_create()
clscrs_type_create()
clscrs_splist_create()
clscrs_reslist_create()
clscrs_entity_id_create()

Each of the calls in the preceding list has a corresponding clscrs_*_destroy() call.

Error Handling and Tracing

Interactive and non-interactive CLSCRS APIs each use a different error-handling mechanism.

For non-interactive CLSCRS APIs, the error code is returned as the return value of the function call. For example:

clscrsret clscrs_sp_get_value(clscrs_sp *sp, oratext **value);

The error code is returned as a clscrsret value.

For interactive CLSCRS APIs, the output result is represented, as follows:

1. The return value of the function call provides a high-level output of the request. Did the request reach the server? Was it completely successful, or completely or only partially unsuccessful? A successful return value means the request was received, processed, and the outcome was successful for all entities requested.

2. For each entity on which the request operated, there is a programmatic completion code stored in the op_status list. If the value is not success, it indicates the high-level type of the problem specific to processing the request for the particular object.

3. Optionally, the API might indicate that it wants to receive localized, human-readable error, warning, or status messages by using the callback mechanism. Each invocation of the callback provides the message, message type (severity), and the ID of the object to which the callback invocation pertains.

For example:

CLSCRS_STAT clscrs_register_resource2(clscrs_reslist *in_reslist, uword flags,
                                       clscrs_msgf2 msgf, void *msgarg,
                                       clscrs_reslist *op_status);

1. The function returns an error code of value CLSCRS_STAT.

2. The crsd sends error messages, warning messages, and progress messages back to the client through the clscrs_msgf2 callback. The client must implement the callback to process these messages returned by the crsd.

3. In previous Oracle Clusterware releases, the API also contained results of each operation on the Oracle Clusterware entities as part of the op_status list. You can access that information using the following API:

   clscrsret clscrs_res_get_op_status(clscrs_res *res, CLSCRS_STAT *status,
                                       oratext **msg);
   

   The status argument contains a status code about the crsd operation on the Oracle Clusterware entity. Additionally, the msg argument contains a message from the crsd about the result of the operation. Though the op_status list continues to contain the results of the crsd operation for each Oracle Clusterware entity in the msg argument, usage of the msg argument to get the error codes and messages has now been deprecated and is not supported for any use of the API on a new entity. Only pre-existing use cases (for acting on resources, specifically) are supported. Use the callback function to process any messages returned by the crsd.

Callback Mechanism

Interactive CLSCRS APIs provide a callback mechanism that the clients can use to process error messages, warning messages, and progress messages sent by the crsd.

The signature of the callback mechanism is:

typedef  void (*clscrs_msgf2)(void *usrp, const oratext *id, const oratext *msg,
                clscrs_msgtype msgtype);

In the preceding syntax:

• usrp: Is a user-supplied pointer that probably contains the context of the call

• id: Is the identifier of the entity to which the message corresponds

• msg: Is the output text

• msgtype: Is the type of the message; either error, warning, or progress

Example F-1 describes an example of the callback mechanism.

void myCallback(void *arg, const oratext *pId, const oratext *pMsg,
                clscrs_msgtype msgType)
{
    if (pMsg != NULL)
   {
       cout << pMsg << endl;
    }
}

Example F-2 describes how to use the callback mechanism in an interactive API.

clscrs_start_resource2(pResIdList, NULL,
                       env, myCallback, NULL,
                       0, pOpStatus);

You can also print debug trace messages for the API, itself by passing the CLSCRS_FLAG_TRACE flag when creating the context. The signature for context creation is:

CLSCRS_STAT clscrs_init_crs(clscrs_ctx **ctx, clscrs_msgf2 errf, void *errCtx,
                             ub4 flags);

For the trace messages to work, you must specify both the CLSCRS_FLAG_TRACE flag and a clscrs_msgf2 callback mechanism in the clscrs_init_crs API.

The clscrs_msgf2 callback mechanism has the following signature:

typedef  void (*clscrs_msgf)(void *usrp, const oratext *msg, sword msglen);

Filters

You can use filters to narrow down Oracle Clusterware entities upon which a CLSCRS API operates. Simple filters are attribute-value pairs with an operator. Operators must be surrounded by spaces, as shown in the examples. You can combine simple filters into expressions called expression filters using Boolean operators.

Supported filter operators are:

Supported Boolean operators are AND and OR.

Examples of filters are:

• TYPE = type1

• ((TYPE = type1) AND (CHECK_INTERVAL > 50))

• (TYPE = type1) AND ((CHECK_INTERVAL > 30) OR (AUTO_START co never))

• NAME en network.res

• TYPE st ora.db

There are two types of filters and CLSCRS has a set of APIs to create these filters:

• Comparison filter: A simple filter that compares two values. For example:

  TYPE = ora.db.type
  

  Use the clscrs_compfilter_create API to create a comparison filter. For example, to create the (TYPE = ora.db.type) comparison filter:

  clscrs_compfilter_create(ctx, clscrs_TYPE,
                      clscrs_comparator_eq, (const oratext *)"ora.db.type",
                      &myCompFilter);
  

• Expression filter: A filter that is created from either a set of comparison filters or expression filters, or both. For example:

  ((TYPE = ora.db.type) AND (CHECK_INTERVAL > 50))
  

  Use the clscrs_expfilter_create API to create a comparison filter. For example, to create an expression filter:

  clscrs_exprfilter_create(myCompFilter1, clscrs_operator_or,
                            myCompFilter2, &myExprFilter);
  

You can use filters in the following interactive CLSCRS APIs in place of an entity list:

Example F-3 describes using filters in an interactive CLSCRS API.

clscrs_start_resource2(myCompFilter, NULL,
                       env, msgf2, NULL,
                       0, pOpStatus);

Script Agent Usage

When you use CLSCRS APIs inside script agent entry points, keep the following in mind:

1. Some actions, such as start, stop, and clean, are executed under a lock on the resource instance. Thus, issuing a request to the server to act on the resource directly or by extension of a relation results in a dead-lock.

2. Issuing read-only (clscrs_stat2) is generally safe unless it is an initial check, where the script agent must not call back on the server, because that results in a dead-lock, as well. Use the clsagfw APIs to query the check entry point.

Help Interface

You can find the entire list of CLSCRS APIs, including usage information for each, in the $ORA_CRS_HOME/crs/demo/clscrsx.h file, along with a demo called crsapp.c.

Deprecated CLSCRS APIs

Table F-1 lists the deprecated CLSCRS APIs and the corresponding new APIs for Oracle Clusterware 11g release 2 (11.2).

clscrs_register_resource

clscrs_register_resource2

clscrs_start_resource

clscrs_start_resource2

clscrs_stat

clscrs_stat2

clscrs_stop_resource

clscrs_stop_resource2

clscrs_check_resource

clscrs_check_resource2

clscrs_relocate_resource

clscrs_relocate_resource2

clscrs_unregister_resource

clscrs_unregister_resource2

clscrs_msgf

clscrs_msgf2

clscrs_fail_resource

Interactive CLSCRS APIs

The APIs listed in Table F-2 make calls to the Cluster Ready Services daemon (crsd) to run commands. The crsd must be up and running for these APIs to function.

clscrs_register_type

clscrs_register_serverpool

clscrs_register_resource2

clscrs_start_resource2

clscrs_stat2

clscrs_stop_resource2

clscrs_check_resource2

clscrs_relocate_resource2

clscrs_unregister_resource2

clscrs_unregister_type

clscrs_unregister_serverpool

clscrs_relocate_server

Non-Interactive CLSCRS APIs

You can use non-interactive CLSCRS APIs for functions such as context initialization, preparing request payloads for interactive APIs, and post-processing output of the interactive APIs. The non-interactive CLSCRS APIs do not call crsd.

A callback error reporting mechanism is not available for the non-interactive CLSCRS APIs. All interactive CLSCRS APIs, except, clscrs_stat2, use this callback mechanism. Clients of these APIs also use the callback mechanism to receive error, warning, and progress messages from the crsd.

You can also use filters to reduce the list of CRS entities. You can also use filters in the interactive APIs to reduce the list of CRS entities.

Table F-3 describes the non-interactive CLSCRS APIs.

clscrs_entity_id_destroy

clscrs_exprfilter_create

clscrs_filter_destroy

clscrs_get_entity_type

clscrs_get_fixed_attrlist

clscrs_get_resource_instance_details

clscrs_getnodename

clscrs_init_crs

clscrs_is_crs_admin

clscrs_res_attr_count

clscrs_res_create

clscrs_res_destroy

clscrs_res_get_attr

clscrs_res_get_attr_list

clscrs_res_get_name

clscrs_res_get_op_status

clscrs_res_get_registered

clscrs_res_get_reslist

clscrs_res_set_attr_list

clscrs_res_set_reslist

clscrs_reslist_append

clscrs_reslist_count

clscrs_reslist_create

clscrs_reslist_delete_res

clscrs_reslist_destroy

clscrs_reslist_find

clscrs_reslist_first

clscrs_reslist_next

clscrs_sp_get

clscrs_sp_set

clscrs_splist_append

clscrs_splist_create

clscrs_splist_delete_sp

clscrs_splist_first

clscrs_splist_replace

clscrs_term_crs

clscrs_type_create

clscrs_type_get_attr

clscrs_type_set_attr

clscrs_compfilter_create

clscrs_entity_id_create

clscrs_register_serverpool

clscrs_register_type

clscrs_relocate_server

clscrs_res_get_node_list

clscrs_res_set_attr

clscrs_sp_get_value

clscrs_splist_count

clscrs_splist_create_and_set

clscrs_splist_destroy

clscrs_splist_find

clscrs_splist_next

clscrs_stat2