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
|
#ifndef PERSISTENCE_CLIENT_LIBRARY_FILE_H
#define PERSISTENCE_CLIENT_LIBRARY_FILE_H
/******************************************************************************
* Project Persistency
* (c) copyright 2011
* Company XS Embedded GmbH
*****************************************************************************/
/******************************************************************************
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
******************************************************************************/
/**
* @file persistence_client_library_file.h
* @ingroup Persistence client library
* @author Ingo Huerner (XSe) / Guy Sagnes (Continental)
* @brief Header of the persistence client library.
* Library provides an API to access persistent data
* @see
*/
/** \ingroup SSW_PERS */
/** \defgroup SSW_PERS_FILE Client: File access
* \{
*/
/** \defgroup SSW_PERS_FILE_INTERFACE API document
* \{
*/
#ifdef __cplusplus
extern "C" {
#endif
#define PERSIST_FILEAPI_INTERFACE_VERSION (0x01000000U)
/**
* @brief close the given POSIX file descriptor
*
* @param fd the file descriptor to close
*
* @return zero on success. On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS
*/
int file_close(int fd);
/**
* @brief get the size of the file given by the file descriptor
*
* @param fd the POSIX file descriptor
*
* @return positive value. On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS
*/
int file_get_size(int fd);
/**
* @brief map a file into the memory
*
* @param addr if NULL, kernel chooses address
* @param size the size in bytes to map into the memory
* @param offset in the file to map
* @param fd the POSIX file descriptor of the file to map
*
* @return a pointer to the mapped area, or on error the value MAP_FAILED or
* EPERS_MAP_FAILEDLOCK if filesystem is currrently locked
*/
void* file_map_data(void* addr, long size, long offset, int fd);
/**
* @brief open a file
*
* @param ldbid logical database ID
* @param resource_id the resource ID
* @param user_no the user ID
* @param seat_no the seat number (seat 0 to 3)
*
* @return positive value: the POSIX file descriptor;
* On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS, EPERS_MAXHANDLE, EPERS_NOKEY, EPERS_NOKEYDATA, EPERS_NOPRCTABLE or EPERS_COMMON,
*/
int file_open(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no);
/**
* @brief read persistent data from a file
*
* @param fd POSIX file descriptor
* @param buffer buffer to read the data
* @param buffer_size the size buffer for reading
*
* @return positive value: the size read;
* On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS or EPERS_COMMON
*/
int file_read_data(int fd, void * buffer, unsigned long buffer_size);
/**
* @brief remove the file
*
* @param ldbid logical database ID
* @param resource_id the resource ID
* @param user_no the user ID
* @param seat_no the seat number (seat 0 to 3)
*
* @return positive value: success;
* On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS or EPERS_COMMON
*/
int file_remove(unsigned char ldbid, char* resource_id, unsigned char user_no, unsigned char seat_no);
/**
* @brief reposition the file descriptor
*
* @param fd the POSIX file descriptor
* @param offset the reposition offset
* @param whence the direction to reposition
SEEK_SET
The offset is set to offset bytes.
SEEK_CUR
The offset is set to its current location plus offset bytes.
SEEK_END
The offset is set to the size of the file plus offset bytes.
*
* @return positive value: resulting offset location;
* On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS or EPERS_COMMON
*/
int file_seek(int fd, long int offset, int whence);
/**
* @brief unmap the file from the memory
*
* @param address the address to unmap
* @param size the size in bytes to unmap
*
* @return on success 0;
* On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS or EPERS_COMMON
*/
int file_unmap_data(void* address, long size);
/**
* @brief write persistent data to file
*
* @param fd the POSIX file descriptor
* @param buffer the buffer to write
* @param buffer_size the size of the buffer to write in bytes
*
* @return positive value: bytes written;
* On error a negative value will be returned with th follwoing error codes:
* EPERS_LOCKFS or EPERS_COMMON
*/
int file_write_data(int fd, const void * buffer, unsigned long buffer_size);
#ifdef __cplusplus
}
#endif
/** \} */ /* End of API */
/** \} */ /* End of MODULE */
#endif /* PERSISTENCY_CLIENT_LIBRARY_FILE_H */
|
