Annotation of freem/src/shmmgr.h, revision 1.4
1.1 snw 1: /*
1.4 ! snw 2: * $Id: shmmgr.h,v 1.3 2025/03/09 19:50:47 snw Exp $
1.1 snw 3: * shared memory manager data structures
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) 2021, 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: shmmgr.h,v $
! 27: * Revision 1.3 2025/03/09 19:50:47 snw
! 28: * Second phase of REUSE compliance and header reformat
! 29: *
1.3 snw 30: *
31: * SPDX-FileCopyrightText: (C) 2025 Coherent Logic Development LLC
32: * SPDX-License-Identifier: AGPL-3.0-or-later
1.1 snw 33: **/
34:
35: #if !defined(__shmmgr_h)
36: # define __shmmgr_h
37:
38: #include <stdlib.h>
39: #if defined(HAVE_STDINT_H)
40: # include <stdint.h>
41: #endif
42: #include <sys/ipc.h>
43: #include <sys/shm.h>
44: #include <sys/sem.h>
45: #include <sys/types.h>
46:
47: #include "locktab.h"
48: #include "jobtab.h"
49:
50: /* allocation states */
51: #define PG_FREE 0
52: #define PG_ALLOC 1
53:
54: /* size of a page */
55: #define PG_SIZE 1024
56:
57: /* shm_init return values */
58: #define SHMS_SUCCESS 1
59: #define SHMS_GET_ERR 0
60: #define SHMS_ATTACH_ERR -1
61:
62: #define SEMK_SHM 0xBBDD21
63: #define SEMK_LOCKTAB 0xBBDD22
64: #define SEMK_JOBTAB 0xBBDD23
65: #define SEMK_TP 0xBBDD24
66:
67: #define SHMALIGN(a) (void *) (((unsigned long) a + sysconf (_SC_PAGESIZE)) & ~(sysconf (_SC_PAGESIZE) - 1))
68:
69: /* data structures */
70:
71: /* alloc map entry */
72: typedef struct shm_page_t {
73:
74: /* is this the first entry for this allocation? */
75: short is_first;
76:
77: /* can be PG_FREE or PG_ALLOC */
78: short pg_state;
79:
80: /* to which pid does this page belong? */
81: pid_t pid;
82:
83: /* is this the last entry for this allocation? */
84: short is_last;
85:
86: } shm_page_t;
87:
88:
89: /* segment header */
90: typedef struct shm_hdr_t {
91:
92: /* will be set to shm_key to identify whether or not the segment is initialized */
93: key_t magic;
94:
95: /* pid of the first process that attached to the segment */
96: pid_t first_process;
97:
98: /* shm address */
99: void *shmad;
100:
101: /* HEAD of lock table linked list */
102: locktab_ent_t *locktab_head;
103:
104: /* HEAD of job table linked list */
105: job_slot_t *jobtab_head;
106:
107: /* locks out non-fmadm processes when set to 1 */
108: short maintenance_mode;
109:
110: unsigned long max_locks;
111: unsigned long max_jobs;
112: unsigned long max_ipcs;
113:
114: /* shared symbol table */
115: char *partition;
116: unsigned long alphptr[128];
117: char *s;
118: char *argptr;
119: long PSIZE;
120: long symlen;
1.4 ! snw 121: short use_mb_globals;
1.1 snw 122:
123: /* pid of process currently in transaction */
124: /* zero if nobody owns these exclusive rights */
125: pid_t tp_owner;
126:
127: /* counter for the tp semaphore */
128: unsigned long long tp_semctr;
129:
130: /* monotonically-incrementing serial number for DB operations:
131: * all ops inside of transactions have the same tp_serial_number.
132: *
133: * used in journaling.
134: */
135: unsigned long long tp_serial_number;
136:
137: /* allocation map */
138: shm_page_t alloc_map[1];
139:
140: } shm_hdr_t;
141:
142: typedef struct shm_config_t {
143:
144: /* segment size */
145: size_t segsiz;
146:
147: /* page size */
148: size_t pgsiz;
149:
150: /* page count */
151: int pgct;
152:
153: /* shared memory key */
154: key_t key;
155:
156: /* segment ID */
157: int seg_id;
158:
159: /* segment data area */
160: void *dta;
161:
162: /* pointer to the header */
163: shm_hdr_t *hdr;
164:
165: /* actual buffer */
166: void *buf;
167:
168: } shm_config_t;
169:
170: /* global variables */
171: extern shm_config_t *shm_config;
172:
173: /* function prototypes */
174: extern short shm_init(const size_t seg_size);
175: extern short shm_exit(void);
176: extern short shm_get_sem(void);
177: extern short shm_release_sem(void);
178: extern shm_page_t *shm_get_alloc_map_entry(const int page_number);
179: extern void *shm_page_num_to_address(const int page_num);
180: extern int shm_address_to_page_num(const void *address);
181: extern void *shm_alloc_pages(const int page_count);
182: extern void *shm_alloc(const size_t bytes);
183: extern void shm_free_page(const int page_number);
184: extern void shm_free(const void *addr);
185: extern void shm_dump(void);
186: extern void shm_dump_pages(void);
187: #endif
188:
189:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to shmmgr.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Coherent Logic Development] / freem / src