outqueue.h

Go to the documentation of this file.

// SPDX-License-Identifier: 0BSD
 
//
//
//  Author:     Lasse Collin
//
 
#ifndef LZMA_OUTQUEUE_H
#define LZMA_OUTQUEUE_H
 
#include "common.h"
 
 
typedef struct lzma_outbuf_s lzma_outbuf;
struct lzma_outbuf_s {
    lzma_outbuf *next;
 
    void *worker;
 
    size_t allocated;
 
    size_t pos;
 
    size_t decoder_in_pos;
 
    bool finished;
 
    lzma_ret finish_ret;
 
    lzma_vli unpadded_size;
    lzma_vli uncompressed_size;
 
    uint8_t buf[];
};
 
 
typedef struct {
    lzma_outbuf *head;
    lzma_outbuf *tail;
 
    size_t read_pos;
 
    lzma_outbuf *cache;
 
    uint64_t mem_allocated;
 
    uint64_t mem_in_use;
 
    uint32_t bufs_in_use;
 
    uint32_t bufs_allocated;
 
    uint32_t bufs_limit;
} lzma_outq;
 
 
extern uint64_t lzma_outq_memusage(uint64_t buf_size_max, uint32_t threads);
 
 
extern lzma_ret lzma_outq_init(lzma_outq *outq,
        const lzma_allocator *allocator, uint32_t threads);
 
 
extern void lzma_outq_end(lzma_outq *outq, const lzma_allocator *allocator);
 
 
extern void lzma_outq_clear_cache(
        lzma_outq *outq, const lzma_allocator *allocator);
 
 
extern void lzma_outq_clear_cache2(
        lzma_outq *outq, const lzma_allocator *allocator,
        size_t keep_size);
 
 
extern lzma_ret lzma_outq_prealloc_buf(
        lzma_outq *outq, const lzma_allocator *allocator, size_t size);
 
 
extern lzma_outbuf *lzma_outq_get_buf(lzma_outq *outq, void *worker);
 
 
extern bool lzma_outq_is_readable(const lzma_outq *outq);
 
 
extern lzma_ret lzma_outq_read(lzma_outq *restrict outq,
        const lzma_allocator *restrict allocator,
        uint8_t *restrict out, size_t *restrict out_pos,
        size_t out_size, lzma_vli *restrict unpadded_size,
        lzma_vli *restrict uncompressed_size);
 
 
extern void lzma_outq_enable_partial_output(lzma_outq *outq,
        void (*enable_partial_output)(void *worker));
 
 
static inline bool
lzma_outq_has_buf(const lzma_outq *outq)
{
    return outq->bufs_in_use < outq->bufs_limit;
}
 
 
static inline bool
lzma_outq_is_empty(const lzma_outq *outq)
{
    return outq->bufs_in_use == 0;
}
 
 
static inline uint64_t
lzma_outq_outbuf_memusage(size_t buf_size)
{
    assert(buf_size <= SIZE_MAX - sizeof(lzma_outbuf));
    return sizeof(lzma_outbuf) + buf_size;
}
 
#endif