Return to global_bltin.h CVS log

Up to [Coherent Logic Development] / freem / src

Annotation of freem/src/global_bltin.h, revision 1.7

1.1       snw         1: /*
1.7     ! snw         2:  *   $Id: global_bltin.h,v 1.6 2025/04/08 20:00:56 snw Exp $
1.1       snw         3:  *    built-in global handler header
                      4:  *
                      5:  *  
1.2       snw         6:  *   Author: Serena Willis <snw@coherent-logic.com>
1.1       snw         7:  *    Copyright (C) 1998 MUG Deutschland
1.3       snw         8:  *    Copyright (C) 2020, 2025 Coherent Logic Development LLC
1.1       snw         9:  *
                     10:  *
                     11:  *   This file is part of FreeM.
                     12:  *
                     13:  *   FreeM is free software: you can redistribute it and/or modify
                     14:  *   it under the terms of the GNU Affero Public License as published by
                     15:  *   the Free Software Foundation, either version 3 of the License, or
                     16:  *   (at your option) any later version.
                     17:  *
                     18:  *   FreeM is distributed in the hope that it will be useful,
                     19:  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
                     20:  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     21:  *   GNU Affero Public License for more details.
                     22:  *
                     23:  *   You should have received a copy of the GNU Affero Public License
                     24:  *   along with FreeM.  If not, see <https://www.gnu.org/licenses/>.
                     25:  *
1.4       snw        26:  *   $Log: global_bltin.h,v $
1.7     ! snw        27:  *   Revision 1.6  2025/04/08 20:00:56  snw
        !            28:  *   Global handler now uses a header file and maintains the last journaling transaction ID
        !            29:  *
1.6       snw        30:  *   Revision 1.5  2025/04/08 16:46:11  snw
                     31:  *   Add global file header and offsets
                     32:  *
1.5       snw        33:  *   Revision 1.4  2025/04/08 14:39:21  snw
                     34:  *   Initial work on global handler refactor
                     35:  *
1.4       snw        36:  *   Revision 1.3  2025/03/09 19:14:25  snw
                     37:  *   First phase of REUSE compliance and header reformat
                     38:  *
1.3       snw        39:  *
                     40:  * SPDX-FileCopyrightText:  (C) 2025 Coherent Logic Development LLC
                     41:  * SPDX-License-Identifier: AGPL-3.0-or-later
1.1       snw        42:  **/
1.4       snw        43: 
                     44: #if !defined(__FREEM_GLOBAL_BLTIN_H)
                     45: # define __FREEM_GLOBAL_BLTIN_H
                     46: 
1.5       snw        47: #include "version.h"
                     48: 
                     49: #define GBL_FORMAT_VERSION 2
                     50: #define GBL_MAGIC "FRMGL"
                     51: 
1.6       snw        52: #define GBL_HDR_OK 0
                     53: #define GBL_HDR_NOTOPEN 1
                     54: #define GBL_HDR_BADMAGIC 2
                     55: #define GBL_HDR_BADVERSION 3
                     56: #define GBL_HDR_BADBLOCKSIZE 4
                     57: 
1.5       snw        58: typedef struct global_header {
                     59:     
                     60:     char magic[5]; /* FRMGL */
                     61:     int format_version;
                     62:     char host_triplet[40];
                     63: 
                     64:     unsigned long block_size;
                     65:     unsigned long last_transaction_id;
                     66: 
                     67:     long created;
                     68:     long last_backup;
                     69:     
                     70: } global_header;
                     71: 
1.4       snw        72: typedef struct global_handle {
                     73: 
                     74:     int fd; /* file descriptor */
1.5       snw        75: 
                     76:     global_header header;
1.4       snw        77:     long use_count; /* how many times has it been accessed? */
                     78:     long age;
                     79:     short opened;
                     80:     short locked;
                     81:     unsigned long last_block;
1.5       snw        82:     
1.4       snw        83:     short fast_path;
                     84:     
                     85:     char global_name[256];
                     86:     char global_path[4096];
                     87: 
                     88:     
                     89:     struct global_handle *next;   
                     90:     
                     91: } global_handle;
                     92: 
                     93: extern global_handle *global_handles_head;
                     94: 
1.7     ! snw        95: 
        !            96: extern inline long gbl_path(char *key, char *buf);
        !            97: extern int gbl_lock(global_handle *g, int type);
        !            98: extern int gbl_unlock(global_handle *g);
        !            99: extern void gbl_close(global_handle *g);
        !           100: extern void gbl_close_all(void);
        !           101: extern int gbl_write_initial_header(global_handle *g);
        !           102: extern int gbl_write_header(global_handle *g, global_header *hdr);
        !           103: extern int gbl_read_header(global_handle *g, global_header *h);
        !           104: extern int gbl_update_tid(global_handle *g);
        !           105: extern int gbl_create(global_handle *g);
        !           106: extern short gbl_open(global_handle *g, short action);
        !           107: extern global_handle *gbl_handle(char *key);
        !           108: 
1.4       snw       109: #endif