include/native/mutex.h

Go to the documentation of this file.

#ifndef _XENO_MUTEX_H
#define _XENO_MUTEX_H

#include <native/types.h>

struct rt_task;

typedef struct rt_mutex_info {

        int locked;             
        int nwaiters;           
        char name[XNOBJECT_NAME_LEN]; 
        char owner[XNOBJECT_NAME_LEN]; 
} RT_MUTEX_INFO;

typedef struct rt_mutex_placeholder {

        xnhandle_t opaque;

#ifdef CONFIG_XENO_FASTSYNCH
        xnarch_atomic_t *fastlock;

        int lockcnt;
#endif /* CONFIG_XENO_FASTSYNCH */

} RT_MUTEX_PLACEHOLDER;

#if (defined(__KERNEL__) || defined(__XENO_SIM__)) && !defined(DOXYGEN_CPP)

#include <nucleus/synch.h>
#include <native/ppd.h>

#define XENO_MUTEX_MAGIC 0x55550505

#define RT_MUTEX_EXPORTED       XNSYNCH_SPARE0  /* Mutex registered by name */

typedef struct __rt_mutex {

        unsigned magic;         /* !< Magic code - must be first */

        xnsynch_t synch_base;   /* !< Base synchronization object. */

        xnhandle_t handle;      /* !< Handle in registry -- zero if unregistered. */

        int lockcnt;            /* !< Lock nesting level (> 0 means "locked"). */

        char name[XNOBJECT_NAME_LEN]; /* !< Symbolic name. */

#ifdef CONFIG_XENO_OPT_PERVASIVE
        pid_t cpid;             /* !< Creator's pid. */
#endif /* CONFIG_XENO_OPT_PERVASIVE */

        xnholder_t rlink;       /* !< Link in resource queue. */

#define rlink2mutex(ln)         container_of(ln, RT_MUTEX, rlink)

        xnqueue_t *rqueue;      /* !< Backpointer to resource queue. */

} RT_MUTEX;

#ifdef __cplusplus
extern "C" {
#endif

#ifdef CONFIG_XENO_OPT_NATIVE_MUTEX

int __native_mutex_pkg_init(void);

void __native_mutex_pkg_cleanup(void);

static inline void __native_mutex_flush_rq(xnqueue_t *rq)
{
        xeno_flush_rq(RT_MUTEX, rq, mutex);
}

int rt_mutex_acquire_inner(RT_MUTEX *mutex, RTIME timeout,
                           xntmode_t timeout_mode);

#else /* !CONFIG_XENO_OPT_NATIVE_MUTEX */

#define __native_mutex_pkg_init()               ({ 0; })
#define __native_mutex_pkg_cleanup()            do { } while(0)
#define __native_mutex_flush_rq(rq)             do { } while(0)

#endif /* !CONFIG_XENO_OPT_NATIVE_MUTEX */

#ifdef __cplusplus
}
#endif

#else /* !(__KERNEL__ || __XENO_SIM__) */

typedef RT_MUTEX_PLACEHOLDER RT_MUTEX;

#ifdef __cplusplus
extern "C" {
#endif

int rt_mutex_bind(RT_MUTEX *mutex,
                  const char *name,
                  RTIME timeout);

static inline int rt_mutex_unbind (RT_MUTEX *mutex)

{
        mutex->opaque = XN_NO_HANDLE;
        return 0;
}

#ifdef __cplusplus
}
#endif

#endif /* __KERNEL__ || __XENO_SIM__ */

#ifdef __cplusplus
extern "C" {
#endif

int rt_mutex_create_inner(RT_MUTEX *mutex, const char *name, int global);

/* Public interface. */

int rt_mutex_create(RT_MUTEX *mutex,
                    const char *name);

int rt_mutex_delete(RT_MUTEX *mutex);

int rt_mutex_acquire(RT_MUTEX *mutex,
                     RTIME timeout);

int rt_mutex_acquire_until(RT_MUTEX *mutex,
                           RTIME timeout);

int rt_mutex_release(RT_MUTEX *mutex);

int rt_mutex_inquire(RT_MUTEX *mutex,
                     RT_MUTEX_INFO *info);

#ifdef __cplusplus
}
#endif

#endif /* !_XENO_MUTEX_H */