xref: /f-stack/lib/include/sys/_mutex.h (revision ebf5cedb)
1 /*
2  * Copyright (c) 2010 Kip Macy All rights reserved.
3  * Copyright (c) 2013 Patrick Kelsey. All rights reserved.
4  * Copyright (C) 2017 THL A29 Limited, a Tencent company.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  *   list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  *   this list of conditions and the following disclaimer in the documentation
14  *   and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  */
28 
29 #ifndef _FSTACK_SYS__MUTEX_H_
30 #define _FSTACK_SYS__MUTEX_H_
31 
32 #include <machine/param.h>
33 
34 #include "ff_host_interface.h"
35 
36 /*
37  * Sleep/spin mutex
38  */
39 struct mtx {
40     struct lock_object lock_object;
41     ff_mutex_t mtx_lock;
42 };
43 
44 /*
45  * Members of struct mtx_padalign must mirror members of struct mtx.
46  * mtx_padalign mutexes can use the mtx(9) API transparently without
47  * modification.
48  */
49 struct mtx_padalign {
50     struct lock_object    lock_object;
51     ff_mutex_t    mtx_lock;
52 } __aligned(CACHE_LINE_SIZE);
53 
54 #endif    /* _FSTACK_SYS__MUTEX_H_ */
55