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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/** \mainpage DLT Filetransfer Main documentation page
\section Introduction Introduction
DLT Filetransfer enables the feature to store the binary data of a file to the automotive dlt log. The file will
be read in binary mode and put as payload to a DLT_INFO log. With a special plugin of the dlt viewer, you can
extract the file from the trace and save it to your hard disk.
\section Protocol Protocol
The file transfer is at least one single transaction. This transaction consist of three main types of packages:
\li header package
\li one or more data packages
\li end package
The following section explains more about the content of each package.
\subsection Header Header Package
Every filetransfer must begin with the header package using:
\code
int dlt_user_log_file_header(DltContext *fileContext,const char *filename)
\endcode
Here's the conent of the header package:
\code
|----------------------------------------------------|
| FLST | Package flag
|----------------------------------------------------|
| fileserialnumber | Inode of the file used as file serialnumber
|----------------------------------------------------|
| filename | Use the absolute filepath to the file
|----------------------------------------------------|
| filesize | Filesize of the file
|----------------------------------------------------|
| file creation date | Creation date of the file
|----------------------------------------------------|
| number of packages | Counted packages which will be transferred in the data packages
|----------------------------------------------------|
| BUFFER_SIZE | Defined buffer size to reconstruct the file
|----------------------------------------------------|
| FLST | Package flag
|----------------------------------------------------|
\endcode
\subsection Data Data Package
After the header package was sent, at least one or more data packages can be send using:
\code
int dlt_user_log_file_data(DltContext *fileContext,const char *filename, int packageToTransfer, int timeout)
\endcode
Here's the conent of the data package:
\code
|----------------------------------------------------|
| FLDA | Package flag
|----------------------------------------------------|
| fileserialnumber | Inode of the file used as file serialnumber
|----------------------------------------------------|
| PackageNumber | Transferred package
|----------------------------------------------------|
| Data | Payload containing data
|----------------------------------------------------|
| FLDA | Package flag
|----------------------------------------------------|
\endcode
\subsection End End Package
After all data packages were sent, the end package must be sent to indicate that the filetransfer is over using:
\code
int dlt_user_log_file_end(DltContext *fileContext,const char *filename,int deleteFlag)
\endcode
Here's the conent of the end package:
\code
|----------------------------------------------------|
| FLFI | Package flag
|----------------------------------------------------|
| fileserialnumber | Inode of the file
|----------------------------------------------------|
| FLFI | Package flag
|----------------------------------------------------|
\endcode
\subsection File information
The library offers the user the possibility to log informations about a file using the following method without transferring the file itself using:
\code
dlt_user_log_file_infoAbout(DltContext *fileContext, const char *filename)
\endcode
Here is the content of the information package:
\code
|----------------------------------------------------|
| FLIF | Package flag
|----------------------------------------------------|
| fileserialnumber | Inode of the file used as file serialnumber
|----------------------------------------------------|
| filename | Use the absolute filepath to the file
|----------------------------------------------------|
| filesize | Filesize of the file
|----------------------------------------------------|
| file creation date | Creation date of the file
|----------------------------------------------------|
| number of packages | Counted packages which will be transferred in the data packages
|----------------------------------------------------|
| FLIF | Package flag
|----------------------------------------------------|
\endcode
\subsection File transfer error
\code
#define ERROR_FILE_COMPLETE -300
#define ERROR_FILE_COMPLETE1 -301
#define ERROR_FILE_COMPLETE2 -302
#define ERROR_FILE_COMPLETE3 -303
#define ERROR_FILE_HEAD -400
#define ERROR_FILE_DATA -500
#define ERROR_FILE_END -600
#define ERROR_INFO_ABOUT -700
#define ERROR_PACKAGE_COUNT -800
\endcode
If an error happens during file transfer, the library will execute the mehtod:
\code
void dlt_user_log_file_errorMessage(DltContext *fileContext, const char *filename, int errorCode)
\endcode
Here is the content of the error package:
\code
|----------------------------------------------------|
| FLER | Package flag
|----------------------------------------------------|
| error code | see error codes above
|----------------------------------------------------|
| linux error code | standard linux error code
|----------------------------------------------------|
| fileserialnumber | Inode of the file used as file serialnumber
|----------------------------------------------------|
| filename | Use the absolute filepath to the file
|----------------------------------------------------|
| filesize | Filesize of the file
|----------------------------------------------------|
| file creation date | Creation date of the file
|----------------------------------------------------|
| number of packages | Counted packages which will be transferred in the data packages
|----------------------------------------------------|
| FLER | Package flag
|----------------------------------------------------|
\endcode
If the file doesn't exist, the conent of the error package is a little bit different:
\code
|----------------------------------------------------|
| FLER | Package flag
|----------------------------------------------------|
| error code | see error codes above
|----------------------------------------------------|
| linux error code | standard linux error code
|----------------------------------------------------|
| filename | Use the absolute filepath to the file
|----------------------------------------------------|
| FLER | Package flag
|----------------------------------------------------|
\endcode
\section Compile
Use the following commands to compile the dlt filetransfer:
\code
mkdir build
cd build
cmake ..
make
sudo make install
\endcode
If you want to generate the doc, you must set ENABLE_BUILD_DOC=ON at cmake.
\section Using Using DLT Filetransfer
There are two ways to use the filetransfer
\li Automatic filetransfer in one step (this is the easiest way to go)
\li Header, data and end package order handeld by the user
\subsection Automatic Automatic
If you won't want to carry about the header, data and end packages ordering, you should use
this method call
\li dlt_user_log_file_complete
The method needs the following arguments:
\li fileContext -> Context for logging the file to dlt
\li filename -> Use the absolute file path to the file
\li deleteFlag -> Flag if the file will be deleted after transfer. 1->delete, 0->notDelete
\li timeout -> Timeout in ms to wait between some logs. Important: The FIFO of dlt should not be flooded with to many messages in a short period of time. The timeout can not be smaller than MIN_TIMEOUT.
The order of the packages is to send at first the header, then one or more data packages (depends on the filesize) and in the end the end package.
The advantage of this method is, that you must not handle the package ordering by your own.
\subsection Manual Manual
Manual starting filetransfer with the following commands:
\li dlt_user_log_file_head | Transfers only the header of the file
\li dlt_user_log_file_data | Transfers only one single package of a file
\li dlt_user_log_file_end | Tranfers only the end of the file
This ordering is very important, so that you can save the transferred files to hard disk on client side with a dlt viewer plugin.
The advantage of using several steps to transfer files by your own is, that you are very flexible to integrate the filetransfer
in your code.
\subsection Important Important for integration
You should care about blocking the main program when you intergrate filetransfer in your code.
Maybe it's useful to extract the filetransfer in an extra thread.
Another point is the filesize. The bigger the file is, the longer takes it to log the file to dlt.
\section Example Example dlt filetransfer
For an example file transfer you can use
\code
Usage: dlt-example-filetransfer [options] <command>
Filetransfer example with DLT Package Version: 2.2.0 , Package Revision: 1666, build on May 28 2011 02:18:19
Command:
-f file - File to transfer (absolute path)
Options:
-a apid - Set application id to apid (default: FLTR)
-c ctid - Set context id to ctid (default: FLTR)
-t ms - Timeout between file packages in ms (minimum 20 ms)
-d - Flag to delete the file after the transfer (default: false)
-i - Flag to log file infos to DLT before transfer file (default: false)
-h - This help
\endcode
\section Test Testing dlt filetransfer
When you call "sudo make install", some automatic tests will be installed. Start the test using the following command from bash:
\code
dlt-test-filetransfer
\endcode
It's important that the dlt-filetransfer example files are installed in /usr/share/dlt-filetransfer which will be done automatically by using "sudo make install".
\subsection testF1P1
Test the file transfer with the condition that the transferred file is smaller as the file transfer buffer using dlt_user_log_file_complete.
\subsection testF1P2
Test the file transfer with the condition that the transferred file is smaller as the file transfer buffer using single package transfer
\subsection testF2P1
Test the file transfer with the condition that the transferred file is bigger as the file transfer buffer using dlt_user_log_file_complete.
\subsection testF2P2
Test the file transfer with the condition that the transferred file is bigger as the file transfer buffer using single package transfer
\subsection testF3P1
Test the file transfer with the condition that the transferred file does not exist using dlt_user_log_file_complete.
\subsection testF3P2
Test the file transfer with the condition that the transferred file does not exist using single package transfer
\subsection testF3P3
Test which logs some information about the file.
\section Requirements Requirements
\code
automotive-dlt
\endcode
<hr>
\section Licence Licence
Copyright 2011 - BMW AG, Christian Muck <christian.muck@bmw.de>
* */
|
