[deb_libhybris.git] / hybris / common / hooks_shm.h

/*
 * Copyright (c) 2012 Carsten Munk <carsten.munk@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef HOOKS_SHM_H_
#define HOOKS_SHM_H_

#include <stddef.h>

typedef unsigned int hybris_shm_pointer_t;

/* 
 * Allocate a space in the shared memory region of hybris
 */
hybris_shm_pointer_t hybris_shm_alloc(size_t size);
/* 
 * Test if the pointers points to the shm region
 */
int hybris_is_pointer_in_shm(void *ptr);
/* 
 * Convert an offset pointer to the shared memory to an absolute pointer that can be used in user space 
 * This function will return a NULL pointer if the handle does not actually point to the shm region
 */
void *hybris_get_shmpointer(hybris_shm_pointer_t handle);

#endif

// vim:ts=4:sw=4:noexpandtab
Commit	Line	Data
d42e7319 JB	1	/*
	2	* Copyright (c) 2012 Carsten Munk <carsten.munk@gmail.com>
	3	*
	4	* Licensed under the Apache License, Version 2.0 (the "License");
	5	* you may not use this file except in compliance with the License.
	6	* You may obtain a copy of the License at
	7	*
	8	* http://www.apache.org/licenses/LICENSE-2.0
	9	*
	10	* Unless required by applicable law or agreed to in writing, software
	11	* distributed under the License is distributed on an "AS IS" BASIS,
	12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	13	* See the License for the specific language governing permissions and
	14	* limitations under the License.
	15	*
	16	*/
	17
	18	#ifndef HOOKS_SHM_H_
	19	#define HOOKS_SHM_H_
	20
	21	#include <stddef.h>
	22
	23	typedef unsigned int hybris_shm_pointer_t;
	24
	25	/*
	26	* Allocate a space in the shared memory region of hybris
	27	*/
	28	hybris_shm_pointer_t hybris_shm_alloc(size_t size);
	29	/*
	30	* Test if the pointers points to the shm region
	31	*/
	32	int hybris_is_pointer_in_shm(void *ptr);
	33	/*
	34	* Convert an offset pointer to the shared memory to an absolute pointer that can be used in user space
	35	* This function will return a NULL pointer if the handle does not actually point to the shm region
	36	*/
	37	void *hybris_get_shmpointer(hybris_shm_pointer_t handle);
	38
	39	#endif
	40
	41	// vim:ts=4:sw=4:noexpandtab