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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
|
/* Copyright (C) 2001-2020 Artifex Software, Inc.
All Rights Reserved.
This software is provided AS-IS with no warranty, either express or
implied.
This software is distributed under license and may not be copied,
modified or distributed except as expressly authorized under the terms
of the license contained in the file LICENSE in this distribution.
Refer to licensing information at http://www.artifex.com or contact
Artifex Software, Inc., 1305 Grant Avenue - Suite 200, Novato,
CA 94945, U.S.A., +1(415)492-9861, for further information.
*/
/* %rom% IODevice implementation for a compressed in-memory filesystem */
/*
* This file implements a special %rom% IODevice designed for embedded
* use. It accesses a compressed filesytem image which may be stored
* in literal ROM, or more commonly is just static data linked directly
* into the executable. This can be used for storing postscript library
* files, fonts, Resources or other data files that Ghostscript needs
* to run.
*/
#include "std.h"
#include "stdint_.h"
#include "string_.h"
#include "gsiorom.h"
#include "gx.h"
#include "gpcheck.h"
#include "gserrors.h"
#include "gsstruct.h"
#include "gsutil.h"
#include "gxiodev.h"
#include "stream.h"
#include "stat_.h"
#include "zlib.h"
/* device method prototypes */
static iodev_proc_init(romfs_init);
static iodev_proc_finit(romfs_finit);
static iodev_proc_open_file(romfs_open_file);
static iodev_proc_file_status(romfs_file_status);
static iodev_proc_enumerate_files(romfs_enumerate_files_init);
static iodev_proc_enumerate_next(romfs_enumerate_next);
static iodev_proc_enumerate_close(romfs_enumerate_close);
/* close is handled by stream closure */
/* device definition */
const gx_io_device gs_iodev_rom =
{
"%rom%", "FileSystem",
{romfs_init, romfs_finit, iodev_no_open_device,
romfs_open_file,
iodev_no_fopen, iodev_no_fclose,
iodev_no_delete_file, iodev_no_rename_file,
romfs_file_status,
romfs_enumerate_files_init, romfs_enumerate_next, romfs_enumerate_close,
iodev_no_get_params, iodev_no_put_params
},
NULL,
NULL
};
/* internal state for our device */
typedef struct romfs_state_s {
int atblock; /* for later when we decompress by blocks */
} romfs_state;
gs_private_st_simple(st_romfs_state, struct romfs_state_s, "romfs_state");
typedef struct romfs_file_enum_s {
char *pattern; /* pattern pointer */
int list_index; /* next node to visit */
gs_memory_t *memory; /* memory structure used */
} romfs_file_enum;
gs_private_st_ptrs1(st_romfs_file_enum, struct romfs_file_enum_s, "romfs_file_enum",
romfs_file_enum_enum_ptrs, romfs_file_enum_reloc_ptrs, pattern);
static uint32_t get_u32_big_endian(const uint32_t *a);
/* coverity[ -tainted_data_return ] */
/* coverity[ -tainted_data_argument : arg-0 ] */
static uint32_t
get_u32_big_endian(const uint32_t *a)
{
uint32_t v;
const unsigned char *c=(const unsigned char *)a;
v = (c[0]<<24) | (c[1]<<16) | (c[2]<<8) | c[3];
return v;
}
/* ------ Block streams, potentially compressed (read only) ------ */
/* String stream procedures */
static int
s_block_read_available(stream *, gs_offset_t *),
s_block_read_seek(stream *, gs_offset_t),
s_block_read_close(stream *),
s_block_read_process(stream_state *, stream_cursor_read *,
stream_cursor_write *, bool);
/* Initialize a stream for reading from a collection of blocks */
static void
sread_block(register stream *s, const byte *ptr, uint len, const uint32_t *node )
{
static const stream_procs p = {
s_block_read_available, s_block_read_seek, s_std_read_reset,
s_std_read_flush, s_block_read_close, s_block_read_process,
NULL /* no read_switch */
};
s_std_init(s, (byte *)ptr, len, &p, s_mode_read + s_mode_seek);
s->end_status = 0;
s->file = (gp_file *)node; /* convenient place to put it for %rom% files */
s->file_modes = s->modes;
s->file_offset = 0;
s->file_limit = S_FILE_LIMIT_MAX;
}
/* Return the number of available bytes */
static int
s_block_read_available(stream *s, gs_offset_t *pl)
{
uint32_t *node = (uint32_t *)s->file;
uint32_t filelen = get_u32_big_endian(node) & 0x7fffffff; /* ignore compression bit */
*pl = filelen - s->position - (sbufptr(s) - s->cbuf);
if (*pl == 0 && s->close_at_eod) /* EOF */
*pl = -1;
return 0;
}
/* Seek in a string being read. Return 0 if OK, ERRC if not. */
static int
s_block_read_seek(register stream * s, gs_offset_t pos)
{
uint32_t *node = (uint32_t *)s->file;
uint32_t filelen = get_u32_big_endian(node) & 0x7fffffff; /* ignore compression bit */
uint end = s->cursor.r.limit - s->cbuf + 1;
long offset = pos - s->position;
if (pos < 0 || pos > filelen)
return ERRC;
if (offset < 0 || offset > end) {
/* Need to pull a different block into the buffer */
stream_cursor_write pw;
/* buffer stays aligned to blocks */
offset = (s->file_offset + pos) % ROMFS_BLOCKSIZE;
s->position = pos - offset;
pw.ptr = s->cbuf - 1;
pw.limit = pw.ptr + s->cbsize;
s->cursor.r.ptr = s->cursor.r.limit = s->cbuf - 1;
if ((s->end_status = s_block_read_process((stream_state *)s, NULL, &pw, 0)) == ERRC)
return ERRC;
if (s->end_status == 1)
s->end_status = 0;
s->cursor.r.ptr = s->cbuf - 1;
s->cursor.r.limit = pw.ptr; /* limit of the block just read */
}
/* Now set the read pointer to the correct place in the buffer */
s->cursor.r.ptr = s->cbuf + offset - 1;
return 0;
}
static int
s_block_read_close(stream * s)
{
gs_free_object(s->memory, s->cbuf, "file_close(buffer)");
s->file = 0; /* disconnect the node */
/* Increment the IDs to prevent further access. */
s->read_id = s->write_id = (s->read_id | s->write_id) + 1;
return 0;
}
static int
s_block_read_process(stream_state * st, stream_cursor_read * ignore_pr,
stream_cursor_write * pw, bool last)
{
int code;
stream *s = (stream *)st; /* no separate state */
uint32_t *node = (uint32_t *)s->file;
uint max_count = pw->limit - pw->ptr;
int status = 1;
int compression = ((get_u32_big_endian(node) & 0x80000000) != 0) ? 1 : 0;
uint32_t filelen = get_u32_big_endian(node) & 0x7fffffff; /* ignore compression bit */
uint32_t blocks = (filelen+ROMFS_BLOCKSIZE-1) / ROMFS_BLOCKSIZE;
uint32_t iblock = (s->position + s->file_offset + (s->cursor.r.limit + 1 - s->cbuf)) / ROMFS_BLOCKSIZE;
uint32_t block_length = get_u32_big_endian(node+1+(2*iblock));
uint32_t block_offset = get_u32_big_endian(node+2+(2*iblock));
unsigned const char *block_data = ((unsigned char *)node) + block_offset;
int count = iblock < (blocks - 1) ? ROMFS_BLOCKSIZE : filelen - (ROMFS_BLOCKSIZE * iblock);
if (s->position + (s->cursor.r.limit - s->cbuf + 1) >= filelen || block_data == NULL)
return EOFC; /* at EOF */
if (s->file_limit < S_FILE_LIMIT_MAX) {
/* Adjust count for subfile limit */
uint32_t limit_count = s->file_offset + s->file_limit - s->position;
if (count > limit_count)
count = limit_count;
}
/* get the block into the buffer */
if (compression) {
unsigned long buflen = ROMFS_BLOCKSIZE;
byte *dest = (pw->ptr + 1); /* destination for unpack */
int need_copy = false;
/* If the dest is not in our buffer, we can only use it if there */
/* is enough space in it */
if ((dest < s->cbuf) || (dest >= (s->cbuf + s->cbsize))) {
/* the destination is _not_ in our buffer. If the area isn't */
/* big enough we need to ucompress to our buffer, then copy */
/* the data afterward. INVARIANT: if the buffer is outside */
/* the cbuf, then the cbuf must be empty. */
if (max_count < count) {
#ifdef DEBUG
if ((sbufptr(s)) != s->cursor.r.limit)
emprintf(s->memory, "cbuf not empty as expected\n.");
#endif
dest = s->cbuf;
need_copy = true;
}
}
/* Decompress the data into this block */
code = uncompress (dest, &buflen, block_data, block_length);
if (code != Z_OK || count != buflen)
return ERRC;
if (need_copy) {
memcpy(pw->ptr+1, dest, max_count);
count = max_count;
}
} else {
/* not compressed -- just copy it */
count = block_length;
if (count > max_count)
count = max_count;
memcpy(pw->ptr+1, block_data, count);
}
if (count < 0)
count = 0;
pw->ptr += count;
process_interrupts(s->memory);
return status;
}
static int
romfs_init(gx_io_device *iodev, gs_memory_t *mem)
{
romfs_state *state = gs_alloc_struct(mem, romfs_state, &st_romfs_state,
"romfs_init(state)");
if (!state)
return_error(gs_error_VMerror);
iodev->state = state;
return 0;
}
static void
romfs_finit(gx_io_device *iodev, gs_memory_t *mem)
{
gs_free_object(mem, iodev->state, "romfs_finit");
iodev->state = NULL;
return;
}
static int
romfs_open_file(gx_io_device *iodev, const char *fname, uint namelen,
const char *access, stream **ps, gs_memory_t *mem)
{
extern const uint32_t *gs_romfs[];
int code;
const uint32_t *node_scan = gs_romfs[0], *node = NULL;
uint32_t filelen, blocks;
int i;
char *filename;
char fmode[4] = "\000\000\000\000";
/* return an empty stream on error */
*ps = NULL;
/* scan the inodes to find the requested file */
for (i=0; node_scan != 0; i++, node_scan = gs_romfs[i]) {
filelen = get_u32_big_endian(node_scan) & 0x7fffffff; /* ignore compression bit */
blocks = (filelen+ROMFS_BLOCKSIZE-1)/ ROMFS_BLOCKSIZE;
filename = (char *)(&(node_scan[1+(2*blocks)]));
if ((namelen == strlen(filename)) &&
(strncmp(filename, fname, namelen) == 0)) {
node = node_scan;
break;
}
}
/* inode points to the file (or NULL if not found */
if (node == NULL)
return_error(gs_error_undefinedfilename);
/* Initialize a stream for reading this romfs file using a common function */
/* we get a buffer that is larger than what we need for decompression */
/* we need extra space since some filters may leave data in the buffer when */
/* calling 'read_process' */
code = file_prepare_stream(fname, namelen, access, ROMFS_BLOCKSIZE+256, ps, fmode, mem);
if (code < 0)
return code;
sread_block(*ps, (*ps)->cbuf, (*ps)->cbsize, node);
/* return success */
return 0;
}
static int
romfs_file_status(gx_io_device * iodev, const char *fname, struct stat *pstat)
{
extern const uint32_t *gs_romfs[];
extern const time_t gs_romfs_buildtime;
const uint32_t *node_scan = gs_romfs[0], *node = NULL;
uint32_t filelen, blocks;
int i;
char *filename;
uint namelen = strlen(fname);
/* a build time of zero indicates we have the "dummy" romfs
* used when COMPILE_INITS==0 - returning a specific error here
* gives us a quick way to check for that.
*/
if (gs_romfs_buildtime == (time_t)0) {
return_error(gs_error_unregistered);
}
memset(pstat, 0, sizeof(struct stat));
/* scan the inodes to find the requested file */
for (i=0; node_scan != 0; i++, node_scan = gs_romfs[i]) {
filelen = get_u32_big_endian(node_scan) & 0x7fffffff; /* ignore compression bit */
blocks = (filelen+ROMFS_BLOCKSIZE-1)/ ROMFS_BLOCKSIZE;
filename = (char *)(&(node_scan[1+(2*blocks)]));
if ((namelen == strlen(filename)) &&
(strncmp(filename, fname, namelen) == 0)) {
node = node_scan;
break;
}
}
/* inode points to the file (or NULL if not found */
if (node == NULL)
return_error(gs_error_undefinedfilename);
/* fill in the values used by zstatus */
pstat->st_size = filelen;
pstat->st_mtime = gs_romfs_buildtime;
pstat->st_ctime = gs_romfs_buildtime;
return 0; /* success */
}
static file_enum *
romfs_enumerate_files_init(gs_memory_t * mem, gx_io_device *iodev, const char *pat,
uint patlen)
{
romfs_file_enum *penum = gs_alloc_struct(mem, romfs_file_enum, &st_romfs_file_enum,
"romfs_enumerate_files_init(file_enum)");
if (penum == NULL)
return NULL;
memset(penum, 0, sizeof(romfs_file_enum));
penum->pattern = (char *)gs_alloc_bytes(mem, patlen+1, "romfs_enumerate_file_init(pattern)");
penum->list_index = 0; /* start at first node */
penum->memory = mem;
if (penum->pattern == NULL) {
romfs_enumerate_close(mem, (file_enum *) penum);
return NULL;
}
memcpy(penum->pattern, pat, patlen); /* Copy string to buffer */
penum->pattern[patlen]=0; /* Terminate string */
return (file_enum *)penum;
}
static void
romfs_enumerate_close(gs_memory_t * mem, file_enum *pfen)
{
romfs_file_enum *penum = (romfs_file_enum *)pfen;
gs_memory_t *mem2 = penum->memory;
(void)mem;
if (penum->pattern)
gs_free_object(mem2, penum->pattern, "romfs_enum_init(pattern)");
gs_free_object(mem2, penum, "romfs_enum_init(romfs_enum)");
}
static uint
romfs_enumerate_next(gs_memory_t * mem, file_enum *pfen, char *ptr, uint maxlen)
{
extern const uint32_t *gs_romfs[];
romfs_file_enum *penum = (romfs_file_enum *)pfen;
(void)mem;
while (gs_romfs[penum->list_index] != 0) {
const uint32_t *node = gs_romfs[penum->list_index];
uint32_t filelen = get_u32_big_endian(node) & 0x7fffffff; /* ignore compression bit */
uint32_t blocks = (filelen+ROMFS_BLOCKSIZE-1)/ ROMFS_BLOCKSIZE;
char *filename = (char *)(&(node[1+(2*blocks)]));
penum->list_index++; /* bump to next unconditionally */
if (string_match((byte *)filename, strlen(filename),
(byte *)penum->pattern,
strlen(penum->pattern), 0)) {
if (strlen(filename) < maxlen)
memcpy(ptr, filename, strlen(filename));
return strlen(filename); /* if > maxlen, caller will detect rangecheck */
}
}
/* ran off end of list, close the enum */
romfs_enumerate_close(mem, pfen);
return ~(uint)0;
}
int
romfs_file_len(gs_memory_t * mem, const char *fname)
{
extern const uint32_t *gs_romfs[];
extern const time_t gs_romfs_buildtime;
const uint32_t *node_scan = gs_romfs[0], *node = NULL;
uint32_t filelen, blocks;
int i;
char *filename;
uint namelen = strlen(fname);
/* a build time of zero indicates we have the "dummy" romfs
* used when COMPILE_INITS==0 - returning a specific error here
* gives us a quick way to check for that.
*/
if (gs_romfs_buildtime == (time_t)0) {
return_error(gs_error_unregistered);
}
/* scan the inodes to find the requested file */
for (i=0; node_scan != 0; i++, node_scan = gs_romfs[i]) {
filelen = get_u32_big_endian(node_scan) & 0x7fffffff; /* ignore compression bit */
blocks = (filelen+ROMFS_BLOCKSIZE-1)/ ROMFS_BLOCKSIZE;
filename = (char *)(&(node_scan[1+(2*blocks)]));
if ((namelen == strlen(filename)) &&
(strncmp(filename, fname, namelen) == 0)) {
node = node_scan;
break;
}
}
/* inode points to the file (or NULL if not found */
if (node == NULL)
return_error(gs_error_undefinedfilename);
return (int)filelen;
}
|