Imagelibrary/rtems
1
0
Fork 1
mirror of https://gitlab.rtems.org/rtems/rtos/rtems.git synced 2025-12-10 01:23:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

cpukit/libmisc/dumpbuf/dumpbuf.c: Fix undefined behavior for sprintf()

Browse Source 
I also used the 'n' versions of the string functions, #define'd magic numbers
and added a few comments.

Updates #2405.
This commit is contained in:
Martin Galvan
2015-09-02 16:54:24 -05:00
committed by Joel Sherrill
parent 631d2548fa
commit 9e2197d5d7
1 changed files with 69 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
cpukit/libmisc/dumpbuf/dumpbuf.c
View File

@@ -6,7 +6,7 @@
*/ */
/* /*
* COPYRIGHT (c) 1997-2007. * COPYRIGHT (c) 1997-2015.
* On-Line Applications Research Corporation (OAR). * On-Line Applications Research Corporation (OAR).
* *
* The license and distribution terms for this file may in * The license and distribution terms for this file may in
@@ -24,62 +24,91 @@
#include <rtems/dumpbuf.h> #include <rtems/dumpbuf.h>
#include <rtems/bspIo.h> #include <rtems/bspIo.h>
#define HEX_FMT_LENGTH 3 /* Length of the formatted hex string. */
#define ASCII_FMT_LENGTH 1 /* Length of the formatted ASCII string. */
#define BYTES_PER_ROW 16 /* Amount of bytes from buffer shown in each row. */
#define BARS 2 /* Amount of bars in each row. */
/* Max length of each row string. */
#define ROW_LENGTH (BYTES_PER_ROW * (HEX_FMT_LENGTH + ASCII_FMT_LENGTH) + BARS)
/* /*
* Put the body below rtems_print_buffer so it won't get inlined. * Put the body below rtems_print_buffer so it won't get inlined.
*/ */
static inline void Dump_Line( static void Dump_Line(const unsigned char *buffer, const unsigned int length);
const unsigned char *buffer,
int length
);
void rtems_print_buffer( /**
const unsigned char *buffer, * @brief Print \p length bytes from \p buffer, both in hex and ASCII.
int length * Printing will be done in rows, each showing BYTES_PER_ROW bytes.
) * @details Non-printable chars will appear as dots.
*
* @param buffer The buffer we'll print.
* @param length Amount of bytes from \p buffer we'll print. This can't be
* unsigned because we don't have a way to check if we're erroneously getting
* a negative \p length.
*/
void rtems_print_buffer(const unsigned char *buffer, const int length)
{ {
unsigned int i, mod, max;
int i, mod, max; if (length > 0) {
mod = length % BYTES_PER_ROW;
if ( !length ) return;
mod = length % 16;
max = length - mod; max = length - mod;
for ( i=0 ; i<max ; i+=16 ) /* Print length / BYTES_PER_ROW rows. */
Dump_Line( &buffer[ i ], 16 ); for (i = 0; i < max; i += BYTES_PER_ROW) {
Dump_Line(&buffer[i], BYTES_PER_ROW);
}
if ( mod ) /* Print another row with the remaining bytes. */
if (mod > 0) {
Dump_Line(&buffer[max], mod); Dump_Line(&buffer[max], mod);
} }
} else {
static inline void Dump_Line( printk("Error: length must be greater than zero.");
const unsigned char *buffer, }
int length }
)
{ /**
* @brief Print \p length bytes from \p buffer, both in hex and ASCII.
int i; * @details Non-printable chars will appear as dots.
char line_buffer[120]; *
* @param buffer The buffer we'll print.
line_buffer[0] = '\0'; * @param length Amount of bytes from \p buffer we'll print.
*/
for( i=0 ; i<length ; i++ ) static void Dump_Line(const unsigned char *buffer, const unsigned int length)
sprintf( line_buffer, "%s%02x ", line_buffer, buffer[ i ] ); {
unsigned int i;
for( ; i<16 ; i++ ) static unsigned char line_buffer[ROW_LENGTH] = "";
strcat( line_buffer, " " ); size_t tmp_len;
strcat( line_buffer, "|" ); /* Output the hex value of each byte. */
for( i=0 ; i<length ; i++ ) for (i = 0; i < length; ++i) {
sprintf( line_buffer, "%s%c", line_buffer, snprintf(&line_buffer[i * HEX_FMT_LENGTH], HEX_FMT_LENGTH + 1,
isprint( buffer[ i ] ) ? buffer[ i ] : '.' ); "%02x ", buffer[i]);
}
for( ; i<16 ; i++ )
strcat( line_buffer, " " ); /* Fill the remaining space with whitespace (if necessary). */
for (; i < BYTES_PER_ROW; ++i) {
strcat( line_buffer, "|\n" ); strncat(line_buffer, " ", HEX_FMT_LENGTH);
}
printk( line_buffer );
/* Append a bar. */
strncat(line_buffer, "|", 1);
tmp_len = strnlen(line_buffer, ROW_LENGTH);
/* Now output the ASCII glyphs of printable chars. */
for (i = 0; i < length; ++i) {
snprintf(&line_buffer[tmp_len + i], ASCII_FMT_LENGTH + 1,
"%c", isprint(buffer[i]) ? buffer[i] : '.');
}
/* Fill the remaining space with whitespace (if necessary). */
for(; i < BYTES_PER_ROW; i++) {
strncat(line_buffer, " ", ASCII_FMT_LENGTH);
}
/* Append another bar and print the resulting string. */
printk("%s|\n", line_buffer);
} }