blob: 49f58588767f9c3949fff5d4270c85d1682ae974 [file] [log] [blame]
/*
* Copyright 2012, Google Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
* OWNER 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.
*/
#ifndef MOSYS_IPC_LOCK_H__
#define MOSYS_IPC_LOCK_H__
#include <sys/ipc.h>
#include <unistd.h>
/* a mosys lock */
struct ipc_lock {
int is_held; /* mosys internal */
/* Used by SysV semaphore */
key_t key; /* provided by the developer */
int sem; /* mosys internal */
/* Used by file lock */
char *filename; /* provided by the developer */
int fd; /* mosys internal */
};
/* don't use C99 initializers here, so this can be used in C++ code */
#define SYSV_IPC_LOCK_INIT(key) \
{ \
0, /* is_held */ \
key, /* key */ \
-1, /* sem */ \
NULL, /* filename */ \
-1, /* fd */ \
}
#define LOCKFILE_INIT(lockfile) \
{ \
0, /* is_held */ \
0, /* key */ \
0, /* sem */ \
lockfile, /* filename */ \
-1, /* fd */ \
}
/*
* mosys_lock: acquire a mosys lock
*
* timeout <0 = no timeout (try forever)
* timeout 0 = do not wait (return immediately)
* timeout >0 = wait up to $timeout milliseconds (subject to kernel scheduling)
*
* return 0 = lock acquired
* return >0 = lock was already held
* return <0 = failed to acquire lock
*/
extern int mosys_lock(struct ipc_lock *lock, int timeout_msecs);
/*
* mosys_unlock: release a mosys lock
*
* returns 0 if lock was released successfully
* returns -1 if lock had not been held before the call
*/
extern int mosys_unlock(struct ipc_lock *lock);
#endif /* MOSYS_IPC_LOCK_H__ */