Return to global_bltin.h CVS log

Up to [Coherent Logic Development] / freem / src

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

1.1       snw         1: /*
1.10    ! snw         2:  *   $Id: global_bltin.h,v 1.9 2025/04/09 14:34:30 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.10    ! snw        27:  *   Revision 1.9  2025/04/09 14:34:30  snw
        !            28:  *   Further work on global_bltin.c refactor
        !            29:  *
1.9       snw        30:  *   Revision 1.8  2025/04/09 00:43:07  snw
                     31:  *   Exit with fatal error if a header mismatch found
                     32:  *
1.8       snw        33:  *   Revision 1.7  2025/04/08 21:41:13  snw
                     34:  *   Make insert, update, and splitp global handler functions take a ptr to a global_handle instead of a file descriptor
                     35:  *
1.7       snw        36:  *   Revision 1.6  2025/04/08 20:00:56  snw
                     37:  *   Global handler now uses a header file and maintains the last journaling transaction ID
                     38:  *
1.6       snw        39:  *   Revision 1.5  2025/04/08 16:46:11  snw
                     40:  *   Add global file header and offsets
                     41:  *
1.5       snw        42:  *   Revision 1.4  2025/04/08 14:39:21  snw
                     43:  *   Initial work on global handler refactor
                     44:  *
1.4       snw        45:  *   Revision 1.3  2025/03/09 19:14:25  snw
                     46:  *   First phase of REUSE compliance and header reformat
                     47:  *
1.3       snw        48:  *
                     49:  * SPDX-FileCopyrightText:  (C) 2025 Coherent Logic Development LLC
                     50:  * SPDX-License-Identifier: AGPL-3.0-or-later
1.1       snw        51:  **/
1.4       snw        52: 
                     53: #if !defined(__FREEM_GLOBAL_BLTIN_H)
                     54: # define __FREEM_GLOBAL_BLTIN_H
                     55: 
1.5       snw        56: #include "version.h"
                     57: 
                     58: #define GBL_FORMAT_VERSION 2
                     59: #define GBL_MAGIC "FRMGL"
                     60: 
1.6       snw        61: #define GBL_HDR_OK 0
                     62: #define GBL_HDR_NOTOPEN 1
                     63: #define GBL_HDR_BADMAGIC 2
                     64: #define GBL_HDR_BADVERSION 3
                     65: #define GBL_HDR_BADBLOCKSIZE 4
                     66: 
1.5       snw        67: typedef struct global_header {
                     68:     
                     69:     char magic[5]; /* FRMGL */
                     70:     int format_version;
                     71:     char host_triplet[40];
1.8       snw        72:     char host_id[256];
                     73:     
1.5       snw        74:     unsigned long block_size;
                     75:     unsigned long last_transaction_id;
                     76: 
                     77:     long created;
                     78:     long last_backup;
                     79:     
                     80: } global_header;
                     81: 
1.4       snw        82: typedef struct global_handle {
                     83: 
                     84:     int fd; /* file descriptor */
1.5       snw        85: 
                     86:     global_header header;
1.9       snw        87:    
1.4       snw        88:     long age;
                     89:     short opened;
                     90:     short locked;
                     91:     unsigned long last_block;
1.5       snw        92:     
1.9       snw        93:     unsigned long use_count; /* how many times has it been accessed? */
1.10    ! snw        94:     unsigned long read_ops;
        !            95:     unsigned long write_ops;
        !            96:     unsigned long splits;    
1.9       snw        97:     unsigned long cache_misses;
                     98:     unsigned long cache_hits;
                     99:     
1.4       snw       100:     short fast_path;
                    101:     
                    102:     char global_name[256];
                    103:     char global_path[4096];
                    104: 
                    105:     
                    106:     struct global_handle *next;   
                    107:     
                    108: } global_handle;
                    109: 
                    110: extern global_handle *global_handles_head;
1.9       snw       111: extern unsigned long gbl_cache_misses;
                    112: extern unsigned long gbl_cache_hits;
1.7       snw       113: 
                    114: extern inline long gbl_path(char *key, char *buf);
1.9       snw       115: extern void gbl_cache_hit(global_handle *g);
                    116: extern void gbl_cache_miss(global_handle *g);
1.7       snw       117: extern int gbl_lock(global_handle *g, int type);
                    118: extern int gbl_unlock(global_handle *g);
                    119: extern void gbl_close(global_handle *g);
                    120: extern void gbl_close_all(void);
                    121: extern int gbl_write_initial_header(global_handle *g);
                    122: extern int gbl_write_header(global_handle *g, global_header *hdr);
                    123: extern int gbl_read_header(global_handle *g, global_header *h);
                    124: extern int gbl_update_tid(global_handle *g);
                    125: extern int gbl_create(global_handle *g);
                    126: extern short gbl_open(global_handle *g, short action);
1.10    ! snw       127: extern int gbl_read_block(global_handle *g, unsigned long blocknum, char *block);
1.7       snw       128: extern global_handle *gbl_handle(char *key);
                    129: 
1.4       snw       130: #endif