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