Files
obitools3/src/obidmscolumn.c

1057 lines
27 KiB
C
Raw Normal View History

2015-05-22 17:54:34 +02:00
/****************************************************************************
* OBIDMS_column functions *
2015-05-22 17:54:34 +02:00
****************************************************************************/
/**
* @file obidmscolumn.c
2015-05-22 17:54:34 +02:00
* @author Celine Mercier
* @date 22 May 2015
* @brief Functions for the shared elements of all the OBIColumn structures.
*/
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <sys/types.h>
#include <dirent.h>
#include <unistd.h>
2015-05-26 10:38:56 +02:00
#include <fcntl.h>
#include <stdbool.h>
2015-05-22 17:54:34 +02:00
#include <sys/mman.h> /* mmap() is defined in this header */
#include "obidmscolumn.h"
#include "obidmscolumndir.h"
#include "obidms.h"
#include "obitypes.h"
#include "obierrno.h"
#include "obidebug.h"
#include "obilittlebigman.h"
#include "obidmscolumn_int.h"
#define DEBUG_LEVEL 0
2015-05-22 17:54:34 +02:00
/**************************************************************************
2015-05-26 10:38:56 +02:00
*
2015-06-10 15:19:02 +02:00
* D E C L A R A T I O N O F T H E P R I V A T E F U N C T I O N S
2015-05-26 10:38:56 +02:00
*
**************************************************************************/
2015-05-26 10:38:56 +02:00
/**
* @brief Internal function building the file name for a column.
*
2015-06-10 15:19:02 +02:00
* The function builds the file name corresponding to a column of an OBIDMS.
2015-05-26 10:38:56 +02:00
*
* @warning The returned pointer has to be freed by the caller.
*
* @param column_name the name of the OBIDMS column.
2015-05-26 10:38:56 +02:00
*
* @return a pointer to the column file name
2015-05-26 10:38:56 +02:00
* @retvalue NULL if an error occurs
*
* ###Error values
* - OBIDMS_MEMORY_ERROR : something wrong occurred during memory allocation.
2015-05-26 10:38:56 +02:00
*
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
static char *build_column_file_name(const char *column_name, obiversion_t version_number);
2015-06-10 15:19:02 +02:00
2015-05-26 10:38:56 +02:00
/**
* @brief Internal function building the file name for a column version file.
2015-05-26 10:38:56 +02:00
*
* The column version file indicates the latest version number for a column.
* This function returns the name of the file storing this information.
2015-05-26 10:38:56 +02:00
*
* @warning The returned pointer has to be freed by the caller.
*
* @param column_name the name of the OBIDMS column.
2015-05-26 10:38:56 +02:00
*
* @return a pointer to the version file name
2015-05-26 10:38:56 +02:00
* @retvalue NULL if an error occurs
*
* ###Error values
* - OBIDMS_MEMORY_ERROR : something wrong occurs during memory allocation.
*
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
static char *build_version_file_name(const char *column_name);
2015-05-26 10:38:56 +02:00
2015-06-10 15:19:02 +02:00
2015-05-26 10:38:56 +02:00
/**
* @brief Internal function returning a new column version number
* in the `dms` database
*
* @param dms a pointer as returned by obi_create_dms() or obi_open_dms()
* @param column_name the name of the column
2015-05-26 10:38:56 +02:00
* @param block is the call is blocking or not
* - `true` the call is blocking
* - `false` the call is not blocking
*
* @return the bigger version number used for this column
* @retvalue -1 if the column does not exist
*
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
static obiversion_t obi_get_new_version_number(OBIDMS_column_directory_p column_directory, bool block);
2015-05-26 10:38:56 +02:00
2015-06-10 15:19:02 +02:00
2015-05-26 10:38:56 +02:00
/**
* @brief Internal function creating a new column version file
* in the `dms` database
*
* The new file is initialized with the minimum version number `0`.
*
* @param dms a pointer as returned by obi_create_dms() or obi_open_dms()
* @param column_name the name of the column
2015-05-26 10:38:56 +02:00
*
* @return the next usable version number for this column : `0`
2015-05-26 10:38:56 +02:00
* @retvalue -1 if the column does not exist
*
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
static int create_version_file(OBIDMS_column_directory_p column_directory);
2015-05-26 10:38:56 +02:00
2015-06-10 15:19:02 +02:00
/**
* @brief Internal function setting the elements names of the lines of a
* column in the header of the OBIDMS column structure.
*
* @param column a pointer as returned by obi_create_column()
* @param elements_names the names of the elements with ';' as separator
*
* @return 0 if the operation was successfully completed
* @retvalue -1 if an error occurred
*
* @since July 2015
* @author Celine Mercier (celine.mercier@metabarcoding.org)
*/
int obi_column_set_elements_names(OBIDMS_column_p column, const char* elements_names);
2015-06-10 15:19:02 +02:00
/************************************************************************
2015-05-26 10:38:56 +02:00
*
2015-06-10 15:19:02 +02:00
* D E F I N I T I O N O F T H E P R I V A T E F U N C T I O N S
2015-05-26 10:38:56 +02:00
*
2015-06-10 15:19:02 +02:00
************************************************************************/
2015-05-26 10:38:56 +02:00
static char *build_column_file_name(const char *column_name, obiversion_t version_number)
{
2015-05-26 10:38:56 +02:00
char *filename;
// Build the database directory name
if (asprintf(&filename,"%s@%d.odc", column_name, version_number) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_MEMORY_ERROR);
obidebug(1, "\nasprintf() function failed");
2015-05-26 10:38:56 +02:00
return NULL;
}
return filename;
}
static char *build_version_file_name(const char *column_name)
{
2015-05-26 10:38:56 +02:00
char *filename;
// Build the database directory name
if (asprintf(&filename,"%s.odv", column_name) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_MEMORY_ERROR);
2015-05-26 10:38:56 +02:00
return NULL;
}
return filename;
}
2015-06-10 15:19:02 +02:00
static obiversion_t obi_get_new_version_number(OBIDMS_column_directory_p column_directory, bool block)
{
off_t loc_size;
obiversion_t new_version_number;
char* version_file_name;
int column_dir_file_descriptor;
int version_file_descriptor;
bool little_endian;
int lock_mode;
2015-05-26 10:38:56 +02:00
new_version_number = 0;
loc_size = sizeof(bool) + sizeof(obiversion_t);
2015-05-26 10:38:56 +02:00
// Select the correct lockf operation according to the blocking mode
if (block)
lock_mode=F_LOCK;
2015-05-26 10:38:56 +02:00
else
lock_mode=F_TLOCK;
2015-05-26 10:38:56 +02:00
// Build the version file name
version_file_name = build_version_file_name(column_directory->column_name);
if (version_file_name == NULL)
2015-05-26 10:38:56 +02:00
return -1;
// Get the file descriptor associated to the column directory
column_dir_file_descriptor = dirfd(column_directory->directory);
if (column_dir_file_descriptor < 0)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Open the version file
version_file_descriptor = openat(column_dir_file_descriptor, version_file_name, O_RDWR);
if (version_file_descriptor < 0)
{
free(version_file_name);
2015-05-26 10:38:56 +02:00
if (errno == ENOENT)
return create_version_file(column_directory);
2015-05-26 10:38:56 +02:00
else
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
2015-05-26 10:38:56 +02:00
return -1;
}
}
// Test if the version file size is ok
if (lseek(version_file_descriptor, 0, SEEK_END) < loc_size)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Prepare the file for locking
if (lseek(version_file_descriptor, 0, SEEK_SET) != 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Lock the file
if (lockf(version_file_descriptor, lock_mode, loc_size) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Read the endianness of the file
if (read(version_file_descriptor, &little_endian, sizeof(bool)) < sizeof(bool))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Check if endianness is correct
if (little_endian != obi_is_little_endian())
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_BAD_ENDIAN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Read the current version number
if (read(version_file_descriptor, &new_version_number, sizeof(obiversion_t)) < sizeof(obiversion_t))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
new_version_number++;
2015-05-26 10:38:56 +02:00
// Write the new version number
if (lseek(version_file_descriptor, sizeof(bool), SEEK_SET) != sizeof(bool))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
if (write(version_file_descriptor, &new_version_number, sizeof(obiversion_t)) < sizeof(obiversion_t))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Prepare for unlocking
if (lseek(version_file_descriptor, 0, SEEK_SET) != 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Unlock the file
if (lockf(version_file_descriptor, F_ULOCK, loc_size) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
close(version_file_descriptor);
close(column_dir_file_descriptor);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
close(version_file_descriptor);
free(version_file_name);
return new_version_number;
2015-05-26 10:38:56 +02:00
}
2015-06-10 15:19:02 +02:00
static int create_version_file(OBIDMS_column_directory_p column_directory)
{
off_t loc_size;
obiversion_t version_number;
char* version_file_name;
int column_dir_file_descriptor;
int version_file_descriptor;
bool little_endian;
2015-05-26 10:38:56 +02:00
loc_size = sizeof(bool) + sizeof(obiversion_t);
version_number = 0;
2015-05-26 10:38:56 +02:00
version_file_name = build_version_file_name(column_directory->column_name);
if (version_file_name == NULL)
2015-05-26 10:38:56 +02:00
return -1;
// Get the file descriptor associated to the column directory
column_dir_file_descriptor = dirfd(column_directory->directory);
if (column_dir_file_descriptor < 0)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Get the file descriptor associated to the version file
version_file_descriptor = openat(column_dir_file_descriptor, version_file_name, O_RDWR | O_CREAT);
if (version_file_descriptor < 0)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Lock the file
if (lockf(version_file_descriptor, F_LOCK, loc_size) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Truncate the version file to the right size
if (ftruncate(version_file_descriptor, loc_size) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Position offset to 0 to prepare for writing
if (lseek(version_file_descriptor, 0, SEEK_SET) != 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
little_endian = obi_is_little_endian();
2015-05-26 10:38:56 +02:00
// Write endianness
if (write(version_file_descriptor, &little_endian, sizeof(bool)) < sizeof(bool))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Write version number
if (write(version_file_descriptor, &version_number, sizeof(obiversion_t)) < sizeof(obiversion_t))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Prepare for unlocking
if (lseek(version_file_descriptor, 0, SEEK_SET) != 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Unlock the file
if (lockf(version_file_descriptor, F_ULOCK, loc_size) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
close(version_file_descriptor);
free(version_file_name);
return version_number;
2015-05-26 10:38:56 +02:00
}
2015-06-10 15:19:02 +02:00
int obi_column_set_elements_names(OBIDMS_column_p column, const char* elements_names)
{
(column->header)->elements_names = malloc(strlen(elements_names)*sizeof(char) + 1);
if ((column->header)->elements_names == NULL)
return -1;
strcpy((column->header)->elements_names, elements_names);
return 0;
}
/**********************************************************************
2015-05-26 10:38:56 +02:00
*
* D E F I N I T I O N O F T H E P U B L I C F U N C T I O N S
2015-05-26 10:38:56 +02:00
*
**********************************************************************/
obiversion_t obi_get_latest_version_number(OBIDMS_column_directory_p column_directory)
{
off_t loc_size;
obiversion_t latest_version_number;
char * version_file_name;
int column_dir_file_descriptor;
int version_file_descriptor;
bool little_endian;
loc_size = sizeof(bool) + sizeof(obiversion_t);
latest_version_number = 0;
version_file_name = build_version_file_name(column_directory->column_name);
if (version_file_name==NULL)
2015-05-26 10:38:56 +02:00
return -1;
// Get the file descriptor associated to the column directory
column_dir_file_descriptor = dirfd(column_directory->directory);
if (column_dir_file_descriptor < 0)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
2015-05-26 10:38:56 +02:00
return -1;
}
// Get the file descriptor associated to the version file
version_file_descriptor = openat(column_dir_file_descriptor, version_file_name, O_RDONLY);
if (version_file_descriptor < 0)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Check that the version file size is ok
if (lseek(version_file_descriptor, 0, SEEK_END) < loc_size)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Set the offset to 0 in the version file
if (lseek(version_file_descriptor, 0, SEEK_SET) != 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Read the endianness
if (read(version_file_descriptor, &little_endian, sizeof(bool)) < sizeof(bool))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Verify the endianness
if (little_endian != obi_is_little_endian())
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_BAD_ENDIAN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
// Read the latest version number
if (read(version_file_descriptor, &latest_version_number, sizeof(obiversion_t)) < sizeof(obiversion_t))
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
free(version_file_name);
close(version_file_descriptor);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return -1;
}
free(version_file_name);
close(version_file_descriptor);
return latest_version_number;
2015-05-26 10:38:56 +02:00
}
2015-06-10 15:19:02 +02:00
obiversion_t obi_column_get_latest_version_from_name(OBIDMS_p dms, const char* column_name)
{
OBIDMS_column_directory_p column_directory;
obiversion_t latest_version;
// Get the column directory structure associated to the column
column_directory = obi_open_column_directory(dms, column_name);
if (column_directory == NULL)
{
obidebug(1, "\nProblem opening column directory");
return -1;
}
// Get the latest version number
latest_version = obi_get_latest_version_number(column_directory);
if (latest_version < 0)
{
obidebug(1, "\nProblem getting the latest version number");
obi_close_column_directory(column_directory);
return -1;
}
return latest_version;
}
2015-05-26 10:38:56 +02:00
size_t obi_get_platform_header_size()
{
return getpagesize() * 1;
}
2015-06-10 15:19:02 +02:00
OBIDMS_column_p obi_create_column(OBIDMS_p dms,
const char *column_name,
OBIType_t type,
size_t nb_elements,
size_t nb_elements_per_line,
const char* elements_names)
2015-05-26 10:38:56 +02:00
{
OBIDMS_column_p new_column;
OBIDMS_column_directory_p column_directory;
OBIDMS_column_header_p header;
size_t file_size;
obiversion_t version_number;
char* column_file_name;
int column_file_descriptor;
int column_dir_file_descriptor;
size_t header_size;
size_t data_size;
new_column = NULL;
// TODO check that informations are not NULL/invalid
// Get the column directory structure associated to the column
column_directory = obi_column_directory(dms, column_name);
if (column_directory == NULL)
return NULL;
// Get the file descriptor associated to the column directory
column_dir_file_descriptor = dirfd(column_directory->directory);
if (column_dir_file_descriptor < 0)
{
obi_set_errno(OBICOLDIR_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
2015-05-26 10:38:56 +02:00
return NULL;
}
// Calculate the size needed
header_size = obi_get_platform_header_size();
data_size = obi_array_sizeof(type, nb_elements, nb_elements_per_line);
file_size = header_size + data_size;
2015-05-26 10:38:56 +02:00
// Get the latest version number
version_number = obi_get_new_version_number(column_directory, true);
if (version_number < 0)
2015-05-26 10:38:56 +02:00
{
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
2015-05-26 10:38:56 +02:00
return NULL;
}
// Get the column file name
column_file_name = build_column_file_name(column_name, version_number);
if (column_file_name == NULL)
{
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
return NULL;
}
2015-06-10 15:19:02 +02:00
// Open the column file
column_file_descriptor = openat(column_dir_file_descriptor, column_file_name, O_RDWR | O_CREAT);
if (column_file_descriptor < 0)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
free(column_file_name);
return NULL;
}
2015-05-26 10:38:56 +02:00
// Truncate the column file to the right size
if (ftruncate(column_file_descriptor, file_size) < 0)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
2015-05-26 10:38:56 +02:00
return NULL;
}
// Allocate the memory for the column structure
new_column = (OBIDMS_column_p) malloc(sizeof(OBIDMS_column_t));
if (new_column == NULL)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
2015-05-26 10:38:56 +02:00
return NULL;
}
// Fill the column structure
new_column->dms = dms;
new_column->column_directory = column_directory;
new_column->header = mmap(NULL,
header_size,
PROT_READ | PROT_WRITE,
MAP_SHARED,
column_file_descriptor,
0
);
2015-05-26 10:38:56 +02:00
if (new_column->header == MAP_FAILED)
2015-05-26 10:38:56 +02:00
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
free(new_column);
2015-05-26 10:38:56 +02:00
return NULL;
}
new_column->data = mmap(NULL,
data_size,
PROT_READ | PROT_WRITE,
MAP_SHARED,
column_file_descriptor,
header_size
);
2015-05-26 10:38:56 +02:00
if (new_column->data == MAP_FAILED)
2015-05-26 10:38:56 +02:00
{
munmap(new_column->header, header_size);
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
free(new_column);
2015-05-26 10:38:56 +02:00
return NULL;
}
new_column->writable = true;
2015-05-26 10:38:56 +02:00
header = new_column->header;
header->little_endian = obi_is_little_endian();
header->header_size = header_size;
header->line_count = nb_elements;
header->lines_used = 0;
header->nb_elements_per_line = nb_elements_per_line;
header->data_type = type;
header->creation_date = time(NULL);
header->version = version_number;
header->comments[0] = 0x0;
obi_column_set_elements_names(new_column, elements_names);
strncpy(header->name, column_name, OBIDMS_MAX_COLNAME);
2015-05-26 10:38:56 +02:00
free(column_file_name);
close(column_file_descriptor);
return new_column;
2015-05-26 10:38:56 +02:00
}
OBIDMS_column_p obi_open_column(OBIDMS_p dms, const char* column_name, obiversion_t version_number)
{
OBIDMS_column_p column;
OBIDMS_column_directory_p column_directory;
char* column_file_name;
int column_file_descriptor;
int column_dir_file_descriptor;
size_t header_size;
size_t data_size;
column = NULL;
// Get the column directory structure associated to the column
column_directory = obi_open_column_directory(dms, column_name);
if (column_directory == NULL)
{
obidebug(1, "\nProblem opening column directory");
return NULL;
}
// Get the file descriptor associated to the column directory
column_dir_file_descriptor = dirfd(column_directory->directory);
if (column_dir_file_descriptor < 0)
{
obidebug(1, "\nProblem opening column directory");
obi_set_errno(OBICOLDIR_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
return NULL;
}
// Calculate the header size
header_size = obi_get_platform_header_size();
// Get the latest version number if it has the value -1 (not given by user)
if (version_number == -1)
{
version_number = obi_get_latest_version_number(column_directory);
if (version_number < 0)
{
obidebug(1, "\nProblem getting the latest version number");
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
return NULL;
}
}
// Get the column file name
column_file_name = build_column_file_name(column_name, version_number);
if (column_file_name == NULL)
{
obidebug(1, "Problem building column file name");
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
return NULL;
}
// Open the column file, ALWAYS READ-ONLY
column_file_descriptor = openat(column_dir_file_descriptor, column_file_name, O_RDONLY);
if (column_file_descriptor < 0)
{
obidebug(1, "\nCan't open column file");
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
free(column_file_name);
return NULL;
}
// Allocate the memory for the column structure
column = (OBIDMS_column_p) malloc(sizeof(OBIDMS_column_t));
if (column == NULL)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
return NULL;
}
// Fill the column structure
column->dms = dms;
column->column_directory = column_directory;
column->header = mmap(NULL,
header_size,
PROT_READ,
MAP_SHARED,
column_file_descriptor,
0
);
if (column->header == MAP_FAILED)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
free(column);
return NULL;
}
// Check endianness?
// Compute data size from the informations in the header
data_size = ((column->header)->line_count) * sizeof((column->header)->data_type); // TODO line_count for tests, change to lines_used later
column->data = mmap(NULL,
data_size,
PROT_READ,
MAP_SHARED,
column_file_descriptor,
header_size
);
if (column->data == MAP_FAILED)
{
munmap(column->header, header_size);
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
free(column);
return NULL;
}
column->writable = false;
free(column_file_name);
close(column_file_descriptor);
return column;
}
int obi_close_column(OBIDMS_column_p column)
{
//munmap?
free(column);
return 0;
}
void obi_column_make_unwritable(OBIDMS_column_p column)
{
column->writable = false;
}
size_t obi_column_get_line_count(OBIDMS_column_p column)
{
return (column->header)->line_count;
}
OBIType_t obi_column_get_data_type(OBIDMS_column_p column)
{
return (column->header)->data_type;
}
OBIType_t obi_column_get_data_type_from_name(OBIDMS_p dms, const char* column_name)
{
OBIDMS_column_header_p header;
OBIDMS_column_directory_p column_directory;
char* column_file_name;
int column_file_descriptor;
int column_dir_file_descriptor;
size_t header_size;
OBIType_t data_type;
obiversion_t version_number;
// Get the column directory structure associated to the column
column_directory = obi_open_column_directory(dms, column_name);
if (column_directory == NULL)
{
obidebug(1, "\nProblem opening column directory");
return -1;
}
// Get the file descriptor associated to the column directory
column_dir_file_descriptor = dirfd(column_directory->directory);
if (column_dir_file_descriptor < 0)
{
obidebug(1, "\nProblem opening column directory");
obi_set_errno(OBICOLDIR_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
return -1;
}
// Calculate the header size
header_size = obi_get_platform_header_size();
// Get the latest version number
version_number = obi_get_latest_version_number(column_directory);
if (version_number < 0)
{
obidebug(1, "\nProblem getting the latest version number");
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
return -1;
}
// Get the column file name
column_file_name = build_column_file_name(column_name, version_number);
if (column_file_name == NULL)
{
obidebug(1, "Problem building column file name");
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
return -1;
}
// Open the column file (READ-ONLY)
column_file_descriptor = openat(column_dir_file_descriptor, column_file_name, O_RDONLY);
if (column_file_descriptor < 0)
{
obidebug(1, "\nCan't open column file");
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
free(column_file_name);
return -1;
}
// Fill the header structure
header = mmap(NULL,
header_size,
PROT_READ,
MAP_SHARED,
column_file_descriptor,
0
);
if (header == MAP_FAILED)
{
obi_set_errno(OBICOL_UNKNOWN_ERROR);
obi_close_column_directory(column_directory);
close(column_dir_file_descriptor);
close(column_file_descriptor);
free(column_file_name);
free(header);
return -1;
}
// Check endianness?
data_type = header->data_type;
free(column_file_name);
close(column_file_descriptor);
munmap(header, header_size);
return data_type;
}
const char* obi_column_get_elements_names(OBIDMS_column_p column)
{
return (column->header)->elements_names;
}
// to be rewritten in an optimized and safe way
size_t obi_column_get_element_index_from_name(OBIDMS_column_p column, const char* element_name)
{
char* elements_names;
char* name;
size_t element_index;
elements_names = strdup((column->header)->elements_names);
if (elements_names == NULL)
{
obidebug(1, "\nError strdup-ing the elements names");
return -1;
}
element_index = 0;
name = strtok (elements_names, ";"); // not thread safe, see strtok_r maybe
if (strcmp(element_name, name) == 0)
{
free(elements_names);
return element_index;
}
element_index++;
while (name != NULL)
{
name = strtok (NULL, ";"); // not thread safe, see strtok_r maybe
if (strcmp(element_name, name) == 0)
{
free(elements_names);
return element_index;
}
element_index++;
}
obidebug(1, "\nCan't find element name");
free(elements_names);
return -1;
}
size_t obi_column_get_nb_elements_per_line(OBIDMS_column_p column)
{
return (column->header)->nb_elements_per_line;
}