forked from parrot/parrot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
filehandle.c
626 lines (444 loc) · 15.7 KB
/
filehandle.c
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
/*
Copyright (C) 2001-2010, Parrot Foundation.
=head1 NAME
src/io/filehandle.c - FileHandle utility functions
=head1 DESCRIPTION
This file defines a set of utility functions for the FileHandle PMC used by all
operating systems. For the primary public I/O API, see F<src/io/api.c>.
=cut
*/
#include "parrot/parrot.h"
#include "io_private.h"
#include "pmc/pmc_filehandle.h"
/* HEADERIZER HFILE: include/parrot/io.h */
/*
=head2 Functions
=over 4
=item C<STRING * Parrot_io_make_string(PARROT_INTERP, STRING **buf, size_t len)>
Creates a STRING* suitable for returning results from IO read functions.
The passed in C<buf> parameter can:
=over 4
=item 1
Point to a NULL STRING
=item 2
Point to a real STRING
=item 3
Point to a fake STRING with (strstart, bufused) holding the *buffer
information.
=back
In the third case, the buffer or STRING must be able to hold the required
amount of data. For cases 1 and 2, a NULL C<strstart> tells this function to
allocate the STRING memory.
=cut
*/
PARROT_WARN_UNUSED_RESULT
PARROT_CANNOT_RETURN_NULL
STRING *
Parrot_io_make_string(PARROT_INTERP, ARGMOD(STRING **buf), size_t len)
{
ASSERT_ARGS(Parrot_io_make_string)
/*
* when we get a NULL string, we read a default len
*/
if (*buf == NULL) {
*buf = Parrot_str_new_noinit(interp, len);
return *buf;
}
else {
STRING * const s = *buf;
if (s->bufused < len)
Parrot_gc_reallocate_string_storage(interp, s, len);
return s;
}
}
/*
=item C<void Parrot_io_set_os_handle(PARROT_INTERP, PMC *filehandle, PIOHANDLE
file_descriptor)>
Sets the C<os_handle> attribute of the FileHandle object, which stores the
low-level filehandle for the OS.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
Possibly, this function should reset some characteristics of the object (like
buffer and file positions) to their default values.
=cut
*/
PARROT_EXPORT
void
Parrot_io_set_os_handle(SHIM_INTERP, ARGMOD(PMC *filehandle), PIOHANDLE file_descriptor)
{
ASSERT_ARGS(Parrot_io_set_os_handle)
PARROT_FILEHANDLE(filehandle)->os_handle = file_descriptor;
}
/*
=item C<PIOHANDLE Parrot_io_get_os_handle(PARROT_INTERP, const PMC *filehandle)>
Retrieve the C<os_handle> attribute of the FileHandle object, which stores the
low-level filehandle for the OS.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PIOHANDLE
Parrot_io_get_os_handle(SHIM_INTERP, ARGIN(const PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_os_handle)
return PARROT_FILEHANDLE(filehandle)->os_handle;
}
/*
=item C<void Parrot_io_set_flags(PARROT_INTERP, PMC *filehandle, INTVAL flags)>
Set the C<flags> attribute of the FileHandle object, which stores bitwise flags
marking filehandle characteristics.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
void
Parrot_io_set_flags(SHIM_INTERP, ARGIN(PMC *filehandle), INTVAL flags)
{
ASSERT_ARGS(Parrot_io_set_flags)
Parrot_FileHandle_attributes * const handle_struct = PARROT_FILEHANDLE(filehandle);
handle_struct->flags = flags;
}
/*
=item C<INTVAL Parrot_io_get_flags(PARROT_INTERP, const PMC *filehandle)>
Set the C<flags> attribute of the FileHandle object, which stores bitwise flags
marking filehandle characteristics.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
INTVAL
Parrot_io_get_flags(SHIM_INTERP, ARGIN(const PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_flags)
return PARROT_FILEHANDLE(filehandle)->flags;
}
/*
=item C<void Parrot_io_set_buffer_start(PARROT_INTERP, PMC *filehandle, unsigned
char *new_start)>
Set the C<buffer_start> attribute of the FileHandle object, which stores
the position of the start of the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
void
Parrot_io_set_buffer_start(SHIM_INTERP, ARGMOD(PMC *filehandle),
ARGIN_NULLOK(unsigned char *new_start))
{
ASSERT_ARGS(Parrot_io_set_buffer_start)
PARROT_FILEHANDLE(filehandle)->buffer_start = new_start;
}
/*
=item C<unsigned char * Parrot_io_get_buffer_start(PARROT_INTERP, PMC
*filehandle)>
Get the C<buffer_start> attribute of the FileHandle object, which stores
the position of the start of the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
unsigned char *
Parrot_io_get_buffer_start(SHIM_INTERP, ARGIN(PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_buffer_start)
return PARROT_FILEHANDLE(filehandle)->buffer_start;
}
/*
=item C<unsigned char * Parrot_io_get_buffer_next(PARROT_INTERP, const PMC
*filehandle)>
Get the C<buffer_next> attribute of the FileHandle object, which stores
the current position within the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
PARROT_CAN_RETURN_NULL
unsigned char *
Parrot_io_get_buffer_next(SHIM_INTERP, ARGIN(const PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_buffer_next)
return PARROT_FILEHANDLE(filehandle)->buffer_next;
}
/*
=item C<void Parrot_io_set_buffer_next(PARROT_INTERP, PMC *filehandle, unsigned
char *new_next)>
Set the C<buffer_next> attribute of the FileHandle object, which stores
the current position within the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
void
Parrot_io_set_buffer_next(SHIM_INTERP, ARGMOD(PMC *filehandle),
ARGIN_NULLOK(unsigned char *new_next))
{
ASSERT_ARGS(Parrot_io_set_buffer_next)
PARROT_FILEHANDLE(filehandle)->buffer_next = new_next;
}
/*
=item C<unsigned char * Parrot_io_get_buffer_end(PARROT_INTERP, const PMC
*filehandle)>
Get the C<buffer_end> attribute of the FileHandle object, which stores
the position of the end of the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PARROT_CAN_RETURN_NULL
unsigned char *
Parrot_io_get_buffer_end(SHIM_INTERP, ARGIN(const PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_buffer_end)
return PARROT_FILEHANDLE(filehandle)->buffer_end;
}
/*
=item C<void Parrot_io_set_buffer_end(PARROT_INTERP, PMC *filehandle, unsigned
char *new_end)>
Set the C<buffer_end> attribute of the FileHandle object, which stores
the position of the end of the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
void
Parrot_io_set_buffer_end(SHIM_INTERP, ARGMOD(PMC *filehandle),
ARGIN_NULLOK(unsigned char *new_end))
{
ASSERT_ARGS(Parrot_io_set_buffer_end)
PARROT_FILEHANDLE(filehandle)->buffer_end = new_end;
}
/*
=item C<INTVAL Parrot_io_get_buffer_flags(PARROT_INTERP, const PMC *filehandle)>
Get the C<buffer_flags> attribute of the FileHandle object, which stores
a collection of flags specific to the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_CAN_RETURN_NULL
INTVAL
Parrot_io_get_buffer_flags(SHIM_INTERP, ARGIN(const PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_buffer_flags)
return PARROT_FILEHANDLE(filehandle)->buffer_flags;
}
/*
=item C<void Parrot_io_set_buffer_flags(PARROT_INTERP, PMC *filehandle, INTVAL
new_flags)>
Set the C<buffer_flags> attribute of the FileHandle object, which stores
a collection of flags specific to the buffer.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
void
Parrot_io_set_buffer_flags(SHIM_INTERP, ARGMOD(PMC *filehandle), INTVAL new_flags)
{
ASSERT_ARGS(Parrot_io_set_buffer_flags)
PARROT_FILEHANDLE(filehandle)->buffer_flags = new_flags;
}
/*
=item C<size_t Parrot_io_get_buffer_size(PARROT_INTERP, const PMC *filehandle)>
Get the C<buffer_size> attribute of the FileHandle object, which stores
the size of the buffer (in bytes).
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_CAN_RETURN_NULL
PARROT_WARN_UNUSED_RESULT
size_t
Parrot_io_get_buffer_size(SHIM_INTERP, ARGIN(const PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_buffer_size)
return PARROT_FILEHANDLE(filehandle)->buffer_size;
}
/*
=item C<void Parrot_io_set_buffer_size(PARROT_INTERP, PMC *filehandle, size_t
new_size)>
Set the C<buffer_size> attribute of the FileHandle object, which stores
the size of the buffer (in bytes).
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
void
Parrot_io_set_buffer_size(SHIM_INTERP, ARGMOD(PMC *filehandle), size_t new_size)
{
ASSERT_ARGS(Parrot_io_set_buffer_size)
PARROT_FILEHANDLE(filehandle)->buffer_size = new_size;
}
/*
=item C<void Parrot_io_clear_buffer(PARROT_INTERP, PMC *filehandle)>
Clear the filehandle buffer and free the associated memory.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_CAN_RETURN_NULL
void
Parrot_io_clear_buffer(PARROT_INTERP, ARGMOD(PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_clear_buffer)
Parrot_FileHandle_attributes * const io = PARROT_FILEHANDLE(filehandle);
if (io->buffer_start && (io->flags & PIO_BF_MALLOC)) {
mem_gc_free(interp, io->buffer_start);
io->buffer_start = NULL;
}
}
/*
=item C<PIOOFF_T Parrot_io_get_file_position(PARROT_INTERP, const PMC
*filehandle)>
Get the C<file_pos> attribute of the FileHandle object, which stores
the current file position of the filehandle.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
PIOOFF_T
Parrot_io_get_file_position(SHIM_INTERP, ARGIN(const PMC *filehandle))
{
ASSERT_ARGS(Parrot_io_get_file_position)
return PARROT_FILEHANDLE(filehandle)->file_pos;
}
/*
=item C<void Parrot_io_set_file_position(PARROT_INTERP, PMC *filehandle,
PIOOFF_T file_pos)>
Get the C<file_pos> attribute of the FileHandle object, which stores the
current file position of the filehandle. Also set the C<last_pos> attribute to
the previous value of C<file_pos>.
Currently, this pokes directly into the C struct of the FileHandle PMC. This
needs to change to a general interface that can be used by all subclasses and
polymorphic equivalents of FileHandle. For now, hiding it behind a function, so
it can be cleanly changed later.
=cut
*/
PARROT_EXPORT
void
Parrot_io_set_file_position(SHIM_INTERP, ARGMOD(PMC *filehandle), PIOOFF_T file_pos)
{
ASSERT_ARGS(Parrot_io_set_file_position)
Parrot_FileHandle_attributes * const handle_struct = PARROT_FILEHANDLE(filehandle);
handle_struct->last_pos = handle_struct->file_pos;
handle_struct->file_pos = file_pos;
}
/*
=item C<INTVAL Parrot_io_close_filehandle(PARROT_INTERP, PMC *pmc)>
Flushes and closes the C<FileHandle> PMC C<*pmc>, but leaves the object intact
to be reused or collected.
=cut
*/
PARROT_EXPORT
INTVAL
Parrot_io_close_filehandle(PARROT_INTERP, ARGMOD(PMC *pmc))
{
ASSERT_ARGS(Parrot_io_close_filehandle)
const PIOHANDLE os_handle = Parrot_io_get_os_handle(interp, pmc);
INTVAL result;
INTVAL flags;
if (os_handle == PIO_INVALID_HANDLE)
return -1;
Parrot_io_flush_buffer(interp, pmc);
PIO_FLUSH(interp, os_handle);
result = PIO_CLOSE(interp, os_handle);
flags = Parrot_io_get_flags(interp, pmc);
if (flags & PIO_F_PIPE) {
INTVAL pid;
INTVAL status;
GETATTR_FileHandle_process_id(interp, pmc, pid);
status = Parrot_proc_waitpid(interp, pid);
SETATTR_FileHandle_exit_status(interp, pmc, status);
}
Parrot_io_set_os_handle(interp, pmc, PIO_INVALID_HANDLE);
Parrot_io_clear_buffer(interp, pmc);
return result;
}
/*
=item C<INTVAL Parrot_io_is_closed_filehandle(PARROT_INTERP, const PMC *pmc)>
Test whether a filehandle is closed.
=cut
*/
PARROT_EXPORT
PARROT_WARN_UNUSED_RESULT
INTVAL
Parrot_io_is_closed_filehandle(PARROT_INTERP, ARGIN(const PMC *pmc))
{
ASSERT_ARGS(Parrot_io_is_closed_filehandle)
const PIOHANDLE os_handle = Parrot_io_get_os_handle(interp, pmc);
return os_handle == PIO_INVALID_HANDLE;
}
/*
=item C<void Parrot_io_flush_filehandle(PARROT_INTERP, PMC *pmc)>
Flushes the C<FileHandle> PMC C<*pmc>.
=cut
*/
PARROT_EXPORT
void
Parrot_io_flush_filehandle(PARROT_INTERP, ARGMOD(PMC *pmc))
{
ASSERT_ARGS(Parrot_io_flush_filehandle)
const PIOHANDLE os_handle = Parrot_io_get_os_handle(interp, pmc);
if (os_handle == PIO_INVALID_HANDLE)
return;
Parrot_io_flush_buffer(interp, pmc);
PIO_FLUSH(interp, os_handle);
}
/*
=back
=head1 SEE ALSO
F<src/io/unix.c>,
F<src/io/win32.c>,
F<src/io/stdio.c>,
F<src/io/io_private.h>.
=cut
*/
/*
* Local variables:
* c-file-style: "parrot"
* End:
* vim: expandtab shiftwidth=4 cinoptions='\:2=2' :
*/