rohc_comp.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef COMP_H
#define COMP_H

#include <netinet/ip.h>
#include <netinet/udp.h>
#include <string.h>
#include <stdbool.h>

#include "rohc.h"
#include <stdlib.h>


struct c_feedback;


#define C_NUM_PROFILES 5


typedef enum
{
        IR = 1,
        FO = 2,
        SO = 3,
} rohc_c_state;


struct rohc_feedback
{
        unsigned char *data;
        size_t length;
        bool is_locked;
};


struct rohc_comp
{
        int enabled;

        struct medium medium;

        struct c_context *contexts;
        int num_contexts;
        int num_contexts_used;

        int profiles[C_NUM_PROFILES];

        /* feedback-related variables: */

#define FEEDBACK_BUFFER_SIZE 10

        struct rohc_feedback feedbacks[FEEDBACK_BUFFER_SIZE];
        size_t feedbacks_first;
        size_t feedbacks_first_unlocked;
        size_t feedbacks_next;

        /* some statistics about the compression process: */

        int num_packets;
        int total_uncompressed_size;
        int total_compressed_size;

        struct c_context *last_context;
 
        /* user interaction variables: */

        int mrru;
        int max_header_size;
        int connection_type;
        int jam_use;
        int adapt_size;
        int encap_size;
};


struct c_context
{
        int used;
        unsigned int latest_used;
        unsigned int first_used;

        int cid;

        struct rohc_comp *compressor;

        struct c_profile *profile;
        void *specific;

        rohc_mode mode;
        rohc_c_state state;

        /* below are some statistics */
        
        int total_uncompressed_size;
        int total_compressed_size;
        int header_uncompressed_size;
        int header_compressed_size; 

        int total_last_uncompressed_size;
        int total_last_compressed_size;
        int header_last_uncompressed_size;
        int header_last_compressed_size;

        int num_sent_packets;
        int num_sent_ir;
        int num_sent_ir_dyn;
        int num_recv_feedbacks;

        struct c_wlsb *total_16_uncompressed;
        struct c_wlsb *total_16_compressed;
        struct c_wlsb *header_16_uncompressed;
        struct c_wlsb *header_16_compressed;
};


struct c_profile
{
        unsigned short protocol;
        
        int *ports;

        unsigned short id;

        char *version;
        char *description;

        int (*create)(struct c_context *context, const struct ip_packet packet);

        void (*destroy)(struct c_context *context);

        int (*check_context)(struct c_context *context, struct ip_packet packet);

        int (*encode)(struct c_context *context, const struct ip_packet packet,
                      int packet_size, unsigned char *dest, int dest_size,
                      int *payload_offset);

        void (*feedback)(struct c_context *context, struct c_feedback *feedback);
};


struct c_feedback
{
        int cid;

        int type;

        unsigned char *data;
        unsigned char size;

        int specific_offset;
        int specific_size;

        enum {
                ACK,
                NACK,
                STATIC_NACK,
                RESERVED
        } acktype;
};


/*
 * Functions related to compressor:
 */

struct rohc_comp * rohc_alloc_compressor(int max_cid, int jam_use, int adapt_size, int encap_size);
void rohc_free_compressor(struct rohc_comp *comp);

int rohc_compress(struct rohc_comp *comp, unsigned char *ibuf, int isize,
                  unsigned char *obuf, int osize);

int rohc_c_info(char *buffer);
int rohc_c_statistics(struct rohc_comp *comp, unsigned int indent,
                      char *buffer);
int rohc_c_context(struct rohc_comp *comp, int cid, unsigned int indent,
                   char *buffer);

int rohc_c_is_enabled(struct rohc_comp *comp);
int rohc_c_using_small_cid(struct rohc_comp *comp);


/*
 * Functions related to context:
 */

struct c_context *c_create_context(struct rohc_comp *, struct c_profile *profile, struct ip_packet ip);
struct c_context *c_find_context(struct rohc_comp *, struct c_profile *profile, struct ip_packet ip);
struct c_context *c_get_context(struct rohc_comp *, int cid);


/*
 * Functions related to profile:
 */

struct c_profile * c_get_profile_from_packet(struct rohc_comp *comp,
                                             struct ip_packet *outer_ip,
                                             struct ip_packet *inner_ip,
                                             int protocol);
struct c_profile * c_get_profile_from_id(struct rohc_comp *comp,
                                         int profile_id);
void rohc_activate_profile(struct rohc_comp *comp, int profile);


/*
 * Functions related to feedback:
 */

void c_piggyback_feedback(struct rohc_comp *comp, unsigned char *packet,
                          int size);
void c_deliver_feedback(struct rohc_comp *comp, unsigned char *feedback,
                        int size);
int rohc_feedback_flush(struct rohc_comp *comp,
                        unsigned char *obuf,
                        int osize);


/*
 * Functions related to user interaction:
 */

void rohc_c_set_header(struct rohc_comp *compressor, int value);
void rohc_c_set_mrru(struct rohc_comp *compressor, int value);
void rohc_c_set_max_cid(struct rohc_comp *compressor, int value);
void rohc_c_set_large_cid(struct rohc_comp *compressor, int value);
void rohc_c_set_enable(struct rohc_comp *compressor, int value);


/*
 * ROHC library includes:
 */

#include "cid.h"


#endif