diff options
| -rw-r--r-- | util/nvmutil/nvmutil.c | 248 |
1 files changed, 129 insertions, 119 deletions
diff --git a/util/nvmutil/nvmutil.c b/util/nvmutil/nvmutil.c index 314d4755..fe3656cd 100644 --- a/util/nvmutil/nvmutil.c +++ b/util/nvmutil/nvmutil.c @@ -88,7 +88,6 @@ static void check_enum_bin(size_t a, const char *a_name, static void set_cmd(int argc, char *argv[]); static void set_cmd_args(int argc, char *argv[]); static size_t conv_argv_part_num(const char *part_str); -static void set_io_flags(int argc, char *argv[]); static int xstrxcmp(const char *a, const char *b, size_t maxlen); #ifndef NVMUTIL_ARC4RANDOM_BUF static void open_dev_urandom(void); @@ -97,8 +96,6 @@ static void open_gbe_file(void); static void xopen(int *fd, const char *path, int flags, struct stat *st); static void read_gbe_file(void); static void read_gbe_file_part(size_t part); -static ssize_t read_gbe_file_exact(int fd, void *buf, size_t len, - off_t off); static void read_checksums(void); static int good_checksum(size_t partnum); static void run_cmd(size_t c); @@ -112,14 +109,14 @@ static void set_mac_nib(size_t mac_str_pos, size_t mac_byte_pos, size_t mac_nib_pos); static uint16_t hextonum(char ch_s); static uint16_t rhex(void); -#ifndef NVMUTIL_ARC4RANDOM_BUF -static ssize_t read_dev_urandom(int fd, void *buf, - size_t len); -#endif +static void read_file_exact(int fd, uint8_t *mem, size_t len, + off_t off, uint8_t plesen, const char *path); static void write_mac_part(size_t partnum); static void cmd_helper_dump(void); static void print_mac_from_nvm(size_t partnum); static void hexdump(size_t partnum); +static void cmd_helper_cat(void); +static void gbe_cat_buf(uint8_t *b); static void write_gbe_file(void); static void override_part_modified(void); static void set_checksum(size_t part); @@ -131,7 +128,7 @@ static void check_nvm_bound(size_t pos16, size_t part); static void check_bin(size_t a, const char *a_name); static void write_gbe_file_part(size_t part); static off_t gbe_file_offset(size_t part, const char *f_op); -static void *gbe_mem_offset(size_t part, const char *f_op); +static uint8_t *gbe_mem_offset(size_t part, const char *f_op); static off_t gbe_x_offset(size_t part, const char *f_op, const char *d_type, off_t nsize, off_t ncmp); static void err(int nvm_errval, const char *msg, ...); @@ -196,11 +193,11 @@ static const char *rname = NULL; * The code will handle this properly. */ static uint8_t buf[GBE_FILE_SIZE]; +static uint8_t pad[GBE_PART_SIZE]; static uint16_t mac_buf[3]; static off_t gbe_file_size; -static int gbe_flags; #ifndef NVMUTIL_ARC4RANDOM_BUF static int urandom_fd = -1; #endif @@ -236,6 +233,9 @@ enum { CMD_SETMAC, CMD_SWAP, CMD_COPY, + CMD_CAT, + CMD_CAT16, + CMD_CAT128 }; /* @@ -276,27 +276,24 @@ struct commands { uint8_t chksum_read; uint8_t chksum_write; size_t rw_size; /* within the 4KB GbE part */ + int flags; /* e.g. O_RDWR or O_RDONLY */ }; /* * Command table, for nvmutil commands */ static const struct commands command[] = { - /* - * Unlike older versions, we require at least - * one checksum to be valid when running dump. - */ { CMD_DUMP, "dump", cmd_helper_dump, ARGC_3, NO_INVERT, SET_MOD_OFF, ARG_NOPART, - CHECKSUM_READ, SKIP_CHECKSUM_WRITE, - NVM_SIZE }, + SKIP_CHECKSUM_READ, SKIP_CHECKSUM_WRITE, + NVM_SIZE, O_RDONLY }, { CMD_SETMAC, "setmac", cmd_helper_setmac, ARGC_3, NO_INVERT, SET_MOD_OFF, ARG_NOPART, CHECKSUM_READ, CHECKSUM_WRITE, - NVM_SIZE }, + NVM_SIZE, O_RDWR }, /* * OPTIMISATION: Read inverted, so no copying is needed. @@ -305,7 +302,7 @@ static const struct commands command[] = { PART_INVERT, SET_MOD_BOTH, ARG_NOPART, CHECKSUM_READ, SKIP_CHECKSUM_WRITE, - GBE_PART_SIZE }, + GBE_PART_SIZE, O_RDWR }, /* * OPTIMISATION: Read inverted, so no copying is needed. @@ -315,7 +312,25 @@ static const struct commands command[] = { PART_INVERT, SET_MOD_N, ARG_PART, CHECKSUM_READ, SKIP_CHECKSUM_WRITE, - GBE_PART_SIZE }, + GBE_PART_SIZE, O_RDWR }, + + { CMD_CAT, "cat", cmd_helper_cat, ARGC_3, + NO_INVERT, SET_MOD_OFF, + ARG_NOPART, + CHECKSUM_READ, SKIP_CHECKSUM_WRITE, + GBE_PART_SIZE, O_RDONLY }, + + { CMD_CAT16, "cat16", cmd_helper_cat, ARGC_3, + NO_INVERT, SET_MOD_OFF, + ARG_NOPART, + CHECKSUM_READ, SKIP_CHECKSUM_WRITE, + GBE_PART_SIZE, O_RDONLY }, + + { CMD_CAT128, "cat128", cmd_helper_cat, ARGC_3, + NO_INVERT, SET_MOD_OFF, + ARG_NOPART, + CHECKSUM_READ, SKIP_CHECKSUM_WRITE, + GBE_PART_SIZE, O_RDONLY }, }; #define MAX_CMD_LEN 50 @@ -352,11 +367,10 @@ main(int argc, char *argv[]) set_cmd(argc, argv); set_cmd_args(argc, argv); - set_io_flags(argc, argv); #ifdef NVMUTIL_PLEDGE #ifdef NVMUTIL_UNVEIL - if (gbe_flags == O_RDONLY) { + if (command[cmd_index].flags == O_RDONLY) { if (unveil(fname, "r") == -1) err(ECANCELED, "%s: unveil ro", fname); if (unveil(NULL, NULL) == -1) @@ -372,7 +386,7 @@ main(int argc, char *argv[]) err(ECANCELED, "pledge rw (kill unveil)"); } #else - if (gbe_flags == O_RDONLY) { + if (command[cmd_index].flags == O_RDONLY) { if (pledge("stdio rpath", NULL) == -1) err(ECANCELED, "pledge ro"); } @@ -395,6 +409,11 @@ main(int argc, char *argv[]) err(ECANCELED, "pledge stdio (main)"); #endif + /* + * Used by CMD_CAT, for padding + */ + memset(pad, 0xff, sizeof(pad)); + read_gbe_file(); read_checksums(); @@ -402,7 +421,7 @@ main(int argc, char *argv[]) if (errno) err(errno, "%s: Unhandled error (WRITE SKIPPED)", fname); - else if (gbe_flags != O_RDONLY) + else if (command[cmd_index].flags == O_RDWR) write_gbe_file(); close_files(); @@ -489,6 +508,10 @@ sanitize_command_index(size_t c) if (gbe_rw_size > GBE_PART_SIZE) err(EINVAL, "rw_size larger than GbE part: %zu", gbe_rw_size); + + if (command[c].flags != O_RDONLY && + command[c].flags != O_RDWR) + err(EINVAL, "invalid cmd.flags setting"); } static void @@ -561,18 +584,6 @@ conv_argv_part_num(const char *part_str) return (size_t)(ch - '0'); } -static void -set_io_flags(int argc, char *argv[]) -{ - gbe_flags = O_RDWR; - - if (argc < 3) - return; - - if (xstrxcmp(argv[2], "dump", MAX_CMD_LEN) == 0) - gbe_flags = O_RDONLY; -} - /* * Portable strcmp() but blocks NULL/empty/unterminated * strings. Even stricter than strncmp(). @@ -637,7 +648,7 @@ open_gbe_file(void) { struct stat gbe_st; - xopen(&gbe_fd, fname, gbe_flags, &gbe_st); + xopen(&gbe_fd, fname, command[cmd_index].flags, &gbe_st); gbe_file_size = gbe_st.st_size; @@ -684,48 +695,12 @@ static void read_gbe_file_part(size_t p) { size_t gbe_rw_size = command[cmd_index].rw_size; - - void *mem_offset = + uint8_t *mem_offset = gbe_mem_offset(p ^ command[cmd_index].invert, "pread"); - if ((size_t)read_gbe_file_exact(gbe_fd, mem_offset, - gbe_rw_size, gbe_file_offset(p, "pread")) != - gbe_rw_size) - err(ECANCELED, "%s: Partial read from p%zu", fname, p); - - printf("%s: Read %zu bytes from p%zu\n", - fname, gbe_rw_size, p); -} - -static ssize_t -read_gbe_file_exact(int fd, - void *buf, size_t len, off_t off) -{ - int retry; - ssize_t rval; - - if (fd == -1) - err(ECANCELED, "Trying to open bad fd: %s", fname); - - for (retry = 0; retry < MAX_RETRY_RW; retry++) { - rval = pread(fd, buf, len, off); - - if (rval == (ssize_t)len) { - errno = 0; - return rval; - } else if (rval != -1) { - err(ECANCELED, - "%s: Short pread of %zd bytes", - fname, rval); - } else if (errno != EINTR) { - err(ECANCELED, - "%s: Could not pread", fname); - } - } - - err(EINTR, "%s: pread: max retries exceeded", fname); - - return -1; + read_file_exact(gbe_fd, mem_offset, + gbe_rw_size, gbe_file_offset(p, "pread"), + 1, fname); } static void @@ -771,9 +746,13 @@ read_checksums(void) if (num_invalid < max_invalid) errno = 0; - if (num_invalid >= max_invalid) + if (num_invalid >= max_invalid) { + if (max_invalid == 1) + err(ECANCELED, "%s: part %zu has a bad checksum", + fname, part); err(ECANCELED, "%s: No valid checksum found in file", fname); + } } static int @@ -782,21 +761,9 @@ good_checksum(size_t partnum) uint16_t expected_checksum = calculated_checksum(partnum); uint16_t current_checksum = nvm_word(NVM_CHECKSUM_WORD, partnum); - size_t real_partnum = partnum ^ command[cmd_index].invert; - if (current_checksum == expected_checksum) return 1; - fprintf(stderr, - "WARNING: BAD checksum in part %zu\n" - "EXPECTED checksum in part %zu: %04x\n" - "CURRENT checksum in part %zu: %04x\n", - real_partnum, - real_partnum, - expected_checksum, - real_partnum, - current_checksum); - set_err(ECANCELED); return 0; } @@ -967,52 +934,45 @@ rhex(void) static uint8_t rnum[12]; if (!n) { -#ifdef NVMUTIL_ARC4RANDOM_BUF n = sizeof(rnum); +#ifdef NVMUTIL_ARC4RANDOM_BUF arc4random_buf(rnum, n); #else - n = (size_t)read_dev_urandom( - urandom_fd, rnum, sizeof(rnum)); - - if (!n || n > sizeof(rnum)) - err(ECANCELED, "Randomisation failure"); + read_file_exact(urandom_fd, rnum, n, 0, 0, rname); #endif } return (uint16_t)(rnum[--n] & 0xf); } -#ifndef NVMUTIL_ARC4RANDOM_BUF -static ssize_t -read_dev_urandom(int fd, void *buf, size_t len) +static void +read_file_exact(int fd, uint8_t *mem, + size_t len, off_t off, uint8_t plesen, const char *path) { - int retry; - ssize_t rval; + ssize_t rval = -1; + ssize_t rc = 0; if (fd == -1) - err(ECANCELED, "Trying to open bad fd: %s", rname); + err(ECANCELED, "Trying to open bad fd: %s", path); - for (retry = 0; retry < MAX_RETRY_RW; retry++) { - rval = read(fd, buf, len); + for (rc = 0; rc != (ssize_t)len; rc += rval) { + if (plesen) + rval = pread(fd, mem + rc, len - rc, off + rc); + else + rval = read(fd, mem + rc, len - rc); - if (rval == -1) { - if (errno == EINTR) - continue; - err(errno, "%s", rname); + if (rval > -1) { + if (!rval) /* prevent infinite loop */ + err(EIO, "%s: read of 0 bytes", path); + continue; } - if (!rval || (size_t)rval > len) - continue; + if (errno != EINTR || rval < -1) + err(EIO, "%s", path); errno = 0; - return rval; } - - err(EINTR, "%s: read: max retries exceeded: %s", rname); - - return -1; } -#endif static void write_mac_part(size_t partnum) @@ -1035,7 +995,18 @@ cmd_helper_dump(void) { size_t partnum; + part_valid[0] = good_checksum(0); + part_valid[1] = good_checksum(1); + + if (part_valid[0] || part_valid[1]) + errno = 0; + for (partnum = 0; partnum < 2; partnum++) { + if (!part_valid[partnum]) + fprintf(stderr, + "BAD checksum %04x in part %zu (expected %04x)\n", + nvm_word(NVM_CHECKSUM_WORD, partnum), + partnum, calculated_checksum(partnum)); printf("MAC (part %zu): ", partnum); print_mac_from_nvm(partnum); @@ -1078,13 +1049,48 @@ hexdump(size_t partnum) } static void +cmd_helper_cat(void) +{ + size_t p; + size_t ff; + size_t n = 0; + + if (cmd_index == CMD_CAT16) + n = 1; + else if (cmd_index == CMD_CAT128) + n = 15; + else if (cmd_index != CMD_CAT) + err(ECANCELED, "cmd_helper_cat called erroneously"); + + fflush(NULL); + + for (p = 0; p < 2; p++) { + gbe_cat_buf(buf + (p * GBE_PART_SIZE)); + + for (ff = 0; ff < n; ff++) + gbe_cat_buf(pad); + } +} + +static void +gbe_cat_buf(uint8_t *b) +{ + size_t wc; + ssize_t w = 0; + + for (wc = 0; wc < GBE_PART_SIZE; wc += w) + if ((w = write(STDOUT_FILENO, b + wc, GBE_PART_SIZE - wc)) < 1) + err(EIO, "%s: stdout", fname); +} + +static void write_gbe_file(void) { size_t p; size_t partnum; uint8_t update_checksum; - if (gbe_flags == O_RDONLY) + if (command[cmd_index].flags == O_RDONLY) return; update_checksum = command[cmd_index].chksum_write; @@ -1271,13 +1277,13 @@ gbe_file_offset(size_t p, const char *f_op) * but used to check Gbe bounds in memory, * and it is *also* used during file I/O. */ -static void * +static uint8_t * gbe_mem_offset(size_t p, const char *f_op) { off_t gbe_off = gbe_x_offset(p, f_op, "mem", GBE_PART_SIZE, GBE_FILE_SIZE); - return (void *)(buf + gbe_off); + return (uint8_t *)(buf + gbe_off); } static off_t @@ -1382,8 +1388,12 @@ usage(uint8_t usage_exit) "\t%s FILE dump\n" "\t%s FILE setmac [MAC]\n" "\t%s FILE swap\n" - "\t%s FILE copy 0|1\n", - util, util, util, util); + "\t%s FILE copy 0|1\n" + "\t%s FILE cat\n" + "\t%s FILE cat16\n" + "\t%s FILE cat128\n", + util, util, util, util, + util, util, util); if (usage_exit) err(EINVAL, "Too few arguments"); |