]> git.ipfire.org Git - thirdparty/util-linux.git/blob - sys-utils/ipcmk.c
textual: add a docstring to most of the utilities
[thirdparty/util-linux.git] / sys-utils / ipcmk.c
1 /*
2 * ipcmk.c - used to create ad-hoc IPC segments
3 *
4 * Copyright (C) 2008 Hayden A. James (hayden.james@gmail.com)
5 * Copyright (C) 2008 Karel Zak <kzak@redhat.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 */
21
22 #include <errno.h>
23 #include <getopt.h>
24 #include <stddef.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <sys/ipc.h>
28 #include <sys/msg.h>
29 #include <sys/sem.h>
30 #include <sys/shm.h>
31 #include <sys/time.h>
32
33 #include "c.h"
34 #include "nls.h"
35 #include "randutils.h"
36 #include "strutils.h"
37 #include "closestream.h"
38
39 static int create_shm(size_t size, int permission)
40 {
41 key_t key;
42
43 random_get_bytes(&key, sizeof(key));
44 return shmget(key, size, permission | IPC_CREAT);
45 }
46
47 static int create_msg(int permission)
48 {
49 key_t key;
50
51 random_get_bytes(&key, sizeof(key));
52 return msgget(key, permission | IPC_CREAT);
53 }
54
55 static int create_sem(int nsems, int permission)
56 {
57 key_t key;
58
59 random_get_bytes(&key, sizeof(key));
60 return semget(key, nsems, permission | IPC_CREAT);
61 }
62
63 static void __attribute__ ((__noreturn__)) usage(FILE * out)
64 {
65 fprintf(out, USAGE_HEADER);
66 fprintf(out, _(" %s [options]\n"), program_invocation_short_name);
67
68 fputs(USAGE_SEPARATOR, out);
69 fputs(_("Create various IPC resources.\n"), out);
70
71 fputs(USAGE_OPTIONS, out);
72 fputs(_(" -M, --shmem <size> create shared memory segment of size <size>\n"), out);
73 fputs(_(" -S, --semaphore <nsems> create semaphore array with <nsems> elements\n"), out);
74 fputs(_(" -Q, --queue create message queue\n"), out);
75 fputs(_(" -p, --mode <mode> permission for the resource (default is 0644)\n"), out);
76
77 fprintf(out, USAGE_SEPARATOR);
78 fprintf(out, USAGE_HELP);
79 fprintf(out, USAGE_VERSION);
80 fprintf(out, USAGE_MAN_TAIL("ipcmk(1)"));
81 exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
82 }
83
84 int main(int argc, char **argv)
85 {
86 int permission = 0644;
87 int opt;
88 size_t size = 0;
89 int nsems = 0;
90 int ask_shm = 0, ask_msg = 0, ask_sem = 0;
91 static const struct option longopts[] = {
92 {"shmem", required_argument, NULL, 'M'},
93 {"semaphore", required_argument, NULL, 'S'},
94 {"queue", no_argument, NULL, 'Q'},
95 {"mode", required_argument, NULL, 'p'},
96 {"version", no_argument, NULL, 'V'},
97 {"help", no_argument, NULL, 'h'},
98 {NULL, 0, NULL, 0}
99 };
100
101 setlocale(LC_ALL, "");
102 bindtextdomain(PACKAGE, LOCALEDIR);
103 textdomain(PACKAGE);
104 atexit(close_stdout);
105
106 while((opt = getopt_long(argc, argv, "hM:QS:p:Vh", longopts, NULL)) != -1) {
107 switch(opt) {
108 case 'M':
109 size = strtou64_or_err(optarg, _("failed to parse size"));
110 ask_shm = 1;
111 break;
112 case 'Q':
113 ask_msg = 1;
114 break;
115 case 'S':
116 nsems = strtos32_or_err(optarg, _("failed to parse elements"));
117 ask_sem = 1;
118 break;
119 case 'p':
120 permission = strtoul(optarg, NULL, 8);
121 break;
122 case 'h':
123 usage(stdout);
124 break;
125 case 'V':
126 printf(UTIL_LINUX_VERSION);
127 return EXIT_SUCCESS;
128 default:
129 ask_shm = ask_msg = ask_sem = 0;
130 break;
131 }
132 }
133
134 if(!ask_shm && !ask_msg && !ask_sem)
135 usage(stderr);
136
137 if (ask_shm) {
138 int shmid;
139 if (-1 == (shmid = create_shm(size, permission)))
140 err(EXIT_FAILURE, _("create share memory failed"));
141 else
142 printf(_("Shared memory id: %d\n"), shmid);
143 }
144
145 if (ask_msg) {
146 int msgid;
147 if (-1 == (msgid = create_msg(permission)))
148 err(EXIT_FAILURE, _("create message queue failed"));
149 else
150 printf(_("Message queue id: %d\n"), msgid);
151 }
152
153 if (ask_sem) {
154 int semid;
155 if (-1 == (semid = create_sem(nsems, permission)))
156 err(EXIT_FAILURE, _("create semaphore failed"));
157 else
158 printf(_("Semaphore id: %d\n"), semid);
159 }
160
161 return EXIT_SUCCESS;
162 }