libburnia/libburn
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Inserted the necessary error messages and magic numbers

Browse Source
This commit is contained in:
Thomas Schmitt 2007-10-04 20:00:58 +00:00
parent f3966e5fee
commit e5f42759a0
5 changed files with 124 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cdrskin/cdrskin_timestamp.h
View File

@ -1 +1 @@
#define Cdrskin_timestamP "2007.10.03.223851" #define Cdrskin_timestamP "2007.10.04.200221"

72
libburn/file.c
View File

@ -14,6 +14,10 @@
#include "file.h" #include "file.h"
#include "async.h" #include "async.h"
#include "libdax_msgs.h"
extern struct libdax_msgs *libdax_messenger;
/* main channel data can be padded on read, but 0 padding the subs will make /* main channel data can be padded on read, but 0 padding the subs will make
an unreadable disc */ an unreadable disc */
@ -123,6 +127,8 @@ failure:;
return NULL; return NULL;
} }
fs->magic[0] = 'f'; fs->magic[1] = 'i';
fs->magic[2] = 'l'; fs->magic[3] = 'e';
fs->datafd = fd1; fs->datafd = fd1;
fs->subfd = fd2; fs->subfd = fd2;
@ -161,6 +167,8 @@ struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size)
fs = malloc(sizeof(struct burn_source_file)); fs = malloc(sizeof(struct burn_source_file));
if (fs == NULL) /* ts A70825 */ if (fs == NULL) /* ts A70825 */
return NULL; return NULL;
fs->magic[0] = 'f'; fs->magic[1] = 'i';
fs->magic[2] = 'l'; fs->magic[3] = 'e';
fs->datafd = datafd; fs->datafd = datafd;
fs->subfd = subfd; fs->subfd = subfd;
fs->fixed_size = size; fs->fixed_size = size;
@ -202,9 +210,9 @@ static int fifo_read(struct burn_source *source,
if (fs->is_started == 0) { if (fs->is_started == 0) {
ret = burn_fifo_start(source, 0); ret = burn_fifo_start(source, 0);
if (ret <= 0) { if (ret <= 0) {
libdax_msgs_submit(libdax_messenger, -1, 0x00020152,
/* >>> msg: cannot start fifo thread */; LIBDAX_MSGS_SEV_FATAL, LIBDAX_MSGS_PRIO_HIGH,
"Cannot start fifo thread", 0, 0);
return -1; return -1;
} }
fs->is_started = 1; fs->is_started = 1;
@ -261,7 +269,9 @@ int burn_fifo_source_shoveller_og(struct burn_source *source, int flag)
else if (ret == 0) else if (ret == 0)
break; /* EOF */ break; /* EOF */
else { else {
/* >>> read error */; libdax_msgs_submit(libdax_messenger, -1, 0x00020153,
LIBDAX_MSGS_SEV_SORRY, LIBDAX_MSGS_PRIO_HIGH,
"Read error on fifo input", errno, 0);
break; break;
} }
ret = write(fs->outlet[1], fs->buf, ret); ret = write(fs->outlet[1], fs->buf, ret);
@ -306,17 +316,15 @@ static int fifo_read_ng(struct burn_source *source,
int ret, todo, rpos, bufsize, diff; int ret, todo, rpos, bufsize, diff;
if (fs->end_of_consumption) { if (fs->end_of_consumption) {
/* ??? msg: reading has been ended already */;
/* >>> msg: reading has been ended already */;
return 0; return 0;
} }
if (fs->is_started == 0) { if (fs->is_started == 0) {
ret = burn_fifo_start(source, 0); ret = burn_fifo_start(source, 0);
if (ret <= 0) { if (ret <= 0) {
libdax_msgs_submit(libdax_messenger, -1, 0x00020152,
/* >>> msg: cannot start fifo thread */; LIBDAX_MSGS_SEV_FATAL, LIBDAX_MSGS_PRIO_HIGH,
"Cannot start fifo thread", 0, 0);
fs->end_of_consumption = 1; fs->end_of_consumption = 1;
return -1; return -1;
} }
@ -344,9 +352,10 @@ static int fifo_read_ng(struct burn_source *source,
if (todo < size) /* deliver partial buffer */ if (todo < size) /* deliver partial buffer */
break; break;
fs->end_of_consumption = 1; fs->end_of_consumption = 1;
libdax_msgs_submit(libdax_messenger, -1,
/* >>> msg: report fs->input_error as errno */; 0x00020154,
LIBDAX_MSGS_SEV_NOTE, LIBDAX_MSGS_PRIO_HIGH,
"Forwarded input error ends output", 0, 0);
return -1; return -1;
} }
fifo_sleep(0); fifo_sleep(0);
@ -447,9 +456,10 @@ int burn_fifo_source_shoveller_ng(struct burn_source *source, int flag)
if (trans_end) { if (trans_end) {
bufpt = calloc(fs->chunksize, 1); bufpt = calloc(fs->chunksize, 1);
if (bufpt == NULL) { if (bufpt == NULL) {
libdax_msgs_submit(libdax_messenger, -1,
/* >>> msg: out of memory */; 0x00000003,
LIBDAX_MSGS_SEV_FATAL, LIBDAX_MSGS_PRIO_HIGH,
"Out of virtual memory", 0, 0);
fs->input_error = ENOMEM; fs->input_error = ENOMEM;
break; break;
} }
@ -463,6 +473,9 @@ int burn_fifo_source_shoveller_ng(struct burn_source *source, int flag)
else if (ret == 0) else if (ret == 0)
break; /* EOF */ break; /* EOF */
else { else {
libdax_msgs_submit(libdax_messenger, -1, 0x00020153,
LIBDAX_MSGS_SEV_SORRY, LIBDAX_MSGS_PRIO_HIGH,
"Read error on fifo input", errno, 0);
fs->input_error = errno; fs->input_error = errno;
if(errno == 0) if(errno == 0)
fs->input_error = EIO; fs->input_error = EIO;
@ -514,7 +527,7 @@ int burn_fifo_source_shoveller_ng(struct burn_source *source, int flag)
So in both cases the consumer is aware that reading is futile So in both cases the consumer is aware that reading is futile
or even fatal. or even fatal.
*/ */
free(fs->buf); free(fs->buf); /* Give up fifo buffer. Next fifo might start soon. */
fs->buf = NULL; fs->buf = NULL;
return (fs->input_error == 0); return (fs->input_error == 0);
@ -543,11 +556,15 @@ struct burn_source *burn_fifo_source_new(struct burn_source *inp,
#endif #endif
if (((double) chunksize) * ((double) chunks) > 1024.0*1024.0*1024.0) { if (((double) chunksize) * ((double) chunks) > 1024.0*1024.0*1024.0) {
/* >>> buffer larger than 1 GB */; libdax_msgs_submit(libdax_messenger, -1, 0x00020155,
LIBDAX_MSGS_SEV_SORRY, LIBDAX_MSGS_PRIO_HIGH,
"Desired fifo buffer too large (> 1GB)", 0, 0);
return NULL; return NULL;
} }
if (chunksize < 1 || chunks < 2) { if (chunksize < 1 || chunks < 2) {
/* >>> buffer too small */; libdax_msgs_submit(libdax_messenger, -1, 0x00020156,
LIBDAX_MSGS_SEV_SORRY, LIBDAX_MSGS_PRIO_HIGH,
"Desired fifo buffer too small", 0, 0);
return NULL; return NULL;
} }
@ -614,17 +631,23 @@ struct burn_source *burn_fifo_source_new(struct burn_source *inp,
/* ts A71003 : API */ /* ts A71003 : API */
int burn_fifo_inquire_status(struct burn_source *source, int *size, int burn_fifo_inquire_status(struct burn_source *source,
int *free_bytes) int *size, int *free_bytes, char **status_text)
{ {
struct burn_source_fifo *fs = source->data; struct burn_source_fifo *fs = source->data;
int ret = 0, diff, wpos, rpos; int ret = 0, diff, wpos, rpos;
static char *(states[8]) = {
"standby", "active", "ending", "failing",
"unused", "abandoned", "ended", "aborted"};
*status_text = NULL;
*size = 0;
if (fs->magic[0] != 'f' || fs->magic[1] != 'i' || if (fs->magic[0] != 'f' || fs->magic[1] != 'i' ||
fs->magic[2] != 'f' || fs->magic[3] != 'o') { fs->magic[2] != 'f' || fs->magic[3] != 'o') {
libdax_msgs_submit(libdax_messenger, -1, 0x00020157,
/* >>> not a fifo burn_source */; LIBDAX_MSGS_SEV_FATAL, LIBDAX_MSGS_PRIO_HIGH,
"burn_source is not a fifo object", 0, 0);
return -1; return -1;
} }
*size = fs->chunksize * fs->chunks; *size = fs->chunksize * fs->chunks;
@ -645,6 +668,7 @@ int burn_fifo_inquire_status(struct burn_source *source, int *size,
ret |= 2; ret |= 2;
else else
ret |= 1; ret |= 1;
*status_text = states[ret];
return ret; return ret;
} }

4
libburn/file.h
View File

@ -5,6 +5,8 @@
struct burn_source_file struct burn_source_file
{ {
char magic[4];
int datafd; int datafd;
int subfd; int subfd;
off_t fixed_size; off_t fixed_size;
@ -33,7 +35,7 @@ struct burn_source_fifo {
/* the burn_source for which this fifo is acting as proxy */ /* the burn_source for which this fifo is acting as proxy */
struct burn_source *inp; struct burn_source *inp;
/* <<< currently it is only a pipe */ /* <<< up to now it was only a pipe. This is on its way out. */
int outlet[2]; int outlet[2];
/* The ring buffer mechanism */ /* The ring buffer mechanism */

70
libburn/libburn.h
View File

@ -334,7 +334,11 @@ struct burn_toc_entry
In general, burn_source objects can be freed as soon as they are attached In general, burn_source objects can be freed as soon as they are attached
to track objects. The track objects will keep them alive and dispose them to track objects. The track objects will keep them alive and dispose them
when they are no longer needed. when they are no longer needed. With a fifo burn_source it makes sense to
keep the own reference for inquiring its state while burning is in
progress.
---
The following description of burn_source applies only to application The following description of burn_source applies only to application
implemented burn_source objects. You need not to know it for API provided implemented burn_source objects. You need not to know it for API provided
@ -423,13 +427,31 @@ struct burn_source {
/** Source specific data. Here the various source classes express their /** Source specific data. Here the various source classes express their
specific properties and the instance objects store their individual specific properties and the instance objects store their individual
management data. E.g. data may point to a struct like this: management data.
You SHOULD implement two attributes in *data :
1) The first member of the structure should be a 4 byte array
magic[] with the first byte being set to an uppercase letter
and the other 3 set to some value you deem unique for your
burn_source.
libburnia sets magic[0] to a lower case letter in its burn_source
objects. Established magic values are:
{'f','i','l','e'} , {'f','i','f','o'} , {'e','1','1','9'}.
2) off_t fixed_size should store an eventual value from (*set_size)
and if set be used as reply of (*get_size).
E.g. data could point to a struct like this:
struct app_burn_source struct app_burn_source
{ {
char magic[4];
off_t fixed_size;
struct my_app *app_handle; struct my_app *app_handle;
... other individual source parameters ... ... other individual source parameters ...
off_t fixed_size;
}; };
With .magic[] getting initialized as {'M','y','a','p'}
and .fixed_size initialized as 0 (= invalid).
Function (*free_data) has to be prepared to clean up and free
the struct.
*/ */
void *data; void *data;
@ -1458,14 +1480,22 @@ struct burn_source *burn_file_source_new(const char *path,
struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size); struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size);
/* ts A70930 : Provisory API call. Subject to changes ! */ /* ts A70930 */
/** Creates a fifo which acts as proxy for an already existing data source. /** Creates a fifo which acts as proxy for an already existing data source.
NOTE: Incomplete function. Curently the ring buffer is not implemented. The fifo is based on a ring buffer which shall smoothen the data stream
The only purpose is to decouple the writer thread of libburn from an between burn_source and writer thread. Each fifo serves only for one
eventually error prone burn_source. data source and gets attached to one track instead of its data source
In future this will implement a ring buffer which shall smoothen the by burn_track_set_source().
data stream between burn_source and writer thread. A fifo starts its life in "standby" mode with no buffer space allocated.
As soon as its track requires bytes, the fifo establishes a worker thread
and allocates its buffer. After input has ended and all buffer content is
consumed, the buffer space gets freedi and the worker thread ends.
This happens asynchronously. So expect two buffers and worker threads to
exist for a short time between tracks. Be modest in your size demands if
multiple tracks are to be expected.
@param inp The burn_source for which the fifo shall act as proxy. @param inp The burn_source for which the fifo shall act as proxy.
It can be disposed by burn_source_free() immediately
after this call.
@param chunksize The size in bytes of a chunk. Use 2048 for sources @param chunksize The size in bytes of a chunk. Use 2048 for sources
suitable for BURN_BLOCK_MODE1 and 2352 for sources suitable for BURN_BLOCK_MODE1 and 2352 for sources
which deliver for BURN_BLOCK_AUDIO. which deliver for BURN_BLOCK_AUDIO.
@ -1477,6 +1507,8 @@ struct burn_source *burn_fd_source_new(int datafd, int subfd, off_t size);
@return A pointer to the newly created burn_source. @return A pointer to the newly created burn_source.
Later both burn_sources, inp and the returned fifo, have Later both burn_sources, inp and the returned fifo, have
to be disposed by calling burn_source_free() for each. to be disposed by calling burn_source_free() for each.
inp can be freed immediately, the returned fifo may be
kept as handle for burn_fifo_inquire_status().
*/ */
struct burn_source *burn_fifo_source_new(struct burn_source *inp, struct burn_source *burn_fifo_source_new(struct burn_source *inp,
int chunksize, int chunks, int flag); int chunksize, int chunks, int flag);
@ -1487,16 +1519,20 @@ struct burn_source *burn_fifo_source_new(struct burn_source *inp,
@param fifo The fifo object to inquire @param fifo The fifo object to inquire
@param size The total size of the fifo @param size The total size of the fifo
@param free_bytes The current free capacity of the fifo @param free_bytes The current free capacity of the fifo
@return <=0 error, @param status_text Returns a pointer to a constant text, see below
1=input and consumption are active @return <0 reply invalid, >=0 fifo status code:
2=input has ended without error bit0+1=input status, bit2=consumption status, i.e:
3=input had error and ended, 0="standby" : data processing not started yet
5=consumption has ended prematurely 1="active" : input and consumption are active
6=consumption has ended without input error 2="ending" : input has ended without error
7=consumption has ended after input error 3="failing" : input had error and ended,
4="unused" : ( consumption has ended before processing start )
5="abandoned" : consumption has ended prematurely
6="ended" : consumption has ended without input error
7="aborted" : consumption has ended after input error
*/ */
int burn_fifo_inquire_status(struct burn_source *fifo, int *size, int burn_fifo_inquire_status(struct burn_source *fifo, int *size,
int *free_bytes); int *free_bytes, char **status_text);
/* ts A70328 */ /* ts A70328 */

19
libburn/libdax_msgs.h
View File

@ -433,6 +433,13 @@ Range "scdbackup" : 0x00020000 to 0x0002ffff
0x0002014d (SORRY,HIGH) = Asynchromous SCSI error 0x0002014d (SORRY,HIGH) = Asynchromous SCSI error
0x0002014f (SORRY,HIGH) = Timeout with asynchromous SCSI command 0x0002014f (SORRY,HIGH) = Timeout with asynchromous SCSI command
0x00020150 (DEBUG,LOW) = Reporting asynchronous waiting time 0x00020150 (DEBUG,LOW) = Reporting asynchronous waiting time
0x00020151 (FATAL,HIGH) = Read attempt on write-only drive
0x00020152 (FATAL,HIGH) = Cannot start fifo thread
0x00020153 (SORRY,HIGH) = Read error on fifo input
0x00020154 (NOTE,HIGH) = Forwarded input error ends output
0x00020155 (SORRY,HIGH) = Desired fifo buffer too large
0x00020156 (SORRY,HIGH) = Desired fifo buffer too small
0x00020157 (FATAL,HIGH) = burn_source is not a fifo object
libdax_audioxtr: libdax_audioxtr:
@ -475,6 +482,18 @@ Range "vreixo" : 0x00030000 to 0x0003ffff
0x00030301 (NOTE,MEDIUM) = Unsupported file type for Joliet tree 0x00030301 (NOTE,MEDIUM) = Unsupported file type for Joliet tree
------------------------------------------------------------------------------
Range "application" : 0x00040000 to 0x0004ffff
0x00040000 (ABORT,HIGH) : Application supplied message
0x00040001 (FATAL,HIGH) : Application supplied message
0x00040002 (SORRY,HIGH) : Application supplied message
0x00040003 (WARNING,HIGH) : Application supplied message
0x00040004 (HINT,HIGH) : Application supplied message
0x00040005 (NOTE,HIGH) : Application supplied message
0x00040006 (UPDATE,HIGH) : Application supplied message
0x00040007 (DEBUG,HIGH) : Application supplied message
------------------------------------------------------------------------------ ------------------------------------------------------------------------------