RTEMS  5.1
Functions
rtl-obj-comp.c File Reference

RTEMS Run-Time Linker Object Compression manages a compress stream of data. More...

#include <errno.h>
#include <string.h>
#include <unistd.h>
#include <inttypes.h>
#include <rtems/rtl/rtl-allocator.h>
#include <rtems/rtl/rtl-obj-comp.h>
#include "rtl-error.h"
#include <rtems/rtl/rtl-trace.h>
#include "fastlz.h"
#include <stdio.h>

Functions

bool rtems_rtl_obj_comp_open (rtems_rtl_obj_comp *comp, size_t size)
 
void rtems_rtl_obj_comp_close (rtems_rtl_obj_comp *comp)
 
void rtems_rtl_obj_comp_set (rtems_rtl_obj_comp *comp, rtems_rtl_obj_cache *cache, int fd, int compression, off_t offset)
 
bool rtems_rtl_obj_comp_read (rtems_rtl_obj_comp *comp, void *buffer, size_t length)
 

Detailed Description

RTEMS Run-Time Linker Object Compression manages a compress stream of data.

Function Documentation

◆ rtems_rtl_obj_comp_close()

void rtems_rtl_obj_comp_close ( rtems_rtl_obj_comp comp)

Close a compressor.

Parameters
compThe compressor to close.

◆ rtems_rtl_obj_comp_open()

bool rtems_rtl_obj_comp_open ( rtems_rtl_obj_comp comp,
size_t  size 
)

Open a compressor allocating the output buffer.

Parameters
compThe compressor to initialise.
sizeThe size of the compressor's output buffer.
Return values
trueThe compressor is open.
falseThe compressor is not open. The RTL error is set.

◆ rtems_rtl_obj_comp_read()

bool rtems_rtl_obj_comp_read ( rtems_rtl_obj_comp comp,
void *  buffer,
size_t  length 
)

Read decompressed data. The length contains the amount of data that should be available in the cache and referenced by the buffer handle. It must be less than or equal to the size of the cache. This call will return the amount of data that is available. It can be less than you ask if the offset and size is past the end of the file.

Parameters
compThe compressor to read data from.
bufferThe buffer the output is written too.
lengthThe length of data to read. Can be modified to a lesser value and true is still returned so check it.
Return values
trueThe data referenced is in the cache.
falseThe read failed and the RTL error has been set.

◆ rtems_rtl_obj_comp_set()

void rtems_rtl_obj_comp_set ( rtems_rtl_obj_comp comp,
rtems_rtl_obj_cache cache,
int  fd,
int  compression,
off_t  offset 
)

Set the cache and offset in the file the compressed stream starts.

Parameters
compThe compressor to set the offset in.
cacheThe cache to read the file in by.
fdThe file descriptor. Must be an open file.
compressionThe type of compression being streamed.
offsetThe offset in the file the compressed stream starts.