sys/sys/specificdata.h

   1 /*      $NetBSD: specificdata.h,v 1.4 2008/04/28 20:24:11 martin Exp $  */
   2
   3 /*-
   4  * Copyright (c) 2006 The NetBSD Foundation, Inc.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to The NetBSD Foundation
   8  * by Jason R. Thorpe.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29  * POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _SYS_SPECIFICDATA_H_
  33 #define _SYS_SPECIFICDATA_H_
  34
  35 #include <sys/mutex.h>
  36
  37 typedef unsigned int specificdata_key_t;
  38 typedef void (*specificdata_dtor_t)(void *);
  39 typedef struct specificdata_domain *specificdata_domain_t;
  40 typedef struct specificdata_container *specificdata_container_t;
  41
  42 typedef struct {
  43         specificdata_container_t specdataref_container;
  44         kmutex_t specdataref_lock;
  45 } specificdata_reference;
  46
  47 specificdata_domain_t   specificdata_domain_create(void);
  48 void                    specificdata_domain_delete(specificdata_domain_t);
  49
  50 int     specificdata_key_create(specificdata_domain_t,
  51                                 specificdata_key_t *, specificdata_dtor_t);
  52 void    specificdata_key_delete(specificdata_domain_t, specificdata_key_t);
  53
  54 int     specificdata_init(specificdata_domain_t, specificdata_reference *);
  55 void    specificdata_fini(specificdata_domain_t, specificdata_reference *);
  56
  57 void *  specificdata_getspecific(specificdata_domain_t,
  58                                  specificdata_reference *, specificdata_key_t);
  59 void *  specificdata_getspecific_unlocked(specificdata_domain_t,
  60                                           specificdata_reference *,
  61                                           specificdata_key_t);
  62 void    specificdata_setspecific(specificdata_domain_t,
  63                                  specificdata_reference *, specificdata_key_t,
  64                                  void *);
  65 int     specificdata_setspecific_nowait(specificdata_domain_t,
  66                                         specificdata_reference *,
  67                                         specificdata_key_t, void *);
  68
  69 #endif /* _SYS_SPECIFICDATA_H_ */