Section 3: library functions
NAME cpg_join – Joins one or more groups in the CPG library SYNOPSIS #include <corosync/cpg.h> int cpg_join(cpg_handle_t handle, struct cpg_name *group); DESCRIPTION The cpg_join function is used to join one group. When a group is joined, the cpg_mcast_joined(3) is called internally to multicast to the groups joined in the argument handle. The process will also…
NAME cpg_iteration_next – Return next item in iteration of CPG SYNOPSIS #include <corosync/cpg.h> cs_error_t cpg_iteration_next (cpg_iteration_handle_t handle, struct cpg_iteration_description_t *description); DESCRIPTION The cpg_iter_next function is used to get next value in iteration. The handle argument is iterator handle obtained by cpg_iteration_initalize(3) function. description is pointer to structure with following definition: struct cpg_iteration_description_t { struct cpg_name…
NAME cpg_iteration_initialize – Initialize iterator for members of CPG SYNOPSIS #include <corosync/cpg.h> cs_error_t cpg_iteration_initialize (cpg_handle_t handle, cpg_iteration_type_t iteration_type, const struct cpg_name *group, cpg_iteration_handle_t *cpg_iteration_handle); DESCRIPTION The cpg_iteration_initialize function is used to initialize iteration of CPG members. The handle argument is connection to CPG database obtained by calling cpg_initialize(3) function. iteration_type is used for limit number…
NAME cpg_iteration_finalize – Finalize iterator for members of CPG SYNOPSIS #include <corosync/cpg.h> cs_error_t cpg_iteration_finalize (cpg_iteration_handle_t handle); DESCRIPTION The cpg_iteration_finalize function is used to free up memory asociated with iteration obtained by calling of cpg_iteration_initialize(3) function. The handle argument is iterator handle obtained by cpg_iteration_initialize(3) function. RETURN VALUE This call returns the CS_OK value if successful….
NAME cpg_initialize – Create a new connection to the CPG service SYNOPSIS #include <corosync/cpg.h> int cpg_initialize(cpg_handle_t *handle, cpg_callbacks_t *callbacks); DESCRIPTION The cpg_initialize function is used to initialize a connection to the closed process groups API. This function is deprecated and cpg_model_initialize should be used in newly written code. Each application may have several connections to…
NAME cpg_finalize – Terminate a connection to the CPG service SYNOPSIS #include <corosync/cpg.h> int cpg_finalize(cpg_handle_t handle); DESCRIPTION The cpg_finalize function is used to close a connection to the closed process group API. Once the connection is finalized, the handle may not be used again by applications. No more callbacks will be dispatched from the cpg_dispatch…
NAME cpg_fd_get – Dispatches callbacks from the CPG service SYNOPSIS #include <corosync/cpg.h> int cpg_fd_get(cpg_handle_t handle, int *fd); DESCRIPTION The cpg_fd_get function is used to retrieve the file descriptor that may be used with the poll system call to determine when cpg_dispatch(3) won’t block. The handle argument may not be used directly with poll because it…
NAME cpg_dispatch – Dispatches callbacks from the CPG service SYNOPSIS #include <corosync/cpg.h> int cpg_dispatch(cpg_handle_t handle, cpg_dispatch_t *dispatch_types); DESCRIPTION The cpg_dispatch function is used to dispatch configuration changes or messages from the closed process groups API. Each application may have several connections to the CPG API. Each application uses the handle argument to uniquely identify the…
NAME cpg_context_set – Sets the context variable for a CPG instance SYNOPSIS #include <corosync/cpg.h> int cpg_context_set(cpg_handle_t handle, void *context); DESCRIPTION The cpg_context_set function is used to set the context variable for a cpg instance. It has no meaning inside libcpg itself and will not be touched by the library. It can be retrieved using cpg_context_get(3)…
NAME cpg_context_get – Gets the context variable for a CPG instance SYNOPSIS #include <corosync/cpg.h> int cpg_context_get(cpg_handle_t handle, void **context); DESCRIPTION The cpg_context_get function is used to retrieve the context variable previously stored using cpg_context_set(3) RETURN VALUE This call returns the CS_OK value if successful, otherwise an error is returned. ERRORS The errors are undocumented. SEE…
cpftrs.f – Synopsis Functions/Subroutines subroutine cpftrs (TRANSR, UPLO, N, NRHS, A, B, LDB, INFO) CPFTRS Function/Subroutine Documentation subroutine cpftrs (characterTRANSR, characterUPLO, integerN, integerNRHS, complex, dimension( 0: * )A, complex, dimension( ldb, * )B, integerLDB, integerINFO) CPFTRS Purpose: CPFTRS solves a system of linear equations A*X = B with a Hermitian positive definite matrix A using…
cpftri.f – Synopsis Functions/Subroutines subroutine cpftri (TRANSR, UPLO, N, A, INFO) CPFTRI Function/Subroutine Documentation subroutine cpftri (characterTRANSR, characterUPLO, integerN, complex, dimension( 0: * )A, integerINFO) CPFTRI Purpose: CPFTRI computes the inverse of a complex Hermitian positive definite matrix A using the Cholesky factorization A = U**H*U or A = L*L**H computed by CPFTRF. Parameters:…
cpftrf.f – Synopsis Functions/Subroutines subroutine cpftrf (TRANSR, UPLO, N, A, INFO) CPFTRF Function/Subroutine Documentation subroutine cpftrf (characterTRANSR, characterUPLO, integerN, complex, dimension( 0: * )A, integerINFO) CPFTRF Purpose: CPFTRF computes the Cholesky factorization of a complex Hermitian positive definite matrix A. The factorization has the form A = U**H * U, if UPLO = ‘U’, or…
cpbtrs.f – Synopsis Functions/Subroutines subroutine cpbtrs (UPLO, N, KD, NRHS, AB, LDAB, B, LDB, INFO) CPBTRS Function/Subroutine Documentation subroutine cpbtrs (characterUPLO, integerN, integerKD, integerNRHS, complex, dimension( ldab, * )AB, integerLDAB, complex, dimension( ldb, * )B, integerLDB, integerINFO) CPBTRS Purpose: CPBTRS solves a system of linear equations A*X = B with a Hermitian positive definite band…
cpbtrf.f – Synopsis Functions/Subroutines subroutine cpbtrf (UPLO, N, KD, AB, LDAB, INFO) CPBTRF Function/Subroutine Documentation subroutine cpbtrf (characterUPLO, integerN, integerKD, complex, dimension( ldab, * )AB, integerLDAB, integerINFO) CPBTRF Purpose: CPBTRF computes the Cholesky factorization of a complex Hermitian positive definite band matrix A. The factorization has the form A = U**H * U, if UPLO…
cpbtf2.f – Synopsis Functions/Subroutines subroutine cpbtf2 (UPLO, N, KD, AB, LDAB, INFO) CPBTF2 computes the Cholesky factorization of a symmetric/Hermitian positive definite band matrix (unblocked algorithm). Function/Subroutine Documentation subroutine cpbtf2 (characterUPLO, integerN, integerKD, complex, dimension( ldab, * )AB, integerLDAB, integerINFO) CPBTF2 computes the Cholesky factorization of a symmetric/Hermitian positive definite band matrix (unblocked algorithm). Purpose:…
cpbsvx.f – Synopsis Functions/Subroutines subroutine cpbsvx (FACT, UPLO, N, KD, NRHS, AB, LDAB, AFB, LDAFB, EQUED, S, B, LDB, X, LDX, RCOND, FERR, BERR, WORK, RWORK, INFO) CPBSVX computes the solution to system of linear equations A * X = B for OTHER matrices Function/Subroutine Documentation subroutine cpbsvx (characterFACT, characterUPLO, integerN, integerKD, integerNRHS, complex, dimension(…
cpbsv.f – Synopsis Functions/Subroutines subroutine cpbsv (UPLO, N, KD, NRHS, AB, LDAB, B, LDB, INFO) CPBSV computes the solution to system of linear equations A * X = B for OTHER matrices Function/Subroutine Documentation subroutine cpbsv (characterUPLO, integerN, integerKD, integerNRHS, complex, dimension( ldab, * )AB, integerLDAB, complex, dimension( ldb, * )B, integerLDB, integerINFO) CPBSV computes…
cpbstf.f – Synopsis Functions/Subroutines subroutine cpbstf (UPLO, N, KD, AB, LDAB, INFO) CPBSTF Function/Subroutine Documentation subroutine cpbstf (characterUPLO, integerN, integerKD, complex, dimension( ldab, * )AB, integerLDAB, integerINFO) CPBSTF Purpose: CPBSTF computes a split Cholesky factorization of a complex Hermitian positive definite band matrix A. This routine is designed to be used in conjunction with CHBGST….
cpbrfs.f – Synopsis Functions/Subroutines subroutine cpbrfs (UPLO, N, KD, NRHS, AB, LDAB, AFB, LDAFB, B, LDB, X, LDX, FERR, BERR, WORK, RWORK, INFO) CPBRFS Function/Subroutine Documentation subroutine cpbrfs (characterUPLO, integerN, integerKD, integerNRHS, complex, dimension( ldab, * )AB, integerLDAB, complex, dimension( ldafb, * )AFB, integerLDAFB, complex, dimension( ldb, * )B, integerLDB, complex, dimension( ldx, * )X,…