summaryrefslogtreecommitdiffstats
path: root/doc/new_chapters/eventlog.t
blob: f502d81ed28dd097713ad5bb8683fd29fe65bef2 (plain)
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
@c
@c  COPYRIGHT (c) 1988-2002.
@c  On-Line Applications Research Corporation (OAR).
@c  All rights reserved. 
@c
@c  $Id$
@c

@chapter Event Logging Manager

@section Introduction

The event logging manager provides a portable method for logging
system and application events and subsequent processing of those
events.  The capabilities in this manager were defined in the POSIX
1003.1h/D3 proposed standard titled @b{Services for Reliable,
Available, and Serviceable Systems}.

The directives provided by the event logging manager are:

@itemize @bullet
@item @code{log_create} - Create a log file
@item @code{log_sys_create} - Create a system log file
@item @code{log_write} - Write to the system Log
@item @code{log_write_any} - Write to any log file
@item @code{log_write_entry} - Write entry to any log file
@item @code{log_open} - Open a log file
@item @code{log_read} - Read from a log file
@item @code{log_notify} - Notify Process of writes to the system log
@item @code{log_close} - Close log descriptor
@item @code{log_seek} - Reposition log file offset
@item @code{log_severity_before} - Compare event record severities
@item @code{log_facilityemptyset} - Manipulate log facility sets
@item @code{log_facilityfillset} - Manipulate log facility sets
@item @code{log_facilityaddset} - Manipulate log facility sets
@item @code{log_facilitydelset} - Manipulate log facility sets
@item @code{log_facilityismember} - Manipulate log facility sets
@item @code{log_facilityisvalid} - Manipulate log facility sets
@end itemize

@section Background

@subsection Log Files and Events

The operating system uses a special log file named @code{syslog}.  
This log file is called the system log and is automatically created and
tracked by the operating system.  The system log is written with 
the @code{log_write()} function.  An alternative log file may be written 
using the @code{log_write_any()} function.  It is possible to use @code{log_read()}
to query the system log and and write the records to a non-system log file 
using @code{log_write_entry()} to produce a filtered version of the
system log.  For example you could produce a log of all disk controller
faults that have occurred.  

A non-system log may be a special log file created by an application to 
describe application faults, or a subset of the system log created 
by the application.  



@subsection Facilities

A facility is an identification code for a subsystem, device, or
other object about which information is being written to 
a log file.  

A facility set is a collection of facilities.

@subsection Severity

Severity is a rating of the error that is being logged.   

@subsection Queries


The facility identifier and the event severity are the basis for
subsequent log query.  A log query is used as a filter to
obtain a subset of a given log file.  The log file may be configured 
to send out an event.

@section Operations

@subsection Creating and Writing a non-System Log

The following code fragment create a non-System log file at /temp/.
A real filename previously read entry and buffer @code{log_buf} of size 
@code{readsize} are written into the log.  See the discussion on opening 
and reading a log for how the entry is created.

@example
#include <evlog.h>
   :
  logd_t           *outlog = NULL;
  char             *path   = "/temp/";

  log_create( outlog, path );
   :  
  log_write_entry( outlog, &entry, log_buf, readsize );

@end example

@subsection Reading a Log

Discuss opening and reading from a log.

@example
  build a query
  log_open
  log_read loop
@end example

@section Directives

This section details the event logging manager's directives.
A subsection is dedicated to each of this manager's directives
and describes the calling sequence, related constants, usage,
and status codes.

@page
@subsection log_write - Write to the system Log

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_write(
  const log_facility_t  facility,
  const int             event_id,
  const log_severity_t  severity,
  const void           *buf,
  const size_t          len
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_write()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item E2BIG
This error indicates an inconsistency in the implementation.
Report this as a bug.

@item EINVAL
The @code{facility} argument is not a valid log facility.

@item EINVAL
The @code{severity} argument exceeds @code{LOG_SEVERITY_MAX}.

@item EINVAL
The @code{len} argument exceeds @code{LOG_MAXIUM_BUFFER_SIZE}.

@item EINVAL
The @code{len} argument was non-zero and @code{buf} is @code{NULL}.

@item ENOSPC
The device which contains the log file has run out of space.

@item EIO
An I/O error occurred in writing to the log file.

@end table

@subheading DESCRIPTION:

The @code{log_write} function writes an event record to the 
system log file.  The event record written consists of the
event attributes specified by the @code{facility}, @code{event_id},
and @code{severity} arguments as well as the data identified by the
@code{buf} and @code{len} arguments.  The fields of the event record
structure to be written are filled in as follows:

@table @b
@item log_recid
This is set to a monotonically increasing log record id
maintained by the system for this individual log file.

@item log_size
This is set to the value of the @code{len} argument.

@item log_event_id
This is set to the value of the @code{event_id} argument.

@item log_facility
This is set to the value of the @code{facility} argument.

@item log_severity
This is set to the value of the @code{severity} argument.

@item log_uid
This is set to the value returned by @code{geteuid()}.

@item log_gid
This is set to the value returned by @code{getegid()}.

@item log_pid
This is set to the value returned by @code{getpid()}.

@item log_pgrp
This is set to the value returned by @code{getpgrp()}.

@item log_time
This is set to the value returned by @code{clock_gettime()} for the 
@code{CLOCK_REALTIME clock} source.

@end table

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

This implementation can not return the @code{EPERM} error.

@page
@subsection log_write_any - Write to the any log file

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_write_any(
  const logd_t          logdes,
  const log_facility_t  facility,
  const int             event_id,
  const log_severity_t  severity,
  const void           *buf,
  const size_t          len
);
@end example
@end ifset
 
@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_write_any()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item E2BIG
This error indicates an inconsistency in the implementation.
Report this as a bug.

@item EBADF
The @code{logdes} argument is not a valid log descriptor.

@item EINVAL
The @code{facility} argument is not a valid log facility.

@item EINVAL
The @code{severity} argument exceeds @code{LOG_SEVERITY_MAX}.

@item EINVAL
The @code{len} argument exceeds @code{LOG_MAXIMUM_BUFFER_SIZE}.

@item EINVAL
The @code{len} argument was non-zero and @code{buf} is @code{NULL}.

@item ENOSPC
The device which contains the log file has run out of space.

@item EIO
An I/O error occurred in writing to the log file.

@end table

@subheading DESCRIPTION:

The @code{log_write_any()} function writes an event record to the log file
specified by @code{logdes}.  The event record written consists of the
event attributes specified by the @code{facility}, @code{event_id},
and @code{severity} arguments as well as the data identified by the
@code{buf} and @code{len} arguments.  The fields of the event record
structure to be written are filled in as follows:

@table @b
@item log_recid
This is set to a monotonically increasing log record id
maintained by the system for this individual log file.

@item log_size
This is set to the value of the @code{len} argument.

@item log_event_id
This is set to the value of the @code{event_id} argument.

@item log_facility
This is set to the value of the @code{facility} argument.

@item log_severity
This is set to the value of the @code{severity} argument.

@item log_uid
This is set to the value returned by @code{geteuid()}.

@item log_gid
This is set to the value returned by @code{getegid()}.

@item log_pid
This is set to the value returned by @code{getpid()}.

@item log_pgrp
This is set to the value returned by @code{getpgrp()}.

@item log_time
This is set to the value returned by @code{clock_gettime()} for the 
@code{CLOCK_REALTIME} clock source.

@end table

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

This implementation can not return the @code{EPERM} error.

This function is not defined in the POSIX specification.  It is 
an extension provided by this implementation.

@page
@subsection log_write_entry - Write entry to any log file

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_write_entry(
  const logd_t      logdes,
  struct log_entry *entry,
  const void       *buf,
  const size_t      len
);
@end example
@end ifset
 
@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_write_entry()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item E2BIG
This error indicates an inconsistency in the implementation.
Report this as a bug.

@item EBADF
The @code{logdes} argument is not a valid log descriptor.

@item EFAULT
The @code{entry} argument is not a valid pointer to a log entry.

@item EINVAL
The @code{facility} field in @code{entry} is not a valid log facility.

@item EINVAL
The @code{severity} field in @code{entry} exceeds @code{LOG_SEVERITY_MAX}.

@item EINVAL
The @code{len} argument exceeds @code{LOG_MAXIMUM_BUFFER_SIZE}.

@item EINVAL
The @code{len} argument was non-zero and @code{buf} is NULL.

@item ENOSPC
The device which contains the log file has run out of space.

@item EIO
An I/O error occurred in writing to the log file.

@end table

@subheading DESCRIPTION:

The @code{log_write_entry()} function writes an event record 
specified by the @code{entry}, @code{buf}, and @code{len} arguments.
Most of the fields of the event record pointed to by @code{entry}
are left intact.  The following fields are filled in as follows:

@table @b
@item log_recid
This is set to a monotonically increasing log record id
maintained by the system for this individual log file.

@item log_size
This is set to the value of the @code{len} argument.

@end table

This allows existing log entries from one log file to be written to 
another log file without destroying the logged information.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

This implementation can not return the @code{EPERM} error.

This function is not defined in the POSIX specification.  It is 
an extension provided by this implementation.

@page
@subsection log_open - Open a log file

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_open(
  logd_t               *logdes,
  const char           *path,
  const log_query_t    *query
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_open()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item EACCES
Search permission is denied on a component of the @code{path} prefix,
or the log file exists and read permission is denied.

@item  EINTR
A signal interrupted the call to @code{log_open()}.

@item EINVAL
The log_severity field of the query argument exceeds 
@code{LOG_SEVERITY_MAX}.

@item EINVAL
The @code{path} argument referred to a file that was not a log file.

@item EMFILE
Too many log file descriptors are currently in use by this
process.

@item ENAMETOOLONG
The length of the path string exceeds @code{PATH_MAX}, or a pathname
component is longer than @code{NAME_MAX} while @code{_POSIX_NO_TRUNC} is
in effect.

@item ENFILE
Too many files are currently open in the system.

@item ENOENT
The file specified by the @code{path} argument does not exist.

@item ENOTDIR
A component of the @code{path} prefix is not a directory.

@end table

@subheading DESCRIPTION:

The @code{log_open()} function establishes the connection between a 
log file and a log file descriptor.  It creates an open log file 
descriptor that refers to this query stream on the specified log file
The log file descriptor is used by the other log functions to refer
to that log query stream.  The @code{path} argument points to a
pathname for a log file.  A @code{path} argument of @code{NULL} specifies
the current system log file.  

The @code{query} argument is not @code{NULL}, then it points to a log query
specification that is used to filter the records in the log file on
subsequent @code{log_read()} operations.  This restricts the set of
event records read using the returned log file descriptor to those
which match the query.  A query match occurs for a given record when
that record's facility is a member of the query's facility set and
the record's severity is greater than or equal to the severity specified
in the query.

If the value of the @code{query} argument is @code{NULL}, no query filter
shall be applied.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

POSIX specifies that @code{EINVAL} will be returned if the 
@code{log_facilities} field of the @code{query} argument is not
a valid facility set.  In this implementation, this condition
can never occur.

Many error codes that POSIX specifies to be returned by @code{log_open()}
should actually be detected by @code{open()} and passed back by the
@code{log_open()} implementation.  In this implementation, @code{EACCESS},
@code{EMFILE}, @code{ENAMETOOLONG}, @code{ENFILE}, @code{ENOENT},
and @code{ENOTDIR} are detected in this manner.

@page
@subsection log_read - Read from a log file

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_read(
  const logd_t      logdes,
  struct log_entry *entry,
  void             *log_buf,
  const size_t      log_len,
  const size_t     *log_sizeread
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_read()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item E2BIG
This error indicates an inconsistency in the implementation.
Report this as a bug.

@item EBADF
The @code{logdes} argument is not a valid log file descriptor.

@item EFAULT
The @code{entry} argument is not a valid pointer to a log entry structure.

@item EFAULT
The @code{log_sizeread} argument is not a valid pointer to a size_t.

@item EBUSY
No data available.  There are no unread event records remaining
in this log file.

@item EINTR
A signal interrupted the call to @code{log_read()}.

@item EIO
An I/O error occurred in reading from the event log.

@item EINVAL
The matching event record has data associated with it and
@code{log_buf} was not a valid pointer.

@item EINVAL
The matching event record has data associated with it which is
longer than @code{log_len}.

@end table

@subheading DESCRIPTION:

The @code{log_read()} function reads the @code{log_entry}
structure and up to @code{log_len} bytes of data from the next
event record of the log file associated with the open log file
descriptor @code{logdes}.  The event record read is placed
into the @code{log_entry} structure pointed to by
@code{entry} and any data into the buffer pointed to by @code{log_buf}.
The log record ID of the returned event record is be stored in the 
@code{log_recid} member of the @code{log_entry} structure for the event
record.

If the query attribute of the open log file description associated with
the @code{logdes} is set, the event record read will match that query.

If the @code{log_read()} is successful the call stores the actual length
of the data associated with the event record into the location specified by
@code{log_sizeread}.  This number will be less than or equal to
@code{log_len}.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

When @code{EINVAL} is returned, then no data is returned although the
event record is returned.  This is an extension to the POSIX specification.

The POSIX specification specifically allows @code{log_read()} to write
greater than @code{log_len} bytes into @code{log_buf}.  This is highly
undesirable and this implementation will NOT do this.

@page
@subsection log_notify - Notify Process of writes to the system log.

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_notify(
  const logd_t           logdes,
  const struct sigevent *notification
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_notify()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item EBADF
The logdes argument is not a valid log file descriptor.

@item EINVAL
The notification argument specifies an invalid signal.

@item EINVAL
The process has requested a notify on a log that will not be
written to.

@item ENOSYS
The function @code{log_notify()} is not supported by this implementation.

@end table

@subheading DESCRIPTION:

If the argument @code{notification} is not @code{NULL} this function registers 
the calling process to be notified of event records received by the system 
log, which match the query parameters associated with the open log descriptor
specified by @code{logdes}.  The notification specified by the 
@code{notification} argument shall be sent to the process when an event 
record received by the system log is matched by the query attribute of the 
open log file description associated with the @code{logdes} log file 
descriptor.  If the calling process has already registered a notification
for the @code{logdes} log file descriptor, the new notification shall 
replace the existing notification registration.

If the @code{notification} argument is @code{NULL} and the calling process is 
currently registered to be notified for the @code{logdes} log file
descriptor, the existing registration shall be removed.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

@page
@subsection log_close - Close log descriptor

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_close(
  const logd_t   logdes
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_close()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item EBADF
The logdes argument is not a valid log file descriptor.

@end table

@subheading DESCRIPTION:

The @code{log_close()} function deallocates the open log file descriptor 
indicated by @code{log_des}.

When all log file descriptors associated with an open log file description
have been closed, the open log file description is freed.

If the link count of the log file is zero, when all log file descriptors
have been closed, the space occupied by the log file is freed and the
log file shall no longer be accessible.

If the process has successfully registered a notification request for the 
log file descriptor, the registration is removed. 

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

@page
@subsection log_seek - Reposition log file offset

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_seek(
  const logd_t    logdes,
  log_recid_t     log_recid
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_seek()} returns a value of zero
and an unsuccessful call returns the @code{errno}.

@table @b
@item EBADF
The @code{logdes} argument is not a valid log file descriptor.
@item EINVAL
The @code{log_recid} argument is not a valid record id.

@end table

@subheading DESCRIPTION:

The @code{log_seek()} function sets the log file offset of the open 
log description associated with the @code{logdes} log file descriptor 
to the event record in the log file identified by @code{log_recid}.  
The @code{log_recid} argument is either the record id of a valid event
record or one of the following values, as defined in the header file
@code{<evlog.h>:}

@table @b
@item LOG_SEEK_START
Set log file position to point at the first event
record in the log file.

@item LOG_SEEK_END
Set log file position to point after the last event 
record in the log file.

@end table

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

This implementation can not return EINTR.

This implementation can not return EINVAL to indicate that
the @code{log_recid} argument is not a valid record id.

@page
@subsection log_severity_before - Compare event record severities

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_severity_before(
  log_severity_t  s1,
  log_severity_t  s2
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@table @b
@item 0
The severity of @code{s1} is less than that of @code{s2}.

@item 1
The severity of @code{s1} is greater than or equal that of @code{s2}.

@item EINVAL 
The value of either s1 or s2 exceeds @code{LOG_SEVERITY_MAX}.

@end table

@subheading DESCRIPTION:

The @code{log_severity_before()} function compares the severity order
of the @code{s1} and @code{s2} arguments.  If @code{s1} is of 
severity greater than or equal to that of @code{s2}, then this
function returns 1.  Otherwise, it returns 0.

If either @code{s1} or @code{s2} specify invalid severity values, the
return value of @code{log_severity_before()} is unspecified.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

The POSIX specification of the return value for this function is ambiguous.
If EINVAL is equal to 1 in an implementation, then the application
can not distinguish between greater than and an error condition.

@page
@subsection log_facilityemptyset - Manipulate log facility sets

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_facilityemptyset(
  log_facility_set_t  *set
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_facilityemptyset()} returns a value of zero
and a unsuccessful call returns the @code{errno}.

@table @b
@item EFAULT
The @code{set} argument is an invalid pointer.

@end table

@subheading DESCRIPTION:

The @code{log_facilityemptyset()} function initializes the facility
set pointed to by the argument @code{set}, such that all facilities
are excluded.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

Applications shall call either @code{log_facilityemptyset()} or 
@code{log_facilityfillset()} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object.  If
such an object is not initialized in this way, but is nonetheless 
supplied as an argument to any of the @code{log_facilityaddset()}, 
@code{logfacilitydelset()}, @code{log_facilityismember()} or 
@code{log_open()} functions, the results are undefined.

@page
@subsection log_facilityfillset - Manipulate log facility sets

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_facilityfillset(
  log_facility_set_t  *set
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_facilityfillset()} returns a value of zero
and a unsuccessful call returns the @code{errno}.

@table @b
@item EFAULT
The @code{set} argument is an invalid pointer.

@end table

@subheading DESCRIPTION:

The @code{log_facilityfillset()} function initializes the facility
set pointed to by the argument @code{set}, such that all facilities
are included.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

Applications shall call either @code{log_facilityemptyset()} or 
@code{log_facilityfillset()} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object.  If
such an object is not initialized in this way, but is nonetheless 
supplied as an argument to any of the @code{log_facilityaddset()}, 
@code{logfacilitydelset()}, @code{log_facilityismember()} or 
@code{log_open()} functions, the results are undefined.

@page
@subsection log_facilityaddset - Manipulate log facility sets

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_facilityaddset(
  log_facility_set_t  *set,
  log_facility_t       facilityno
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_facilityaddset()} returns a value of zero
and a unsuccessful call returns the @code{errno}.

@table @b
@item EFAULT
The @code{set} argument is an invalid pointer.

@item EINVAL
The @code{facilityno} argument is not a valid facility.

@end table

@subheading DESCRIPTION:

The @code{log_facilityaddset()} function adds the individual
facility specified by the value of the argument @code{facilityno}
to the facility set pointed to by the argument @code{set}.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

Applications shall call either @code{log_facilityemptyset()} or 
@code{log_facilityfillset()} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object.  If
such an object is not initialized in this way, but is nonetheless 
supplied as an argument to any of the @code{log_facilityaddset()}, 
@code{logfacilitydelset()}, @code{log_facilityismember()} or 
@code{log_open()} functions, the results are undefined.

@page
@subsection log_facilitydelset - Manipulate log facility sets

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_facilitydelset(
  log_facility_set_t  *set,
  log_facility_t       facilityno
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_facilitydelset()} returns a value of zero
and a unsuccessful call returns the @code{errno}.

@table @b
@item EFAULT
The @code{set} argument is an invalid pointer.

@item EINVAL
The @code{facilityno} argument is not a valid facility.

@end table

@subheading DESCRIPTION:

The @code{log_facilitydelset()} function deletes the individual
facility specified by the value of the argument @code{facilityno}
from the facility set pointed to by the argument @code{set}.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

Applications shall call either @code{log_facilityemptyset()} or 
@code{log_facilityfillset()} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object.  If
such an object is not initialized in this way, but is nonetheless 
supplied as an argument to any of the @code{log_facilityaddset()}, 
@code{logfacilitydelset()}, @code{log_facilityismember()} or 
@code{log_open()} functions, the results are undefined.

@page
@subsection log_facilityismember - Manipulate log facility sets

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_facilityismember(
  const log_facility_set_t *set,
  log_facility_t            facilityno,
  const int                *member
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_facilityismember()} returns a value 
of zero and a unsuccessful call returns the @code{errno}.

@table @b
@item EFAULT
The @code{set} or @code{member} argument is an invalid pointer.

@item EINVAL
The @code{facilityno} argument is not a valid facility.

@end table

@subheading DESCRIPTION:

The @code{log_facilityismember()} function tests whether the facility
specified by the value of the argument @code{facilityno} is a member
of the set pointed to by the argument @code{set}.  Upon successful
completion, the @code{log_facilityismember()} function either returns
a value of one to the location specified by @code{member} if the 
specified facility is a member of the specified set or value of
zero to the location specified by @code{member} if the specified
facility is not a member of the specified set.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

Applications shall call either @code{log_facilityemptyset()} or 
@code{log_facilityfillset()} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object.  If
such an object is not initialized in this way, but is nonetheless 
supplied as an argument to any of the @code{log_facilityaddset()}, 
@code{logfacilitydelset()}, @code{log_facilityismember()} or 
@code{log_open()} functions, the results are undefined.

@page
@subsection log_facilityisvalid - Manipulate log facility sets

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_facilityisvalid(
  log_facility_t        facilityno
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A return value of zero indicates that the @code{facilityno} is valid and 
a return value other than zero represents an @code{errno}.

@table @b
@item EFAULT
The @code{set} or @code{member} argument is an invalid pointer.

@item EINVAL
The @code{facilityno} argument is not a valid facility.

@end table

@subheading DESCRIPTION:

The @code{log_facilityisvalid()} function tests whether the facility
specified by the value of the argument @code{facilityno} is a valid
facility number.  Upon successful completion, the 
the @code{log_facilityisvalid()} function either returns a value of
0 if the specified facility is a valid facility or value of EINVAL 
if the specified facility is not a valid facility.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

Applications shall call either @code{log_facilityemptyset()} or 
@code{log_facilityfillset()} at least once for each object of type
@code{log_facilityset_t} prior to any other use of that object.  If
such an object is not initialized in this way, but is nonetheless 
supplied as an argument to any of the @code{log_facilityaddset()}, 
@code{logfacilitydelset()}, @code{log_facilityismember()} or 
@code{log_open()} functions, the results are undefined.

@page
@subsection log_create - Creates a log file

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_create(
  logd_t       *ld,
  const char   *path,
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_create()} returns a value 
of zero and a unsuccessful call returns the @code{errno}.

@table @b

@item EEXIST 
The @code{path} already exists and O_CREAT and O_EXCL were used.

@item EISDIR 
The @code{path} refers to a directory and the access requested involved 
writing.

@item ETXTBSY
The @code{path} refers to an executable image which is currently being  
executed and write access was requested.

@item EFAULT 
The @code{path} points outside your accessible address space.

@item EACCES 
The requested access to the file is not allowed, or one of the 
directories in @code{path} did not allow search (execute) permission.

@item ENAMETOOLONG
The @code{path} was too long.

@item ENOENT 
A directory component in @code{path} does not exist or is a dangling symbolic 
link.

@item ENOTDIR
A component used as a directory in @code{path} is not, in fact, a directory.

@item EMFILE
The process already has the maximum number of files open.

@item ENFILE
The limit on the total number of files open on the system has been reached.

@item ENOMEM
Insufficient kernel memory was available.

@item EROFS
The @code{path} refers to a file on a read-only filesystem and write access
was requested.

@item ELOOP
The @code{path} contains a reference to a circular symbolic link, ie a 
symbolic link whose expansion contains a reference to itself.

@end table

@subheading DESCRIPTION:

This function attempts to create a file associated with the @code{logdes} 
argument in the directory provided by the argument @code{path}.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.

@page
@subsection log_sys_create - Creates a system log file

@subheading CALLING SEQUENCE:

@ifset is-C
@example
#include <evlog.h>

int log_sys_create();
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

A successful call to @code{log_sys_create()} returns a value 
of zero and a unsuccessful call returns the @code{errno}.

@table @b
@item EEXIST
The directory path to the system log already exist.

@end table

@subheading DESCRIPTION:

This function will create a predefined system log directory path and
system log file if they do not already exist.

@subheading NOTES:

The @code{_POSIX_LOGGING} feature flag is defined to indicate
this service is available.