corerwlock.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 1989-2008.
 *  On-Line Applications Research Corporation (OAR).
 *
 *  The license and distribution terms for this file may be
 *  found in the file LICENSE in this distribution or at
 *  http://www.rtems.com/license/LICENSE.
 *
 *  $Id: corerwlock.h,v 1.3 2008/01/29 23:58:17 joel Exp $
 */

#ifndef _RTEMS_SCORE_CORERWLOCK_H
#define _RTEMS_SCORE_CORERWLOCK_H

#ifdef __cplusplus
extern "C" {
#endif

#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
#include <rtems/score/priority.h>
#include <rtems/score/watchdog.h>

typedef void ( *CORE_RWLock_API_mp_support_callout )(
                 Thread_Control *,
                 Objects_Id
             );

typedef enum {
  CORE_RWLOCK_UNLOCKED,
  CORE_RWLOCK_LOCKED_FOR_READING,
  CORE_RWLOCK_LOCKED_FOR_WRITING
}   CORE_RWLock_States;

typedef enum {
  CORE_RWLOCK_SUCCESSFUL,
  CORE_RWLOCK_WAS_DELETED,
  CORE_RWLOCK_UNAVAILABLE,
  CORE_RWLOCK_TIMEOUT
}   CORE_RWLock_Status;

#define CORE_RWLOCK_STATUS_LAST CORE_RWLOCK_TIMEOUT

#define CORE_RWLOCK_THREAD_WAITING_FOR_READ  0

#define CORE_RWLOCK_THREAD_WAITING_FOR_WRITE 1

typedef struct {
  int XXX;
}   CORE_RWLock_Attributes;

typedef struct {
  Thread_queue_Control     Wait_queue;
  CORE_RWLock_Attributes  Attributes;
  CORE_RWLock_States       current_state;
  uint32_t                 number_of_readers;
}   CORE_RWLock_Control;

void _CORE_RWLock_Initialize(
  CORE_RWLock_Control       *the_rwlock,
  CORE_RWLock_Attributes    *the_rwlock_attributes
);

void _CORE_RWLock_Obtain_for_reading(
  CORE_RWLock_Control                 *the_rwlock,
  Objects_Id                           id,
  boolean                              wait,
  Watchdog_Interval                    timeout,
  CORE_RWLock_API_mp_support_callout   api_rwlock_mp_support
);

void _CORE_RWLock_Obtain_for_writing(
  CORE_RWLock_Control                 *the_rwlock,
  Objects_Id                           id,
  boolean                              wait,
  Watchdog_Interval                    timeout,
  CORE_RWLock_API_mp_support_callout   api_rwlock_mp_support
);

CORE_RWLock_Status _CORE_RWLock_Release(
  CORE_RWLock_Control                *the_rwlock
);

#define _CORE_RWLock_Flush( _the_rwlock, _remote_extract_callout, _status) \
  _Thread_queue_Flush( \
    &((_the_rwlock)->Wait_queue), \
    (_remote_extract_callout), \
    (_status) \
  )

void _CORE_RWLock_Timeout(
  Objects_Id  id,
  void       *ignored
);


#ifndef __RTEMS_APPLICATION__
#include <rtems/score/corerwlock.inl>
#endif

#ifdef __cplusplus
}
#endif

#endif
/*  end of include file */

---