xref: /titanic_51/usr/src/man/man3cpc/cpc_open.3cpc (revision 5963c4f9d1eb33d95ac319791aa1d0b9ea17f154)
te
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
cpc_open 3CPC "30 Jan 2004" "SunOS 5.11" "CPU Performance Counters Library Functions"
NAME
cpc_open, cpc_close - initialize the CPU Performance Counter library
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -lcpc [ library.\|.\|. ] 
#include <libcpc.h>

cpc_t *cpc_open(int vers);

int cpc_close(cpc_t *cpc);
DESCRIPTION

The cpc_open() function initializes libcpc(3LIB) and returns an identifier that must be used as the cpc argument in subsequent libcpc function calls. The cpc_open() function takes an interface version as an argument and returns NULL if that version of the interface is incompatible with the libcpc implementation present on the system. Usually, the argument has the value of CPC_VER_CURRENT bound to the application when it was compiled.

The cpc_close() function releases all resources associated with the cpc argument. Any bound counters utilized by the process are unbound. All entities of type cpc_set_t and cpc_buf_t are invalidated and destroyed.

RETURN VALUES

If the version requested is supported by the implementation, cpc_open() returns a cpc_t handle for use in all subsequent libcpc operations. If the implementation cannot support the version needed by the application, cpc_open() returns NULL, indicating that the application at least needs to be recompiled to operate correctly on the new platform and might require further changes.

The cpc_close() function always returns 0.

ERRORS

These functions will fail if:

EINVAL

The version requested by the client is incompatible with the implementation.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelSafe
SEE ALSO

libcpc(3LIB), attributes(5)