rtl-obj-comp.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 2012, 2018 Chris Johns <chrisj@rtems.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#if !defined (_RTEMS_RTL_OBJ_COMP_H_)
#define _RTEMS_RTL_OBJ_COMP_H_
 
#include <rtems/rtl/rtl-obj-cache.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define RTEMS_RTL_DECOMP_INPUT_SIZE (256)

#define RTEMS_RTL_COMP_NONE (0)
#define RTEMS_RTL_COMP_LZ77 (1)

typedef struct rtems_rtl_obj_cpmp
{
  rtems_rtl_obj_cache* cache;       
  int                  fd;          
  int                  compression; 
  off_t                offset;      
  size_t               size;        
  size_t               level;       
  uint8_t*             buffer;      
  uint32_t             read;        
} rtems_rtl_obj_comp;

static inline uint32_t rtems_rtl_obj_comp_input (rtems_rtl_obj_comp* comp)
{
  return comp->read;
}

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);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif