xref: /aosp_15_r20/external/cronet/third_party/ashmem/ashmem.h (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1 /* third_party/ashmem/ashmem.h
2  **
3  ** Copyright 2008 The Android Open Source Project
4  **
5  ** This file is dual licensed.  It may be redistributed and/or modified
6  ** under the terms of the Apache 2.0 License OR version 2 of the GNU
7  ** General Public License.
8  */
9 
10 #ifndef _THIRD_PARTY_ASHMEM_H
11 #define _THIRD_PARTY_ASHMEM_H
12 
13 #include <stddef.h>
14 
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18 
19 /* Returns true if the ashmem device is supported on this device.
20  * Not that even if the device is not supported,
21  * ashmem_{create,set_prot,get_prot,get_size}_region() will still work
22  * because they will use the ASharedMemory functions from libandroid.so
23  * instead. But ashmem_{pin,unpin}_region() will be no-ops.
24  */
25 int ashmem_device_is_supported(void);
26 
27 int ashmem_create_region(const char *name, size_t size);
28 int ashmem_set_prot_region(int fd, int prot);
29 int ashmem_get_prot_region(int fd);
30 int ashmem_pin_region(int fd, size_t offset, size_t len);
31 int ashmem_unpin_region(int fd, size_t offset, size_t len);
32 int ashmem_get_size_region(int fd);
33 
34 #ifdef __cplusplus
35 }
36 #endif
37 
38 #ifndef __ASHMEMIOC	/* in case someone included <linux/ashmem.h> too */
39 
40 #define ASHMEM_NAME_LEN		256
41 
42 #define ASHMEM_NAME_DEF		"dev/ashmem"
43 
44 /* Return values from ASHMEM_PIN: Was the mapping purged while unpinned? */
45 #define ASHMEM_NOT_PURGED	0
46 #define ASHMEM_WAS_PURGED	1
47 
48 /* Return values from ASHMEM_UNPIN: Is the mapping now pinned or unpinned? */
49 #define ASHMEM_IS_UNPINNED	0
50 #define ASHMEM_IS_PINNED	1
51 
52 #endif	/* ! __ASHMEMIOC */
53 
54 #endif	/* _THIRD_PARTY_ASHMEM_H */
55