[ SYSTEM ]: Linux srv.persadacompanies.com 4.18.0-553.56.1.el8_10.x86_64 #1 SMP Tue Jun 10 05:00:59 EDT 2025 x86_64
[ SERVER ]: Apache | PHP: 8.4.19
[ USER ]: persadamedika | IP: 45.64.1.108
GEFORCE FILE MANAGER
/
usr
/
include
/
UPLOAD:
NAME
SIZE
QUICK PERMS
ACTIONS
📁 GL
SET
[ DEL ]
📁 X11
SET
[ DEL ]
📁 arpa
SET
[ DEL ]
📁 asm
SET
[ DEL ]
📁 asm-generic
SET
[ DEL ]
📁 bind9
SET
[ DEL ]
📁 bits
SET
[ DEL ]
📁 c++
SET
[ DEL ]
📁 drm
SET
[ DEL ]
📁 e2p
SET
[ DEL ]
📁 et
SET
[ DEL ]
📁 event2
SET
[ DEL ]
📁 ext2fs
SET
[ DEL ]
📁 finclude
SET
[ DEL ]
📁 fontconfig
SET
[ DEL ]
📁 freetype2
SET
[ DEL ]
📁 fstrm
SET
[ DEL ]
📁 gdbm
SET
[ DEL ]
📁 gnu
SET
[ DEL ]
📁 google
SET
[ DEL ]
📁 gssapi
SET
[ DEL ]
📁 gssrpc
SET
[ DEL ]
📁 json-c
SET
[ DEL ]
📁 kadm5
SET
[ DEL ]
📁 krb5
SET
[ DEL ]
📁 libexslt
SET
[ DEL ]
📁 libltdl
SET
[ DEL ]
📁 libpng16
SET
[ DEL ]
📁 libxml2
SET
[ DEL ]
📁 libxslt
SET
[ DEL ]
📁 linux
SET
[ DEL ]
📁 lzma
SET
[ DEL ]
📁 misc
SET
[ DEL ]
📁 mtd
SET
[ DEL ]
📁 mysql
SET
[ DEL ]
📁 ncurses
SET
[ DEL ]
📁 ncursesw
SET
[ DEL ]
📁 net
SET
[ DEL ]
📁 netash
SET
[ DEL ]
📁 netatalk
SET
[ DEL ]
📁 netax25
SET
[ DEL ]
📁 neteconet
SET
[ DEL ]
📁 netinet
SET
[ DEL ]
📁 netipx
SET
[ DEL ]
📁 netiucv
SET
[ DEL ]
📁 netpacket
SET
[ DEL ]
📁 netrom
SET
[ DEL ]
📁 netrose
SET
[ DEL ]
📁 nfs
SET
[ DEL ]
📁 openssl
SET
[ DEL ]
📁 perf
SET
[ DEL ]
📁 protobuf-c
SET
[ DEL ]
📁 protocols
SET
[ DEL ]
📁 python3.12
SET
[ DEL ]
📁 python3.6m
SET
[ DEL ]
📁 rdma
SET
[ DEL ]
📁 rpc
SET
[ DEL ]
📁 scsi
SET
[ DEL ]
📁 security
SET
[ DEL ]
📁 selinux
SET
[ DEL ]
📁 sepol
SET
[ DEL ]
📁 sound
SET
[ DEL ]
📁 sys
SET
[ DEL ]
📁 uuid
SET
[ DEL ]
📁 video
SET
[ DEL ]
📁 webp
SET
[ DEL ]
📁 xcb
SET
[ DEL ]
📁 xen
SET
[ DEL ]
📄 FlexLexer.h
6,893 B
SET
[ EDIT ]
|
[ DEL ]
📄 a.out.h
4,350 B
SET
[ EDIT ]
|
[ DEL ]
📄 aio.h
7,456 B
SET
[ EDIT ]
|
[ DEL ]
📄 aliases.h
2,031 B
SET
[ EDIT ]
|
[ DEL ]
📄 alloca.h
1,203 B
SET
[ EDIT ]
|
[ DEL ]
📄 ar.h
1,730 B
SET
[ EDIT ]
|
[ DEL ]
📄 argp.h
25,414 B
SET
[ EDIT ]
|
[ DEL ]
📄 argz.h
6,050 B
SET
[ EDIT ]
|
[ DEL ]
📄 assert.h
4,561 B
SET
[ EDIT ]
|
[ DEL ]
📄 autosprintf.h
2,383 B
SET
[ EDIT ]
|
[ DEL ]
📄 byteswap.h
1,404 B
SET
[ EDIT ]
|
[ DEL ]
📄 bzlib.h
6,245 B
SET
[ EDIT ]
|
[ DEL ]
📄 com_err.h
2,118 B
SET
[ EDIT ]
|
[ DEL ]
📄 complex.h
7,163 B
SET
[ EDIT ]
|
[ DEL ]
📄 cpio.h
2,267 B
SET
[ EDIT ]
|
[ DEL ]
📄 cpuidle.h
844 B
SET
[ EDIT ]
|
[ DEL ]
📄 crypt.h
9,118 B
SET
[ EDIT ]
|
[ DEL ]
📄 ctype.h
10,963 B
SET
[ EDIT ]
|
[ DEL ]
📄 curses.h
99,625 B
SET
[ EDIT ]
|
[ DEL ]
📄 cursesapp.h
6,775 B
SET
[ EDIT ]
|
[ DEL ]
📄 cursesf.h
27,849 B
SET
[ EDIT ]
|
[ DEL ]
📄 cursesm.h
19,677 B
SET
[ EDIT ]
|
[ DEL ]
📄 cursesp.h
8,601 B
SET
[ EDIT ]
|
[ DEL ]
📄 cursesw.h
49,719 B
SET
[ EDIT ]
|
[ DEL ]
📄 cursslk.h
7,304 B
SET
[ EDIT ]
|
[ DEL ]
📄 dbm.h
1,414 B
SET
[ EDIT ]
|
[ DEL ]
📄 dirent.h
12,484 B
SET
[ EDIT ]
|
[ DEL ]
📄 dlfcn.h
7,238 B
SET
[ EDIT ]
|
[ DEL ]
📄 elf.h
174,828 B
SET
[ EDIT ]
|
[ DEL ]
📄 endian.h
3,189 B
SET
[ EDIT ]
|
[ DEL ]
📄 entities.h
4,930 B
SET
[ EDIT ]
|
[ DEL ]
📄 envz.h
2,866 B
SET
[ EDIT ]
|
[ DEL ]
📄 err.h
2,209 B
SET
[ EDIT ]
|
[ DEL ]
📄 errno.h
1,678 B
SET
[ EDIT ]
|
[ DEL ]
📄 error.h
2,039 B
SET
[ EDIT ]
|
[ DEL ]
📄 eti.h
2,891 B
SET
[ EDIT ]
|
[ DEL ]
📄 etip.h
9,702 B
SET
[ EDIT ]
|
[ DEL ]
📄 evdns.h
2,019 B
SET
[ EDIT ]
|
[ DEL ]
📄 event.h
2,744 B
SET
[ EDIT ]
|
[ DEL ]
📄 evhttp.h
2,035 B
SET
[ EDIT ]
|
[ DEL ]
📄 evrpc.h
2,015 B
SET
[ EDIT ]
|
[ DEL ]
📄 evutil.h
1,782 B
SET
[ EDIT ]
|
[ DEL ]
📄 execinfo.h
1,522 B
SET
[ EDIT ]
|
[ DEL ]
📄 expat.h
44,273 B
SET
[ EDIT ]
|
[ DEL ]
📄 expat_config.h
3,910 B
SET
[ EDIT ]
|
[ DEL ]
📄 expat_external.h
6,029 B
SET
[ EDIT ]
|
[ DEL ]
📄 fcntl.h
10,958 B
SET
[ EDIT ]
|
[ DEL ]
📄 features.h
16,062 B
SET
[ EDIT ]
|
[ DEL ]
📄 fenv.h
5,857 B
SET
[ EDIT ]
|
[ DEL ]
📄 fmtmsg.h
3,239 B
SET
[ EDIT ]
|
[ DEL ]
📄 fnmatch.h
2,295 B
SET
[ EDIT ]
|
[ DEL ]
📄 form.h
18,601 B
SET
[ EDIT ]
|
[ DEL ]
📄 fpu_control.h
3,583 B
SET
[ EDIT ]
|
[ DEL ]
📄 fstab.h
3,111 B
SET
[ EDIT ]
|
[ DEL ]
📄 fstrm.h
13,017 B
SET
[ EDIT ]
|
[ DEL ]
📄 fts.h
8,372 B
SET
[ EDIT ]
|
[ DEL ]
📄 ftw.h
5,251 B
SET
[ EDIT ]
|
[ DEL ]
📄 gconv.h
4,410 B
SET
[ EDIT ]
|
[ DEL ]
📄 gcrypt.h
70,361 B
SET
[ EDIT ]
|
[ DEL ]
📄 gd.h
57,777 B
SET
[ EDIT ]
|
[ DEL ]
📄 gd_color_map.h
478 B
SET
[ EDIT ]
|
[ DEL ]
📄 gd_errors.h
1,503 B
SET
[ EDIT ]
|
[ DEL ]
📄 gd_io.h
3,125 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdbm.h
10,345 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdcache.h
2,898 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdfontg.h
553 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdfontl.h
551 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdfontmb.h
519 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdfonts.h
515 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdfontt.h
546 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdfx.h
497 B
SET
[ EDIT ]
|
[ DEL ]
📄 gdpp.h
52,162 B
SET
[ EDIT ]
|
[ DEL ]
📄 gelf.h
11,406 B
SET
[ EDIT ]
|
[ DEL ]
📄 getopt.h
1,468 B
SET
[ EDIT ]
|
[ DEL ]
📄 gettext-po.h
15,534 B
SET
[ EDIT ]
|
[ DEL ]
📄 glob.h
6,614 B
SET
[ EDIT ]
|
[ DEL ]
📄 gnu-versions.h
2,342 B
SET
[ EDIT ]
|
[ DEL ]
📄 gnumake.h
2,912 B
SET
[ EDIT ]
|
[ DEL ]
📄 gpg-error.h
67,879 B
SET
[ EDIT ]
|
[ DEL ]
📄 gpgrt.h
67,879 B
SET
[ EDIT ]
|
[ DEL ]
📄 grp.h
6,686 B
SET
[ EDIT ]
|
[ DEL ]
📄 gshadow.h
4,528 B
SET
[ EDIT ]
|
[ DEL ]
📄 gssapi.h
181 B
SET
[ EDIT ]
|
[ DEL ]
📄 iconv.h
1,857 B
SET
[ EDIT ]
|
[ DEL ]
📄 idn-free.h
2,472 B
SET
[ EDIT ]
|
[ DEL ]
📄 idn-int.h
20 B
SET
[ EDIT ]
|
[ DEL ]
📄 idna.h
3,564 B
SET
[ EDIT ]
|
[ DEL ]
📄 ieee754.h
4,910 B
SET
[ EDIT ]
|
[ DEL ]
📄 ifaddrs.h
2,840 B
SET
[ EDIT ]
|
[ DEL ]
📄 inttypes.h
11,892 B
SET
[ EDIT ]
|
[ DEL ]
📄 jconfig-64.h
2,225 B
SET
[ EDIT ]
|
[ DEL ]
📄 jconfig.h
246 B
SET
[ EDIT ]
|
[ DEL ]
📄 jerror.h
15,088 B
SET
[ EDIT ]
|
[ DEL ]
📄 jmorecfg.h
15,049 B
SET
[ EDIT ]
|
[ DEL ]
📄 jpegint.h
15,586 B
SET
[ EDIT ]
|
[ DEL ]
📄 jpeglib.h
49,875 B
SET
[ EDIT ]
|
[ DEL ]
📄 kdb.h
69,285 B
SET
[ EDIT ]
|
[ DEL ]
📄 keyutils.h
7,698 B
SET
[ EDIT ]
|
[ DEL ]
📄 krad.h
8,933 B
SET
[ EDIT ]
|
[ DEL ]
📄 krb5.h
402 B
SET
[ EDIT ]
|
[ DEL ]
📄 langinfo.h
17,848 B
SET
[ EDIT ]
|
[ DEL ]
📄 lastlog.h
126 B
SET
[ EDIT ]
|
[ DEL ]
📄 libaio.h
8,937 B
SET
[ EDIT ]
|
[ DEL ]
📄 libelf.h
20,318 B
SET
[ EDIT ]
|
[ DEL ]
📄 libgen.h
1,385 B
SET
[ EDIT ]
|
[ DEL ]
📄 libintl.h
4,579 B
SET
[ EDIT ]
|
[ DEL ]
📄 limits.h
5,412 B
SET
[ EDIT ]
|
[ DEL ]
📄 link.h
7,218 B
SET
[ EDIT ]
|
[ DEL ]
📄 locale.h
7,674 B
SET
[ EDIT ]
|
[ DEL ]
📄 ltdl.h
5,709 B
SET
[ EDIT ]
|
[ DEL ]
📄 lzma.h
9,817 B
SET
[ EDIT ]
|
[ DEL ]
📄 malloc.h
6,102 B
SET
[ EDIT ]
|
[ DEL ]
📄 math.h
53,318 B
SET
[ EDIT ]
|
[ DEL ]
📄 mcheck.h
2,434 B
SET
[ EDIT ]
|
[ DEL ]
📄 memory.h
955 B
SET
[ EDIT ]
|
[ DEL ]
📄 menu.h
12,197 B
SET
[ EDIT ]
|
[ DEL ]
📄 mntent.h
3,358 B
SET
[ EDIT ]
|
[ DEL ]
📄 monetary.h
1,803 B
SET
[ EDIT ]
|
[ DEL ]
📄 mqueue.h
3,759 B
SET
[ EDIT ]
|
[ DEL ]
📄 nc_tparm.h
4,197 B
SET
[ EDIT ]
|
[ DEL ]
📄 ncurses.h
99,625 B
SET
[ EDIT ]
|
[ DEL ]
📄 ncurses_dll.h
4,277 B
SET
[ EDIT ]
|
[ DEL ]
📄 ndbm.h
2,454 B
SET
[ EDIT ]
|
[ DEL ]
📄 netdb.h
28,099 B
SET
[ EDIT ]
|
[ DEL ]
📄 nl_types.h
1,752 B
SET
[ EDIT ]
|
[ DEL ]
📄 nlist.h
1,601 B
SET
[ EDIT ]
|
[ DEL ]
📄 nss.h
1,878 B
SET
[ EDIT ]
|
[ DEL ]
📄 obstack.h
21,306 B
SET
[ EDIT ]
|
[ DEL ]
📄 panel.h
4,123 B
SET
[ EDIT ]
|
[ DEL ]
📄 paths.h
2,977 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcre.h
31,718 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcre2.h
44,802 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcre2posix.h
5,804 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcre_scanner.h
6,600 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcre_stringpiece.h
6,312 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcrecpp.h
26,529 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcrecpparg.h
6,783 B
SET
[ EDIT ]
|
[ DEL ]
📄 pcreposix.h
5,452 B
SET
[ EDIT ]
|
[ DEL ]
📄 png.h
144,149 B
SET
[ EDIT ]
|
[ DEL ]
📄 pngconf.h
22,845 B
SET
[ EDIT ]
|
[ DEL ]
📄 pnglibconf.h
7,567 B
SET
[ EDIT ]
|
[ DEL ]
📄 poll.h
22 B
SET
[ EDIT ]
|
[ DEL ]
📄 pr29.h
2,123 B
SET
[ EDIT ]
|
[ DEL ]
📄 printf.h
6,800 B
SET
[ EDIT ]
|
[ DEL ]
📄 proc_service.h
3,476 B
SET
[ EDIT ]
|
[ DEL ]
📄 profile.h
12,154 B
SET
[ EDIT ]
|
[ DEL ]
📄 pthread.h
41,269 B
SET
[ EDIT ]
|
[ DEL ]
📄 pty.h
1,569 B
SET
[ EDIT ]
|
[ DEL ]
📄 punycode.h
9,384 B
SET
[ EDIT ]
|
[ DEL ]
📄 pwd.h
6,158 B
SET
[ EDIT ]
|
[ DEL ]
📄 re_comp.h
962 B
SET
[ EDIT ]
|
[ DEL ]
📄 regex.h
24,715 B
SET
[ EDIT ]
|
[ DEL ]
📄 regexp.h
1,447 B
SET
[ EDIT ]
|
[ DEL ]
📄 resolv.h
12,153 B
SET
[ EDIT ]
|
[ DEL ]
📄 sched.h
4,732 B
SET
[ EDIT ]
|
[ DEL ]
📄 search.h
5,223 B
SET
[ EDIT ]
|
[ DEL ]
📄 semaphore.h
2,399 B
SET
[ EDIT ]
|
[ DEL ]
📄 setjmp.h
3,669 B
SET
[ EDIT ]
|
[ DEL ]
📄 sgtty.h
1,343 B
SET
[ EDIT ]
|
[ DEL ]
📄 shadow.h
5,471 B
SET
[ EDIT ]
|
[ DEL ]
📄 signal.h
12,243 B
SET
[ EDIT ]
|
[ DEL ]
📄 spawn.h
6,690 B
SET
[ EDIT ]
|
[ DEL ]
📄 stab.h
264 B
SET
[ EDIT ]
|
[ DEL ]
📄 stdc-predef.h
2,289 B
SET
[ EDIT ]
|
[ DEL ]
📄 stdint.h
8,469 B
SET
[ EDIT ]
|
[ DEL ]
📄 stdio.h
30,168 B
SET
[ EDIT ]
|
[ DEL ]
📄 stdio_ext.h
2,799 B
SET
[ EDIT ]
|
[ DEL ]
📄 stdlib.h
35,653 B
SET
[ EDIT ]
|
[ DEL ]
📄 string.h
17,587 B
SET
[ EDIT ]
|
[ DEL ]
📄 stringprep.h
8,227 B
SET
[ EDIT ]
|
[ DEL ]
📄 strings.h
4,752 B
SET
[ EDIT ]
|
[ DEL ]
📄 syscall.h
25 B
SET
[ EDIT ]
|
[ DEL ]
📄 sysexits.h
5,232 B
SET
[ EDIT ]
|
[ DEL ]
📄 syslog.h
24 B
SET
[ EDIT ]
|
[ DEL ]
📄 tar.h
3,785 B
SET
[ EDIT ]
|
[ DEL ]
📄 term.h
41,190 B
SET
[ EDIT ]
|
[ DEL ]
📄 term_entry.h
8,760 B
SET
[ EDIT ]
|
[ DEL ]
📄 termcap.h
3,473 B
SET
[ EDIT ]
|
[ DEL ]
📄 termio.h
214 B
SET
[ EDIT ]
|
[ DEL ]
📄 termios.h
3,598 B
SET
[ EDIT ]
|
[ DEL ]
📄 tgmath.h
31,489 B
SET
[ EDIT ]
|
[ DEL ]
📄 thread_db.h
16,023 B
SET
[ EDIT ]
|
[ DEL ]
📄 threads.h
6,655 B
SET
[ EDIT ]
|
[ DEL ]
📄 tic.h
13,638 B
SET
[ EDIT ]
|
[ DEL ]
📄 tiff.h
35,983 B
SET
[ EDIT ]
|
[ DEL ]
📄 tiffconf-64.h
3,429 B
SET
[ EDIT ]
|
[ DEL ]
📄 tiffconf.h
250 B
SET
[ EDIT ]
|
[ DEL ]
📄 tiffio.h
23,227 B
SET
[ EDIT ]
|
[ DEL ]
📄 tiffio.hxx
1,702 B
SET
[ EDIT ]
|
[ DEL ]
📄 tiffvers.h
410 B
SET
[ EDIT ]
|
[ DEL ]
📄 time.h
10,360 B
SET
[ EDIT ]
|
[ DEL ]
📄 tld.h
4,650 B
SET
[ EDIT ]
|
[ DEL ]
📄 ttyent.h
2,494 B
SET
[ EDIT ]
|
[ DEL ]
📄 uchar.h
2,001 B
SET
[ EDIT ]
|
[ DEL ]
📄 ucontext.h
2,036 B
SET
[ EDIT ]
|
[ DEL ]
📄 ulimit.h
1,583 B
SET
[ EDIT ]
|
[ DEL ]
📄 unctrl.h
3,099 B
SET
[ EDIT ]
|
[ DEL ]
📄 unistd.h
42,738 B
SET
[ EDIT ]
|
[ DEL ]
📄 utime.h
1,501 B
SET
[ EDIT ]
|
[ DEL ]
📄 utmp.h
3,222 B
SET
[ EDIT ]
|
[ DEL ]
📄 utmpx.h
4,099 B
SET
[ EDIT ]
|
[ DEL ]
📄 values.h
1,955 B
SET
[ EDIT ]
|
[ DEL ]
📄 verto-module.h
6,640 B
SET
[ EDIT ]
|
[ DEL ]
📄 verto.h
19,437 B
SET
[ EDIT ]
|
[ DEL ]
📄 wait.h
22 B
SET
[ EDIT ]
|
[ DEL ]
📄 wchar.h
31,111 B
SET
[ EDIT ]
|
[ DEL ]
📄 wctype.h
5,548 B
SET
[ EDIT ]
|
[ DEL ]
📄 wordexp.h
2,501 B
SET
[ EDIT ]
|
[ DEL ]
📄 zbuff.h
11,500 B
SET
[ EDIT ]
|
[ DEL ]
📄 zconf.h
16,262 B
SET
[ EDIT ]
|
[ DEL ]
📄 zdict.h
17,203 B
SET
[ EDIT ]
|
[ DEL ]
📄 zlib.h
96,261 B
SET
[ EDIT ]
|
[ DEL ]
📄 zstd.h
119,972 B
SET
[ EDIT ]
|
[ DEL ]
📄 zstd_errors.h
3,751 B
SET
[ EDIT ]
|
[ DEL ]
DELETE SELECTED
[ CLOSE ]
EDIT: fstrm.h
/* * Copyright (c) 2013-2014 by Farsight Security, Inc. * * Permission is hereby granted, free of charge, to any person obtaining * a copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to * permit persons to whom the Software is furnished to do so, subject to * the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * */ /*! \file * \mainpage Introduction * * This is `fstrm`, a C implementation of the Frame Streams data transport * protocol. * * Frame Streams is a light weight, binary clean protocol that allows for the * transport of arbitrarily encoded data payload sequences with minimal framing * overhead -- just four bytes per data frame. Frame Streams does not specify an * encoding format for data frames and can be used with any data serialization * format that produces byte sequences, such as [Protocol Buffers], [XML], * [JSON], [MessagePack], [YAML], etc. Frame Streams can be used as both a * streaming transport over a reliable byte stream socket (TCP sockets, TLS * connections, `AF_UNIX` sockets, etc.) for data in motion as well as a file * format for data at rest. A "Content Type" header identifies the type of * payload being carried over an individual Frame Stream and allows cooperating * programs to determine how to interpret a given sequence of data payloads. * * `fstrm` is an optimized C implementation of Frame Streams that includes a * fast, lockless circular queue implementation and exposes library interfaces * for setting up a dedicated Frame Streams I/O thread and asynchronously * submitting data frames for transport from worker threads. It was originally * written to facilitate the addition of high speed binary logging to DNS * servers written in C using the [dnstap] log format. * * This is the API documentation for the `fstrm` library. For the project * hosting site, see <https://github.com/farsightsec/fstrm>. * * \authors Farsight Security, Inc. and the `fstrm` authors. * * \copyright 2013-2018. Licensed under the terms of the [MIT] license. * * [Protocol Buffers]: https://developers.google.com/protocol-buffers/ * [XML]: http://www.w3.org/TR/xml11/ * [JSON]: http://www.json.org/ * [MessagePack]: http://msgpack.org/ * [YAML]: http://www.yaml.org/ * [dnstap]: http://dnstap.info/ * [MIT]: https://opensource.org/licenses/MIT * * \page overview Library overview * * \section init Initializing the library * * `fstrm` has no global library state. In most cases, only a single * \ref fstrm_iothr library context object will be needed for the entire process, * which will implicitly create a background I/O serialization thread. This I/O * thread is bound to a particular output writer (for example, an `AF_UNIX` * socket) and is fully buffered -- submitted data frames will be accumulated in * an output buffer and periodically flushed, minimizing the number of system * calls that need to be performed. This frees worker threads from waiting for a * write() to complete. * * `fstrm` abstracts the actual I/O operations needed to read or write a byte * stream. File and socket I/O implementations are included in the library, but * if necessary `fstrm` can be extended to support new types of byte stream * transports. See the \ref fstrm_reader, \ref fstrm_writer, and \ref fstrm_rdwr * interfaces for details. * * The following code example shows the initialization of an `fstrm_iothr` * library context object connected to an \ref fstrm_file writer. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ const char *file_path = "/tmp/output.fs"; struct fstrm_file_options *fopt; struct fstrm_iothr *iothr; struct fstrm_writer *writer; fopt = fstrm_file_options_init(); fstrm_file_options_set_file_path(fopt, file_path); writer = fstrm_file_writer_init(fopt, NULL); if (!writer) { fprintf(stderr, "Error: fstrm_file_writer_init() failed.\n"); exit(EXIT_FAILURE); } iothr = fstrm_iothr_init(NULL, &writer); if (!iothr) { fprintf(stderr, "Error: fstrm_iothr_init() failed.\n"); exit(EXIT_FAILURE); } fstrm_file_options_destroy(&fopt); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * * Since the I/O operations are abstracted through the `fstrm_writer` interface, * the `writer` variable in the above example could instead have been * initialized with a completely different implementation. For example, * \ref fstrm_unix_writer objects can be initialized as follows: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ const char *socket_path = "/tmp/output.sock"; struct fstrm_writer *writer; struct fstrm_unix_writer_options *uwopt; uwopt = fstrm_unix_writer_options_init(); fstrm_unix_writer_options_set_socket_path(uwopt, socket_path); writer = fstrm_unix_writer_init(uwopt, NULL); if (!writer) { fprintf(stderr, "Error: fstrm_unix_writer_init() failed.\n"); exit(EXIT_FAILURE); } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * * \section queue Getting an input queue * * After the `fstrm_iothr` object has been created with fstrm_iothr_init(), an * input queue handle can be obtained with the fstrm_iothr_get_input_queue() * function, which returns an `fstrm_iothr_queue` object. This function is * thread-safe and returns a unique queue each time it is called, up to the * number of queues specified by fstrm_iothr_options_set_num_input_queues(). * `fstrm_iothr_queue` objects belong to their parent `fstrm_iothr` object and * will be destroyed when the parent `fstrm_iothr` object is destroyed. * * The following code example shows a single `fstrm_iothr_queue` handle being * obtained from an already initialized `fstrm_iothr` library context object. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // 'iothr' is a struct fstrm_iothr * struct fstrm_iothr_queue *ioq; ioq = fstrm_iothr_get_input_queue(iothr); if (!ioq) { fprintf(stderr, "Error: fstrm_iothr_get_input_queue() failed.\n"); exit(EXIT_FAILURE); } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * * \section submit Submitting data frames * * Once the `fstrm_iothr` object has been created and an `fstrm_iothr_queue` * handle is available, data frames can be submitted for asynchronous writing * using the fstrm_iothr_submit() function. A callback is passed to this * function which will be invoked to deallocate the data frame once the I/O * thread has completed processing it. In the common case where the data frame * is dynamically allocated with `malloc()`, the deallocation callback must call * `free()`. fstrm_free_wrapper() is provided as a convenience function which * does this and can be specified as the `free_func` parameter to * fstrm_iothr_submit(). * * If space is available in the queue, fstrm_iothr_submit() will return * #fstrm_res_success, indicating that ownership of the memory allocation for the * data frame has passed from the caller to the library. The caller must not * reuse or deallocate the memory for the data frame after a successful call to * fstrm_iothr_submit(). * * Callers must check the return value of fstrm_iothr_submit(). If this function * fails, that is, it returns any result code other than #fstrm_res_success, the * caller must deallocate or otherwise dispose of memory allocated for the data * frame, in order to avoid leaking memory. fstrm_iothr_submit() can fail with * #fstrm_res_again if there is currently no space in the circular queue for an * additional frame, in which case a later call to fstrm_iothr_submit() with the * same parameters may succeed. However, if fstrm_iothr_submit() fails with * #fstrm_res_invalid, then there is a problem with the parameters and a later * call will not succeed. * * The following code example shows data frames containing a short sequence of * bytes being created and submitted repeatedly, with appropriate error * handling. Note that the data frames in this example intentionally contain * embedded unprintable characters, showing that Frame Streams is binary clean. * This example follows from the previous examples, where the `iothr` and `ioq` * variables have already been initialized. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // 'iothr' is a struct fstrm_iothr * // 'ioq' is a struct fstrm_queue * const unsigned num_frames = 100; const uint8_t frame_template[] = { 'H', 'e', 'l', 'l', 'o', 0x00, 0x01, 0x02, 0x03, 'W', 'o', 'r', 'l', 'd', 0x04, 0x05, 0x06, 0x07, }; for (unsigned i = 0; i < num_frames; i++) { // Allocate a new frame from the template. uint8_t *frame = malloc(sizeof(frame_template)); if (!frame) break; memcpy(frame, frame_template, sizeof(frame_template)); // Submit the frame for writing. for (;;) { fstrm_res res; res = fstrm_iothr_submit(iothr, ioq, frame, sizeof(frame_template), fstrm_free_wrapper, NULL); if (res == fstrm_res_success) { // Frame successfully queued. break; } else if (res == fstrm_res_again) { // Queue is full. Try again in a busy loop. // Alternatively, if loss can be tolerated we // could free the frame here and break out of // the loop. continue; } else { // Permanent failure. free(frame); fputs("fstrm_iothr_submit() failed.\n", stderr); break; } } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * * \section shutdown Shutting down * * Calling fstrm_iothr_destroy() on the `fstrm_iothr` object will signal the I/O * thread to flush any outstanding data frames being written and will deallocate * all associated resources. This function is synchronous and does not return * until the I/O thread has terminated. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // 'iothr' is a struct fstrm_iothr * fstrm_iothr_destroy(&iothr); ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */ #ifndef FSTRM_H #define FSTRM_H #ifdef __cplusplus extern "C" { #endif #include <sys/uio.h> #include <stddef.h> #include <stdint.h> /** * \defgroup fstrm_res fstrm_res * * Library result codes. * @{ */ /** * Result codes for functions. */ typedef enum { /** Success. */ fstrm_res_success, /** Failure. */ fstrm_res_failure, /** Resource temporarily unavailable. */ fstrm_res_again, /** Parameters were invalid. */ fstrm_res_invalid, /** The end of a stream has been reached. */ fstrm_res_stop, } fstrm_res; /**@}*/ struct fstrm_control; struct fstrm_file_options; struct fstrm_iothr; struct fstrm_iothr_options; struct fstrm_iothr_queue; struct fstrm_rdwr; struct fstrm_reader_options; struct fstrm_unix_writer_options; struct fstrm_writer; struct fstrm_writer_options; #include <fstrm/control.h> #include <fstrm/file.h> #include <fstrm/iothr.h> #include <fstrm/rdwr.h> #include <fstrm/reader.h> #include <fstrm/tcp_writer.h> #include <fstrm/unix_writer.h> #include <fstrm/writer.h> #ifdef __cplusplus } #endif #endif /* FSTRM_H */