dlt_shm.h

Go to the documentation of this file.

/*
 * @licence app begin@
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2011-2015, BMW AG
 *
 * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
 *
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License (MPL), v. 2.0.
 * If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * For further information see http://www.genivi.org/.
 * @licence end@
 */

/*******************************************************************************
**                                                                            **
**  SRC-MODULE: dlt_shm.h                                                     **
**                                                                            **
**  TARGET    : linux                                                         **
**                                                                            **
**  PROJECT   : DLT                                                           **
**                                                                            **
**  AUTHOR    : Alexander Wenzel Alexander.AW.Wenzel@bmw.de                   **
**                                                                            **
**  PURPOSE   :                                                               **
**                                                                            **
**  REMARKS   :                                                               **
**                                                                            **
**  PLATFORM DEPENDANT [yes/no]: yes                                          **
**                                                                            **
**  TO BE CHANGED BY USER [yes/no]: no                                        **
**                                                                            **
*******************************************************************************/

/*******************************************************************************
**                      Author Identity                                       **
********************************************************************************
**                                                                            **
** Initials     Name                       Company                            **
** --------     -------------------------  ---------------------------------- **
**  aw          Alexander Wenzel           BMW                                **
*******************************************************************************/

#ifndef DLT_SHM_H
#define DLT_SHM_H

#include "dlt_common.h"

/* shared memory key */
/* must be the same for server and cleint */
#define DLT_SHM_KEY    11771

/* default size of shared memory */
/* size is extended during creation to fit segment size */
/* client retreives real size from shm buffer */
#define DLT_SHM_SIZE   100000

/* Id of the used semaphore */
/* used for synchronisation of write and read access of multiple clients and server */
/* must be the same for server and client */
#define DLT_SHM_SEM    22771

#define DLT_SHM_HEAD   "SHM"

typedef struct
{
    int shmid;        /* Id of shared memory */
    int semid;        /* Id of semaphore */
    DltBuffer buffer;
} DltShm;

typedef struct
{
    char head[4];
    unsigned char status;
    int size;
} DltShmBlockHead;

#define DLT_SHM_SEM_GET(id) dlt_shm_pv(id,-1)
#define DLT_SHM_SEM_FREE(id) dlt_shm_pv(id,1)

extern DltReturnValue dlt_shm_init_client(DltShm *buf,int key);

extern DltReturnValue dlt_shm_init_server(DltShm *buf,int key,int size);

extern int dlt_shm_push(DltShm *buf,const unsigned char *data1,unsigned int size1,const unsigned char *data2,unsigned int size2,const unsigned char *data3,unsigned int size3);

extern int dlt_shm_pull(DltShm *buf,unsigned char *data, int size);

extern int dlt_shm_copy(DltShm *buf,unsigned char *data, int size);

extern int dlt_shm_remove(DltShm *buf);

extern void dlt_shm_info(DltShm *buf);

extern void dlt_shm_status(DltShm *buf);

extern DltReturnValue dlt_shm_free_client(DltShm *buf);

extern int dlt_shm_get_total_size(DltShm *buf);

extern int dlt_shm_get_used_size(DltShm *buf);

extern int dlt_shm_get_message_count(DltShm *buf);

extern int dlt_shm_reset(DltShm *buf);

extern int dlt_shm_recover(DltShm *buf);

extern int dlt_shm_free_server(DltShm *buf);

#endif /* DLT_SHM_H */