libjf API reference guide

jf_journal_file.h

Go to the documentation of this file.

/*
 * Copyright 2005 Tiian
 * {In real life Tiian is Christian Ferrari}
 * This file is part of "libjf" package.
 *
 * "libjf" is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * "libjf" 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with ; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef JF_JOURNAL_FILE_H
#define JF_JOURNAL_FILE_H



#include <jf/jf_config.h>



#ifdef HAVE_STDIO_H
# include <stdio.h>
#endif /* HAVE_STDIO_H */
#ifdef HAVE_LIMITS_H
# include <limits.h>
#endif /* HAVE_LIMITS_H */

#include <jf/jf_defines.h>
#include <jf/jf_errors.h>
#include <jf/jf_cache_file.h>
#include <jf/jf_trace.h>



/* save old JF_TRACE_MODULE and set a new value */
#ifdef JF_TRACE_MODULE
# define JF_TRACE_MODULE_SAVE JF_TRACE_MODULE
# undef JF_TRACE_MODULE
#else
# undef JF_TRACE_MODULE_SAVE
#endif /* JF_TRACE_MODULE */
#define JF_TRACE_MODULE      JF_TRACE_MOD_LIB_JOURNAL_FILE



#define JF_JOURNAL_FILE_CACHE_SIZE_ENV_VAR     "JF_JOURNALED_FILE_CACHE_SIZE"



#define JF_FILE_OM_READ           0x80000000

#define JF_FILE_OM_WRITE          0x40000000

#define JF_FILE_OM_APPEND         0x20000000

#define JF_FILE_OM_RESTART        0x10000000

#define JF_FILE_OM_TRUNCATE       0x08000000

#define JF_FILE_OM_MSDOS          0x04000000

#define JF_FILE_OM_MASK           (JF_FILE_OM_READ | JF_FILE_OM_WRITE | JF_FILE_OM_APPEND | JF_FILE_OM_RESTART | JF_FILE_OM_TRUNCATE | JF_FILE_OM_MSDOS)



#define JF_JOURNAL_FILE_ST_RESET         0x0

#define JF_JOURNAL_FILE_ST_OPEN          0x1

#define JF_JOURNAL_FILE_ST_SYNC          0x2

#define JF_JOURNAL_FILE_MAX_PATH_SIZE    (PATH_MAX + 1)



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */



        struct jf_journal_file_opts_s {
                jf_offset_t         cache_size_limit;
        };



        static void inline jf_set_default_journal_file_opts(
                struct jf_journal_file_opts_s *options) {
                options->cache_size_limit =
                        (getenv(JF_JOURNAL_FILE_CACHE_SIZE_ENV_VAR) != NULL) ?
                        strtoll(getenv(JF_JOURNAL_FILE_CACHE_SIZE_ENV_VAR),
                                NULL, 0) : JF_CACHE_FILE_DEFAULT_LIMIT;
                if (options->cache_size_limit < JF_CACHE_FILE_DEFAULT_LIMIT)
                        options->cache_size_limit =
                                JF_CACHE_FILE_DEFAULT_LIMIT;
        }

    

        typedef struct {
                char                     *file_path;
                jf_offset_t               last_pos;
                jf_offset_t               last_size;
                uint32_t                  status;
                FILE                     *stream;
                jf_offset_t               last_uc_pos;
                jf_offset_t               last_uc_size;
                uint32_t                  open_mode;
                jf_cache_file_t           cache_file;
                int                       all_in_cache;
        } jf_journal_file_t;



        static inline FILE *jf_journal_file_get_stream(
                const jf_journal_file_t *jf) { return jf->stream; }



        static inline int jf_journal_file_set_stream(
                jf_journal_file_t *jf, FILE *stream) {
                jf->stream = stream;
                return JF_RC_OK;
        }



        static inline const char *jf_journal_file_get_path(
                const jf_journal_file_t *jf) { return jf->file_path; }



        int jf_journal_file_set_path(jf_journal_file_t *jf,
                                     const char *new_path);

        
        
        static inline jf_offset_t jf_journal_file_get_last_pos(
                const jf_journal_file_t *jf) { return jf->last_pos; }


      
        static inline int jf_journal_file_set_last_pos(
                jf_journal_file_t *jf, jf_offset_t new_pos) {
                jf->last_pos = new_pos;
                return JF_RC_OK;
        }



        static inline jf_offset_t jf_journal_file_get_last_size(
                const jf_journal_file_t *jf) { return jf->last_size; }



        static inline int jf_journal_file_set_last_size(
                jf_journal_file_t *jf, jf_offset_t new_size) {
                jf->last_size = new_size;
                return JF_RC_OK;
        }



        static inline uint32_t jf_journal_file_get_status(
                const jf_journal_file_t *jf) { return jf->status; }



        static inline int jf_journal_file_set_status(
                jf_journal_file_t *jf, uint32_t status) {
                jf->status = status;
                return JF_RC_OK;
        }



        static inline jf_offset_t jf_journal_file_get_last_uc_size(
                const jf_journal_file_t *jf) { return jf->last_uc_size; }



        static inline int jf_journal_file_set_last_uc_size(
                jf_journal_file_t *jf, jf_offset_t new_size) {
                jf->last_uc_size = new_size;
                return JF_RC_OK;
        }



        static inline uint32_t jf_journal_file_get_open_mode(
                const jf_journal_file_t *jf) {
                JF_TRACE(("jf_journal_file_get_open_mode: 0x%x\n",
                          jf->open_mode));
                return jf->open_mode;
        }



        static inline int jf_journal_file_set_open_mode(
                jf_journal_file_t *jf, uint32_t new_open_mode) {
                JF_TRACE(("jf_journal_file_set_open_mode: 0x%x\n" ,
                          new_open_mode));
                jf->open_mode = new_open_mode;
                return JF_RC_OK;
        }



        static inline jf_offset_t jf_journal_file_get_last_uc_pos(
                const jf_journal_file_t *jf) { return jf->last_uc_pos; }



        static inline int jf_journal_file_set_last_uc_pos(
                jf_journal_file_t *jf, jf_offset_t new_pos) {
                jf->last_uc_pos = new_pos;
                return JF_RC_OK;
        }



        static inline jf_cache_file_t *jf_journal_file_get_cache_file(
                jf_journal_file_t *jf) { return &(jf->cache_file); }



        int jf_journal_file_set_cache_file(jf_journal_file_t *jf,
                                           const jf_cache_file_t *cf);



        static inline int jf_journal_file_get_all_in_cache(
                const jf_journal_file_t *jf) {
                return jf->all_in_cache;
        }



        static inline int jf_journal_file_set_all_in_cache(
                jf_journal_file_t *jf, int new_value) {
                jf->all_in_cache = new_value;
                return JF_RC_OK;
        }



        int jf_journal_file_set_options(
                jf_journal_file_t *jf,
                const struct jf_journal_file_opts_s *options);

        
        
        void jf_journal_file_reset(jf_journal_file_t *jf);



        void jf_journal_file_create(jf_journal_file_t *jf);



        void jf_journal_file_destroy(jf_journal_file_t *jf);

      
      
        int jf_journal_file_init(jf_journal_file_t *jf,
                                 const char *path, FILE *stream,
                                 uint32_t open_mode,
                                 const struct jf_journal_file_opts_s *options);


      
#ifdef __cplusplus
}
#endif /* __cplusplus */



/* restore old value of JF_TRACE_MODULE */
#ifdef JF_TRACE_MODULE_SAVE
# undef JF_TRACE_MODULE
# define JF_TRACE_MODULE JF_TRACE_MODULE_SAVE
# undef JF_TRACE_MODULE_SAVE
#endif /* JF_TRACE_MODULE_SAVE */



#endif /* JF_JOURNAL_FILE_H */

---

Copyright 2005 © Tiian