CONTRIBUTING.d/lint: 'make build' does not build everything anymore
[man-pages.git] / man / man7 / sysvipc.7
blob460ff0f04a06daa84ed3ea5823e87b3f8c1dc2e8
1 .\" Copyright 2020 Michael Kerrisk <mtk.manpages@gmail.com>
2 .\"
3 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
4 .\"
5 .TH sysvipc 7 (date) "Linux man-pages (unreleased)"
6 .SH NAME
7 sysvipc \- System V interprocess communication mechanisms
8 .SH DESCRIPTION
9 System V IPC is the name given to three interprocess
10 communication mechanisms that are widely available on UNIX systems:
11 message queues, semaphore, and shared memory.
12 .\"
13 .SS Message queues
14 System V message queues allow data to be exchanged in units called messages.
15 Each message can have an associated priority.
16 POSIX message queues provide an alternative API for achieving the same result;
17 see
18 .BR mq_overview (7).
20 The System V message queue API consists of the following system calls:
21 .TP
22 .BR msgget (2)
23 Create a new message queue or obtain the ID of an existing message queue.
24 This call returns an identifier that is used in the remaining APIs.
25 .TP
26 .BR msgsnd (2)
27 Add a message to a queue.
28 .TP
29 .BR msgrcv (2)
30 Remove a message from a queue.
31 .TP
32 .BR msgctl (2)
33 Perform various control operations on a queue, including deletion.
34 .\"
35 .SS Semaphore sets
36 System V semaphores allow processes to synchronize their actions.
37 System V semaphores are allocated in groups called sets;
38 each semaphore in a set is a counting semaphore.
39 POSIX semaphores provide an alternative API for achieving the same result;
40 see
41 .BR sem_overview (7).
43 The System V semaphore API consists of the following system calls:
44 .TP
45 .BR semget (2)
46 Create a new set or obtain the ID of an existing set.
47 This call returns an identifier that is used in the remaining APIs.
48 .TP
49 .BR semop (2)
50 Perform operations on the semaphores in a set.
51 .TP
52 .BR semctl (2)
53 Perform various control operations on a set, including deletion.
54 .\"
55 .SS Shared memory segments
56 System V shared memory allows processes to share a region a memory
57 (a "segment").
58 POSIX shared memory is an alternative API for achieving the same result; see
59 .BR shm_overview (7).
61 The System V shared memory API consists of the following system calls:
62 .TP
63 .BR shmget (2)
64 Create a new segment or obtain the ID of an existing segment.
65 This call returns an identifier that is used in the remaining APIs.
66 .TP
67 .BR shmat (2)
68 Attach an existing shared memory object into the calling process's
69 address space.
70 .TP
71 .BR shmdt (2)
72 Detach a segment from the calling process's address space.
73 .TP
74 .BR shmctl (2)
75 Perform various control operations on a segment, including deletion.
76 .\"
77 .SS IPC namespaces
78 For a discussion of the interaction of System V IPC objects and
79 IPC namespaces, see
80 .BR ipc_namespaces (7).
81 .SH SEE ALSO
82 .BR ipcmk (1),
83 .BR ipcrm (1),
84 .BR ipcs (1),
85 .BR lsipc (1),
86 .BR ipc (2),
87 .BR msgctl (2),
88 .BR msgget (2),
89 .BR msgrcv (2),
90 .BR msgsnd (2),
91 .BR semctl (2),
92 .BR semget (2),
93 .BR semop (2),
94 .BR shmat (2),
95 .BR shmctl (2),
96 .BR shmdt (2),
97 .BR shmget (2),
98 .BR ftok (3),
99 .BR ipc_namespaces (7)