saslock_8h_source.html

 /*

  * Copyright (c) 2003-2014 IBM Corporation.

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *     IBM Corporation, Steven Munroe - initial API and implementation

  */


 #ifndef __SAS_LOCK_H

 #define __SAS_LOCK_H


 #ifdef __cplusplus

 #define __C__ "C"

 #else

 #define __C__

 #endif


 typedef void *vm_address_t;


 typedef enum

 {

   SasUserLock__READ,

   SasUserLock__WRITE

 } sas_userlock_request_t;


 extern __C__ int        SasLockOwner;


 extern __C__ void

 SASLockReset (void);


 extern __C__ void

 SASLockInit (void);


 extern __C__ void

 SASLock(vm_address_t addr,

         sas_userlock_request_t lockT);


 extern __C__ void

 SASUnlock(vm_address_t addr);


 extern __C__ void

 SASLockPrintHighLevelStats(void);


 extern __C__ void

 SASLockPrintDetailedStats(void);


 extern __C__ void

 SASLockDetach (void);


 extern __C__ void

 SASLockRemove (void);


 #endif //__SAS_LOCK_H


SASLockReset
__C__ void SASLockReset(void)
Reset the SAS Lock tables.

sas_userlock_request_t
sas_userlock_request_t
SAS Lock request types.
Definition: saslock.h:53

vm_address_t
void * vm_address_t
Generic address to be used as symbolic lock ID.
Definition: saslock.h:50

SASLockInit
__C__ void SASLockInit(void)
Initialize the SAS Lock tables.

SASLockRemove
__C__ void SASLockRemove(void)
Remove the shared memory segment holding the SAS lock tables.

SASLockDetach
__C__ void SASLockDetach(void)
Detach the shared memory segment holding the SAS lock tables.

SASLockPrintDetailedStats
__C__ void SASLockPrintDetailedStats(void)
Print detailed Lock Statistic.

SASUnlock
__C__ void SASUnlock(vm_address_t addr)
UnLock a SAS Address.

__C__
#define __C__
ignore this macro behind the curtain
Definition: saslock.h:46

SasLockOwner
__C__ int SasLockOwner
Lock Segment Owner TRUE if this process was the first to run and created the lock segment...

SASLockPrintHighLevelStats
__C__ void SASLockPrintHighLevelStats(void)
Print High level Lock Statistic.

SASLock
__C__ void SASLock(vm_address_t addr, sas_userlock_request_t lockT)
Lock a SAS Address.