electrobun 0.0.1 → 0.0.3

package/src/bsdiff/zstd/examples/Makefile

@@ -1,93 +0,0 @@
-# ################################################################
-# Copyright (c) Meta Platforms, Inc. and affiliates.
-# All rights reserved.
-#
-# This source code is licensed under both the BSD-style license (found in the
-# LICENSE file in the root directory of this source tree) and the GPLv2 (found
-# in the COPYING file in the root directory of this source tree).
-# You may select, at your option, one of the above-listed licenses.
-# ################################################################
-
-LIBDIR =../lib
-CPPFLAGS += -I$(LIBDIR)
-LIB = $(LIBDIR)/libzstd.a
-
-
-.PHONY: default
-default: all
-
-.PHONY: all
-all: simple_compression simple_decompression \
-	multiple_simple_compression\
-	dictionary_compression dictionary_decompression \
-	streaming_compression streaming_decompression \
-	multiple_streaming_compression streaming_memory_usage
-
-$(LIB) :
-	$(MAKE) -C $(LIBDIR) libzstd.a
-
-simple_compression.o: common.h
-simple_compression : $(LIB)
-
-simple_decompression.o: common.h
-simple_decompression : $(LIB)
-
-multiple_simple_compression.o: common.h
-multiple_simple_compression : $(LIB)
-
-dictionary_compression.o: common.h
-dictionary_compression : $(LIB)
-
-dictionary_decompression.o: common.h
-dictionary_decompression : $(LIB)
-
-streaming_compression.o: common.h
-streaming_compression : $(LIB)
-
-multiple_streaming_compression.o: common.h
-multiple_streaming_compression : $(LIB)
-
-streaming_decompression.o: common.h
-streaming_decompression : $(LIB)
-
-streaming_memory_usage.o: common.h
-streaming_memory_usage : $(LIB)
-
-
-.PHONY:clean
-clean:
-	@$(RM) core *.o tmp* result* *.zst \
-        simple_compression simple_decompression \
-        multiple_simple_compression \
-        dictionary_compression dictionary_decompression \
-        streaming_compression streaming_decompression \
-        multiple_streaming_compression streaming_memory_usage
-	@echo Cleaning completed
-
-.PHONY:test
-test: all
-	cp README.md tmp
-	cp Makefile tmp2
-	@echo -- Simple compression tests
-	./simple_compression tmp
-	./simple_decompression tmp.zst
-	./multiple_simple_compression *.c
-	./streaming_decompression tmp.zst > /dev/null
-	@echo -- Streaming memory usage
-	./streaming_memory_usage
-	@echo -- Streaming compression tests
-	./streaming_compression tmp
-	./streaming_decompression tmp.zst > /dev/null
-	@echo -- Edge cases detection
-	! ./streaming_decompression tmp    # invalid input, must fail
-	! ./simple_decompression tmp       # invalid input, must fail
-	touch tmpNull                      # create 0-size file
-	./simple_compression tmpNull
-	./simple_decompression tmpNull.zst # 0-size frame : must work
-	@echo -- Multiple streaming tests
-	./multiple_streaming_compression *.c
-	@echo -- Dictionary compression tests
-	./dictionary_compression tmp2 tmp README.md
-	./dictionary_decompression tmp2.zst tmp.zst README.md
-	$(RM) tmp* *.zst
-	@echo tests completed

package/src/bsdiff/zstd/examples/README.md

@@ -1,46 +0,0 @@
-Zstandard library : usage examples
-==================================
-
-- [Simple compression](simple_compression.c) :
-  Compress a single file.
-  Introduces usage of : `ZSTD_compress()`
-
-- [Simple decompression](simple_decompression.c) :
-  Decompress a single file.
-  Only compatible with simple compression.
-  Result remains in memory.
-  Introduces usage of : `ZSTD_decompress()`
-
-- [Multiple simple compression](multiple_simple_compression.c) :
-  Compress multiple files (in simple mode) in a single command line.
-  Demonstrates memory preservation technique that
-  minimizes malloc()/free() calls by re-using existing resources.
-  Introduces usage of : `ZSTD_compressCCtx()`
-
-- [Streaming memory usage](streaming_memory_usage.c) :
-  Provides amount of memory used by streaming context.
-  Introduces usage of : `ZSTD_sizeof_CStream()`
-
-- [Streaming compression](streaming_compression.c) :
-  Compress a single file.
-  Introduces usage of : `ZSTD_compressStream()`
-
-- [Multiple Streaming compression](multiple_streaming_compression.c) :
-  Compress multiple files (in streaming mode) in a single command line.
-  Introduces memory usage preservation technique,
-  reducing impact of malloc()/free() and memset() by re-using existing resources.
-
-- [Streaming decompression](streaming_decompression.c) :
-  Decompress a single file compressed by zstd.
-  Compatible with both simple and streaming compression.
-  Result is sent to stdout.
-  Introduces usage of : `ZSTD_decompressStream()`
-
-- [Dictionary compression](dictionary_compression.c) :
-  Compress multiple files using the same dictionary.
-  Introduces usage of : `ZSTD_createCDict()` and `ZSTD_compress_usingCDict()`
-
-- [Dictionary decompression](dictionary_decompression.c) :
-  Decompress multiple files using the same dictionary.
-  Result remains in memory.
-  Introduces usage of : `ZSTD_createDDict()` and `ZSTD_decompress_usingDDict()`

package/src/bsdiff/zstd/examples/common.h

@@ -1,246 +0,0 @@
-/*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- * All rights reserved.
- *
- * This source code is licensed under both the BSD-style license (found in the
- * LICENSE file in the root directory of this source tree) and the GPLv2 (found
- * in the COPYING file in the root directory of this source tree).
- * You may select, at your option, one of the above-listed licenses.
- */
-
-/*
- * This header file has common utility functions used in examples.
- */
-#ifndef COMMON_H
-#define COMMON_H
-
-#include <stdlib.h>    // malloc, free, exit
-#include <stdio.h>     // fprintf, perror, fopen, etc.
-#include <string.h>    // strerror
-#include <errno.h>     // errno
-#include <sys/stat.h>  // stat
-#include <zstd.h>
-
-
-/* UNUSED_ATTR tells the compiler it is okay if the function is unused. */
-#if defined(__GNUC__)
-#  define UNUSED_ATTR __attribute__((unused))
-#else
-#  define UNUSED_ATTR
-#endif
-
-#define HEADER_FUNCTION static UNUSED_ATTR
-
-
-/*
- * Define the returned error code from utility functions.
- */
-typedef enum {
-    ERROR_fsize = 1,
-    ERROR_fopen = 2,
-    ERROR_fclose = 3,
-    ERROR_fread = 4,
-    ERROR_fwrite = 5,
-    ERROR_loadFile = 6,
-    ERROR_saveFile = 7,
-    ERROR_malloc = 8,
-    ERROR_largeFile = 9,
-} COMMON_ErrorCode;
-
-/*! CHECK
- * Check that the condition holds. If it doesn't print a message and die.
- */
-#define CHECK(cond, ...)                        \
-    do {                                        \
-        if (!(cond)) {                          \
-            fprintf(stderr,                     \
-                    "%s:%d CHECK(%s) failed: ", \
-                    __FILE__,                   \
-                    __LINE__,                   \
-                    #cond);                     \
-            fprintf(stderr, "" __VA_ARGS__);    \
-            fprintf(stderr, "\n");              \
-            exit(1);                            \
-        }                                       \
-    } while (0)
-
-/*! CHECK_ZSTD
- * Check the zstd error code and die if an error occurred after printing a
- * message.
- */
-#define CHECK_ZSTD(fn)                                           \
-    do {                                                         \
-        size_t const err = (fn);                                 \
-        CHECK(!ZSTD_isError(err), "%s", ZSTD_getErrorName(err)); \
-    } while (0)
-
-/*! fsize_orDie() :
- * Get the size of a given file path.
- *
- * @return The size of a given file path.
- */
-HEADER_FUNCTION size_t fsize_orDie(const char *filename)
-{
-    struct stat st;
-    if (stat(filename, &st) != 0) {
-        /* error */
-        perror(filename);
-        exit(ERROR_fsize);
-    }
-
-    off_t const fileSize = st.st_size;
-    size_t const size = (size_t)fileSize;
-    /* 1. fileSize should be non-negative,
-     * 2. if off_t -> size_t type conversion results in discrepancy,
-     *    the file size is too large for type size_t.
-     */
-    if ((fileSize < 0) || (fileSize != (off_t)size)) {
-        fprintf(stderr, "%s : filesize too large \n", filename);
-        exit(ERROR_largeFile);
-    }
-    return size;
-}
-
-/*! fopen_orDie() :
- * Open a file using given file path and open option.
- *
- * @return If successful this function will return a FILE pointer to an
- * opened file otherwise it sends an error to stderr and exits.
- */
-HEADER_FUNCTION FILE* fopen_orDie(const char *filename, const char *instruction)
-{
-    FILE* const inFile = fopen(filename, instruction);
-    if (inFile) return inFile;
-    /* error */
-    perror(filename);
-    exit(ERROR_fopen);
-}
-
-/*! fclose_orDie() :
- * Close an opened file using given FILE pointer.
- */
-HEADER_FUNCTION void fclose_orDie(FILE* file)
-{
-    if (!fclose(file)) { return; };
-    /* error */
-    perror("fclose");
-    exit(ERROR_fclose);
-}
-
-/*! fread_orDie() :
- *
- * Read sizeToRead bytes from a given file, storing them at the
- * location given by buffer.
- *
- * @return The number of bytes read.
- */
-HEADER_FUNCTION size_t fread_orDie(void* buffer, size_t sizeToRead, FILE* file)
-{
-    size_t const readSize = fread(buffer, 1, sizeToRead, file);
-    if (readSize == sizeToRead) return readSize;   /* good */
-    if (feof(file)) return readSize;   /* good, reached end of file */
-    /* error */
-    perror("fread");
-    exit(ERROR_fread);
-}
-
-/*! fwrite_orDie() :
- *
- * Write sizeToWrite bytes to a file pointed to by file, obtaining
- * them from a location given by buffer.
- *
- * Note: This function will send an error to stderr and exit if it
- * cannot write data to the given file pointer.
- *
- * @return The number of bytes written.
- */
-HEADER_FUNCTION size_t fwrite_orDie(const void* buffer, size_t sizeToWrite, FILE* file)
-{
-    size_t const writtenSize = fwrite(buffer, 1, sizeToWrite, file);
-    if (writtenSize == sizeToWrite) return sizeToWrite;   /* good */
-    /* error */
-    perror("fwrite");
-    exit(ERROR_fwrite);
-}
-
-/*! malloc_orDie() :
- * Allocate memory.
- *
- * @return If successful this function returns a pointer to allo-
- * cated memory.  If there is an error, this function will send that
- * error to stderr and exit.
- */
-HEADER_FUNCTION void* malloc_orDie(size_t size)
-{
-    void* const buff = malloc(size);
-    if (buff) return buff;
-    /* error */
-    perror("malloc");
-    exit(ERROR_malloc);
-}
-
-/*! loadFile_orDie() :
- * load file into buffer (memory).
- *
- * Note: This function will send an error to stderr and exit if it
- * cannot read data from the given file path.
- *
- * @return If successful this function will load file into buffer and
- * return file size, otherwise it will printout an error to stderr and exit.
- */
-HEADER_FUNCTION size_t loadFile_orDie(const char* fileName, void* buffer, size_t bufferSize)
-{
-    size_t const fileSize = fsize_orDie(fileName);
-    CHECK(fileSize <= bufferSize, "File too large!");
-
-    FILE* const inFile = fopen_orDie(fileName, "rb");
-    size_t const readSize = fread(buffer, 1, fileSize, inFile);
-    if (readSize != (size_t)fileSize) {
-        fprintf(stderr, "fread: %s : %s \n", fileName, strerror(errno));
-        exit(ERROR_fread);
-    }
-    fclose(inFile);  /* can't fail, read only */
-    return fileSize;
-}
-
-/*! mallocAndLoadFile_orDie() :
- * allocate memory buffer and then load file into it.
- *
- * Note: This function will send an error to stderr and exit if memory allocation
- * fails or it cannot read data from the given file path.
- *
- * @return If successful this function will return buffer and bufferSize(=fileSize),
- * otherwise it will printout an error to stderr and exit.
- */
-HEADER_FUNCTION void* mallocAndLoadFile_orDie(const char* fileName, size_t* bufferSize)
-{
-    size_t const fileSize = fsize_orDie(fileName);
-    *bufferSize = fileSize;
-    void* const buffer = malloc_orDie(*bufferSize);
-    loadFile_orDie(fileName, buffer, *bufferSize);
-    return buffer;
-}
-
-/*! saveFile_orDie() :
- *
- * Save buffSize bytes to a given file path, obtaining them from a location pointed
- * to by buff.
- *
- * Note: This function will send an error to stderr and exit if it
- * cannot write to a given file.
- */
-HEADER_FUNCTION void saveFile_orDie(const char* fileName, const void* buff, size_t buffSize)
-{
-    FILE* const oFile = fopen_orDie(fileName, "wb");
-    size_t const wSize = fwrite(buff, 1, buffSize, oFile);
-    if (wSize != (size_t)buffSize) {
-        fprintf(stderr, "fwrite: %s : %s \n", fileName, strerror(errno));
-        exit(ERROR_fwrite);
-    }
-    if (fclose(oFile)) {
-        perror(fileName);
-        exit(ERROR_fclose);
-    }
-}
-
-#endif

package/src/bsdiff/zstd/examples/dictionary_compression.c

@@ -1,107 +0,0 @@
-/*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- * All rights reserved.
- *
- * This source code is licensed under both the BSD-style license (found in the
- * LICENSE file in the root directory of this source tree) and the GPLv2 (found
- * in the COPYING file in the root directory of this source tree).
- * You may select, at your option, one of the above-listed licenses.
-**/
-
-/* This example deals with Dictionary compression,
- * its counterpart is `examples/dictionary_decompression.c` .
- * These examples presume that a dictionary already exists.
- * The main method to create a dictionary is `zstd --train`,
- * look at the CLI documentation for details.
- * Another possible method is to employ dictionary training API,
- * published in `lib/zdict.h` .
-**/
-
-#include <stdio.h>     // printf
-#include <stdlib.h>    // free
-#include <string.h>    // memset, strcat
-#include <zstd.h>      // presumes zstd library is installed
-#include "common.h"    // Helper functions, CHECK(), and CHECK_ZSTD()
-
-/* createDict() :
-** `dictFileName` is supposed already created using `zstd --train` */
-static ZSTD_CDict* createCDict_orDie(const char* dictFileName, int cLevel)
-{
-    size_t dictSize;
-    printf("loading dictionary %s \n", dictFileName);
-    void* const dictBuffer = mallocAndLoadFile_orDie(dictFileName, &dictSize);
-    ZSTD_CDict* const cdict = ZSTD_createCDict(dictBuffer, dictSize, cLevel);
-    CHECK(cdict != NULL, "ZSTD_createCDict() failed!");
-    free(dictBuffer);
-    return cdict;
-}
-
-
-static void compress(const char* fname, const char* oname, const ZSTD_CDict* cdict)
-{
-    size_t fSize;
-    void* const fBuff = mallocAndLoadFile_orDie(fname, &fSize);
-    size_t const cBuffSize = ZSTD_compressBound(fSize);
-    void* const cBuff = malloc_orDie(cBuffSize);
-
-    /* Compress using the dictionary.
-     * This function writes the dictionary id, and content size into the header.
-     * But, it doesn't use a checksum. You can control these options using the
-     * advanced API: ZSTD_CCtx_setParameter(), ZSTD_CCtx_refCDict(),
-     * and ZSTD_compress2().
-     */
-    ZSTD_CCtx* const cctx = ZSTD_createCCtx();
-    CHECK(cctx != NULL, "ZSTD_createCCtx() failed!");
-    size_t const cSize = ZSTD_compress_usingCDict(cctx, cBuff, cBuffSize, fBuff, fSize, cdict);
-    CHECK_ZSTD(cSize);
-
-    saveFile_orDie(oname, cBuff, cSize);
-
-    /* success */
-    printf("%25s : %6u -> %7u - %s \n", fname, (unsigned)fSize, (unsigned)cSize, oname);
-
-    ZSTD_freeCCtx(cctx);   /* never fails */
-    free(fBuff);
-    free(cBuff);
-}
-
-
-static char* createOutFilename_orDie(const char* filename)
-{
-    size_t const inL = strlen(filename);
-    size_t const outL = inL + 5;
-    void* outSpace = malloc_orDie(outL);
-    memset(outSpace, 0, outL);
-    strcat(outSpace, filename);
-    strcat(outSpace, ".zst");
-    return (char*)outSpace;
-}
-
-int main(int argc, const char** argv)
-{
-    const char* const exeName = argv[0];
-    int const cLevel = 3;
-
-    if (argc<3) {
-        fprintf(stderr, "wrong arguments\n");
-        fprintf(stderr, "usage:\n");
-        fprintf(stderr, "%s [FILES] dictionary\n", exeName);
-        return 1;
-    }
-
-    /* load dictionary only once */
-    const char* const dictName = argv[argc-1];
-    ZSTD_CDict* const dictPtr = createCDict_orDie(dictName, cLevel);
-
-    int u;
-    for (u=1; u<argc-1; u++) {
-        const char* inFilename = argv[u];
-        char* const outFilename = createOutFilename_orDie(inFilename);
-        compress(inFilename, outFilename, dictPtr);
-        free(outFilename);
-    }
-
-    ZSTD_freeCDict(dictPtr);
-    printf("All %u files compressed. \n", argc-2);
-    return 0;
-}

package/src/bsdiff/zstd/examples/dictionary_decompression.c

@@ -1,99 +0,0 @@
-/*
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- * All rights reserved.
- *
- * This source code is licensed under both the BSD-style license (found in the
- * LICENSE file in the root directory of this source tree) and the GPLv2 (found
- * in the COPYING file in the root directory of this source tree).
- * You may select, at your option, one of the above-listed licenses.
- */
-
-
-#include <stdio.h>     // printf
-#include <stdlib.h>    // free
-#include <zstd.h>      // presumes zstd library is installed
-#include "common.h"    // Helper functions, CHECK(), and CHECK_ZSTD()
-
-/* createDict() :
-   `dictFileName` is supposed to have been created using `zstd --train` */
-static ZSTD_DDict* createDict_orDie(const char* dictFileName)
-{
-    size_t dictSize;
-    printf("loading dictionary %s \n", dictFileName);
-    void* const dictBuffer = mallocAndLoadFile_orDie(dictFileName, &dictSize);
-    ZSTD_DDict* const ddict = ZSTD_createDDict(dictBuffer, dictSize);
-    CHECK(ddict != NULL, "ZSTD_createDDict() failed!");
-    free(dictBuffer);
-    return ddict;
-}
-
-static void decompress(const char* fname, const ZSTD_DDict* ddict)
-{
-    size_t cSize;
-    void* const cBuff = mallocAndLoadFile_orDie(fname, &cSize);
-    /* Read the content size from the frame header. For simplicity we require
-     * that it is always present. By default, zstd will write the content size
-     * in the header when it is known. If you can't guarantee that the frame
-     * content size is always written into the header, either use streaming
-     * decompression, or ZSTD_decompressBound().
-     */
-    unsigned long long const rSize = ZSTD_getFrameContentSize(cBuff, cSize);
-    CHECK(rSize != ZSTD_CONTENTSIZE_ERROR, "%s: not compressed by zstd!", fname);
-    CHECK(rSize != ZSTD_CONTENTSIZE_UNKNOWN, "%s: original size unknown!", fname);
-    void* const rBuff = malloc_orDie((size_t)rSize);
-
-    /* Check that the dictionary ID matches.
-     * If a non-zstd dictionary is used, then both will be zero.
-     * By default zstd always writes the dictionary ID into the frame.
-     * Zstd will check if there is a dictionary ID mismatch as well.
-     */
-    unsigned const expectedDictID = ZSTD_getDictID_fromDDict(ddict);
-    unsigned const actualDictID = ZSTD_getDictID_fromFrame(cBuff, cSize);
-    CHECK(actualDictID == expectedDictID,
-          "DictID mismatch: expected %u got %u",
-          expectedDictID,
-          actualDictID);
-
-    /* Decompress using the dictionary.
-     * If you need to control the decompression parameters, then use the
-     * advanced API: ZSTD_DCtx_setParameter(), ZSTD_DCtx_refDDict(), and
-     * ZSTD_decompressDCtx().
-     */
-    ZSTD_DCtx* const dctx = ZSTD_createDCtx();
-    CHECK(dctx != NULL, "ZSTD_createDCtx() failed!");
-    size_t const dSize = ZSTD_decompress_usingDDict(dctx, rBuff, rSize, cBuff, cSize, ddict);
-    CHECK_ZSTD(dSize);
-    /* When zstd knows the content size, it will error if it doesn't match. */
-    CHECK(dSize == rSize, "Impossible because zstd will check this condition!");
-
-    /* success */
-    printf("%25s : %6u -> %7u \n", fname, (unsigned)cSize, (unsigned)rSize);
-
-    ZSTD_freeDCtx(dctx);
-    free(rBuff);
-    free(cBuff);
-}
-
-
-int main(int argc, const char** argv)
-{
-    const char* const exeName = argv[0];
-
-    if (argc<3) {
-        printf("wrong arguments\n");
-        printf("usage:\n");
-        printf("%s [FILES] dictionary\n", exeName);
-        return 1;
-    }
-
-    /* load dictionary only once */
-    const char* const dictName = argv[argc-1];
-    ZSTD_DDict* const dictPtr = createDict_orDie(dictName);
-
-    int u;
-    for (u=1; u<argc-1; u++) decompress(argv[u], dictPtr);
-
-    ZSTD_freeDDict(dictPtr);
-    printf("All %u files correctly decoded (in memory) \n", argc-2);
-    return 0;
-}