Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[linebuf] Support buffering of multiple lines
Allow line buffer to accumulate multiple lines, with buffered_line()
returning each freshly-completed line as it is encountered.  This
allows buffered lines to be subsequently processed as a group.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
  • Loading branch information
mcb30 committed Jul 28, 2015
1 parent 20d35b0 commit 1e4ff87
Show file tree
Hide file tree
Showing 4 changed files with 358 additions and 45 deletions.
53 changes: 40 additions & 13 deletions src/core/linebuf.c
Expand Up @@ -43,7 +43,18 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
* @ret line Buffered line, or NULL if no line ready to read
*/
char * buffered_line ( struct line_buffer *linebuf ) {
return ( linebuf->ready ? linebuf->data : NULL );
char *line = &linebuf->data[ linebuf->len ];

/* Fail unless we have a newly completed line to retrieve */
if ( ( linebuf->len == 0 ) || ( linebuf->consumed == 0 ) ||
( *(--line) != '\0' ) )
return NULL;

/* Identify start of line */
while ( ( line > linebuf->data ) && ( line[-1] != '\0' ) )
line--;

return line;
}

/**
Expand All @@ -52,10 +63,11 @@ char * buffered_line ( struct line_buffer *linebuf ) {
* @v linebuf Line buffer
*/
void empty_line_buffer ( struct line_buffer *linebuf ) {

free ( linebuf->data );
linebuf->data = NULL;
linebuf->len = 0;
linebuf->ready = 0;
linebuf->consumed = 0;
}

/**
Expand All @@ -76,16 +88,13 @@ void empty_line_buffer ( struct line_buffer *linebuf ) {
* should call empty_line_buffer() before freeing a @c struct @c
* line_buffer.
*/
ssize_t line_buffer ( struct line_buffer *linebuf,
const char *data, size_t len ) {
int line_buffer ( struct line_buffer *linebuf, const char *data, size_t len ) {
const char *eol;
size_t consume;
size_t new_len;
char *new_data;

/* Free any completed line from previous iteration */
if ( linebuf->ready )
empty_line_buffer ( linebuf );
char *lf;
char *cr;

/* Search for line terminator */
if ( ( eol = memchr ( data, '\n', len ) ) ) {
Expand All @@ -94,6 +103,10 @@ ssize_t line_buffer ( struct line_buffer *linebuf,
consume = len;
}

/* Reject any embedded NULs within the data to be consumed */
if ( memchr ( data, '\0', consume ) )
return -EINVAL;

/* Reallocate data buffer and copy in new data */
new_len = ( linebuf->len + consume );
new_data = realloc ( linebuf->data, ( new_len + 1 ) );
Expand All @@ -104,13 +117,27 @@ ssize_t line_buffer ( struct line_buffer *linebuf,
linebuf->data = new_data;
linebuf->len = new_len;

/* If we have reached end of line, trim the line and mark as ready */
/* If we have reached end of line, terminate the line */
if ( eol ) {
linebuf->data[--linebuf->len] = '\0'; /* trim NL */
if ( linebuf->data[linebuf->len - 1] == '\r' )
linebuf->data[--linebuf->len] = '\0'; /* trim CR */
linebuf->ready = 1;

/* Overwrite trailing LF (which must exist at this point) */
assert ( linebuf->len > 0 );
lf = &linebuf->data[ linebuf->len - 1 ];
assert ( *lf == '\n' );
*lf = '\0';

/* Trim (and overwrite) trailing CR, if present */
if ( linebuf->len > 1 ) {
cr = ( lf - 1 );
if ( *cr == '\r' ) {
linebuf->len--;
*cr = '\0';
}
}
}

/* Record consumed length */
linebuf->consumed = consume;

return consume;
}
12 changes: 6 additions & 6 deletions src/include/ipxe/linebuf.h
Expand Up @@ -14,17 +14,17 @@ FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

/** A line buffer */
struct line_buffer {
/** Current string in the buffer */
/** Data buffer */
char *data;
/** Length of current string, excluding the terminating NUL */
/** Length of buffered data */
size_t len;
/** String is ready to read */
int ready;
/** Most recently consumed length */
size_t consumed;
};

extern char * buffered_line ( struct line_buffer *linebuf );
extern ssize_t line_buffer ( struct line_buffer *linebuf,
const char *data, size_t len );
extern int line_buffer ( struct line_buffer *linebuf,
const char *data, size_t len );
extern void empty_line_buffer ( struct line_buffer *linebuf );

#endif /* _IPXE_LINEBUF_H */

0 comments on commit 1e4ff87

Please sign in to comment.