1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/**
* @licence app begin@
* Copyright (C) 2012 BMW AG
*
* This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.
*
* Contributions are licensed to the GENIVI Alliance under one or more
* Contribution License Agreements.
*
* \copyright
* This Source Code Form is subject to the terms of the
* Mozilla Public License, 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/.
*
*
* \author Alexander Wenzel <alexander.wenzel@bmw.de> BMW 2011-2012
*
* \file dlt_user_shared.h
* For further information see http://www.genivi.org/.
* @licence end@
*/
/*******************************************************************************
** **
** SRC-MODULE: dlt_user_shared.h **
** **
** TARGET : linux **
** **
** PROJECT : DLT **
** **
** AUTHOR : Alexander Wenzel Alexander.AW.Wenzel@bmw.de **
** Markus Klein **
** **
** PURPOSE : **
** **
** REMARKS : **
** **
** PLATFORM DEPENDANT [yes/no]: yes **
** **
** TO BE CHANGED BY USER [yes/no]: no **
** **
*******************************************************************************/
/*******************************************************************************
** Author Identity **
********************************************************************************
** **
** Initials Name Company **
** -------- ------------------------- ---------------------------------- **
** aw Alexander Wenzel BMW **
** mk Markus Klein Fraunhofer ESK **
*******************************************************************************/
/*******************************************************************************
** Author Identity **
********************************************************************************
** **
** Initials Name Company **
** -------- ------------------------- ---------------------------------- **
** aw Alexander Wenzel BMW **
** mk Markus Klein Fraunhofer ESK **
*******************************************************************************/
#ifndef DLT_USER_SHARED_H
#define DLT_USER_SHARED_H
#include "dlt_types.h"
#include "dlt_user.h"
#include <sys/types.h>
/**
* This are the return values for the functions dlt_user_log_out2() and dlt_user_log_out3()
*/
typedef enum
{
DLT_RETURN_PIPE_FULL = -3,
DLT_RETURN_PIPE_ERROR = -2,
DLT_RETURN_ERROR = -1,
DLT_RETURN_OK = 0
} DltReturnValue;
/**
* This is the header of each message to be exchanged between application and daemon.
*/
typedef struct
{
char pattern[DLT_ID_SIZE]; /**< This pattern should be DUH0x01 */
uint32_t message; /**< messsage info */
} PACKED DltUserHeader;
/**
* This is the internal message content to exchange control msg register app information between application and daemon.
*/
typedef struct
{
char apid[DLT_ID_SIZE]; /**< application id */
pid_t pid; /**< process id of user application */
uint32_t description_length; /**< length of description */
} PACKED DltUserControlMsgRegisterApplication;
/**
* This is the internal message content to exchange control msg unregister app information between application and daemon.
*/
typedef struct
{
char apid[DLT_ID_SIZE]; /**< application id */
pid_t pid; /**< process id of user application */
} PACKED DltUserControlMsgUnregisterApplication;
/**
* This is the internal message content to exchange control msg register information between application and daemon.
*/
typedef struct
{
char apid[DLT_ID_SIZE]; /**< application id */
char ctid[DLT_ID_SIZE]; /**< context id */
int32_t log_level_pos; /**< offset in management structure on user-application side */
int8_t log_level; /**< log level */
int8_t trace_status; /**< trace status */
pid_t pid; /**< process id of user application */
uint32_t description_length; /**< length of description */
} PACKED DltUserControlMsgRegisterContext;
/**
* This is the internal message content to exchange control msg unregister information between application and daemon.
*/
typedef struct
{
char apid[DLT_ID_SIZE]; /**< application id */
char ctid[DLT_ID_SIZE]; /**< context id */
pid_t pid; /**< process id of user application */
} PACKED DltUserControlMsgUnregisterContext;
/**
* This is the internal message content to exchange control msg log level information between application and daemon.
*/
typedef struct
{
uint8_t log_level; /**< log level */
uint8_t trace_status; /**< trace status */
int32_t log_level_pos; /**< offset in management structure on user-application side */
} PACKED DltUserControlMsgLogLevel;
/**
* This is the internal message content to exchange control msg injection information between application and daemon.
*/
typedef struct
{
int32_t log_level_pos; /**< offset in management structure on user-application side */
uint32_t service_id; /**< service id of injection */
uint32_t data_length_inject; /**< length of injection message data field */
} PACKED DltUserControlMsgInjection;
/**
* This is the internal message content to exchange information about application log level and trace stats between
* application and daemon.
*/
typedef struct
{
char apid[DLT_ID_SIZE]; /**< application id */
uint8_t log_level; /**< log level */
uint8_t trace_status; /**< trace status */
} PACKED DltUserControlMsgAppLogLevelTraceStatus;
/**
* This is the internal message content to set the logging mode: off, external, internal, both.
*/
typedef struct
{
int8_t log_mode; /**< the mode to be used for logging: off, external, internal, both */
} PACKED DltUserControlMsgLogMode;
/**
* This is the internal message content to get the logging state: 0 = off, 1 = external client connected.
*/
typedef struct
{
int8_t log_state; /**< the state to be used for logging state: 0 = off, 1 = external client connected */
} PACKED DltUserControlMsgLogState;
/**************************************************************************************************
* The folowing functions are used shared between the user lib and the daemon implementation
**************************************************************************************************/
/**
* Set user header marker and store message type in user header
* @param userheader pointer to the userheader
* @param mtype user message type of internal message
* @return negative value if there was an error {
return -1;
}
*/
int dlt_user_set_userheader(DltUserHeader *userheader, uint32_t mtype);
/**
* Check if user header contains its marker
* @param userheader pointer to the userheader
* @return 0 no, 1 yes, negative value if there was an error
*/
int dlt_user_check_userheader(DltUserHeader *userheader);
/**
* Atomic write to file descriptor, using vector of 2 elements
* @param handle file descriptor
* @param ptr1 generic pointer to first segment of data to be written
* @param len1 length of first segment of data to be written
* @param ptr2 generic pointer to second segment of data to be written
* @param len2 length of second segment of data to be written
* @return Value from DltReturnValue enum
*/
DltReturnValue dlt_user_log_out2(int handle, void *ptr1, size_t len1, void* ptr2, size_t len2);
/**
* Atomic write to file descriptor, using vector of 3 elements
* @param handle file descriptor
* @param ptr1 generic pointer to first segment of data to be written
* @param len1 length of first segment of data to be written
* @param ptr2 generic pointer to second segment of data to be written
* @param len2 length of second segment of data to be written
* @param ptr3 generic pointer to third segment of data to be written
* @param len3 length of third segment of data to be written
* @return Value from DltReturnValue enum
*/
DltReturnValue dlt_user_log_out3(int handle, void *ptr1, size_t len1, void* ptr2, size_t len2, void *ptr3, size_t len3);
#endif /* DLT_USER_SHARED_H */
|
