common/ctf/ctf_util.c

e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * CDDL HEADER START
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * The contents of this file are subject to the terms of the
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Common Development and Distribution License, Version 1.0 only
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * (the "License").  You may not use this file except in compliance
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * with the License.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * or http://www.opensolaris.org/os/licensing.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * See the License for the specific language governing permissions
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * and limitations under the License.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * When distributing Covered Code, include this CDDL HEADER in each
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * If applicable, add the following below this CDDL HEADER, with the
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * fields enclosed by brackets "[]" replaced with your own identifying
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * information: Portions Copyright [yyyy] [name of copyright owner]
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * CDDL HEADER END
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Use is subject to license terms.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
d11c725a6a076f607c240f98ff03ca3166b581c9vboxsync#ifndef VBOX
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync#pragma ident   "%Z%%M% %I% %E% SMI"
d11c725a6a076f607c240f98ff03ca3166b581c9vboxsync#endif
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync#include <ctf_impl.h>
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Simple doubly-linked list append routine.  This implementation assumes that
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * each list element contains an embedded ctf_list_t as the first member.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * An additional ctf_list_t is used to store the head (l_next) and tail
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * (l_prev) pointers.  The current head and tail list elements have their
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * previous and next pointers set to NULL, respectively.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncvoid
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_list_append(ctf_list_t *lp, void *new)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    ctf_list_t *p = lp->l_prev; /* p = tail list element */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    ctf_list_t *q = new;        /* q = new list element */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    lp->l_prev = q;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    q->l_prev = p;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    q->l_next = NULL;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    if (p != NULL)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        p->l_next = q;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    else
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        lp->l_next = q;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Prepend the specified existing element to the given ctf_list_t.  The
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * existing pointer should be pointing at a struct with embedded ctf_list_t.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncvoid
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_list_prepend(ctf_list_t *lp, void *new)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    ctf_list_t *p = new;        /* p = new list element */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    ctf_list_t *q = lp->l_next; /* q = head list element */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    lp->l_next = p;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    p->l_prev = NULL;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    p->l_next = q;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    if (q != NULL)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        q->l_prev = p;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    else
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        lp->l_prev = p;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Delete the specified existing element from the given ctf_list_t.  The
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * existing pointer should be pointing at a struct with embedded ctf_list_t.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncvoid
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_list_delete(ctf_list_t *lp, void *existing)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    ctf_list_t *p = existing;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    if (p->l_prev != NULL)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        p->l_prev->l_next = p->l_next;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    else
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        lp->l_next = p->l_next;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    if (p->l_next != NULL)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        p->l_next->l_prev = p->l_prev;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    else
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        lp->l_prev = p->l_prev;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Convert an encoded CTF string name into a pointer to a C string by looking
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * up the appropriate string table buffer and then adding the offset.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncconst char *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_strraw(ctf_file_t *fp, uint_t name)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    ctf_strs_t *ctsp = &fp->ctf_str[CTF_NAME_STID(name)];
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    if (ctsp->cts_strs != NULL && CTF_NAME_OFFSET(name) < ctsp->cts_len)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        return (ctsp->cts_strs + CTF_NAME_OFFSET(name));
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    /* string table not loaded or corrupt offset */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    return (NULL);
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncconst char *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_strptr(ctf_file_t *fp, uint_t name)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    const char *s = ctf_strraw(fp, name);
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    return (s != NULL ? s : "(?)");
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Same strdup(3C), but use ctf_alloc() to do the memory allocation.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncchar *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_strdup(const char *s1)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    char *s2 = ctf_alloc(strlen(s1) + 1);
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    if (s2 != NULL)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        (void) strcpy(s2, s1);
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    return (s2);
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Store the specified error code into errp if it is non-NULL, and then
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * return NULL for the benefit of the caller.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_file_t *
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_set_open_errno(int *errp, int error)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    if (errp != NULL)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync        *errp = error;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    return (NULL);
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync/*
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * Store the specified error code into the CTF container, and then return
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync * CTF_ERR for the benefit of the caller.
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync */
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsynclong
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsyncctf_set_errno(ctf_file_t *fp, int err)
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync{
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    fp->ctf_errno = err;
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync    return (CTF_ERR);
e083a0c2c99cea982dcf8e12ec3452cc575b5663vboxsync}