te
Copyright (c) 2007, 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]
papiAttributeListAddValue, papiAttributeListAddBoolean, papiAttributeListAddCollection, papiAttributeListAddDatetime, papiAttributeListAddInteger, papiAttributeListAddMetadata, papiAttributeListAddRange, papiAttributeListAddResolution, papiAttributeListAddString, papiAttributeListDelete, papiAttributeListGetValue, papiAttributeListGetNext, papiAttributeListFind, papiAttributeListGetBoolean, papiAttributeListGetCollection, papiAttributeListGetDatetime, papiAttributeListGetInteger, papiAttributeListGetMetadata, papiAttributeListGetRange, papiAttributeListGetResolution, papiAttributeListGetString, papiAttributeListFromString, papiAttributeListToString, papiAttributeListFree - manage PAPI attribute lists

cc [ flag.\|.\|. ] file.\|.\|. -lpapi [ library.\|.\|. ]
#include <papi.h>

papi_status_t papiAttributeListAddValue(papi_attribute_t ***attrs,
 int flags, char *name, papi_attribute_value_type_t type,
 papi_attribute_value_t *value);

papi_status_t papiAttributeListAddString(papi_attribute_t ***attrs,
 int flags, char *name, char *string);

papi_status_t papiAttributeListAddInteger(papi_attribute_t ***attrs,
 int flags, char *name, int integer);

papi_status_t papiAttributeListAddBoolean(papi_attribute_t ***attrs,
 int flags, char *name, char boolean);

papi_status_t papiAttributeListAddRange(papi_attribute_t ***attrs,
 int flags, char *name, int lower, int upper);

papi_status_t papiAttributeListAddResolution(papi_attribute_t ***attrs,
 int flags, char *name, int xres, int yres,
 papi_resolution_unit_t units);

papi_status_t papiAttributeListAddDatetime(papi_attribute_t ***attrs,
 int flags, char *name, time_t datetime);

papi_status_t papiAttributeListAddCollection(papi_attribute_t ***attrs,
 int flags, char *name, papi_attribute_t **collection);

papi_status_t papiAttributeListAddMetadata(papi_attribute_t ***attrs,
 int flags, char *name, papi_metadata_t metadata);

papi_status_t papiAttributeListDelete(papi_attribute_t ***attributes,
 char *name);

papi_status_t papiAttributeListGetValue(papi_attribute_t **list,
 void **iterator, char *name, papi_attribute_value_type_t type,
 papi_attribute_value_t **value);

papi_status_t papiAttributeListGetString(papi_attribute_t **list,
 void **iterator, char *name, char **vptr);

papi_status_t papiAttributeListGetInteger(papi_attribute_t **list,
 void **iterator, char *name, int *vptr);

papi_status_t papiAttributeListGetBoolean(papi_attribute_t **list,
 void **iterator, char *name, char *vptr);

papi_status_t papiAttributeListGetRange(papi_attribute_t **list,
 void **iterator, char *name, int *min, int *max);

papi_status_t papiAttributeListGetResolution(papi_attribute_t **list,
 void **iterator, char *name, int *x, int *y,
 papi_resolution_unit_t *units);

papi_status_t papiAttributeListGetDatetime(papi_attribute_t **list,
 void **iterator, char *name, time_t *dt);

papi_status_t papiAttributeListGetCollection(papi_attribute_t **list,
 void **iterator, char *name, papi_attribute_t ***collection);

papi_status_t papiAttributeListGetMetadata(papi_attribute_t **list,
 void **iterator, char *name, papi_metadata_t *vptr);

papi_attribute_t *papiAttributeListFind(papi_attribute_t **list,
 char *name);

papi_attribute_t *papiAttributeListGetNext(papi_attribute_t **list,
 void **iterator);

void papiAttributeListFree(papi_attribute_t **attributes);

papi_status_t papiAttributeListFromString(papi_attribute_t ***attrs,
 int flags, char *string);

papi_status_t papiAttributeListToString(papi_attribute_t **attrs,
 char *delim, char *buffer, size_t buflen);

attrs attributes boolean buffer buflen collection datetime delim dt flags integer iterator list lower max metadata min name string type units upper value vptr x xres y yres

The papiAttributeListAdd*() functions add new attributes and/or values to the attribute list passed in. If necessary, the attribute list passed in is expanded to contain a new attribute pointer for any new attributes added to the list. The list is null-terminated. Space for the new attributes and values is allocated and the name and value are copied into this allocated space.

If PAPI_ATTR_REPLACE is specified in flags, any existing attribute values are freed and replaced with the supplied value.

If PAPI_ATTR_APPEND is specified, the supplied value is appended to the attribute's list of values.

If PAPI_ATTR_EXCL is specified, the operation succeeds only if the attribute was not previously defined.

The papiAttributeListGet*() functions retrieve an attribute value from an attribute list. If the attribute is a multi-valued attribute, the first call to retrieve a value should pass in an iterator and attribute name. Subsequent calls to retrieve additional values should pass in the iterator and a null value for the attribute name. If a single-valued attribute is to be retrieved, NULL can be used in place of the iterator.

Upon successful completion of a get operation, the value passed in (string, integer, boolean, ...) is changed to the value from the attribute list. If the operation fails for any reason (type mismatch, not found, ...), the value passed in remains untouched.

The resulting value returned from a get operation is returned from the attribute list's allocated memory. It is not guaranteed to be available after the attribute list has been freed.

The papiAttributeListDelete() function removes an attribute from a supplied list.

The papiAttributeListFind() function allows an application to retrieve an entire attribute structure from the passed-in attribute list.

The papiAttributeListGetNext() function allows an application to walk through an attribute list returning subsequent attributes from the list. With the first call, the iterator should be initialized to NULL and subsequent calls should use NULL for the list argument.

The papiAttributeListFree() function deallocates all memory associated with an attribute list, including values that might have been retrieved previously using papiAttributeListGet*() calls.

The papiAttributeListFromString() function takes in a string representation of a set of attributes, parses the string and adds the attributes to the passed in attribute list using the flags to determine how to add them. String values are specified with "key=value". Integer values are specified with "key=number". Boolean values are specified with either "key=(true|false)" or "[no]key". Multiple attributes can be specified in the string by separating them with a whitespace character.

The papiAttributeListToString() function converts an attribute list to a string representation that can be displayed to a user. The delimiter value is placed between attributes in the string.

These functions return PAPI_OK upon successful completion and one of the following on failure: PAPI_BAD_ARGUMENT

PAPI_CONFLICT PAPI_NOT_FOUND PAPI_NOT_POSSIBLE PAPI_TEMPORARY_ERROR

Example 1 The following example manipulates a PAPI attribute list.

/*
 * program to manipulate a PAPI attribute list
 */
#include <stdio.h>
#include <papi.h>

/*ARGSUSED*/
int
main(int ac, char *av[])
{
 char buf[BUFSIZ];
 papi_status_t status;
 papi_attribute_t **list = NULL;
 void *iter = NULL;
 char *string = NULL;
 int32_t integer = 0;

 /* build an attribute list */
 (void) papiAttributeListAddString(&list, PAPI_ATTR_EXCL,
 "job-title", "example");
 (void) papiAttributeListAddInteger(&list, PAPI_ATTR_EXCL,
 "copies", 1);
 (void) papiAttributeListFromString(&list, PAPI_ATTR_REPLACE, av[1]);
 status = papiAttributeListAddString(&list, PAPI_ATTR_EXCL,
 "document-format", "text/plain");
 if (status != PAPI_OK)
 printf("failed to set document-format to text/plain: %s\en",
 papiStatusString(status));

 /* dump the list */
 status = papiAttributeListToString(list, "\en\et", buf, sizeof (buf));
 if (status == PAPI_OK)
 printf("Attributes: %s\en", buf);
 else
 printf("Attribute list to big to dump\en");


 /* retreive various elements */
 integer = 12;
 (void) papiAttributeListGetInteger(list, NULL, "copies", &integer);
 printf("copies: %d\en", integer);

 string = NULL;
 for (status = papiAttributeListGetString(list, &oter,
 "job-files", &string);
 status == PAPI_OK;
 status = papiAttributeListGetString(list, &iter, NULL, &string))
 printf("file: %s\en", string);

 papiAttributeListFree(list);
}

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Volatile

MT-Level Safe

libpapi(3LIB), attributes(5)