libtesla.h

Go to the documentation of this file.

/*-
 * Copyright (c) 2011 Robert N. M. Watson
 * Copyright (c) 2012-2013 Jonathan Anderson
 * All rights reserved.
 *
 * This software was developed by SRI International and the University of
 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
 * ("CTSRD"), as part of the DARPA CRASH research programme.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $Id$
 */

#ifndef _TESLA_STATE
#define _TESLA_STATE

#ifdef _KERNEL
#include <sys/types.h>
#else
#include <stdint.h>             /* int32_t, uint32_t */
#endif

enum tesla_err_t {
        TESLA_SUCCESS,          /* Success. */
        TESLA_ERROR_ENOENT,     /* Entry not found. */
        TESLA_ERROR_ENOMEM,     /* Insufficient memory. */
        TESLA_ERROR_EINVAL,     /* Invalid parameters. */
        TESLA_ERROR_UNKNOWN,    /* An unknown (e.g. platform) error. */
};

const char      *tesla_strerror(int32_t error);


struct tesla_store;

enum tesla_context {
        TESLA_CONTEXT_GLOBAL,
        TESLA_CONTEXT_THREAD,
};

int32_t tesla_store_get(enum tesla_context context,
                        uint32_t classes, uint32_t instances,
                        struct tesla_store* *store);


struct tesla_class;

int32_t tesla_class_get(struct tesla_store *store,
                        uint32_t id,
                        struct tesla_class **tclass,
                        const char *name,
                        const char *description);

void    tesla_class_put(struct tesla_class*);


struct tesla_transition {
        uint32_t        from;

        uint32_t        from_mask;

        uint32_t        to;

        uint32_t        to_mask;

        int             flags;
};

#define TESLA_TRANS_INIT        0x02    /* May need to initialise the class. */
#define TESLA_TRANS_CLEANUP     0x04    /* Clean up the class now. */

struct tesla_transitions {
        uint32_t                 length;

        struct tesla_transition *transitions;
};

#define TESLA_KEY_SIZE          4

struct tesla_key {
        uintptr_t       tk_keys[TESLA_KEY_SIZE];

        uint32_t        tk_mask;
};


void    tesla_update_state(enum tesla_context context, uint32_t class_id,
        const struct tesla_key *key, const char *name, const char *description,
        const struct tesla_transitions*);


struct tesla_instance {
        struct tesla_key        ti_key;
        uint32_t                ti_state;
};


/*
 * Event notification:
 */
typedef void    (*tesla_ev_new_instance)(struct tesla_class *,
            struct tesla_instance *);

typedef void    (*tesla_ev_transition)(struct tesla_class *,
            struct tesla_instance *, const struct tesla_transition*);

typedef void    (*tesla_ev_clone)(struct tesla_class *,
            struct tesla_instance *orig, struct tesla_instance *copy,
            const struct tesla_transition*);

typedef void    (*tesla_ev_no_instance)(struct tesla_class *,
            const struct tesla_key *, const struct tesla_transitions *);

typedef void    (*tesla_ev_bad_transition)(struct tesla_class *,
            struct tesla_instance *, const struct tesla_transitions *);

typedef void    (*tesla_ev_error)(struct tesla_class *, int32_t, const char *);

typedef void    (*tesla_ev_accept)(struct tesla_class *,
            struct tesla_instance *);

typedef void    (*tesla_ev_ignored)(const struct tesla_class *,
            const struct tesla_key *, const struct tesla_transitions *);

struct tesla_event_handlers {
        tesla_ev_new_instance   teh_init;
        tesla_ev_transition     teh_transition;
        tesla_ev_clone          teh_clone;
        tesla_ev_no_instance    teh_fail_no_instance;
        tesla_ev_bad_transition teh_bad_transition;
        tesla_ev_error          teh_err;
        tesla_ev_accept         teh_accept;
        tesla_ev_ignored        teh_ignored;
};

struct tesla_event_metahandler {
        const uint32_t  tem_length;

        uint32_t        tem_mask;

        const struct tesla_event_handlers* const *tem_handlers;
};

int     tesla_set_event_handler(struct tesla_event_handlers *);

int     tesla_set_event_handlers(struct tesla_event_metahandler *);

#ifdef _KERNEL
#define TESLA_KERN_PRINTF_EV    0x1
#define TESLA_KERN_PRINTERR_EV  0x2
#define TESLA_KERN_DTRACE_EV    0x4
#define TESLA_KERN_PANIC_EV     0x8
#endif

#endif /* _TESLA_STATE */