logo

utils-std

Collection of commonly available Unix tools
commit: 59d5fc7d7968bb883f050e099ed7bdad1c58cf61
parent 5b078a8460c78f96002bdd9b9d422109c67a181c
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date:   Tue, 13 Aug 2024 00:44:10 +0200

cmd/cksum: new

Diffstat:

Acmd/cksum.127+++++++++++++++++++++++++++
Acmd/cksum.c164+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Mcoreutils.txt2+-
Mlsb_commands.txt2+-
Mposix_utilities.txt2+-
Mtest-cmd/Kyuafile1+
Atest-cmd/cksum.sh21+++++++++++++++++++++
7 files changed, 216 insertions(+), 3 deletions(-)

diff --git a/cmd/cksum.1 b/cmd/cksum.1 @@ -0,0 +1,27 @@ +.\" utils-std: Collection of commonly available Unix tools +.\" Copyright 2017 Haelwenn (lanodan) Monnier <contact+utils@hacktivis.me> +.\" SPDX-License-Identifier: MPL-2.0 +.Dd 2024-08-13 +.Dt CKSUM 1 +.Os +.Sh NAME +.Nm cksum +.Nd write file checksums and sizes +.Sh SYNOPSIS +.Nm +.Op Ar file... +.Sh DESCRIPTION +.Nm +reads each +.Ar file , +or standard input if none were specified, +and prints each of their CRC-32 checksum and filesize. +.Sh EXIT STATUS +.Ex -std +.Sh STANDARDS +.Nm +should be compliant with the +IEEE Std 1003.1-2024 (“POSIX.1”) +specification. +.Sh AUTHORS +.An Haelwenn (lanodan) Monnier Aq Mt contact+utils@hacktivis.me diff --git a/cmd/cksum.c b/cmd/cksum.c @@ -0,0 +1,164 @@ +// utils-std: Collection of commonly available Unix tools +// SPDX-FileCopyrightText: 2017 Haelwenn (lanodan) Monnier <contact+utils@hacktivis.me> +// SPDX-License-Identifier: MPL-2.0 + +#define _POSIX_C_SOURCE 200809L +#include <errno.h> +#include <fcntl.h> // open, O_* +#include <inttypes.h> // uint32_t +#include <stdio.h> // fprintf +#include <string.h> // strerror +#include <unistd.h> // read, write, close, getopt + +// Table taken from POSIX.1-2024 cksum(1) +// https://pubs.opengroup.org/onlinepubs/9799919799/utilities/cksum.html +// clang-format off +static const uint32_t crctab[256] = { 0x00000000, + 0x04c11db7, 0x09823b6e, 0x0d4326d9, 0x130476dc, 0x17c56b6b, + 0x1a864db2, 0x1e475005, 0x2608edb8, 0x22c9f00f, 0x2f8ad6d6, + 0x2b4bcb61, 0x350c9b64, 0x31cd86d3, 0x3c8ea00a, 0x384fbdbd, + 0x4c11db70, 0x48d0c6c7, 0x4593e01e, 0x4152fda9, 0x5f15adac, + 0x5bd4b01b, 0x569796c2, 0x52568b75, 0x6a1936c8, 0x6ed82b7f, + 0x639b0da6, 0x675a1011, 0x791d4014, 0x7ddc5da3, 0x709f7b7a, + 0x745e66cd, 0x9823b6e0, 0x9ce2ab57, 0x91a18d8e, 0x95609039, + 0x8b27c03c, 0x8fe6dd8b, 0x82a5fb52, 0x8664e6e5, 0xbe2b5b58, + 0xbaea46ef, 0xb7a96036, 0xb3687d81, 0xad2f2d84, 0xa9ee3033, + 0xa4ad16ea, 0xa06c0b5d, 0xd4326d90, 0xd0f37027, 0xddb056fe, + 0xd9714b49, 0xc7361b4c, 0xc3f706fb, 0xceb42022, 0xca753d95, + 0xf23a8028, 0xf6fb9d9f, 0xfbb8bb46, 0xff79a6f1, 0xe13ef6f4, + 0xe5ffeb43, 0xe8bccd9a, 0xec7dd02d, 0x34867077, 0x30476dc0, + 0x3d044b19, 0x39c556ae, 0x278206ab, 0x23431b1c, 0x2e003dc5, + 0x2ac12072, 0x128e9dcf, 0x164f8078, 0x1b0ca6a1, 0x1fcdbb16, + 0x018aeb13, 0x054bf6a4, 0x0808d07d, 0x0cc9cdca, 0x7897ab07, + 0x7c56b6b0, 0x71159069, 0x75d48dde, 0x6b93dddb, 0x6f52c06c, + 0x6211e6b5, 0x66d0fb02, 0x5e9f46bf, 0x5a5e5b08, 0x571d7dd1, + 0x53dc6066, 0x4d9b3063, 0x495a2dd4, 0x44190b0d, 0x40d816ba, + 0xaca5c697, 0xa864db20, 0xa527fdf9, 0xa1e6e04e, 0xbfa1b04b, + 0xbb60adfc, 0xb6238b25, 0xb2e29692, 0x8aad2b2f, 0x8e6c3698, + 0x832f1041, 0x87ee0df6, 0x99a95df3, 0x9d684044, 0x902b669d, + 0x94ea7b2a, 0xe0b41de7, 0xe4750050, 0xe9362689, 0xedf73b3e, + 0xf3b06b3b, 0xf771768c, 0xfa325055, 0xfef34de2, 0xc6bcf05f, + 0xc27dede8, 0xcf3ecb31, 0xcbffd686, 0xd5b88683, 0xd1799b34, + 0xdc3abded, 0xd8fba05a, 0x690ce0ee, 0x6dcdfd59, 0x608edb80, + 0x644fc637, 0x7a089632, 0x7ec98b85, 0x738aad5c, 0x774bb0eb, + 0x4f040d56, 0x4bc510e1, 0x46863638, 0x42472b8f, 0x5c007b8a, + 0x58c1663d, 0x558240e4, 0x51435d53, 0x251d3b9e, 0x21dc2629, + 0x2c9f00f0, 0x285e1d47, 0x36194d42, 0x32d850f5, 0x3f9b762c, + 0x3b5a6b9b, 0x0315d626, 0x07d4cb91, 0x0a97ed48, 0x0e56f0ff, + 0x1011a0fa, 0x14d0bd4d, 0x19939b94, 0x1d528623, 0xf12f560e, + 0xf5ee4bb9, 0xf8ad6d60, 0xfc6c70d7, 0xe22b20d2, 0xe6ea3d65, + 0xeba91bbc, 0xef68060b, 0xd727bbb6, 0xd3e6a601, 0xdea580d8, + 0xda649d6f, 0xc423cd6a, 0xc0e2d0dd, 0xcda1f604, 0xc960ebb3, + 0xbd3e8d7e, 0xb9ff90c9, 0xb4bcb610, 0xb07daba7, 0xae3afba2, + 0xaafbe615, 0xa7b8c0cc, 0xa379dd7b, 0x9b3660c6, 0x9ff77d71, + 0x92b45ba8, 0x9675461f, 0x8832161a, 0x8cf30bad, 0x81b02d74, + 0x857130c3, 0x5d8a9099, 0x594b8d2e, 0x5408abf7, 0x50c9b640, + 0x4e8ee645, 0x4a4ffbf2, 0x470cdd2b, 0x43cdc09c, 0x7b827d21, + 0x7f436096, 0x7200464f, 0x76c15bf8, 0x68860bfd, 0x6c47164a, + 0x61043093, 0x65c52d24, 0x119b4be9, 0x155a565e, 0x18197087, + 0x1cd86d30, 0x029f3d35, 0x065e2082, 0x0b1d065b, 0x0fdc1bec, + 0x3793a651, 0x3352bbe6, 0x3e119d3f, 0x3ad08088, 0x2497d08d, + 0x2056cd3a, 0x2d15ebe3, 0x29d4f654, 0xc5a92679, 0xc1683bce, + 0xcc2b1d17, 0xc8ea00a0, 0xd6ad50a5, 0xd26c4d12, 0xdf2f6bcb, + 0xdbee767c, 0xe3a1cbc1, 0xe760d676, 0xea23f0af, 0xeee2ed18, + 0xf0a5bd1d, 0xf464a0aa, 0xf9278673, 0xfde69bc4, 0x89b8fd09, + 0x8d79e0be, 0x803ac667, 0x84fbdbd0, 0x9abc8bd5, 0x9e7d9662, + 0x933eb0bb, 0x97ffad0c, 0xafb010b1, 0xab710d06, 0xa6322bdf, + 0xa2f33668, 0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4 +}; +// clang-format on + +static int +cksum(int fd, char *fdname) +{ + uint32_t crc = 0; + ssize_t total = 0; + + uint8_t buf[BUFSIZ]; + ssize_t nread = -1; + while((nread = read(fd, buf, BUFSIZ)) > 0) + { + for(ssize_t i = 0; i < nread; i++) + { + uint8_t idx = (crc >> 24) ^ buf[i]; + crc = (crc << 8) ^ crctab[idx]; + } + + total += nread; + } + if(nread < 0) + { + fprintf(stderr, + "cksum: I/O Error while reading file '%s': %s\n", + fdname ? fdname : "<stdin>", + strerror(errno)); + return -1; + } + + for(ssize_t i = total; i; i >>= 8) + { + uint8_t idx = (crc >> 24) ^ (i & 0xFF); + crc = (crc << 8) ^ crctab[idx]; + } + + printf("%" PRIu32 " %zd", ~crc, total); + if(fdname) + { + putchar(' '); + fputs(fdname, stdout); + } + putchar('\n'); + + return 0; +} + +int +main(int argc, char *argv[]) +{ + argc--, argv++; + + if(argc == 0) + { + if(cksum(STDIN_FILENO, NULL) < 0) return 1; + + return 0; + } + + for(int i = 0; i < argc; i++) + { + int fd = -1; + if(argv[i][0] == '-' && argv[i][1] == '\0') + { + argv[i] = "<stdin>"; + fd = STDIN_FILENO; + } + else + { + fd = open(argv[i], O_RDONLY | O_NOCTTY); + if(fd < 0) + { + fprintf(stderr, "cksum: Error: Failed opening file '%s': %s\n", argv[i], strerror(errno)); + return 1; + } + + if(posix_fadvise(fd, 0, 0, POSIX_FADV_SEQUENTIAL) != 0) + fprintf(stderr, + "cksum: Warning: posix_fadvise failed on file '%s': %s\n", + argv[i], + strerror(errno)); + } + + int err = 0; + if(cksum(fd, argv[i]) < 0) err = 1; + + if(close(fd) < 0) + { + fprintf(stderr, "cksum: Failed closing file '%s': %s\n", argv[i], strerror(errno)); + return 1; + } + + if(err == 1) return 1; + } + + return 0; +} diff --git a/coreutils.txt b/coreutils.txt @@ -13,7 +13,7 @@ chgrp: Done chmod: Done chown: Done chroot: Done -cksum: No, POSIX +cksum: Done comm: Maybe, POSIX cp: Todo csplit: No. Considered obsolete diff --git a/lsb_commands.txt b/lsb_commands.txt @@ -13,7 +13,7 @@ chgrp: Done chmod: Done chown: Done chsh: out of scope -cksum: No, POSIX +cksum: Done cmp: Done col: No? comm: Maybe, POSIX diff --git a/posix_utilities.txt b/posix_utilities.txt @@ -21,7 +21,7 @@ cflow: no, toolchain XOPEN_UNIX chgrp: done chmod: done chown: done -cksum +cksum: done cmp: done comm command: no, sh built-in diff --git a/test-cmd/Kyuafile b/test-cmd/Kyuafile @@ -15,6 +15,7 @@ tap_test_program{name="base64.sh", required_files=basedir.."/cmd/base64", timeou tap_test_program{name="basename.sh", required_files=basedir.."/cmd/basename", timeout=1} tap_test_program{name="cat.sh", required_files=basedir.."/cmd/cat", timeout=1} tap_test_program{name="chmod.sh", required_files=basedir.."/cmd/chmod", timeout=1} +tap_test_program{name="cksum.sh", required_files=basedir.."/cmd/cksum", timeout=1} tap_test_program{name="cmp.sh", required_files=basedir.."/cmd/cmp", timeout=1} tap_test_program{name="date.sh", required_files=basedir.."/cmd/date", timeout=1} tap_test_program{name="dirname.sh", required_files=basedir.."/cmd/dirname", timeout=1} diff --git a/test-cmd/cksum.sh b/test-cmd/cksum.sh @@ -0,0 +1,21 @@ +#!/bin/sh +# SPDX-FileCopyrightText: 2017 Haelwenn (lanodan) Monnier <contact+utils@hacktivis.me> +# SPDX-License-Identifier: MPL-2.0 + +WD="$(dirname "$0")" +target="${WD}/../cmd/cksum" +plans=5 +. "$(dirname "$0")/tap.sh" + +t devnull '/dev/null' '4294967295 0 /dev/null +' +t empty "$WD/inputs/empty" "4294967295 0 $WD/inputs/empty +" +t --input='' 'empty_stdin' '' '4294967295 0 +' + +t all_bytes "$WD/inputs/all_bytes" "1313719201 256 $WD/inputs/all_bytes +" + +t --exit=1 'enoent' '/var/empty/e/no/ent' "cksum: Error: Failed opening file '/var/empty/e/no/ent': No such file or directory +"