summaryrefslogtreecommitdiff
path: root/src/shared/dlt_offline_trace.c
blob: 760884f5bc75e48332e531c29a196cabc2856cff (plain)
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
255
256
257
258
259
260
261
262
263
264
265
/*
 * @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@
 */

/*!
 * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de>
 *
 * \copyright Copyright © 2015 BMW AG. \n
 * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/.
 *
 * \file dlt_offline_trace.c
 */

/*******************************************************************************
**                                                                            **
**  SRC-MODULE: dlt_offline_trace.c                                           **
**                                                                            **
**  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                                **
*******************************************************************************/

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <dirent.h>
   
#include <dlt_offline_trace.h>

int dlt_offline_trace_create_new_file(DltOfflineTrace *trace) {
    time_t t;
    struct tm *tmp;
    char outstr[200];

	/* set filename */
    t = time(NULL);
    tmp = localtime(&t);
    if (NULL == tmp) {
        printf("dlt_offline_trace_create_new_file: pointer to tmp is NULL!");
        return -1;
    }
    if (strftime(outstr, sizeof(outstr),"%Y%m%d_%H%M%S", tmp) == 0) {
    }
	snprintf(trace->filename,NAME_MAX + 1,"%s/dlt_offlinetrace_%s.dlt",trace->directory,outstr);

    /* open DLT output file */
	trace->ohandle = open(trace->filename,O_WRONLY|O_CREAT, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH); /* mode: wb */
	if (trace->ohandle == -1)
	{
		/* trace file cannot be opened */
		printf("Offline trace file %s cannot be created\n",trace->filename);
		return -1;
	} /* if */

	return 0; /* OK */	
}

unsigned long dlt_offline_trace_get_total_size(DltOfflineTrace *trace) {
	struct dirent *dp;
	char filename[256];
	unsigned long size = 0;
	struct stat status;

	/* go through all dlt files in directory */
	DIR *dir = opendir(trace->directory);
	while ((dp=readdir(dir)) != NULL) {
        if(strstr(dp->d_name,".dlt"))
        {
            int res = snprintf(filename, sizeof(filename), "%s/%s",trace->directory,dp->d_name);
            // if the total length of the string is greater than the buffer, silently forget it.
            // snprintf: a return value of size  or more means that the output was truncated
            //           if an output error is encountered, a negative value is returned.
            if( (unsigned int)res<sizeof(filename) && res>0 )
            {
            	if(0 == stat(filename,&status))
            	{
            		size += status.st_size;
            	}
            	else
            		printf("Offline trace file %s cannot be stat-ed",filename);
            }
            //else
            //{
            //    dlt_log(3, "dlt_offline_trace_get_total_size: long filename ignored");
            //}
        }
    }

	closedir(dir);
	
	/* return size */
	return size; 
}

int dlt_offline_trace_delete_oldest_file(DltOfflineTrace *trace) {
	struct dirent *dp;
	char filename[PATH_MAX+1];
	char filename_oldest[PATH_MAX+1];
	unsigned long size_oldest = 0;
	struct stat status;
	time_t time_oldest = 0;

	filename[0] = 0;
	filename_oldest[0] = 0;

	/* go through all dlt files in directory */
	DIR *dir = opendir(trace->directory);
	while ((dp=readdir(dir)) != NULL) {
		if(strstr(dp->d_name,".dlt")) {
			int res = snprintf(filename, sizeof(filename), "%s/%s",trace->directory,dp->d_name);
				// if the total length of the string is greater than the buffer, silently forget it.
				// snprintf: a return value of size  or more means that the output was truncated
				//           if an output error is encountered, a negative value is returned.
				if( (unsigned int)res<sizeof(filename) && res>0 )
				{
					if(0 == stat(filename,&status))
					{
						if(time_oldest == 0 || status.st_mtime < time_oldest) {
								time_oldest = status.st_mtime;
								size_oldest = status.st_size;
								strncpy(filename_oldest,filename,PATH_MAX);
								filename_oldest[PATH_MAX]=0;
						}
					}
					else
						printf("Old offline trace file %s cannot be stat-ed",filename);
				}
		}
	}	
	closedir(dir);
	
	/* delete file */
	if(filename_oldest[0]) {
		if(remove(filename_oldest)) {
			printf("Remove file %s failed!\n",filename_oldest);
			return -1; /* ERROR */
		}
	}
	else {
			printf("No file to be removed!\n");
			return -1; /* ERROR */
	}
	
	/* return size of deleted file*/
	return size_oldest; 
}

int dlt_offline_trace_check_size(DltOfflineTrace *trace) {
	
	/* check size of complete offline trace */
	while((int)dlt_offline_trace_get_total_size(trace) > (trace->maxSize-trace->fileSize))
	{
		/* remove oldest files as long as new file will not fit in completely into complete offline trace */
		if(dlt_offline_trace_delete_oldest_file(trace)<0) {
			return -1;
		}
	}
	
	return 0; /* OK */	
}
	
int dlt_offline_trace_init(DltOfflineTrace *trace,const char *directory,int fileSize,int maxSize) {

	/* init parameters */
    strncpy(trace->directory,directory,NAME_MAX);
    trace->directory[NAME_MAX]=0;
	trace->fileSize = fileSize;
	trace->maxSize = maxSize;

	/* check complete offlien trace size, remove old logs if needed */
	dlt_offline_trace_check_size(trace);

	return dlt_offline_trace_create_new_file(trace);
}

int dlt_offline_trace_write(DltOfflineTrace *trace,unsigned char *data1,int size1,unsigned char *data2,int size2,unsigned char *data3,int size3) {

	if(trace->ohandle <= 0)
		return -1;

	/* check file size here */
	if((lseek(trace->ohandle,0,SEEK_CUR)+size1+size2+size3)>=trace->fileSize)
	{
		/* close old file */
		close(trace->ohandle);
        trace->ohandle = -1;
		
		/* check complete offline trace size, remove old logs if needed */
		dlt_offline_trace_check_size(trace);
		
		/* create new file */
		dlt_offline_trace_create_new_file(trace);
	}
	
	/* write data into log file */
        if(data1 && (trace->ohandle >= 0)) {
		if(write(trace->ohandle,data1,size1)!=size1) {
			printf("Offline trace write failed!\n");
			return -1;			
		}
	}
        if(data2 && (trace->ohandle >= 0)) {
		if(write(trace->ohandle,data2,size2)!=size2) {
			printf("Offline trace write failed!\n");
			return -1;						
		}
	}
        if(data3 && (trace->ohandle >= 0)) {
		if(write(trace->ohandle,data3,size3)!=size3) {
			printf("Offline trace write failed!\n");
			return -1;						
		}
	}

	return 0; /* OK */
}

int dlt_offline_trace_free(DltOfflineTrace *trace) {

	if(trace->ohandle <= 0)
		return -1;
	
	/* close last used log file */
	close(trace->ohandle);

	return 0; /* OK */
}