aboutsummaryrefslogtreecommitdiffstats
path: root/doc/info/bus.texinfo
blob: d71a4fd52656f4d0e4bd819e520f1f0b97798045 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
\input texinfo   @c -*-texinfo-*-

@c %**start of header
@setfilename bus.info
@settitle bus
@afourpaper
@documentencoding UTF-8
@documentlanguage en
@finalout
@c %**end of header


@dircategory Interprorcess Communication
@direntry
* bus: (bus).                        A simple daemonless system for broadcasting messages locally
@end direntry


@copying
Copyright @copyright{} 2015 Mattias Andrée

@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
``GNU Free Documentation License''.
@end quotation
@end copying

@ifnottex
@node Top
@top bus -- A simple daemonless system for broadcasting messages locally
@insertcopying
@end ifnottex

@titlepage
@title bus
@subtitle A simple daemonless system for broadcasting messages locally
@author by Mattias Andrée (maandree)

@page
@vskip 0pt plus 1filll
@insertcopying
@page
@end titlepage

@contents


@iftex
@macro xrm{}
@rm{}
@end macro
@macro xtt{}
@tt{}
@end macro
@end iftex

@ifnottex
@macro xrm{}
@end macro
@macro xtt{}
@end macro
@end ifnottex



@menu
* Overview::                        Brief overview of @command{bus}.
* Standard::                        How to use @command{bus} properly.
* Invoking::                        Executing @command{bus}.
* Interface::                       Using @command{libbus}.
* Protocol::                        How communication over @command{bus} works internally.
* Rationale::                       Why @command{bus}?
* Examples::                        Usecase examples and API-demonstration.
* GNU Free Documentation License::  Copying and sharing this manual.
@end menu
@c TODO @detailmenu (`C-c C-u m`)



@node Overview
@chapter Overview

@command{bus} is a stupid-simple, thrilless, daemonless interprocess
communication system for broadcasting messages. It is a lightweight
alternative to a two-phase interprocess flexible barrier.

@command{bus} uses a System V semaphore array and System V shared
memory. Buses are named; the key of the semaphore array and the
shared memory is stored in a regular file.

The shared memory used by @command{bus} is always 2048 bytes.
Additionally all messages should be encoded in UTF-8 and not contain
any NULL characters, except they @emph{must} always end with a NULL
byte. Furthermore messages should be prefixed with the process
identifer of the process whence the message originated, followed
by a space. If the process is ephemeral@footnote{The process exits
after the broadcast, or shortly thereafter.}, 0 should be used
instead of the process identifier.

Communication over @command{bus} is synchronous. The broadcast call
does not return until all listeners have received (and copied) the
message. A malfunctioning program can lock the bus.

This software package contains a C library and a command line
utility. The package python-bus provides a Python 3 module.



@node Standard
@chapter Standard

The command @command{bus create} can be used to create new buses. By
convention, buses should be stored in @file{$XDG_RUNTIME_DIR/bus},
this is what @command{bus create} does if no pathname is given. The
pathname of the bus should be tracked using @env{BUS_X}, where @env{X}
is replaced with either:

@table @env
@item GENERIC
For the bus used in generic cases. That is all but the cases
of the buses listed below.
@item AUDIO
For the bus used in with the audio subsystem is involved.
@item VIDEO
For the bus used in with the video subsystem is involved.
@item INPUT
For the bus used in with the input subsystem is involved.
@item FILES
For the bus used in with the storage subsystem is involved.
@end table

This list may be extended in the future. Therefore, and for
other conventions, project-private buses should be tracked
using @env{X_BUS}, where @env{X} is the project name.

Messages broadcasted on a bus cannot be longer than 2047 bytes,
excluding NUL termination. Message should be encoded in UTF-8,
and most not contain the NUL character.

Broadcasted message should start with the process ID whence
the message originated, followed by a single regular space.
If the process is ephemeral@footnote{The process exits after
the broadcast, or shortly thereafter.}, 0 should be used instead
of the process identifier.



@node Invoking
@chapter Invoking

@command{bus} includes the following commands:

@table @command
@item create
Create a bus.
See @ref{bus create} for more information.
@item remove
Remove a bus.
See @ref{bus remove} for more information.
@item listen
Listen for new message on a bus.
See @ref{bus listen} for more information.
@item wait
Listen for one new message only on a bus.
See @ref{bus wait} for more information.
@item broadcast
Broadcast a message on a bus.
See @ref{bus broadcast} for more information.
@item chmod
Change permissions on a bus.
See @ref{bus chmod} for more information.
@item chown
Change ownership of a bus.
See @ref{bus chown} for more information.
@item chgrp
Change group ownership of a bus.
See @ref{bus chgrp} for more information.
@end table

Upon successful completion, these commands exit with the value
0. On failure, they exit with the value 1. If the command is
not recognised the exit value is 2.

@menu
* bus create::                      Create a bus.
* bus remove::                      Remove a bus.
* bus listen::                      Listen for new message on a bus.
* bus wait::                        Listen for one new message only on a bus.
* bus broadcast::                   Broadcast a message on a bus.
* bus chmod::                       Change permissions on a bus.
* bus chown::                       Change ownership of a bus.
* bus chgrp::                       Change group ownership of a bus.
@end menu



@node bus create
@section @command{bus create}

The syntax for invocation of @command{bus create} is
@example
bus create [-x] [--] [@var{PATHNAME}]
@end example

The command creates a bus and stores the key to it in the
file @var{PATHNAME}. If @var{PATHNAME} is omitted, a
random pathname in @file{$XDG_RUNTIME_DIR/bus} will be
used and printed to stdout.

If @option{-x} is used, the command will fail if
the file @var{PATHNAME} already exists.




@node bus remove
@section @command{bus remove}

The syntax for invocation of @command{bus remove} is
@example
bus remove [--] @var{PATHNAME}
@end example

The command removes the bus whose key is stored in
the file @var{PATHNAME}.  The file holding the
key is also unlinked.



@node bus listen
@section @command{bus listen}

The syntax for invocation of @command{bus command} is
@example
bus listen [--] @var{PATHNAME} @var{COMMAND}
@end example

The command listens for new messages on the bus whose
key is stored in the file @var{PATHNAME}. Once a message
is received, @var{COMMAND} will be spawned with the
environment variable @env{msg} (lowercased) set to the
received message. @sc{POSIX} shell syntax applies to
@var{COMMAND}.


@node bus wait
@section @command{bus wait}

The syntax for invocation of @command{bus wait} is
@example
bus wait [--] @var{PATHNAME} @var{COMMAND}
@end example

The command listens for a new message on the bus whose
key is stored in the file @var{PATHNAME}. Once a message
is received, the process will stop listening for more
messages and @var{COMMAND} will be spawned with the
environment variable @env{msg} (lowercased) set to the
received message. @sc{POSIX} shell syntax applies to
@var{COMMAND}.



@node bus broadcast
@section @command{bus broadcast}

The syntax for invocation of @command{bus broadcast} is
@example
bus broadcast [-n] [--] @var{PATHNAME} @var{MESSAGE}
@end example

The command broadcasts the message @var{MESSAGE} on the
bus whose key is stored in the file @var{PATHNAME}.



@node bus chmod
@section @command{bus chmod}

The syntax for invocation of @command{bus chmod} is
@example
bus chmod [--] @var{PERMISSIONS} @var{PATHNAME}
@end example

This command changes who have access to the bus whose key
is stored in the file @var{PATHNAME}. In the permissions,
the owner, the group, and others (not in tgroup) are
represented by the symbols @code{u}@footnote{@code{u}
stands for `user'.}, @code{g}, and @code{o}, respectively.
The permissions string is imagined to have always be
prefixed with an @code{=}. This symbols means that all user
classes list after it, and only those classes, as permission
to use the bus. Similarly the symbols @code{+} and @code{-}
can be used to grant and revoke access, respectively. The
symbols @code{=}, @code{+}, and @code{-} can be mixed, and
are interpreted from left to right. Alternatively the
permissions string can be a octal number, where the  owner
is represented by any bit in 700 (100, 200, or 400, or any
combination thereof), the group is represented by any bit
in 70, and others (not in the group) is represented by any
bit in 7.

The current permission of the bus can be retrieved by
running @command{stat} over the file @var{PATHNAME}.



@node bus chown
@section @command{bus chown}

The syntax for invocation of @command{bus chown} is
@example
bus chown [--] @var{OWNER}[:@var{GROUP}] @var{PATHNAME}
@end example

This command changes the owner, that owns the bus whose
key is stored in the file @var{PATHNAME}, to the specified
owner. The owner can be specified either with a numerical
user identifier or with a user name. If a group is
specified, the bus's owner-group will be set to that group,
otherwise the group will remain unchanged (not changed
to the group of the new owner.) The group can be specified
either with a numerical group identifier or with a group
name.

The current ownership of the bus can be retrieved by
running @command{stat} over the file @var{PATHNAME}.



@node bus chgrp
@section @command{bus chgrp}

The syntax for invocation of @command{bus chgrp} is
@example
bus chgrp [--] @var{GROUP} @var{PATHNAME}
@end example

This command changes the group, that owns the bus whose
key is stored in the file @var{PATHNAME}, to the specified
group. The group can be specified either with a numerical
group identifier or with a group name.

The current ownership of the bus can be retrieved by
running @command{stat} over the file @var{PATHNAME}.



@node Interface
@chapter Interface

To use @command{libbus} in your C program, include the
header file @file{<bus.h>} and link with the flag
@option{-lbus}.

With exception to @code{bus_poll} and @code{bus_poll_timed},
all functions return @code{0} upon successful completion,
and @code{-1} in case of failure. @code{bus_poll} and
@code{bus_poll_timed} return @code{NULL} on failure.
On failure on all functions set @code{errno} to indicate
what went wrong.

@file{<bus.h>} defines the following functions:

@table @code
@item int bus_create(const char *file, int flags, char **out_file)
This function creates a bus with the asscoiated pathname
specifed by the value of the parameter @code{file}. If
@code{file} is @code{NULL} a random pathname is selected.
This pathname adheres to the convention set forth by
in @ref{Standard}.

If @code{file} is not @code{NULL} the function fails if the
file already exists if @code{flags} contains @code{BUS_EXCL}.
Otherwise if @code{file} is not @code{NULL}, the function
does nothing if the file already exists.

If @code{flags} contains @code{BUS_INTR}, the function fails
if it is interrupted.

Unless @code{out_file} is NULL, the pathname of the bus
should be stored in a new char array stored in @code{*out_file}.
The caller must free the allocated stored in @code{*out_file}.

If the processes cannot allocate enough memory to perform
the action, the function sets @code{errno} to @code{ENOMEM}
and fails. It may also fail and set @code{errno} to any of
the errors specified for the system calls @code{open} and
@code{write}.

@item int bus_unlink(const char *file)
This function removes the bus assoicated with the pathname
stored in the parameter @code{file}. The function also
unlinks the file.

The function may set @code{errno} to any of the following
values and fail for the specified reasons:
@table @code
@item EINVAL
The bus does not exist.
@item EACCES
Operation permission is denied to the calling process.
@item EPERM
The user does not have permission to remove the bus.
@end table
@noindent
It may also fail and set @code{errno} to any of the errors
specified for the system calls @code{unlink} and @code{open},
and the functions @code{semget} and @code{shmget}.

@item int bus_open(bus_t *bus, const char *file, int flags)
This function acquires resources required for the process
to use the bus associated with the filename stored in the
parameter @code{file}. The function also stores the resources
in @code{bus} for use by other @command{bus} functions.

Values for @code{flags} are constructed by a bitwise
inclusive @sc{or} of flags from the following list.
@table @code
@item BUS_RDONLY
The process will only be using the bus for receiving messages.
@item BUS_WRONLY
The process will only be using the bus for sending messages.
@item BUS_RDWR
The process will use the bus for both receiving and sending
messages.
@end table

The function may set @code{errno} to any of the following
values and fail for the specified reasons:
@table @code
@item ENOMEM
The process cannot allocate enough memory to perform the
action.
@item EACCES
Operation permission is denied to the calling process.
@item EINVAL
The described bus does not exist.
@end table
@noindent
It may also fail and set @code{errno} to any of the errors
specified for the system call @code{open}.

@item int bus_close(bus_t *bus)
This function disposes of resources allocated to the
process, as referenced in the parameter @code{bus}.

The function fails and sets @code{errno} to @code{EINVAL}
if the bus does not exist.

@item int bus_write(const bus_t *bus, const char *message, int flags)
This function broadcasts a message on the bus whose
information is stored in the parameter @code{bus}. The
message read by the function is stored in the parameter
@code{message}. It may not exceeed 2048 bytes, including
NUL termination.

The function shall fail, and set @code{errno} to
@code{EAGAIN}, if the call would suspend the process and
@code{flags} contains @code{BUS_NOWAIT}.

The function may fail and set @code{errno} to any of the
errors specified for the function @code{semop}.

@item int bus_write_timed(const bus_t *bus, const char *message, const struct timespec *timeout, clockid_t clockid)
This function behaves like @code{bus_write}, except if it
is not able to write the message within the specified time,
it will fail and set @code{errno} to @code{EAGAIN}. The
time is specified as an absolute time using the parameter
@code{timeout}. The behaviour is unspecified if @code{timeout}
is @code{NULL}. @code{timeout} is measured with the clock whose
identifier is specified by the parameter @code{clockid}. This
clock must be a predicitable clock@footnote{There are probably
other, undocumented, seemingly arbitrary restrictions too.}.

The function may fail and set @code{errno} to any of the
errors specified for the functions @code{semop} and
@code{clock_gettime}.

@item int bus_read(const bus_t *bus, int (*callback)(const char *message, void *user_data), void *user_data)
This function waits for new message to be sent on the bus
specified in the @code{bus} parameter, as provieded by a
previous call to the function @code{bus_open}. Once a
message is received, the parameter-function @code{callback}
is invoked. The parameter @code{message} in @code{callback}
is the received message, and @code{user_data} in
@code{callback} should be @code{user_data} from @code{bus_read}.
However, once the function [@code{bus_read}] has ensured
that it will receive any message sent on the bus, it shall
invoke the parameter-function @code{callback} with
@code{message} set to @code{NULL}, to notify the process that
it can perform any action that requires that it is listening
on the bus.

After @code{callback} returns, @code{message} may be override.
Therefore @code{callback} should copy message and start a new
thread that uses the copy of @code{message}. @code{callback}
shall return @code{-1} on failure, @code{0} if the function
[@code{bus_read}] should stop listening, or @code{1} if
the function should continue listening.

The function may fail and set @code{errno} to any of the
errors specified for the function @code{semop}.

@item int bus_read_timed(const bus_t *bus, int (*callback)(const char *message, void *user_data), void *user_data, const struct timespec *timeout, clockid_t clockid)
This function behaves like @code{bus_read}, except it will
automatically fail and set @code{errno} to @code{EAGAIN} when
the specified time has passed. The time is specified as an
absolute time using the parameter @code{timeout}. The
behaviour is unspecified if @code{timeout} is @code{NULL}.
@code{timeout} is measured with the clock whose identifier
is specified by the parameter @code{clockid}. This clock
must be a predicitable clock@footnote{There are probably
other, undocumented, seemingly arbitrary restrictions too.}.

The function may fail and set @code{errno} to any of the
errors specified for the functions @code{semop} and
@code{clock_gettime}.

@item int bus_poll_start(bus_t *bus)
@itemx int bus_poll_stop(const bus_t *bus)
@itemx const char *bus_poll(bus_t *bus, int flags)
@itemx const char *bus_poll_timed(bus_t *bus, const struct timespec *timeout, clockid_t clockid)
The function @code{bus_poll} waits for a message to be
broadcasted on the bus, and return the message it receives.
The function fails if @code{flags} contains @code{BUS_NOWAIT}
and there is not already a message waiting on the bus.
Received messages shall be copied and parsed, and acted
upon, in a separate thread, and the function @code{bus_poll}
or the function @code{bus_poll_stop} called again as soon
as possible.

The funcion @code{bus_poll_start} must be called before
@code{bus_poll} is called for the first time. When the
process is done listening on the bus, it must call the
function @code{bus_poll_stop}.

The function @code{bus_poll_timed} behaves like the function
@code{bus_poll}, except if it is not able to read a message
within the specified time, it will fail and set @code{errno}
to @code{EAGAIN}. The time is specified as an absolute time
using the parameter @code{timeout}. The behaviour is
unspecified if @code{timeout} is @code{NULL}. @code{timeout}
is measured with the clock whose identifier is specified by
the parameter @code{clockid}. This clock must be a predicitable
clock@footnote{There are probably other, undocumented,
seemingly arbitrary restrictions too.}.

Upon successful completion, the functions @code{bus_poll} and
@code{bus_poll_timed} returns the received message.

These functions may fail and set @code{errno} to any of the
errors specified for the function @code{semop}. The function
@code{bus_poll_timed} may also set @code{errno} to any of
the errors specified for @code{clock_gettime}.

@item int bus_chown(const char *file, uid_t owner, gid_t group)
This function changes the owner and the group of the bus,
associated with the file whose pathname is stored in the
parameter @code{file}, to the owner and group specified by
the parameters @code{owner} and @code{group}, respectively.

The current ownership of a bus can be retrieved by calling
@code{stat} over the pathname of the bus.

The function may fail and set @code{errno} to any of the
errors specified for the functions @code{bus_open},
@code{chown}, @code{semget}, @code{shmget}, and @code{shmctl}
as well as any errors specified for the commands
@code{IPC_STAT} and @code{IPC_SET} for the function
@code{semctl}.

@item int bus_chmod(const char *file, mode_t mode)
This function gives access to the bus associated with the
file whose pathname is stored in the parameter @code{file}
according to the following rules:

@itemize @bullet{}
@item
If @code{mode} contains any of the bits @code{S_IRWXU}
contains, the owner should be given full access to the
bus. Otherwise the owner should have no access.
@item
If @code{mode} contains any of the bits @code{S_IRWXG}
contains, the group should be given read and write
access to the bus. Otherwise the group should have no
access.
@item
If @code{mode} contains any of the bits @code{S_IRWXO}
contains, users that are neither the owner nor member
of the group should be given read and write access to
the bus. Otherwise they should have no access.
@end itemize

The current permissions of a bus can be retrieved by calling
@code{stat} over the pathname of the bus.

The function may fail and set @code{errno} to any of the
errors specified for the functions @code{bus_open},
@code{chmode}, @code{semget}, @code{shmget}, and @code{shmctl}
as well as any errors specified for the commands
@code{IPC_STAT} and @code{IPC_SET} for the function
@code{semctl}.
@end table

There is not reason for poking around in @code{bus_t}
(@code{struct bus}). It should be considered opaque.
You can read the documentation in @file{<bus.h>} if
you want to know what is in it.




@node Protocol
@chapter Protocol

@command{bus} is built upon following three procedures.

@noindent
@code{create}
@example
@w{@xrm{}Select a filename.@xtt{}}

@w{@xrm{}Create XSI semaphore array @{@code{S} = 0, @code{W} = 0, @code{X} = 1, @code{Q} = 0, @code{N} = 0@}@xtt{}}
@w{@xrm{}with random key. Store the semaphore array's key in decimal form@xtt{}}
@w{@xrm{}on the first line in the selected file.@xtt{}}

@w{@xrm{}Create XSI shared memory, with an allocation of 2048 bytes, with@xtt{}}
@w{@xrm{}a random key. Store the shared memory's key in decimal form on@xtt{}}
@w{@xrm{}the second line in the selected file.@xtt{}}
@end example

@noindent
@code{broadcast}
@example
with P(X):
  Z(W)
  @w{@xrm{}Write NUL-terminate message to shared memory@xtt{}}
  with V(N): -- (1)
    Q := 0
    Z(S)

-- (1) @w{@xrm{}may be omitted if semaphores are known that@xtt{}}
   @w{P()@xrm{}, @xtt{}Z()@xrm{}, @xtt{}V()@xrm{} cannot create a race condition@xtt{}}
   @w{@xrm{}with a processes running @xtt{}Z()@xrm{}.@xtt{}}
@end example

@noindent
@code{listen}
@example
with V(S):
  forever:
    V(Q)
    Z(Q)
    @w{@xrm{}Read NUL-terminated message from shared memory@xtt{}}
    if breaking:
      break
    with V(W):
      with P(S):
        Z(S)
        Z(N)
@end example

@noindent
@code{V(a)} means that semaphore a is released.@*
@code{P(a)} means that semaphore a is acquired.@*
@code{Z(a)} means that the process waits for semaphore a to become 0.@*
@code{with P(a)} that @code{P(a)} is done before the entering the scope,
and @code{V(a)} is done when exiting the scope. It also means that
these actions [@code{P(a)} and @code{V(a)}] are undone when the process
exits, or if the call fails.@*
@code{with V(a)} is to @code{V(a)} as @code{with P(a)} is to @code{P(a)}.



@node Rationale
@chapter Rationale

We need an interprocess communication system similar
to message queues. But we need broadcasting rather than
anycasting, so we have a fast, simple and daemonless
system for announcing events to any processes that
might be interested.



@node Examples
@chapter Examples

This chapter contains usecase examples and
API-demonstrations. You will find that they are (on
a standard installation) installed on your system.

@menu
* Audio-volume control::
* Telephony and music::
* Timed::
* Nonblocking::
* Daemon-depedencies::
@end menu




@node Audio-volume control
@section Audio-volume control

Assume you have program that display the audio volume.
This program checks every second third if the volume
have changed.

Also assume that you use @command{amixer} to change the
volume, most often by using keybindings via @command{xbindkeys}.

To reduce the delay, you want to send a signal to the
monitor program that the volume have changed. For this
more primitive IPC is sufficient, but lets assume there
are other programs interested in this information too.

To accomplish this, you create a wrapper for @command{amixer}
that broadcasts updates on a bus. This wrapper is
installed as @command{~/.local/bin/amixer}, and
@command{~/.local/bin/} is included in @env{$PATH}
before @command{/usr/bin}.
@*

@noindent
Before starting run @command{./init}, this code is
should be run from your profile file if you want to
implement this on your system. After running
@command{./init}, you can start one or more listeners
by running @command{./alsa-monitor}.

To change the volume run
@code{./amixer -c 0 -- set Master 5%+} or similar.

When you are done run @command{./cleanup}.


@subsubheading @file{./amixer}
@example
#!/bin/sh
/usr/bin/amixer "$@@"
for arg in "$@@"; do
  if [ "$@{arg@}" = "set" ]  || \
     [ "$@{arg@}" = "sset" ] || \
     [ "$@{arg@}" = "cset" ]; then
    exec bus broadcast "/tmp/example-bus" '0 volume-changed *'
  fi
done
@end example


@subsubheading @file{./cleanup}
@example
#!/bin/sh
exec bus remove "/tmp/example-bus"
@end example


@subsubheading @file{./init}
@example
#!/bin/sh
bus create "/tmp/example-bus"

# @w{@xrm{}The following code is more suitable in the real world,@xtt{}}
# @w{@xrm{}if used, the other files should use @xtt{}"$@{BUS_AUDIO@}"}
# @w{@xrm{}instead of @xtt{}"/tmp/example-bus"@xrm{}.@xtt{}}
# 
# export BUS_AUDIO="$@{XDG_RUNTIME_DIR@}/bus/audio"
# if [ ! -f "$@{BUS_AUDIO@}" ]; then
#   bus create "$@{BUS_AUDIO@}"
# fi
@end example


@subsubheading @file{./monitor}
@example
#!/bin/sh
if [ $# = 1 ]; then
  if [ "$(echo "$@{1@}" | cut -d ' ' -f 2)" = "volume-changed" ]; then
    printf '\e[H\e[2J'
    amixer get Master
  fi
  exit 0
fi

exec 2>/dev/null

printf '\e[?1049h\e[H\e[2J'
trap -- "printf '\e[?1049l'" SIGINT
bus listen "/tmp/example-bus" \'"$@{0/\'/\'\\\'\'@}"\'' "$@{msg@}"'
@end example



@node Telephony and music
@section Telephony and music

Assume you have a music player and a telephony program.
You might like it if the music player pauses whenever
you make or receive a call. You may also like it, if
the music resumed when the call ended.

In this example we will assume you the have @command{mocp}
(@command{moc} package) running. And we will use the shell to
simulate a telephony program.
@*

@noindent
First of, run make to build this example. Before
starting run @command{./init}. And when you are
done run @command{./cleanup}.

In one terminal run @command{./monitor}. This program
will pause @command{mocp} when you make or receive a call,
it will also resume @command{mocp} when all calls have
ended if it did pause @command{mocp}.

Then start any positive number of terminals.
We will pretend that each of them are telephony
programs. To make or receive a call, run
@command{./receive-or-make-call}, when you want to
end the pretend call, run @command{./end-call} from
the terminal (or more accurately, from the same
process.)


@subsubheading @file{./Makefile}
@example
COMMANDS = init cleanup monitor end-call receive-or-make-call

all: $@{COMMANDS@}
%: %.c
        $@{CC@} -Wall -Wextra -pedantic -std=c99 -lbus -o $@@ $<
clean:
        -rm $@{COMMANDS@}

.PHONY: all clean
@end example


@subsubheading @file{./cleanup.c}
@example
#include <bus.h>
#include <stdio.h>

int main()
@{
  return bus_unlink("/tmp/example-bus") && (perror("cleanup"), 1);
@}
@end example


@subsubheading @file{./end-call.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <stdint.h>

#define t(stmt)  if (stmt) goto fail

static char message[BUS_MEMORY_SIZE];

int main()
@{
  bus_t bus;
  sprintf(message, "%ji unforce-pause", (intmax_t)getppid());
  /* @w{@xrm{}Yes, PPID; in this example we pretend the shell is the telephony process.@xtt{}} */
  t (bus_open(&bus, "/tmp/example-bus", BUS_WRONLY));
  t (bus_write(&bus, message, 0));
  bus_close(&bus);
  return 0;

fail:
  perror("end-call");
  bus_close(&bus);
  return 1;
@}
@end example


@subsubheading @file{./init.c}
@example
#include <bus.h>
#include <stdio.h>

int main()
@{
  return bus_create("/tmp/example-bus", 0, NULL) && (perror("init"), 1);
@}
@end example


@subsubheading @file{./monitor.c}
@example
#include <bus.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#define t(stmt)  if (stmt) goto fail

static size_t pauser_count = 0;
static size_t pausers_size = 0;
static char* pausers = NULL;

static int is_moc_playing(void)
@{
  return !WEXITSTATUS(system("env LANG=C mocp -i 2>/dev/null |"
                             "grep 'State: PLAY' >/dev/null"));
@}

/* @w{@xrm{}In a proper implementation, message whould be copyied, and then@xtt{}}
 * @w{@xrm{}a new thread would be created that parsed the copy. But that is@xtt{}}
 * @w{@xrm{}too much for an example, especially since it would also require@xtt{}}
 * @w{@xrm{}a mutex to make sure two threads do not modify data at the same@xtt{}}
 * @w{@xrm{}time, causing chaos.@xtt{}} */
static int callback(const char *message, void *user_data)
@{
  char *msg = NULL;
  size_t len = 0;
  if (message == 0)
    return 1;
  while ((len < 2047) && message[len])
    len++;
  msg = malloc((len + 1) * sizeof(char));
  t (msg == NULL);
  memcpy(msg, message, len * sizeof(char));
  msg[len] = 0;
  /* @w{@xrm{}BEGIN run as in a separate thread@xtt{}} */
  if (pauser_count || is_moc_playing()) @{
    char *begin = strchr(msg, ' ');
    ssize_t pid;
    int requests_pause;
    if (begin == NULL)
      goto done;
    *begin++ = 0;
    pid = (ssize_t)atoll(msg);
    if (pid < 1) /* @w{@xrm{}We need a real PID, too bad there is@xtt{}}
                  * @w{@xrm{}no convient way to detect if it dies.@xtt{}} */
      goto done;
    if ((strstr(begin, "force-pause ") == begin) ||
        !strcmp(begin, "force-pause"))
      requests_pause = 1;
    else if ((strstr(begin, "unforce-pause ") == begin) ||
             !strcmp(begin, "unforce-pause"))
      requests_pause = 0;
    else
      goto done;
    if ((size_t)pid >= pausers_size) @{
      pausers = realloc(pausers, (size_t)(pid + 1) * sizeof(char));
      t (pausers == NULL); /* @w{@xrm{}Let's ignore the memory leak.@xtt{}} */
      memset(pausers + pausers_size, 0,
             ((size_t)(pid + 1) - pausers_size) * sizeof(char));
      pausers_size = (size_t)(pid + 1);
    @}
    if (pausers[pid] ^ requests_pause) @{
      pauser_count += requests_pause ? 1 : -1;
      pausers[pid] = requests_pause;
      if (pauser_count == (size_t)requests_pause)
        system(requests_pause ? "mocp -P" : "mocp -U");
    @}
  @}
  /* @w{@xrm{}END run as in a separate thread@xtt{}} */
  goto done;
  (void) user_data;

fail:
  perror("monitor");
  return -1;

done:
  free(msg);
  return 1;
@}

int main()
@{
  bus_t bus;
  t (bus_open(&bus, "/tmp/example-bus", BUS_RDONLY));
  t (bus_read(&bus, callback, NULL));
  bus_close(&bus);
  free(pausers);
  return 0;

fail:
  perror("monitor");
  bus_close(&bus);
  free(pausers);
  return 1;
@}
@end example


@subsubheading @file{./receive-or-make-call.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <stdint.h>

#define t(stmt)  if (stmt) goto fail

static char message[BUS_MEMORY_SIZE];

int main()
@{
  bus_t bus;
  sprintf(message, "%ji force-pause", (intmax_t)getppid());
  /* @w{@xrm{}Yes, PPID; in this example we pretend the shell is the telephony process.@xtt{}} */
  t (bus_open(&bus, "/tmp/example-bus", BUS_WRONLY));
  t (bus_write(&bus, message, 0));
  bus_close(&bus);
  return 0;

fail:
  perror("receive-or-make-call");
  bus_close(&bus);
  return 1;
@}
@end example



@node Timed
@section Timed

This example shows how to use timed operations.

First of, run make to build this example.

To start the example run @command{./init}. When you are
done run @command{./cleanup}.

Running instances of @command{./poll} will wait for new
messages continuously, but with one second timeouts.

@command{./slow-poll} works like @command{./poll}, except
it will sleep for one second every time it receives
a message.

Running instances of @command{./read} will read for ten
seconds and then time out.

@command{./poll}, @command{./read}, and @command{./slow-poll}
will stop if the message "stop" is broadcasted.

@command{./write} will wait for atmost a tenth of a
seconds before failing. This means that if two instances
of @command{./write} is started at the same time one of
them will fail if @command{./slow-poll} is running.

@command{./poll}, @command{./read}, @command{./init} and
@command{./cleanup} are run without any additional
arguments. @command{./write} is run with the message
as the second argument.


@subsubheading @file{./Makefile}
@example
COMMANDS = init cleanup write poll read slow-poll

all: $@{COMMANDS@}
%: %.c
        $@{CC@} -Wall -Wextra -pedantic -std=c99 -lbus -o $@@ $<
clean:
        -rm $@{COMMANDS@}

.PHONY: all clean
@end example


@subsubheading @file{./cleanup.c}
@example
#include <bus.h>
#include <stdio.h>

int main()
@{
  return bus_unlink("/tmp/example-bus") && (perror("cleanup"), 1);
@}
@end example


@subsubheading @file{./init.c}
@example
#include <bus.h>
#include <stdio.h>

int main()
@{
  return bus_create("/tmp/example-bus", 0, NULL) && (perror("init"), 1);
@}
@end example


@subsubheading @file{./poll.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>

#define t(stmt)  if (stmt) goto fail

int main()
@{
  bus_t bus;
  const char *message;
  long long tick = 0;
  struct timespec timeout;
  t (bus_open(&bus, "/tmp/example-bus", BUS_RDONLY));
  t (bus_poll_start(&bus));
  for (;;) @{
    t(clock_gettime(CLOCK_MONOTONIC, &timeout));
    timeout.tv_sec += 1;
    message = bus_poll_timed(&bus, &timeout, CLOCK_MONOTONIC);
    if (message == NULL) @{
      t (errno != EAGAIN);
      printf("waiting... %lli\n", ++tick);
      continue;
    @}
    tick = 0;
    message = strchr(message, ' ') + 1;
    if (!strcmp(message, "stop"))
      break;
    printf("\033[01m%s\033[21m\n", message);
  @}
  t (bus_poll_stop(&bus));
  bus_close(&bus);
  return 0;

fail:
  perror("poll");
  bus_poll_stop(&bus);
  bus_close(&bus);
  return 1;
@}
@end example


@subsubheading @file{./read.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>

#define t(stmt)  if (stmt) goto fail

static int callback(const char *message, void *user_data)
@{
  (void) user_data;

  if (message == NULL)
    return 1;

  message = strchr(message, ' ') + 1;
  if (!strcmp(message, "stop"))
    return 0;
  printf("%s\n", message);
  return 1;
@}

int main()
@{
  bus_t bus;
  struct timespec timeout;
  t (bus_open(&bus, "/tmp/example-bus", BUS_RDONLY));
  t (clock_gettime(CLOCK_MONOTONIC, &timeout));
  timeout.tv_sec += 10;
  t (bus_read_timed(&bus, callback, NULL, &timeout, CLOCK_MONOTONIC));
  bus_close(&bus);
  return 0;

fail:
  perror("poll");
  bus_poll_stop(&bus);
  bus_close(&bus);
  return 1;
@}
@end example


@subsubheading @file{./slow-poll.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>

#define t(stmt)  if (stmt) goto fail

int main()
@{
  bus_t bus;
  const char *message;
  long long tick = 0;
  struct timespec timeout;
  t (bus_open(&bus, "/tmp/example-bus", BUS_RDONLY));
  t (bus_poll_start(&bus));
  for (;;) @{
    t (clock_gettime(CLOCK_MONOTONIC, &timeout));
    timeout.tv_sec += 1;
    message = bus_poll_timed(&bus, &timeout, CLOCK_MONOTONIC);
    if (message == NULL) @{
      t (errno != EAGAIN);
      printf("waiting... %lli\n", ++tick);
      continue;
    @}
    tick = 0;
    message = strchr(message, ' ') + 1;
    if (!strcmp(message, "stop"))
      break;
    printf("\033[01m%s\033[21m\n", message);
    sleep(1);
  @}
  t (bus_poll_stop(&bus));
  bus_close(&bus);
  return 0;

fail:
  perror("poll");
  bus_poll_stop(&bus);
  bus_close(&bus);
  return 1;
@}
@end example


@subsubheading @file{./write.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <stdint.h>

#define t(stmt)  if (stmt) goto fail

static char message[BUS_MEMORY_SIZE];

int main(int argc, char *argv[])
@{
  bus_t bus;
  struct timespec timeout;
  if (argc < 2) @{
    fprintf(stderr, "%s: USAGE: %s message\n", argv[0], argv[0]);
    return 2;
  @}
  sprintf(message, "0 %s", argv[1]);
  t (bus_open(&bus, "/tmp/example-bus", BUS_WRONLY));
  t (clock_gettime(CLOCK_MONOTONIC, &timeout));
  timeout.tv_nsec += 100000000L;
  t (bus_write_timed(&bus, message, &timeout, CLOCK_MONOTONIC));
  bus_close(&bus);
  return 0;

fail:
  perror("write");
  bus_close(&bus);
  return 1;
@}
@end example



@node Nonblocking
@section Nonblocking

This example shows how to use bus_poll instead of bus_read,
and how to do non-blocking polling and non-blocking writing.

First of, run make to build this example.

To start the example run @command{./init}. When you are done
run @command{./cleanup}.

Running instances of @command{./poll} will check every second
if there is a new inbound message. Between these checks
@command{./write} will wait for all @command{./poll}:s to
receive the message. This means that @command{./write} blocks
while @command{./poll} sleeps. If two or more instances of
@command{./write} is started at approximately the same time,
only one will continue to write a message on the bus, the
others will fail.

@command{./poll} will stop if the message ``stop'' is
broadcasted.

@command{./poll}, @command{./init} and @command{./cleanup}
are run without any additional arguments. @command{./write}
is run with the message as the second argument.


@subsubheading @file{./Makefile}
@example
COMMANDS = init cleanup write poll

all: $@{COMMANDS@}
%: %.c
        $@{CC@} -Wall -Wextra -pedantic -std=c99 -lbus -o $@@ $<
clean:
        -rm $@{COMMANDS@}

.PHONY: all clean
@end example


@subsubheading @file{./cleanup.c}
@example
#include <bus.h>
#include <stdio.h>

int main()
@{
  return bus_unlink("/tmp/example-bus") && (perror("cleanup"), 1);
@}
@end example


@subsubheading @file{./init.c}
@example
#include <bus.h>
#include <stdio.h>

int main()
@{
  return bus_create("/tmp/example-bus", 0, NULL) && (perror("init"), 1);
@}
@end example


@subsubheading @file{./poll.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>

#define t(stmt)  if (stmt) goto fail

int main()
@{
  bus_t bus;
  const char *message;
  long long tick = 0;
  t (bus_open(&bus, "/tmp/example-bus", BUS_RDONLY));
  t (bus_poll_start(&bus));
  for (;;) @{
    message = bus_poll(&bus, BUS_NOWAIT);
    if (message == NULL) @{
      t (errno != EAGAIN);
      printf("waiting... %lli\n", ++tick);
      sleep(1);
      continue;
    @}
    tick = 0;
    message = strchr(message, ' ') + 1;
    if (!strcmp(message, "stop"))
      break;
    printf("\033[01m%s\033[21m\n", message);
  @}
  t (bus_poll_stop(&bus));
  bus_close(&bus);
  return 0;

fail:
  perror("poll");
  bus_poll_stop(&bus);
  bus_close(&bus);
  return 1;
@}
@end example


@subsubheading @file{./write.c}
@example
#include <bus.h>
#include <stdio.h>
#include <unistd.h>
#include <stdint.h>

#define t(stmt)  if (stmt) goto fail

static char message[BUS_MEMORY_SIZE];

int main(int argc, char *argv[])
@{
  bus_t bus;
  if (argc < 2) @{
    fprintf(stderr, "%s: USAGE: %s message\n", argv[0], argv[0]);
    return 2;
  @}
  sprintf(message, "0 %s", argv[1]);
  t (bus_open(&bus, "/tmp/example-bus", BUS_WRONLY));
  t (bus_write(&bus, message, BUS_NOWAIT));
  bus_close(&bus);
  return 0;

fail:
  perror("write");
  bus_close(&bus);
  return 1;
@}
@end example



@node Daemon-depedencies
@section Daemon-depedencies

TODO



@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include fdl.texinfo

@bye