corsaro_io.h

Go to the documentation of this file.

/* 
 * corsaro
 *
 * Alistair King, CAIDA, UC San Diego
 * corsaro-info@caida.org
 * 
 * Copyright (C) 2012 The Regents of the University of California.
 * 
 * This file is part of corsaro.
 *
 * corsaro 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 3 of the License, or
 * (at your option) any later version.
 *
 * corsaro 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 corsaro.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef __CORSARO_IO_H
#define __CORSARO_IO_H

#include "config.h"

#include "corsaro_int.h"

#include "corsaro_file.h"
#include "corsaro_plugin.h"

#define CORSARO_IO_HEADER_FIXED_BYTE_LEN (4+4+1+1+4+2)

#define CORSARO_IO_INTERVAL_HEADER_BYTE_LEN sizeof(corsaro_interval_t)
/*(4+4+2+4)*/

#define CORSARO_IO_TRAILER_BYTE_LEN sizeof(corsaro_trailer_t)
/* (4+4+8+8+8+4+4+4+4) */

#define CORSARO_IO_PLUGIN_PATTERN  'P'

#define CORSARO_IO_PLUGIN_PATTERN_STR  "%P"

#define CORSARO_IO_MONITOR_PATTERN 'N'

#define CORSARO_IO_MONITOR_PATTERN_STR "%N"

#define CORSARO_IO_GLOBAL_NAME     "global"

#define CORSARO_IO_LOG_NAME        "log"

corsaro_file_t *corsaro_io_prepare_file_full(corsaro_t *corsaro, 
                                             const char *plugin_name,
                                             corsaro_interval_t *interval,
                                             corsaro_file_mode_t mode,
                                             corsaro_file_compress_t compress,
                                             int compress_level,
                                             int flags);

corsaro_file_t *corsaro_io_prepare_file(corsaro_t* corsaro, 
                                        const char *plugin_name,
                                        corsaro_interval_t *interval);

int corsaro_io_validate_template(corsaro_t *corsaro, char *template);

int corsaro_io_template_has_timestamp(corsaro_t *corsaro);

off_t corsaro_io_write_header(corsaro_t *corsaro, corsaro_file_t *file,
                              corsaro_header_t *header);

void corsaro_io_print_header(corsaro_plugin_manager_t *plugin_manager,
                             corsaro_header_t *header);

off_t corsaro_io_write_trailer(corsaro_t *corsaro, corsaro_file_t *file,
                               corsaro_trailer_t *trailer);

void corsaro_io_print_trailer(corsaro_trailer_t *trailer);

off_t corsaro_io_write_interval_start(corsaro_t *corsaro, corsaro_file_t *file,
                                    corsaro_interval_t *int_start);

void corsaro_io_print_interval_start(corsaro_interval_t *int_start);

off_t corsaro_io_write_interval_end(corsaro_t *corsaro, corsaro_file_t *file, 
                                  corsaro_interval_t *int_end);

void corsaro_io_print_interval_end(corsaro_interval_t *int_end);

off_t corsaro_io_write_plugin_start(corsaro_t *corsaro, corsaro_file_t *file, 
                                    corsaro_plugin_t *plugin);

off_t corsaro_io_write_plugin_end(corsaro_t *corsaro, corsaro_file_t *file, 
                                  corsaro_plugin_t *plugin); 

off_t corsaro_io_write_record(corsaro_t *corsaro, corsaro_file_t *file,
                            corsaro_in_record_type_t record_type,
                            corsaro_in_record_t *record);

int corsaro_io_print_record(corsaro_plugin_manager_t *plugin_manager,
                            corsaro_in_record_type_t record_type,
                            corsaro_in_record_t *record);

off_t corsaro_io_read_header(corsaro_in_t *corsaro, corsaro_file_in_t *file,
                           corsaro_in_record_type_t *record_type,
                           corsaro_in_record_t *record);

off_t corsaro_io_read_trailer(corsaro_in_t *corsaro, corsaro_file_in_t *file,
                            corsaro_in_record_type_t *record_type,
                            corsaro_in_record_t *record);

off_t corsaro_io_read_interval_start(corsaro_in_t *corsaro, 
                                     corsaro_file_in_t *file,
                                     corsaro_in_record_type_t *record_type,
                                     corsaro_in_record_t *record);

off_t corsaro_io_read_interval_end(corsaro_in_t *corsaro, 
                                   corsaro_file_in_t *file,
                                 corsaro_in_record_type_t *record_type,
                                 corsaro_in_record_t *record);

off_t corsaro_io_read_plugin_start(corsaro_in_t *corsaro, 
                                   corsaro_file_in_t *file, 
                                   corsaro_in_record_type_t *record_type,
                                   corsaro_in_record_t *record);

off_t corsaro_io_read_plugin_end(corsaro_in_t *corsaro, 
                                 corsaro_file_in_t *file, 
                                 corsaro_in_record_type_t *record_type,
                                 corsaro_in_record_t *record); 

off_t corsaro_io_read_bytes(corsaro_in_t *corsaro, corsaro_in_record_t *record,
                          off_t len);

off_t corsaro_io_read_bytes_offset(corsaro_in_t *corsaro, 
                                   corsaro_in_record_t *record,
                                   off_t offset, off_t len);

#endif /* __CORSARO_IO_H */