archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-28 14:42:31 +00:00
Code Issues Projects Releases Wiki Activity

Recursively merge mqtt_websockets ()

Browse source 
* initial version

* basic GitHub Actions CI

* Create README.md

* run GitHub Action at least once weekly
to check test pass if distro was updated but project doesn't get
any change for long time

* add test for rbuf_find_bytes

* minor - add .vscode to .gitignore

* minor - add CFLAGS to makefile

* minor - silence unused var warning

* minor - update readme

* add submodules

* initial commit

* add README

* allow setting MQTT LWT

* allow setting LWT QOS

* handle MQTT keep-alives properly

* allow choosing keep alive time

* handle WS_OP_CONNECTION_CLOSE

* allow sending other frames than WS_OP_BINARY_FRAME

* minor readability improvements

* work on graceful disconnect

* reset ws_client state on subsequent connections

* implement mqtt_wss_destroy

* more descriptive RC for mqtt_wss_service

* properly free/destroy SSL

* work on reconnect

* set return code for WS disconnect

* Less logging under normal operation

* readme point to `test.c` as how-to for now

* OpenSSL certificate checking by default

* reset poll_fds on reconnect

* fix older SSL versions

* empty install and dist targets

* fix LGTM warning

* add rbuf_get_capacity

* gh actions test

* ws_ping impl

* test.c - port as cmd line param

* properly handle WebSocket disconnect packet

* initial HTTPS proxy support

* remove base64 submodule, use OpenSSL

* change to urandom

* ws_client_process WS_RAW retval fix

* coverity fixes

* CID 1448838

* CID 1448836

* CID 1448829

* test check for error on init

* make it play nicer with automake projects

* MQTT-C coverity fixes

* Create codeql-analysis.yml

* Make typedef introduce a new name for struct. ()

* add autotools related files to gitignore

* minor - silence -Wmaybe-uninitialized warning

* reinit on MQTT clean session connect

* fix apple endianness functions

* add libcrypto for macos

* MacOS compatibility

* fix FreeBSD build

* use TLS SNI

* propagate buffer full EC to app layer

* store buffer sizes in mqtt_wss_client

* allow auto buffer growth on buffer too small

* quicker connection drop on BUFFER FULL

* always clear last_ec on connect

* parse all HTTP headers

* minor - rename constant for clarity

* rename idx and idx2 for code readability

* limit response header field count

* flush not needed, replace with descriptive err msg

* bump MQTT-C

* Blocking publish and inflight MQTT-C buffer growth

* update obsolete comment

* add missing unlock in error case

* fix EINTR

* initial MQTT 5 implementation

Implements minimal MQTT 5 features. Up to QoS1

* fixes for bugs in initial MQTT5 implementation

* initial statistics support

* fix vbi parser

* initial base http proxy auth support

* fix base64 helper for longer credentials

* minor - create with single allocation

* allow defining custom alloc functions for user

* Allow custom memory fncs and macros by user ()

* update crbuf module
* allow custom malloc, free, strdup, calloc ...

* use long long for till_next_keep_alive

* dont send PUBACK on QOS0 ()

* fix publish parser ()

* mark QoS0 as GC on send ()

* log extra info in case of OpenSSL error ()

* log extra info in case of SSL error

* fix build error with older SSL ()

* adds possibility to decrypt traffic with wireshark for debugging ()

* initial commit

* add fncs key:uint64 and data:opaque ptr

* add uint64_t key iterator

* add github test runner

* start working on proper tests

* Initial support for topic aliases ()

Add support for topic alias functionality for PUBLISH packets
also adds support for parsing all MQTT properties as opposed to just skipping and ignoring them (what we did previously)

* implement c_rhash_iter_str_keys + tests

* Fixes of Topic Alias implementation ()

* initial removal of mqtt-c support ()

* honor max msglen for server ()

* Update README.md ()

* memory align fragments ()

* Remove mqtt_websocket submodule

* Remove c-rbuf and c_rhash submodules

* Exclude mqtt_websockets from Codacy

It seems that it was excluded before merging
the mqtt_websockets submodule.

---------

Co-authored-by: Timotej Šiškovič <timotejs@gmail.com>
Co-authored-by: Timotej S <6674623+underhood@users.noreply.github.com>
Co-authored-by: Emmanuel Vasilakis <mrzammler@mm.st>
This commit is contained in:
vkalintiris 2024-01-11 20:03:13 +02:00 • committed by GitHub
parent 989c856c5b
commit 6e90e9c7e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
49 changed files with 9290 additions and 4 deletions

1
.codacy.yml
View file

@ -22,3 +22,4 @@ exclude_paths:
- build/**
- build_external/**
- packaging/**
- mqtt_websockets/**

3
.gitmodules vendored
View file

@ -1,6 +1,3 @@
[submodule "mqtt_websockets"]
path = mqtt_websockets
url = https://github.com/underhood/mqtt_websockets.git
[submodule "aclk/aclk-schemas"]
path = aclk/aclk-schemas
url = https://github.com/netdata/aclk-schemas.git

1
mqtt_websockets

@ -1 +0,0 @@
Subproject commit 6664789ccf57c95451638364f544d1679efd910e

14
mqtt_websockets/.github/workflows/run-tests.yaml vendored Normal file
View file

@ -0,0 +1,14 @@
name: run-tests
on:
push:
schedule:
- cron: '5 3 * * 0'
pull_request:
jobs:
run-tests:
runs-on: ubuntu-latest
steps:
- name: Install ruby and deps
run: sudo apt-get install ruby ruby-dev mosquitto
- name: Checkout
uses: actions/checkout@v2

10
mqtt_websockets/.gitignore vendored Normal file
View file

@ -0,0 +1,10 @@
build/*
!build/.keep
test
.vscode
mqtt/mqtt.c
mqtt/include/mqtt.h
libmqttwebsockets.*
*.o
.dirstamp
.deps

674
mqtt_websockets/LICENSE Normal file
View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

61
mqtt_websockets/Makefile Normal file
View file

@ -0,0 +1,61 @@
# Copyright (C) 2020 Timotej Šiškovič
# SPDX-License-Identifier: GPL-3.0-only
#
# This program is free software: you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program.
# If not, see <https://www.gnu.org/licenses/>.
CC = gcc -std=gnu99
CFLAGS = -Wextra -Wall `pkg-config --cflags openssl` `pkg-config --cflags libcrypto`
BUILD_DIR = build
INCLUDES = -Isrc/include -Ic-rbuf/include -Ic_rhash/include -Imqtt/include
all: test
$(BUILD_DIR)/c_rhash.o: c_rhash/src/c_rhash.c c_rhash/src/c_rhash_internal.h c_rhash/include/c_rhash.h
$(CC) -o $(BUILD_DIR)/c_rhash.o -c c_rhash/src/c_rhash.c $(CFLAGS) $(INCLUDES)
c-rbuf/build/ringbuffer.o:
cd c-rbuf && $(MAKE) build/ringbuffer.o
$(BUILD_DIR)/ws_client.o: src/ws_client.c src/include/ws_client.h src/include/common_internal.h
$(CC) -o $(BUILD_DIR)/ws_client.o -c src/ws_client.c $(CFLAGS) $(INCLUDES)
$(BUILD_DIR)/test.o: src/test.c src/include/ws_client.h libmqttwebsockets.a
$(CC) -o $(BUILD_DIR)/test.o -c src/test.c $(CFLAGS) $(INCLUDES)
$(BUILD_DIR)/mqtt_wss_log.o: src/mqtt_wss_log.c src/include/mqtt_wss_log.h
$(CC) -o $(BUILD_DIR)/mqtt_wss_log.o -c src/mqtt_wss_log.c $(CFLAGS) $(INCLUDES)
$(BUILD_DIR)/mqtt_wss_client.o: src/mqtt_wss_client.c src/include/mqtt_wss_client.h src/include/ws_client.h src/include/common_internal.h $(BUILD_DIR)/common_public.o
$(CC) -o $(BUILD_DIR)/mqtt_wss_client.o -c src/mqtt_wss_client.c $(CFLAGS) $(INCLUDES)
$(BUILD_DIR)/mqtt_ng.o: src/mqtt_ng.c src/include/mqtt_ng.h src/include/common_internal.h $(BUILD_DIR)/common_public.o
$(CC) -o $(BUILD_DIR)/mqtt_ng.o -c src/mqtt_ng.c $(CFLAGS) $(INCLUDES)
$(BUILD_DIR)/common_public.o: src/common_public.c src/include/common_public.h
$(CC) -o $(BUILD_DIR)/common_public.o -c src/common_public.c $(CFLAGS) $(INCLUDES)
libmqttwebsockets.a: $(BUILD_DIR)/mqtt_wss_client.o $(BUILD_DIR)/ws_client.o c-rbuf/build/ringbuffer.o $(BUILD_DIR)/c_rhash.o $(BUILD_DIR)/mqtt_wss_log.o $(BUILD_DIR)/mqtt_ng.o $(BUILD_DIR)/common_public.o
ar rcs libmqttwebsockets.a $(BUILD_DIR)/mqtt_wss_client.o $(BUILD_DIR)/ws_client.o c-rbuf/build/ringbuffer.o $(BUILD_DIR)/c_rhash.o $(BUILD_DIR)/mqtt_wss_log.o $(BUILD_DIR)/mqtt_ng.o $(BUILD_DIR)/common_public.o
test: $(BUILD_DIR)/test.o libmqttwebsockets.a
$(CC) -o test $(BUILD_DIR)/test.o libmqttwebsockets.a `pkg-config --libs openssl` -lpthread $(CFLAGS)
clean:
rm -f $(BUILD_DIR)/*
cd c-rbuf && $(MAKE) clean
rm -f test libmqttwebsockets.a
install:
dist:
distdir:

12
mqtt_websockets/README.md Normal file
View file

@ -0,0 +1,12 @@
# mqtt_websockets
Library to connect MQTT client over Websockets Secure (WSS).
Documentation is pending. Best way to figure out how to use the library it to look at `src\test.c`.
## License
The Project is released under GPL v3 license. See [License](LICENSE)
Uses following git submodules:
- **c-rbuf**: under LGPL 3 by underhood
- **c_rhash**: GPL 3 by underhood

0
mqtt_websockets/build/.keep Normal file
View file

67
mqtt_websockets/c-rbuf/.github/workflows/codeql-analysis.yml vendored Normal file
View file

@ -0,0 +1,67 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"
on:
push:
branches: [ master ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ master ]
schedule:
- cron: '19 3 * * 1'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
language: [ 'cpp' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
steps:
- name: Checkout repository
uses: actions/checkout@v2
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1
# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language
#- run: |
# make bootstrap
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1

13
mqtt_websockets/c-rbuf/.github/workflows/run-tests.yaml vendored Normal file
View file

@ -0,0 +1,13 @@
name: run-tests
on:
push:
schedule:
- cron: '5 3 * * 0'
pull_request:
jobs:
run-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: make
- run: ./test

8
mqtt_websockets/c-rbuf/.gitignore vendored Normal file
View file

@ -0,0 +1,8 @@
build/*
!build/.keep
libringbuffer.*
test
.vscode
*.o
.deps
.dirstamp

165
mqtt_websockets/c-rbuf/LICENSE Normal file
View file

@ -0,0 +1,165 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

24
mqtt_websockets/c-rbuf/Makefile Normal file
View file

@ -0,0 +1,24 @@
CFLAGS = -Wall -Wextra -std=c99
all: libringbuffer.a libringbuffer.so build/ringbuffer_test.o
gcc -o test build/ringbuffer_test.o libringbuffer.a $(CFLAGS)
libringbuffer.so: build/ringbuffer.o
gcc -shared -o libringbuffer.so build/ringbuffer.o
libringbuffer.a: build/ringbuffer.o
ar rcs libringbuffer.a build/ringbuffer.o
build/ringbuffer.o: src/ringbuffer.c src/ringbuffer_internal.h include/ringbuffer.h
gcc -o build/ringbuffer.o -c src/ringbuffer.c -Iinclude -fPIC $(CFLAGS)
build/ringbuffer_test.o: libringbuffer.a tests/ringbuffer_test.c
gcc -o build/ringbuffer_test.o -c tests/ringbuffer_test.c -Iinclude $(CFLAGS)
clean:
rm -f build/*
rm -f libringbuffer.a
rm -f libringbuffer.so
rm -f test
distclean: clean

20
mqtt_websockets/c-rbuf/README.md Normal file
View file

@ -0,0 +1,20 @@
# c-rbuf [![run-tests](https://github.com/underhood/c-rbuf/workflows/run-tests/badge.svg)](https://github.com/underhood/c-rbuf/actions)
Simple C ringbuffer implementation with API allowing usage without intermediate buffer. Meant to be as simple as possible to use and integrate. You can copy the files into your project, use it as a static lib, or shared lib depending on what is most convenient for you.
Usage without intermediate buffer means when reading from file descriptor/socket you can insert data directly into the ringbuffer:
```C
char *ptr;
size_t bytes;
rbuf_t buff = rbuf_create(12345);
ptr = rbuf_get_linear_insert_range(buff, &ret);
read(fd, ptr, bytes);
```
**Multiple tail support:** Only single tail is supported but multiple tail support might be implemented in the future.
**Thread Safety:** Currently you will have to ensure only a single thread accesses the buffer at a time yourself.
## License
The Project is released under LGPL v3 license. See [License](LICENSE)

0
mqtt_websockets/c-rbuf/build/.keep Normal file
View file

53
mqtt_websockets/c-rbuf/include/ringbuffer.h Normal file
View file

@ -0,0 +1,53 @@
/*
*
* Copyright: SPDX-License-Identifier: LGPL-3.0-only
*
* Author: Timotej Šiškovič <timotejs@gmail.com>
*
*/
#ifndef RINGBUFFER_H
#define RINGBUFFER_H
#include <stddef.h>
typedef struct rbuf_t *rbuf_t;
rbuf_t rbuf_create(size_t size);
void rbuf_free(rbuf_t buffer);
void rbuf_flush(rbuf_t buffer);
/* /param bytes how much bytes can be copied into pointer returned
* /return pointer where data can be copied to or NULL if buffer full
*/
char *rbuf_get_linear_insert_range(rbuf_t buffer, size_t *bytes);
char *rbuf_get_linear_read_range(rbuf_t buffer, size_t *bytes);
int rbuf_bump_head(rbuf_t buffer, size_t bytes);
int rbuf_bump_tail(rbuf_t buffer, size_t bytes);
/* @param buffer related buffer instance
* @returns total capacity of buffer in bytes (not free/used)
*/
size_t rbuf_get_capacity(rbuf_t buffer);
/* @param buffer related buffer instance
* @returns count of bytes stored in the buffer
*/
size_t rbuf_bytes_available(rbuf_t buffer);
/* @param buffer related buffer instance
* @returns count of bytes available/free in the buffer (how many more bytes you can store in this buffer)
*/
size_t rbuf_bytes_free(rbuf_t buffer);
/* writes as many bytes from `data` into the `buffer` as possible
* but maximum `len` bytes
*/
size_t rbuf_push(rbuf_t buffer, const char *data, size_t len);
size_t rbuf_pop(rbuf_t buffer, char *data, size_t len);
char *rbuf_find_bytes(rbuf_t buffer, const char *needle, size_t needle_bytes, int *found_idx);
int rbuf_memcmp_n(rbuf_t buffer, const char *to_cmp, size_t to_cmp_bytes);
#endif

209
mqtt_websockets/c-rbuf/src/ringbuffer.c Normal file
View file

@ -0,0 +1,209 @@
/*
*
* Copyright: SPDX-License-Identifier: LGPL-3.0-only
*
* Author: Timotej Šiškovič <timotejs@gmail.com>
*
*/
#include "ringbuffer.h"
#include "ringbuffer_internal.h"
#include <stdlib.h>
#include <assert.h>
#include <string.h>
#define MIN(a,b) (((a)<(b))?(a):(b))
#define MAX(a,b) (((a)>(b))?(a):(b))
// this allows user to use their own
// custom memory allocation functions
#ifdef RBUF_CUSTOM_MALLOC
#include "ringbuffer_pal.h"
#else
#define crbuf_malloc(...) malloc(__VA_ARGS__)
#define crbuf_free(...) free(__VA_ARGS__)
#endif
rbuf_t rbuf_create(size_t size)
{
rbuf_t buffer = crbuf_malloc(sizeof(struct rbuf_t) + size);
if (!buffer)
return NULL;
memset(buffer, 0, sizeof(struct rbuf_t));
buffer->data = ((char*)buffer) + sizeof(struct rbuf_t);
buffer->head = buffer->data;
buffer->tail = buffer->data;
buffer->size = size;
buffer->end = buffer->data + size;
return buffer;
}
void rbuf_free(rbuf_t buffer)
{
crbuf_free(buffer);
}
void rbuf_flush(rbuf_t buffer)
{
buffer->head = buffer->data;
buffer->tail = buffer->data;
buffer->size_data = 0;
}
char *rbuf_get_linear_insert_range(rbuf_t buffer, size_t *bytes)
{
*bytes = 0;
if (buffer->head == buffer->tail && buffer->size_data)
return NULL;
*bytes = ((buffer->head >= buffer->tail) ? buffer->end : buffer->tail) - buffer->head;
return buffer->head;
}
char *rbuf_get_linear_read_range(rbuf_t buffer, size_t *bytes)
{
*bytes = 0;
if(buffer->head == buffer->tail && !buffer->size_data)
return NULL;
*bytes = ((buffer->tail >= buffer->head) ? buffer->end : buffer->head) - buffer->tail;
return buffer->tail;
}
int rbuf_bump_head(rbuf_t buffer, size_t bytes)
{
size_t free_bytes = rbuf_bytes_free(buffer);
if (bytes > free_bytes)
return 0;
int i = buffer->head - buffer->data;
buffer->head = &buffer->data[(i + bytes) % buffer->size];
buffer->size_data += bytes;
return 1;
}
int rbuf_bump_tail(rbuf_t buffer, size_t bytes)
{
if(!rbuf_bump_tail_noopt(buffer, bytes))
return 0;
// if tail catched up with head
// start writing buffer from beggining
// this is not necessary (rbuf must work well without it)
// but helps to optimize big writes as rbuf_get_linear_insert_range
// will return bigger continuous region
if(buffer->tail == buffer->head) {
assert(buffer->size_data == 0);
rbuf_flush(buffer);
}
return 1;
}
size_t rbuf_get_capacity(rbuf_t buffer)
{
return buffer->size;
}
size_t rbuf_bytes_available(rbuf_t buffer)
{
return buffer->size_data;
}
size_t rbuf_bytes_free(rbuf_t buffer)
{
return buffer->size - buffer->size_data;
}
size_t rbuf_push(rbuf_t buffer, const char *data, size_t len)
{
size_t to_cpy;
char *w_ptr = rbuf_get_linear_insert_range(buffer, &to_cpy);
if(!to_cpy)
return to_cpy;
to_cpy = MIN(to_cpy, len);
memcpy(w_ptr, data, to_cpy);
rbuf_bump_head(buffer, to_cpy);
if(to_cpy < len)
to_cpy += rbuf_push(buffer, &data[to_cpy], len - to_cpy);
return to_cpy;
}
size_t rbuf_pop(rbuf_t buffer, char *data, size_t len)
{
size_t to_cpy;
const char *r_ptr = rbuf_get_linear_read_range(buffer, &to_cpy);
if(!to_cpy)
return to_cpy;
to_cpy = MIN(to_cpy, len);
memcpy(data, r_ptr, to_cpy);
rbuf_bump_tail(buffer, to_cpy);
if(to_cpy < len)
to_cpy += rbuf_pop(buffer, &data[to_cpy], len - to_cpy);
return to_cpy;
}
static inline void rbuf_ptr_inc(rbuf_t buffer, const char **ptr)
{
(*ptr)++;
if(*ptr >= buffer->end)
*ptr = buffer->data;
}
int rbuf_memcmp(rbuf_t buffer, const char *haystack, const char *needle, size_t needle_bytes)
{
const char *end = needle + needle_bytes;
// as head==tail can mean 2 things here
if (haystack == buffer->head && buffer->size_data) {
if (*haystack != *needle)
return (*haystack - *needle);
rbuf_ptr_inc(buffer, &haystack);
needle++;
}
while (haystack != buffer->head && needle != end) {
if (*haystack != *needle)
return (*haystack - *needle);
rbuf_ptr_inc(buffer, &haystack);
needle++;
}
return 0;
}
int rbuf_memcmp_n(rbuf_t buffer, const char *to_cmp, size_t to_cmp_bytes)
{
return rbuf_memcmp(buffer, buffer->tail, to_cmp, to_cmp_bytes);
}
char *rbuf_find_bytes(rbuf_t buffer, const char *needle, size_t needle_bytes, int *found_idx)
{
const char *ptr = buffer->tail;
*found_idx = 0;
if (!rbuf_bytes_available(buffer))
return NULL;
if (buffer->head == buffer->tail && buffer->size_data) {
if(!rbuf_memcmp(buffer, ptr, needle, needle_bytes))
return (char *)ptr;
rbuf_ptr_inc(buffer, &ptr);
(*found_idx)++;
}
while (ptr != buffer->head)
{
if(!rbuf_memcmp(buffer, ptr, needle, needle_bytes))
return (char *)ptr;
rbuf_ptr_inc(buffer, &ptr);
(*found_idx)++;
}
return NULL;
}

43
mqtt_websockets/c-rbuf/src/ringbuffer_internal.h Normal file
View file

@ -0,0 +1,43 @@
/*
*
* Copyright: SPDX-License-Identifier: LGPL-3.0-only
*
* Author: Timotej Šiškovič <timotejs@gmail.com>
*
*/
#ifndef RINGBUFFER_INTERNAL_H
#define RINGBUFFER_INTERNAL_H
struct rbuf_t {
char *data;
// points to next byte where we can write
char *head;
// points to oldest (next to be poped) readable byte
char *tail;
// to avoid calculating data + size
// all the time
char *end;
size_t size;
size_t size_data;
};
/* this exists so that it can be tested by unit tests
* without optimization that resets head and tail to
* beginning if buffer empty
*/
inline static int rbuf_bump_tail_noopt(rbuf_t buffer, size_t bytes)
{
if (bytes > buffer->size_data)
return 0;
int i = buffer->tail - buffer->data;
buffer->tail = &buffer->data[(i + bytes) % buffer->size];
buffer->size_data -= bytes;
return 1;
}
#endif

491
mqtt_websockets/c-rbuf/tests/ringbuffer_test.c Normal file
View file

@ -0,0 +1,491 @@
/*
*
* Copyright: SPDX-License-Identifier: LGPL-3.0-only
*
* Author: Timotej Šiškovič <timotejs@gmail.com>
*
*/
#include "ringbuffer.h"
// to be able to access internals
// never do this from app
#include "../src/ringbuffer_internal.h"
#include <stdio.h>
#include <string.h>
#define KNRM "\x1B[0m"
#define KRED "\x1B[31m"
#define KGRN "\x1B[32m"
#define KYEL "\x1B[33m"
#define KBLU "\x1B[34m"
#define KMAG "\x1B[35m"
#define KCYN "\x1B[36m"
#define KWHT "\x1B[37m"
#define UNUSED(x) (void)(x)
int total_fails = 0;
int total_tests = 0;
int total_checks = 0;
#define CHECK_EQ_RESULT(x, y) \
while (s_len--) \
putchar('.'); \
printf("%s%s " KNRM "\n", (((x) == (y)) ? KGRN : KRED), (((x) == (y)) ? " PASS " : " FAIL ")); \
if ((x) != (y)) \
total_fails++; \
total_checks++;
#define CHECK_EQ_PREFIX(x, y, prefix, subtest_name, ...) \
{ \
int s_len = \
100 - \
printf(("Checking: " KWHT "%s %s%2d " subtest_name " " KNRM), __func__, prefix, subtest_no, ##__VA_ARGS__); \
CHECK_EQ_RESULT(x, y) \
}
#define CHECK_EQ(x, y, subtest_name, ...) \
{ \
int s_len = \
100 - printf(("Checking: " KWHT "%s %2d " subtest_name " " KNRM), __func__, subtest_no, ##__VA_ARGS__); \
CHECK_EQ_RESULT(x, y) \
}
#define TEST_DECL() \
int subtest_no = 0; \
printf(KYEL "TEST SUITE: %s\n" KNRM, __func__); \
total_tests++;
static void test_rbuf_get_linear_insert_range()
{
TEST_DECL();
// check empty buffer behaviour
rbuf_t buff = rbuf_create(5);
char *to_write;
size_t ret;
to_write = rbuf_get_linear_insert_range(buff, &ret);
CHECK_EQ(ret, 5, "empty size");
CHECK_EQ(to_write, buff->head, "empty write ptr");
rbuf_free(buff);
// check full buffer behaviour
subtest_no++;
buff = rbuf_create(5);
ret = rbuf_bump_head(buff, 5);
CHECK_EQ(ret, 1, "ret");
to_write = rbuf_get_linear_insert_range(buff, &ret);
CHECK_EQ(to_write, NULL, "writable NULL");
CHECK_EQ(ret, 0, "writable count = 0");
// check buffer flush
subtest_no++;
rbuf_flush(buff);
CHECK_EQ(rbuf_bytes_free(buff), 5, "size_free");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check behaviour head > tail
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 3);
to_write = rbuf_get_linear_insert_range(buff, &ret);
CHECK_EQ(to_write, buff->head, "write location");
CHECK_EQ(ret, 2, "availible to linear write");
// check behaviour tail > head
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 5);
rbuf_bump_tail(buff, 3);
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data + 3, "tail_ptr");
to_write = rbuf_get_linear_insert_range(buff, &ret);
CHECK_EQ(to_write, buff->head, "write location");
CHECK_EQ(ret, 3, "availible to linear write");
/* // check behaviour tail and head at last element
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 4);
rbuf_bump_tail(buff, 4);
CHECK_EQ(buff->head, buff->end - 1, "head_ptr");
CHECK_EQ(buff->tail, buff->end - 1, "tail_ptr");
to_write = rbuf_get_linear_insert_range(buff, &ret);
CHECK_EQ(to_write, buff->head, "write location");
CHECK_EQ(ret, 1, "availible to linear write");*/
// check behaviour tail and head at last element
// after rbuf_bump_tail optimisation that restarts buffer
// in case tail catches up with head
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 4);
rbuf_bump_tail(buff, 4);
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
to_write = rbuf_get_linear_insert_range(buff, &ret);
CHECK_EQ(to_write, buff->head, "write location");
CHECK_EQ(ret, 5, "availible to linear write");
}
#define _CHECK_EQ(x, y, subtest_name, ...) CHECK_EQ_PREFIX(x, y, prefix, subtest_name, ##__VA_ARGS__)
#define _PREFX "(size = %5zu) "
static void test_rbuf_bump_head_bsize(size_t size)
{
char prefix[16];
snprintf(prefix, 16, _PREFX, size);
int subtest_no = 0;
rbuf_t buff = rbuf_create(size);
_CHECK_EQ(rbuf_bytes_free(buff), size, "size_free");
subtest_no++;
int ret = rbuf_bump_head(buff, size);
_CHECK_EQ(buff->data, buff->head, "loc");
_CHECK_EQ(ret, 1, "ret");
_CHECK_EQ(buff->size_data, buff->size, "size");
_CHECK_EQ(rbuf_bytes_free(buff), 0, "size_free");
subtest_no++;
ret = rbuf_bump_head(buff, 1);
_CHECK_EQ(buff->data, buff->head, "loc no move");
_CHECK_EQ(ret, 0, "ret error");
_CHECK_EQ(buff->size_data, buff->size, "size");
_CHECK_EQ(rbuf_bytes_free(buff), 0, "size_free");
rbuf_free(buff);
subtest_no++;
buff = rbuf_create(size);
ret = rbuf_bump_head(buff, size - 1);
_CHECK_EQ(buff->head, buff->end-1, "loc end");
rbuf_free(buff);
}
#undef _CHECK_EQ
static void test_rbuf_bump_head()
{
TEST_DECL();
UNUSED(subtest_no);
size_t test_sizes[] = { 1, 2, 3, 5, 6, 7, 8, 100, 99999, 0 };
for (int i = 0; test_sizes[i]; i++)
test_rbuf_bump_head_bsize(test_sizes[i]);
}
static void test_rbuf_bump_tail_noopt(int subtest_no)
{
rbuf_t buff = rbuf_create(10);
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
subtest_no++;
int ret = rbuf_bump_head(buff, 5);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_free(buff), 5, "size_free");
CHECK_EQ(rbuf_bytes_available(buff), 5, "size_avail");
CHECK_EQ(buff->head, buff->data + 5, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail_noopt(buff, 2);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 3, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 7, "size_free");
CHECK_EQ(buff->head, buff->data + 5, "head_ptr");
CHECK_EQ(buff->tail, buff->data + 2, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail_noopt(buff, 3);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(buff->head, buff->data + 5, "head_ptr");
CHECK_EQ(buff->tail, buff->data + 5, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail_noopt(buff, 1);
CHECK_EQ(ret, 0, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(buff->head, buff->data + 5, "head_ptr");
CHECK_EQ(buff->tail, buff->data + 5, "tail_ptr");
subtest_no++;
ret = rbuf_bump_head(buff, 7);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 7, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 3, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data + 5, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail_noopt(buff, 5);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 2, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 8, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check tail can't overrun head
subtest_no++;
ret = rbuf_bump_tail_noopt(buff, 3);
CHECK_EQ(ret, 0, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 2, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 8, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check head can't overrun tail
subtest_no++;
ret = rbuf_bump_head(buff, 9);
CHECK_EQ(ret, 0, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 2, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 8, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check head can fill the buffer
subtest_no++;
ret = rbuf_bump_head(buff, 8);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 10, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 0, "size_free");
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check can empty the buffer
subtest_no++;
ret = rbuf_bump_tail_noopt(buff, 10);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
}
static void test_rbuf_bump_tail_opt(int subtest_no)
{
subtest_no++;
rbuf_t buff = rbuf_create(10);
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
subtest_no++;
int ret = rbuf_bump_head(buff, 5);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_free(buff), 5, "size_free");
CHECK_EQ(rbuf_bytes_available(buff), 5, "size_avail");
CHECK_EQ(buff->head, buff->data + 5, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail(buff, 2);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 3, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 7, "size_free");
CHECK_EQ(buff->head, buff->data + 5, "head_ptr");
CHECK_EQ(buff->tail, buff->data + 2, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail(buff, 3);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail_noopt(buff, 1);
CHECK_EQ(ret, 0, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
subtest_no++;
ret = rbuf_bump_head(buff, 6);
ret = rbuf_bump_tail(buff, 5);
ret = rbuf_bump_head(buff, 6);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 7, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 3, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data + 5, "tail_ptr");
subtest_no++;
ret = rbuf_bump_tail(buff, 5);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 2, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 8, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check tail can't overrun head
subtest_no++;
ret = rbuf_bump_tail(buff, 3);
CHECK_EQ(ret, 0, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 2, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 8, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check head can't overrun tail
subtest_no++;
ret = rbuf_bump_head(buff, 9);
CHECK_EQ(ret, 0, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 2, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 8, "size_free");
CHECK_EQ(buff->head, buff->data + 2, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check head can fill the buffer
subtest_no++;
ret = rbuf_bump_head(buff, 8);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 10, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 0, "size_free");
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
// check can empty the buffer
subtest_no++;
ret = rbuf_bump_tail(buff, 10);
CHECK_EQ(ret, 1, "ret");
CHECK_EQ(rbuf_bytes_available(buff), 0, "size_avail");
CHECK_EQ(rbuf_bytes_free(buff), 10, "size_free");
CHECK_EQ(buff->head, buff->data, "head_ptr");
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
}
static void test_rbuf_bump_tail()
{
TEST_DECL();
test_rbuf_bump_tail_noopt(subtest_no);
test_rbuf_bump_tail_opt(subtest_no);
}
#define ASCII_A 0x61
#define ASCII_Z 0x7A
#define TEST_DATA_SIZE ASCII_Z-ASCII_A+1
static void test_rbuf_push()
{
TEST_DECL();
rbuf_t buff = rbuf_create(10);
int i;
char test_data[TEST_DATA_SIZE];
for (int i = 0; i <= TEST_DATA_SIZE; i++)
test_data[i] = i + ASCII_A;
int ret = rbuf_push(buff, test_data, 10);
CHECK_EQ(ret, 10, "written 10 bytes");
CHECK_EQ(rbuf_bytes_free(buff), 0, "empty size == 0");
for (i = 0; i < 10; i++)
CHECK_EQ(buff->data[i], i + ASCII_A, "Check data");
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 5);
rbuf_bump_tail_noopt(buff, 5); //to not reset both pointers to beginning
ret = rbuf_push(buff, test_data, 10);
CHECK_EQ(ret, 10, "written 10 bytes");
for (i = 0; i < 10; i++)
CHECK_EQ(buff->data[i], ((i+5)%10) + ASCII_A, "Check Data");
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 9);
rbuf_bump_tail_noopt(buff, 9);
ret = rbuf_push(buff, test_data, 10);
CHECK_EQ(ret, 10, "written 10 bytes");
for (i = 0; i < 10; i++)
CHECK_EQ(buff->data[i], ((i + 1) % 10) + ASCII_A, "Check data");
// let tail > head
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 9);
rbuf_bump_tail_noopt(buff, 9);
rbuf_bump_head(buff, 1);
ret = rbuf_push(buff, test_data, 9);
CHECK_EQ(ret, 9, "written 9 bytes");
CHECK_EQ(buff->head, buff->end - 1, "head_ptr");
CHECK_EQ(buff->tail, buff->head, "tail_ptr");
rbuf_bump_tail(buff, 1);
//TODO push byte can be usefull optimisation
ret = rbuf_push(buff, &test_data[9], 1);
CHECK_EQ(ret, 1, "written 1 byte");
CHECK_EQ(rbuf_bytes_free(buff), 0, "empty size == 0");
for (i = 0; i < 10; i++)
CHECK_EQ(buff->data[i], i + ASCII_A, "Check data");
subtest_no++;
rbuf_flush(buff);
rbuf_bump_head(buff, 9);
rbuf_bump_tail_noopt(buff, 7);
rbuf_bump_head(buff, 1);
ret = rbuf_push(buff, test_data, 7);
CHECK_EQ(ret, 7, "written 7 bytes");
CHECK_EQ(buff->head, buff->data + 7, "head_ptr");
CHECK_EQ(buff->tail, buff->head, "tail_ptr");
rbuf_bump_tail(buff, 3);
CHECK_EQ(buff->tail, buff->data, "tail_ptr");
//TODO push byte can be usefull optimisation
ret = rbuf_push(buff, &test_data[7], 3);
CHECK_EQ(ret, 3, "written 3 bytes");
CHECK_EQ(rbuf_bytes_free(buff), 0, "empty size == 0");
for (i = 0; i < 10; i++)
CHECK_EQ(buff->data[i], i + ASCII_A, "Check data");
// test can't overfill the buffer
subtest_no++;
rbuf_flush(buff);
rbuf_push(buff, test_data, TEST_DATA_SIZE);
CHECK_EQ(ret, 3, "written 10 bytes");
for (i = 0; i < 10; i++)
CHECK_EQ(buff->data[i], i + ASCII_A, "Check data");
}
#define TEST_RBUF_FIND_BYTES_SIZE 10
void test_rbuf_find_bytes()
{
TEST_DECL();
rbuf_t buff = rbuf_create(TEST_RBUF_FIND_BYTES_SIZE);
char *filler_3 = " ";
char *needle = "needle";
int idx;
char *ptr;
// make sure needle is wrapped aroung in the buffer
// to test we still can find it
// target "edle ne"
rbuf_bump_head(buff, TEST_RBUF_FIND_BYTES_SIZE / 2);
rbuf_push(buff, filler_3, strlen(filler_3));
rbuf_bump_tail(buff, TEST_RBUF_FIND_BYTES_SIZE / 2);
rbuf_push(buff, needle, strlen(needle));
ptr = rbuf_find_bytes(buff, needle, strlen(needle), &idx);
CHECK_EQ(ptr, buff->data + (TEST_RBUF_FIND_BYTES_SIZE / 2) + strlen(filler_3), "Pointer to needle correct");
CHECK_EQ(idx, ptr - buff->tail, "Check needle index");
}
int main()
{
test_rbuf_bump_head();
test_rbuf_bump_tail();
test_rbuf_get_linear_insert_range();
test_rbuf_push();
test_rbuf_find_bytes();
printf(
KNRM "Total Tests %d, Total Checks %d, Successful Checks %d, Failed Checks %d\n",
total_tests, total_checks, total_checks - total_fails, total_fails);
if (total_fails)
printf(KRED "!!!Some test(s) Failed!!!\n");
else
printf(KGRN "ALL TESTS PASSED\n");
return total_fails;
}

16
mqtt_websockets/c_rhash/.github/workflows/run-tests.yaml vendored Normal file
View file

@ -0,0 +1,16 @@
name: run-tests
on:
push:
schedule:
- cron: '5 3 * * 0'
pull_request:
jobs:
run-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: sudo apt-get install -y valgrind
- run: autoreconf -ivf
- run: ./configure
- run: make
- run: valgrind --leak-check=full --error-exitcode=66 ./test

58
mqtt_websockets/c_rhash/.gitignore vendored Normal file
View file

@ -0,0 +1,58 @@
# http://www.gnu.org/software/automake
Makefile.in
/ar-lib
/mdate-sh
/py-compile
/test-driver
/ylwrap
.deps/
.dirstamp
# http://www.gnu.org/software/autoconf
autom4te.cache
/autoscan.log
/autoscan-*.log
/aclocal.m4
/compile
/config.cache
/config.guess
/config.h.in
/config.log
/config.status
/config.sub
/configure
/configure.scan
/depcomp
/install-sh
/missing
/stamp-h1
# https://www.gnu.org/software/libtool/
/ltmain.sh
# http://www.gnu.org/software/texinfo
/texinfo.tex
# http://www.gnu.org/software/m4/
m4/libtool.m4
m4/ltoptions.m4
m4/ltsugar.m4
m4/ltversion.m4
m4/lt~obsolete.m4
# Generated Makefile
# (meta build system like autotools,
# can automatically generate from config.status script
# (which is called by configure script))
Makefile
test
*.o
.vscode
libcrhash.a
config.h

0
mqtt_websockets/c_rhash/AUTHORS Normal file
View file

674
mqtt_websockets/c_rhash/COPYING Normal file
View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

0
mqtt_websockets/c_rhash/ChangeLog Normal file
View file

368
mqtt_websockets/c_rhash/INSTALL Normal file
View file

@ -0,0 +1,368 @@
Installation Instructions
*************************
Copyright (C) 1994-1996, 1999-2002, 2004-2017, 2020-2021 Free
Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved. This file is offered as-is,
without warranty of any kind.
Basic Installation
==================
Briefly, the shell command './configure && make && make install'
should configure, build, and install this package. The following
more-detailed instructions are generic; see the 'README' file for
instructions specific to this package. Some packages provide this
'INSTALL' file but do not implement all of the features documented
below. The lack of an optional feature in a given package is not
necessarily a bug. More recommendations for GNU packages can be found
in *note Makefile Conventions: (standards)Makefile Conventions.
The 'configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a 'Makefile' in each directory of the package.
It may also create one or more '.h' files containing system-dependent
definitions. Finally, it creates a shell script 'config.status' that
you can run in the future to recreate the current configuration, and a
file 'config.log' containing compiler output (useful mainly for
debugging 'configure').
It can also use an optional file (typically called 'config.cache' and
enabled with '--cache-file=config.cache' or simply '-C') that saves the
results of its tests to speed up reconfiguring. Caching is disabled by
default to prevent problems with accidental use of stale cache files.
If you need to do unusual things to compile the package, please try
to figure out how 'configure' could check whether to do them, and mail
diffs or instructions to the address given in the 'README' so they can
be considered for the next release. If you are using the cache, and at
some point 'config.cache' contains results you don't want to keep, you
may remove or edit it.
The file 'configure.ac' (or 'configure.in') is used to create
'configure' by a program called 'autoconf'. You need 'configure.ac' if
you want to change it or regenerate 'configure' using a newer version of
'autoconf'.
The simplest way to compile this package is:
1. 'cd' to the directory containing the package's source code and type
'./configure' to configure the package for your system.
Running 'configure' might take a while. While running, it prints
some messages telling which features it is checking for.
2. Type 'make' to compile the package.
3. Optionally, type 'make check' to run any self-tests that come with
the package, generally using the just-built uninstalled binaries.
4. Type 'make install' to install the programs and any data files and
documentation. When installing into a prefix owned by root, it is
recommended that the package be configured and built as a regular
user, and only the 'make install' phase executed with root
privileges.
5. Optionally, type 'make installcheck' to repeat any self-tests, but
this time using the binaries in their final installed location.
This target does not install anything. Running this target as a
regular user, particularly if the prior 'make install' required
root privileges, verifies that the installation completed
correctly.
6. You can remove the program binaries and object files from the
source code directory by typing 'make clean'. To also remove the
files that 'configure' created (so you can compile the package for
a different kind of computer), type 'make distclean'. There is
also a 'make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
7. Often, you can also type 'make uninstall' to remove the installed
files again. In practice, not all packages have tested that
uninstallation works correctly, even though it is required by the
GNU Coding Standards.
8. Some packages, particularly those that use Automake, provide 'make
distcheck', which can by used by developers to test that all other
targets like 'make install' and 'make uninstall' work correctly.
This target is generally not run by end users.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the 'configure' script does not know about. Run './configure --help'
for details on some of the pertinent environment variables.
You can give 'configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here is
an example:
./configure CC=c99 CFLAGS=-g LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU 'make'. 'cd' to the
directory where you want the object files and executables to go and run
the 'configure' script. 'configure' automatically checks for the source
code in the directory that 'configure' is in and in '..'. This is known
as a "VPATH" build.
With a non-GNU 'make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use 'make distclean' before
reconfiguring for another architecture.
On MacOS X 10.5 and later systems, you can create libraries and
executables that work on multiple system types--known as "fat" or
"universal" binaries--by specifying multiple '-arch' options to the
compiler but only a single '-arch' option to the preprocessor. Like
this:
./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
CPP="gcc -E" CXXCPP="g++ -E"
This is not guaranteed to produce working output in all cases, you
may have to build one architecture at a time and combine the results
using the 'lipo' tool if you have problems.
Installation Names
==================
By default, 'make install' installs the package's commands under
'/usr/local/bin', include files under '/usr/local/include', etc. You
can specify an installation prefix other than '/usr/local' by giving
'configure' the option '--prefix=PREFIX', where PREFIX must be an
absolute file name.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option '--exec-prefix=PREFIX' to 'configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like '--bindir=DIR' to specify different values for particular
kinds of files. Run 'configure --help' for a list of the directories
you can set and what kinds of files go in them. In general, the default
for these options is expressed in terms of '${prefix}', so that
specifying just '--prefix' will affect all of the other directory
specifications that were not explicitly provided.
The most portable way to affect installation locations is to pass the
correct locations to 'configure'; however, many packages provide one or
both of the following shortcuts of passing variable assignments to the
'make install' command line to change installation locations without
having to reconfigure or recompile.
The first method involves providing an override variable for each
affected directory. For example, 'make install
prefix=/alternate/directory' will choose an alternate location for all
directory configuration variables that were expressed in terms of
'${prefix}'. Any directories that were specified during 'configure',
but not in terms of '${prefix}', must each be overridden at install time
for the entire installation to be relocated. The approach of makefile
variable overrides for each directory variable is required by the GNU
Coding Standards, and ideally causes no recompilation. However, some
platforms have known limitations with the semantics of shared libraries
that end up requiring recompilation when using this method, particularly
noticeable in packages that use GNU Libtool.
The second method involves providing the 'DESTDIR' variable. For
example, 'make install DESTDIR=/alternate/directory' will prepend
'/alternate/directory' before all installation names. The approach of
'DESTDIR' overrides is not required by the GNU Coding Standards, and
does not work on platforms that have drive letters. On the other hand,
it does better at avoiding recompilation issues, and works well even
when some directory options were not specified in terms of '${prefix}'
at 'configure' time.
Optional Features
=================
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving 'configure' the
option '--program-prefix=PREFIX' or '--program-suffix=SUFFIX'.
Some packages pay attention to '--enable-FEATURE' options to
'configure', where FEATURE indicates an optional part of the package.
They may also pay attention to '--with-PACKAGE' options, where PACKAGE
is something like 'gnu-as' or 'x' (for the X Window System). The
'README' should mention any '--enable-' and '--with-' options that the
package recognizes.
For packages that use the X Window System, 'configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the 'configure' options '--x-includes=DIR' and
'--x-libraries=DIR' to specify their locations.
Some packages offer the ability to configure how verbose the
execution of 'make' will be. For these packages, running './configure
--enable-silent-rules' sets the default to minimal output, which can be
overridden with 'make V=1'; while running './configure
--disable-silent-rules' sets the default to verbose, which can be
overridden with 'make V=0'.
Particular systems
==================
On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC
is not installed, it is recommended to use the following options in
order to use an ANSI C compiler:
./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
HP-UX 'make' updates targets which have the same timestamps as their
prerequisites, which makes it generally unusable when shipped generated
files such as 'configure' are involved. Use GNU 'make' instead.
On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
parse its '<wchar.h>' header file. The option '-nodtk' can be used as a
workaround. If GNU CC is not installed, it is therefore recommended to
try
./configure CC="cc"
and if that doesn't work, try
./configure CC="cc -nodtk"
On Solaris, don't put '/usr/ucb' early in your 'PATH'. This
directory contains several dysfunctional programs; working variants of
these programs are available in '/usr/bin'. So, if you need '/usr/ucb'
in your 'PATH', put it _after_ '/usr/bin'.
On Haiku, software installed for all users goes in '/boot/common',
not '/usr/local'. It is recommended to use the following options:
./configure --prefix=/boot/common
Specifying the System Type
==========================
There may be some features 'configure' cannot figure out
automatically, but needs to determine by the type of machine the package
will run on. Usually, assuming the package is built to be run on the
_same_ architectures, 'configure' can figure that out, but if it prints
a message saying it cannot guess the machine type, give it the
'--build=TYPE' option. TYPE can either be a short name for the system
type, such as 'sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS
KERNEL-OS
See the file 'config.sub' for the possible values of each field. If
'config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option '--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with '--host=TYPE'.
Sharing Defaults
================
If you want to set default values for 'configure' scripts to share,
you can create a site shell script called 'config.site' that gives
default values for variables like 'CC', 'cache_file', and 'prefix'.
'configure' looks for 'PREFIX/share/config.site' if it exists, then
'PREFIX/etc/config.site' if it exists. Or, you can set the
'CONFIG_SITE' environment variable to the location of the site script.
A warning: not all 'configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to 'configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the 'configure' command line, using 'VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified 'gcc' to be used as the C compiler (unless it is
overridden in the site shell script).
Unfortunately, this technique does not work for 'CONFIG_SHELL' due to an
Autoconf limitation. Until the limitation is lifted, you can use this
workaround:
CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash
'configure' Invocation
======================
'configure' recognizes the following options to control how it
operates.
'--help'
'-h'
Print a summary of all of the options to 'configure', and exit.
'--help=short'
'--help=recursive'
Print a summary of the options unique to this package's
'configure', and exit. The 'short' variant lists options used only
in the top level, while the 'recursive' variant lists options also
present in any nested packages.
'--version'
'-V'
Print the version of Autoconf used to generate the 'configure'
script, and exit.
'--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally 'config.cache'. FILE defaults to '/dev/null' to
disable caching.
'--config-cache'
'-C'
Alias for '--cache-file=config.cache'.
'--quiet'
'--silent'
'-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to '/dev/null' (any error
messages will still be shown).
'--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
'configure' can determine that directory automatically.
'--prefix=DIR'
Use DIR as the installation prefix. *note Installation Names:: for
more details, including other options available for fine-tuning the
installation locations.
'--no-create'
'-n'
Run the configure checks, but stop before creating any output
files.
'configure' also accepts some other, not widely useful, options. Run
'configure --help' for more details.

674
mqtt_websockets/c_rhash/LICENSE Normal file
View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

21
mqtt_websockets/c_rhash/Makefile.am Normal file
View file

@ -0,0 +1,21 @@
crhash_includedir = -I$(abs_top_srcdir)/include
dist_doc_DATA = LICENSE \
README.md \
$(NULL)
CRHASH_FILES = src/c_rhash.c \
src/c_rhash.h \
$(NULL)
lib_LIBRARIES = libcrhash.a
libcrhash_a_SOURCES = $(CRHASH_FILES)
libcrhash_a_CFLAGS = $(crhash_includedir)
bin_PROGRAMS = test
test_LDADD = libcrhash.a
test_SOURCES = src/tests.c
test_CFLAGS = $(crhash_includedir)

0
mqtt_websockets/c_rhash/NEWS Normal file
View file

0
mqtt_websockets/c_rhash/README.md Normal file
View file

8
mqtt_websockets/c_rhash/configure.ac Normal file
View file

@ -0,0 +1,8 @@
AC_INIT([c_rbuf], [0.1])
AM_INIT_AUTOMAKE([subdir-objects])
AC_PROG_CC
AC_PROG_RANLIB
AC_CONFIG_FILES([Makefile])
AC_OUTPUT

59
mqtt_websockets/c_rhash/include/c_rhash.h Normal file
View file

@ -0,0 +1,59 @@
#include <sys/types.h>
#include <stdint.h>
#include <stddef.h>
#ifndef DEFAULT_BIN_COUNT
#define DEFAULT_BIN_COUNT 1000
#endif
#define ITEMTYPE_UNSET (0x0)
#define ITEMTYPE_STRING (0x1)
#define ITEMTYPE_UINT8 (0x2)
#define ITEMTYPE_UINT64 (0x3)
#define ITEMTYPE_OPAQUE_PTR (0x4)
typedef struct c_rhash_s *c_rhash;
c_rhash c_rhash_new(size_t bin_count);
void c_rhash_destroy(c_rhash hash);
// # Insert
// ## Insert where key is string
int c_rhash_insert_str_ptr(c_rhash hash, const char *key, void *value);
int c_rhash_insert_str_uint8(c_rhash hash, const char *key, uint8_t value);
// ## Insert where key is uint64
int c_rhash_insert_uint64_ptr(c_rhash hash, uint64_t key, void *value);
// # Get
// ## Get where key is string
int c_rhash_get_ptr_by_str(c_rhash hash, const char *key, void **ret_val);
int c_rhash_get_uint8_by_str(c_rhash hash, const char *key, uint8_t *ret_val);
// ## Get where key is uint64
int c_rhash_get_ptr_by_uint64(c_rhash hash, uint64_t key, void **ret_val);
typedef struct {
size_t bin;
struct bin_item *item;
int initialized;
} c_rhash_iter_t;
#define C_RHASH_ITER_T_INITIALIZER { .bin = 0, .item = NULL, .initialized = 0 }
#define c_rhash_iter_t_initialize(p_iter) memset(p_iter, 0, sizeof(c_rhash_iter_t))
/*
* goes trough whole hash map and returns every
* type uint64 key present/stored
*
* it is not necessary to finish iterating and iterator can be reinitialized
* there are no guarantees on the order in which the keys will come
* behavior here is implementation dependent and can change any time
*
* returns:
* 0 for every key and stores the key in *key
* 1 on error or when all keys of this type has been already iterated over
*/
int c_rhash_iter_uint64_keys(c_rhash hash, c_rhash_iter_t *iter, uint64_t *key);
int c_rhash_iter_str_keys(c_rhash hash, c_rhash_iter_t *iter, const char **key);

262
mqtt_websockets/c_rhash/src/c_rhash.c Normal file
View file

@ -0,0 +1,262 @@
#include "c_rhash_internal.h"
#include <stdlib.h>
#include <string.h>
#ifdef DEBUG_VERBOSE
#include <stdio.h>
#endif
#define c_rmalloc(...) malloc(__VA_ARGS__)
#define c_rcalloc(...) calloc(__VA_ARGS__)
#define c_rfree(...) free(__VA_ARGS__)
static inline uint32_t simple_hash(const char *name) {
unsigned char *s = (unsigned char *) name;
uint32_t hval = 0x811c9dc5;
while (*s) {
hval *= 16777619;
hval ^= (uint32_t) *s++;
}
return hval;
}
c_rhash c_rhash_new(size_t bin_count) {
if (!bin_count)
bin_count = 1000;
c_rhash hash = c_rcalloc(1, sizeof(struct c_rhash_s) + (bin_count * sizeof(struct bin_ll*)) );
if (hash == NULL)
return NULL;
hash->bin_count = bin_count;
hash->bins = (c_rhash_bin *)((char*)hash + sizeof(struct c_rhash_s));
return hash;
}
static size_t get_itemtype_len(uint8_t item_type, const void* item_data) {
switch (item_type) {
case ITEMTYPE_STRING:
return strlen(item_data) + 1;
case ITEMTYPE_UINT64:
return sizeof(uint64_t);
case ITEMTYPE_UINT8:
return 1;
case ITEMTYPE_OPAQUE_PTR:
return sizeof(void*);
default:
return 0;
}
}
static int compare_bin_item(struct bin_item *item, uint8_t key_type, const void *key) {
if (item->key_type != key_type)
return 1;
size_t key_value_len = get_itemtype_len(key_type, key);
if(key_type == ITEMTYPE_STRING) {
size_t new_key_value_len = get_itemtype_len(item->key_type, item->key);
if (new_key_value_len != key_value_len)
return 1;
}
if(memcmp(item->key, key, key_value_len) == 0) {
return 0;
}
return 1;
}
static int insert_into_bin(c_rhash_bin *bin, uint8_t key_type, const void *key, uint8_t value_type, const void *value) {
struct bin_item *prev = NULL;
while (*bin != NULL) {
if (!compare_bin_item(*bin, key_type, key)) {
#ifdef DEBUG_VERBOSE
printf("Key already present! Updating value!\n");
#endif
// TODO: optimize here if the new value is of different kind compared to the old one
// in case it is not crazily bigger we can reuse the memory and avoid malloc and free
c_rfree((*bin)->value);
(*bin)->value_type = value_type;
(*bin)->value = c_rmalloc(get_itemtype_len(value_type, value));
if ((*bin)->value == NULL)
return 1;
memcpy((*bin)->value, value, get_itemtype_len(value_type, value));
return 0;
}
prev = *bin;
bin = &(*bin)->next;
}
if (*bin == NULL)
*bin = c_rcalloc(1, sizeof(struct bin_item));
if (prev != NULL)
prev->next = *bin;
(*bin)->key_type = key_type;
size_t len = get_itemtype_len(key_type, key);
(*bin)->key = c_rmalloc(len);
memcpy((*bin)->key, key, len);
(*bin)->value_type = value_type;
len = get_itemtype_len(value_type, value);
(*bin)->value = c_rmalloc(len);
memcpy((*bin)->value, value, len);
return 0;
}
static inline uint32_t get_bin_idx_str(c_rhash hash, const char *key) {
uint32_t nhash = simple_hash(key);
return nhash % hash->bin_count;
}
static inline c_rhash_bin *get_binptr_by_str(c_rhash hash, const char *key) {
return &hash->bins[get_bin_idx_str(hash, key)];
}
int c_rhash_insert_str_ptr(c_rhash hash, const char *key, void *value) {
c_rhash_bin *bin = get_binptr_by_str(hash, key);
#ifdef DEBUG_VERBOSE
if (bin != NULL)
printf("COLLISION. There will be more than one item in bin idx=%d\n", nhash);
#endif
return insert_into_bin(bin, ITEMTYPE_STRING, key, ITEMTYPE_OPAQUE_PTR, &value);
}
int c_rhash_insert_str_uint8(c_rhash hash, const char *key, uint8_t value) {
c_rhash_bin *bin = get_binptr_by_str(hash, key);
#ifdef DEBUG_VERBOSE
if (bin != NULL)
printf("COLLISION. There will be more than one item in bin idx=%d\n", nhash);
#endif
return insert_into_bin(bin, ITEMTYPE_STRING, key, ITEMTYPE_UINT8, &value);
}
int c_rhash_insert_uint64_ptr(c_rhash hash, uint64_t key, void *value) {
c_rhash_bin *bin = &hash->bins[key % hash->bin_count];
#ifdef DEBUG_VERBOSE
if (bin != NULL)
printf("COLLISION. There will be more than one item in bin idx=%d\n", nhash);
#endif
return insert_into_bin(bin, ITEMTYPE_UINT64, &key, ITEMTYPE_OPAQUE_PTR, &value);
}
int c_rhash_get_uint8_by_str(c_rhash hash, const char *key, uint8_t *ret_val) {
uint32_t nhash = get_bin_idx_str(hash, key);
struct bin_item *bin = hash->bins[nhash];
while (bin) {
if (bin->key_type == ITEMTYPE_STRING) {
if (!strcmp(bin->key, key)) {
*ret_val = *(uint8_t*)bin->value;
return 0;
}
}
bin = bin->next;
}
return 1;
}
int c_rhash_get_ptr_by_str(c_rhash hash, const char *key, void **ret_val) {
uint32_t nhash = get_bin_idx_str(hash, key);
struct bin_item *bin = hash->bins[nhash];
while (bin) {
if (bin->key_type == ITEMTYPE_STRING) {
if (!strcmp(bin->key, key)) {
*ret_val = *((void**)bin->value);
return 0;
}
}
bin = bin->next;
}
*ret_val = NULL;
return 1;
}
int c_rhash_get_ptr_by_uint64(c_rhash hash, uint64_t key, void **ret_val) {
uint32_t nhash = key % hash->bin_count;
struct bin_item *bin = hash->bins[nhash];
while (bin) {
if (bin->key_type == ITEMTYPE_UINT64) {
if (*((uint64_t *)bin->key) == key) {
*ret_val = *((void**)bin->value);
return 0;
}
}
bin = bin->next;
}
*ret_val = NULL;
return 1;
}
static void c_rhash_destroy_bin(c_rhash_bin bin) {
struct bin_item *next;
do {
next = bin->next;
c_rfree(bin->key);
c_rfree(bin->value);
c_rfree(bin);
bin = next;
} while (bin != NULL);
}
int c_rhash_iter_uint64_keys(c_rhash hash, c_rhash_iter_t *iter, uint64_t *key) {
while (iter->bin < hash->bin_count) {
if (iter->item != NULL)
iter->item = iter->item->next;
if (iter->item == NULL) {
if (iter->initialized)
iter->bin++;
else
iter->initialized = 1;
if (iter->bin < hash->bin_count)
iter->item = hash->bins[iter->bin];
}
if (iter->item != NULL && iter->item->key_type == ITEMTYPE_UINT64) {
*key = *(uint64_t*)iter->item->key;
return 0;
}
}
return 1;
}
int c_rhash_iter_str_keys(c_rhash hash, c_rhash_iter_t *iter, const char **key) {
while (iter->bin < hash->bin_count) {
if (iter->item != NULL)
iter->item = iter->item->next;
if (iter->item == NULL) {
if (iter->initialized)
iter->bin++;
else
iter->initialized = 1;
if (iter->bin < hash->bin_count)
iter->item = hash->bins[iter->bin];
}
if (iter->item != NULL && iter->item->key_type == ITEMTYPE_STRING) {
*key = (const char*)iter->item->key;
return 0;
}
}
return 1;
}
void c_rhash_destroy(c_rhash hash) {
for (size_t i = 0; i < hash->bin_count; i++) {
if (hash->bins[i] != NULL)
c_rhash_destroy_bin(hash->bins[i]);
}
c_rfree(hash);
}

17
mqtt_websockets/c_rhash/src/c_rhash_internal.h Normal file
View file

@ -0,0 +1,17 @@
#include "c_rhash.h"
struct bin_item {
uint8_t key_type:4;
void *key;
uint8_t value_type:4;
void *value;
struct bin_item *next;
};
typedef struct bin_item *c_rhash_bin;
struct c_rhash_s {
size_t bin_count;
c_rhash_bin *bins;
};

271
mqtt_websockets/c_rhash/src/tests.c Normal file
View file

@ -0,0 +1,271 @@
#include <stdio.h>
#include <string.h>
#include "c_rhash.h"
// terminal color codes
#define KNRM "\x1B[0m"
#define KRED "\x1B[31m"
#define KGRN "\x1B[32m"
#define KYEL "\x1B[33m"
#define KBLU "\x1B[34m"
#define KMAG "\x1B[35m"
#define KCYN "\x1B[36m"
#define KWHT "\x1B[37m"
#define KEY_1 "key1"
#define KEY_2 "keya"
#define PRINT_ERR(str, ...) fprintf(stderr, "└─╼ ❌ " KRED str KNRM "\n" __VA_OPT__(,) __VA_ARGS__)
#define ASSERT_RETVAL(fnc, comparator, expected_retval, ...) \
{ int rval; \
if(!((rval = fnc(__VA_ARGS__)) comparator expected_retval)) { \
PRINT_ERR("Failed test. Value returned by \"%s\" in fnc:\"%s\",line:%d is not equal to expected value. Expected:%d, Got:%d", #fnc, __FUNCTION__, __LINE__, expected_retval, rval); \
rc = 1; \
goto test_cleanup; \
} passed_subtest_count++;};
#define ASSERT_VAL_UINT8(returned, expected) \
if(returned != expected) { \
PRINT_ERR("Failed test. Value returned (%d) doesn't match expected (%d)! fnc:\"%s\",line:%d", returned, expected, __FUNCTION__, __LINE__); \
rc = 1; \
goto test_cleanup; \
} passed_subtest_count++;
#define ASSERT_VAL_PTR(returned, expected) \
if((void*)returned != (void*)expected) { \
PRINT_ERR("Failed test. Value returned(%p) doesn't match expected(%p)! fnc:\"%s\",line:%d", (void*)returned, (void*)expected, __FUNCTION__, __LINE__); \
rc = 1; \
goto test_cleanup; \
} passed_subtest_count++;
#define ALL_SUBTESTS_PASS() printf("└─╼ ✅" KGRN " Test \"%s\" DONE. All of %zu subtests PASS. (line:%d)\n" KNRM, __FUNCTION__, passed_subtest_count, __LINE__);
#define TEST_START() size_t passed_subtest_count = 0; int rc = 0; printf("╒═ Starting test \"%s\"\n", __FUNCTION__);
int test_str_uint8() {
c_rhash hash = c_rhash_new(100);
uint8_t val;
TEST_START();
// function should fail on empty hash
ASSERT_RETVAL(c_rhash_get_uint8_by_str, !=, 0, hash, KEY_1, &val);
ASSERT_RETVAL(c_rhash_insert_str_uint8, ==, 0, hash, KEY_1, 5);
ASSERT_RETVAL(c_rhash_get_uint8_by_str, ==, 0, hash, KEY_1, &val);
ASSERT_VAL_UINT8(5, val);
ASSERT_RETVAL(c_rhash_insert_str_uint8, ==, 0, hash, KEY_2, 8);
ASSERT_RETVAL(c_rhash_get_uint8_by_str, ==, 0, hash, KEY_1, &val);
ASSERT_VAL_UINT8(5, val);
ASSERT_RETVAL(c_rhash_get_uint8_by_str, ==, 0, hash, KEY_2, &val);
ASSERT_VAL_UINT8(8, val);
ASSERT_RETVAL(c_rhash_get_uint8_by_str, !=, 0, hash, "sndnskjdf", &val);
// test update of key
ASSERT_RETVAL(c_rhash_insert_str_uint8, ==, 0, hash, KEY_1, 100);
ASSERT_RETVAL(c_rhash_get_uint8_by_str, ==, 0, hash, KEY_1, &val);
ASSERT_VAL_UINT8(100, val);
ALL_SUBTESTS_PASS();
test_cleanup:
c_rhash_destroy(hash);
return rc;
}
int test_uint64_ptr() {
c_rhash hash = c_rhash_new(100);
void *val;
TEST_START();
// function should fail on empty hash
ASSERT_RETVAL(c_rhash_get_ptr_by_uint64, !=, 0, hash, 0, &val);
ASSERT_RETVAL(c_rhash_insert_uint64_ptr, ==, 0, hash, 0, &hash);
ASSERT_RETVAL(c_rhash_get_ptr_by_uint64, ==, 0, hash, 0, &val);
ASSERT_VAL_PTR(&hash, val);
ASSERT_RETVAL(c_rhash_insert_uint64_ptr, ==, 0, hash, 1, &val);
ASSERT_RETVAL(c_rhash_get_ptr_by_uint64, ==, 0, hash, 0, &val);
ASSERT_VAL_PTR(&hash, val);
ASSERT_RETVAL(c_rhash_get_ptr_by_uint64, ==, 0, hash, 1, &val);
ASSERT_VAL_PTR(&val, val);
ASSERT_RETVAL(c_rhash_get_ptr_by_uint64, !=, 0, hash, 2, &val);
ALL_SUBTESTS_PASS();
test_cleanup:
c_rhash_destroy(hash);
return rc;
}
#define UINT64_PTR_INC_ITERATION_COUNT 5000
int test_uint64_ptr_incremental() {
c_rhash hash = c_rhash_new(100);
void *val;
TEST_START();
char a = 0x20;
char *ptr = &a;
while(ptr < &a + UINT64_PTR_INC_ITERATION_COUNT) {
ASSERT_RETVAL(c_rhash_insert_uint64_ptr, ==, 0, hash, (ptr-&a), ptr);
ptr++;
}
ptr = &a;
char *retptr;
for(int i = 0; i < UINT64_PTR_INC_ITERATION_COUNT; i++) {
ASSERT_RETVAL(c_rhash_get_ptr_by_uint64, ==, 0, hash, i, (void**)&retptr);
ASSERT_VAL_PTR(retptr, (&a+i));
}
ALL_SUBTESTS_PASS();
test_cleanup:
c_rhash_destroy(hash);
return rc;
}
struct test_string {
const char *str;
int counter;
};
struct test_string test_strings[] = {
{ .str = "Cillum reprehenderit eiusmod elit nisi aliquip esse exercitation commodo Lorem voluptate esse.", .counter = 0 },
{ .str = "Ullamco eiusmod tempor occaecat ad.", .counter = 0 },
{ .str = "Esse aliquip tempor sint tempor ullamco duis aute incididunt ad.", .counter = 0 },
{ .str = "Cillum Lorem labore cupidatat commodo proident adipisicing.", .counter = 0 },
{ .str = "Quis ad cillum officia exercitation.", .counter = 0 },
{ .str = "Ipsum enim dolor ullamco amet sint nisi ut occaecat sint non.", .counter = 0 },
{ .str = "Id duis officia ipsum cupidatat velit fugiat.", .counter = 0 },
{ .str = "Aliqua non occaecat voluptate reprehenderit reprehenderit veniam minim exercitation ea aliquip enim aliqua deserunt qui.", .counter = 0 },
{ .str = "Ullamco elit tempor laboris reprehenderit quis deserunt duis quis tempor reprehenderit magna dolore reprehenderit exercitation.", .counter = 0 },
{ .str = "Culpa do dolor quis incididunt et labore in ex.", .counter = 0 },
{ .str = "Aliquip velit cupidatat qui incididunt ipsum nostrud eiusmod ut proident nisi magna fugiat excepteur.", .counter = 0 },
{ .str = "Aliqua qui dolore tempor id proident ullamco sunt magna.", .counter = 0 },
{ .str = "Labore eiusmod ut fugiat dolore reprehenderit mollit magna.", .counter = 0 },
{ .str = "Veniam aliquip dolor excepteur minim nulla esse cupidatat esse.", .counter = 0 },
{ .str = "Do quis dolor irure nostrud occaecat aute proident anim.", .counter = 0 },
{ .str = "Enim veniam non nulla ad quis sit amet.", .counter = 0 },
{ .str = "Cillum reprehenderit do enim esse do ullamco consectetur ea.", .counter = 0 },
{ .str = "Sit et duis sint anim qui ad anim labore exercitation sunt cupidatat.", .counter = 0 },
{ .str = "Dolor officia adipisicing sint pariatur in dolor occaecat officia reprehenderit magna.", .counter = 0 },
{ .str = "Aliquip dolore qui occaecat eiusmod sunt incididunt reprehenderit minim et.", .counter = 0 },
{ .str = "Aute fugiat laboris cillum tempor consequat tempor do non laboris culpa officia nisi.", .counter = 0 },
{ .str = "Et excepteur do aliquip fugiat nisi velit tempor officia enim quis elit incididunt.", .counter = 0 },
{ .str = "Eu officia adipisicing incididunt occaecat officia cupidatat enim sit sit officia.", .counter = 0 },
{ .str = "Do amet cillum duis pariatur commodo nulla cillum magna nulla Lorem veniam cupidatat.", .counter = 0 },
{ .str = "Dolor adipisicing voluptate laboris occaecat culpa aliquip ipsum ut consequat aliqua aliquip commodo sunt velit.", .counter = 0 },
{ .str = "Nulla proident ipsum quis nulla.", .counter = 0 },
{ .str = "Laborum adipisicing nulla do aute aliqua est quis sint culpa pariatur laborum voluptate qui.", .counter = 0 },
{ .str = "Proident eiusmod sunt et nulla elit pariatur dolore irure ex voluptate excepteur adipisicing consectetur.", .counter = 0 },
{ .str = "Consequat ex voluptate officia excepteur aute deserunt proident commodo et.", .counter = 0 },
{ .str = "Velit sit cupidatat dolor dolore.", .counter = 0 },
{ .str = "Sunt enim do non anim nostrud exercitation ullamco ex proident commodo.", .counter = 0 },
{ .str = "Id ex officia cillum ad.", .counter = 0 },
{ .str = "Laboris in sunt eiusmod veniam laboris nostrud.", .counter = 0 },
{ .str = "Ex magna occaecat ea ea incididunt aliquip.", .counter = 0 },
{ .str = "Sunt eiusmod ex nostrud eu pariatur sit cupidatat ea adipisicing cillum culpa esse consequat aliquip.", .counter = 0 },
{ .str = "Excepteur commodo qui incididunt enim culpa sunt non excepteur Lorem adipisicing.", .counter = 0 },
{ .str = "Quis officia est ullamco reprehenderit incididunt occaecat pariatur ex reprehenderit nisi.", .counter = 0 },
{ .str = "Culpa irure proident proident et eiusmod irure aliqua ipsum cupidatat minim sit.", .counter = 0 },
{ .str = "Qui cupidatat aliquip est velit magna veniam.", .counter = 0 },
{ .str = "Pariatur ad ad mollit nostrud non irure minim veniam anim aliquip quis eu.", .counter = 0 },
{ .str = "Nisi ex minim eu adipisicing tempor Lorem nisi do ad exercitation est non eu.", .counter = 0 },
{ .str = "Cupidatat do mollit ad commodo cupidatat ut.", .counter = 0 },
{ .str = "Est non excepteur eiusmod nostrud et eu.", .counter = 0 },
{ .str = "Cupidatat mollit nisi magna officia ut elit eiusmod.", .counter = 0 },
{ .str = "Est aliqua consectetur laboris ex consequat est ut dolor.", .counter = 0 },
{ .str = "Duis eu laboris laborum ut id Lorem nostrud qui ad velit proident fugiat minim ullamco.", .counter = 0 },
{ .str = "Pariatur esse excepteur anim amet excepteur irure sint quis esse ex cupidatat ut.", .counter = 0 },
{ .str = "Esse reprehenderit amet qui excepteur aliquip amet.", .counter = 0 },
{ .str = "Ullamco laboris elit labore adipisicing aute nulla qui laborum tempor officia ut dolor aute.", .counter = 0 },
{ .str = "Commodo sunt cillum velit minim laborum Lorem aliqua tempor ad id eu.", .counter = 0 },
{ .str = NULL, .counter = 0 }
};
uint32_t test_strings_contain_element(const char *str) {
struct test_string *str_desc = test_strings;
while(str_desc->str) {
if (!strcmp(str, str_desc->str))
return str_desc - test_strings;
str_desc++;
}
return -1;
}
#define TEST_INCREMENT_STR_KEYS_HASH_SIZE 20
int test_increment_str_keys() {
c_rhash hash;
const char *key;
TEST_START();
hash = c_rhash_new(TEST_INCREMENT_STR_KEYS_HASH_SIZE); // less than element count of test_strings
c_rhash_iter_t iter = C_RHASH_ITER_T_INITIALIZER;
// check iter on empty hash
ASSERT_RETVAL(c_rhash_iter_str_keys, !=, 0, hash, &iter, &key);
int32_t element_count = 0;
while (test_strings[element_count].str) {
ASSERT_RETVAL(c_rhash_insert_str_ptr, ==, 0, hash, test_strings[element_count].str, NULL);
test_strings[element_count].counter++; // we want to test we got each key exactly once
element_count++;
}
if (element_count <= TEST_INCREMENT_STR_KEYS_HASH_SIZE * 2) {
// verify we are actually test also iteration trough single bin (when 2 keys have same hash pointing them to same bin)
PRINT_ERR("For this test to properly test all the hash size needs to be much smaller than all test key count.");
rc = 1;
goto test_cleanup;
}
// we insert another type of key as iterator should skip it
// in case is another type
ASSERT_RETVAL(c_rhash_insert_uint64_ptr, ==, 0, hash, 5, NULL);
c_rhash_iter_t_initialize(&iter);
while(!c_rhash_iter_str_keys(hash, &iter, &key)) {
element_count--;
int i;
if ( (i = test_strings_contain_element(key)) < 0) {
PRINT_ERR("Key \"%s\" is not present in test_strings array! (Fnc: %s, Line: %d)", key, __FUNCTION__, __LINE__);
rc = 1;
goto test_cleanup;
}
passed_subtest_count++;
test_strings[i].counter--;
}
ASSERT_VAL_UINT8(element_count, 0); // we added also same non string keys
// check each key was present exactly once
struct test_string *str_desc = test_strings;
while (str_desc->str) {
ASSERT_VAL_UINT8(str_desc->counter, 0);
str_desc++;
}
ALL_SUBTESTS_PASS();
test_cleanup:
c_rhash_destroy(hash);
return rc;
}
#define RUN_TEST(fnc) \
if(fnc()) \
return 1;
int main(int argc, char *argv[]) {
RUN_TEST(test_str_uint8);
RUN_TEST(test_uint64_ptr);
RUN_TEST(test_uint64_ptr_incremental);
RUN_TEST(test_increment_str_keys);
// TODO hash with mixed key tests
// TODO iterator test
return 0;
}

7
mqtt_websockets/src/common_public.c Normal file
View file

@ -0,0 +1,7 @@
#include "common_public.h"
// this dummy exists to have a special pointer with special meaning
// other than NULL
void _caller_responsibility(void *ptr) {
(void)(ptr);
}

37
mqtt_websockets/src/include/common_internal.h Normal file
View file

@ -0,0 +1,37 @@
// SPDX-License-Identifier: GPL-3.0-only
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <https://www.gnu.org/licenses/>.
#ifndef COMMON_INTERNAL_H
#define COMMON_INTERNAL_H
#include "endian_compat.h"
#ifdef MQTT_WSS_CUSTOM_ALLOC
#include "mqtt_wss_pal.h"
#else
#define mw_malloc(...) malloc(__VA_ARGS__)
#define mw_calloc(...) calloc(__VA_ARGS__)
#define mw_free(...) free(__VA_ARGS__)
#define mw_strdup(...) strdup(__VA_ARGS__)
#define mw_realloc(...) realloc(__VA_ARGS__)
#endif
#ifndef MQTT_WSS_FRAG_MEMALIGN
#define MQTT_WSS_FRAG_MEMALIGN (8)
#endif
#define OPENSSL_VERSION_095 0x00905100L
#define OPENSSL_VERSION_097 0x00907000L
#define OPENSSL_VERSION_110 0x10100000L
#define OPENSSL_VERSION_111 0x10101000L
#endif /* COMMON_INTERNAL_H */

33
mqtt_websockets/src/include/common_public.h Normal file
View file

@ -0,0 +1,33 @@
#ifndef MQTT_WEBSOCKETS_COMMON_PUBLIC_H
#define MQTT_WEBSOCKETS_COMMON_PUBLIC_H
#include <stddef.h>
/* free_fnc_t in general (in whatever function or struct it is used)
* decides how the related data will be handled.
* - If NULL the data are copied internally (causing malloc and later free)
* - If pointer provided the free function pointed will be called when data are no longer needed
* to free associated memory. This is effectively transfering ownership of that pointer to the library.
* This also allows caller to provide custom free function other than system one.
* - If == CALLER_RESPONSIBILITY the library will not copy the data pointed to and will not call free
* at the end. This is usefull to avoid copying memory (and associated malloc/free) when data are for
* example static. In this case caller has to guarantee the memory pointed to will be valid for entire duration
* it is needed. For example by freeing the data after PUBACK is received or by data being static.
*/
typedef void (*free_fnc_t)(void *ptr);
void _caller_responsibility(void *ptr);
#define CALLER_RESPONSIBILITY ((free_fnc_t)&_caller_responsibility)
struct mqtt_ng_stats {
size_t tx_bytes_queued;
int tx_messages_queued;
int tx_messages_sent;
int rx_messages_rcvd;
size_t tx_buffer_used;
size_t tx_buffer_free;
size_t tx_buffer_size;
// part of transaction buffer that containes mesages we can free alredy during the garbage colleciton step
size_t tx_buffer_reclaimable;
};
#endif /* MQTT_WEBSOCKETS_COMMON_PUBLIC_H */

41
mqtt_websockets/src/include/endian_compat.h Normal file
View file

@ -0,0 +1,41 @@
// SPDX-License-Identifier: GPL-3.0-only
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <https://www.gnu.org/licenses/>.
#ifndef MQTT_WSS_ENDIAN_COMPAT_H
#define MQTT_WSS_ENDIAN_COMPAT_H
#ifdef __APPLE__
#include <libkern/OSByteOrder.h>
#define htobe16(x) OSSwapHostToBigInt16(x)
#define htole16(x) OSSwapHostToLittleInt16(x)
#define be16toh(x) OSSwapBigToHostInt16(x)
#define le16toh(x) OSSwapLittleToHostInt16(x)
#define htobe32(x) OSSwapHostToBigInt32(x)
#define htole32(x) OSSwapHostToLittleInt32(x)
#define be32toh(x) OSSwapBigToHostInt32(x)
#define le32toh(x) OSSwapLittleToHostInt32(x)
#define htobe64(x) OSSwapHostToBigInt64(x)
#define htole64(x) OSSwapHostToLittleInt64(x)
#define be64toh(x) OSSwapBigToHostInt64(x)
#define le64toh(x) OSSwapLittleToHostInt64(x)
#else
#ifdef __FreeBSD__
#include <sys/endian.h>
#else
#include <endian.h>
#endif
#endif
#endif /* MQTT_WSS_ENDIAN_COMPAT_H */

101
mqtt_websockets/src/include/mqtt_constants.h Normal file
View file

@ -0,0 +1,101 @@
#ifndef MQTT_CONSTANTS_H
#define MQTT_CONSTANTS_H
#define MQTT_MAX_QOS 0x02
#define MQTT_VERSION_5_0 0x5
/* [MQTT-1.5.5] most significant bit
of MQTT Variable Byte Integer signifies
there are more bytes following */
#define MQTT_VBI_CONTINUATION_FLAG 0x80
#define MQTT_VBI_DATA_MASK 0x7F
#define MQTT_VBI_MAXBYTES 4
/* MQTT control packet types as defined in
2.1.2 MQTT Control Packet type */
#define MQTT_CPT_CONNECT 0x1
#define MQTT_CPT_CONNACK 0x2
#define MQTT_CPT_PUBLISH 0x3
#define MQTT_CPT_PUBACK 0x4
#define MQTT_CPT_PUBREC 0x5
#define MQTT_CPT_PUBREL 0x6
#define MQTT_CPT_PUBCOMP 0x7
#define MQTT_CPT_SUBSCRIBE 0x8
#define MQTT_CPT_SUBACK 0x9
#define MQTT_CPT_UNSUBSCRIBE 0xA
#define MQTT_CPT_UNSUBACK 0xB
#define MQTT_CPT_PINGREQ 0xC
#define MQTT_CPT_PINGRESP 0xD
#define MQTT_CPT_DISCONNECT 0xE
#define MQTT_CPT_AUTH 0xF
// MQTT CONNECT FLAGS (spec:3.1.2.3)
#define MQTT_CONNECT_FLAG_USERNAME 0x80
#define MQTT_CONNECT_FLAG_PASSWORD 0x40
#define MQTT_CONNECT_FLAG_LWT_RETAIN 0x20
#define MQTT_CONNECT_FLAG_LWT 0x04
#define MQTT_CONNECT_FLAG_CLEAN_START 0x02
#define MQTT_CONNECT_FLAG_QOS_MASK 0x18
#define MQTT_CONNECT_FLAG_QOS_BITSHIFT 3
#define MQTT_MAX_CLIENT_ID 23 /* [MQTT-3.1.3-5] */
// MQTT Property identifiers [MQTT-2.2.2.2]
#define MQTT_PROP_PAYLOAD_FMT_INDICATOR 0x01
#define MQTT_PROP_PAYLOAD_FMT_INDICATOR_NAME "Payload Format Indicator"
#define MQTT_PROP_MSG_EXPIRY_INTERVAL 0x02
#define MQTT_PROP_MSG_EXPIRY_INTERVAL_NAME "Message Expiry Interval"
#define MQTT_PROP_CONTENT_TYPE 0x03
#define MQTT_PROP_CONTENT_TYPE_NAME "Content Type"
#define MQTT_PROP_RESPONSE_TOPIC 0x08
#define MQTT_PROP_RESPONSE_TOPIC_NAME "Response Topic"
#define MQTT_PROP_CORRELATION_DATA 0x09
#define MQTT_PROP_CORRELATION_DATA_NAME "Correlation Data"
#define MQTT_PROP_SUB_IDENTIFIER 0x0B
#define MQTT_PROP_SUB_IDENTIFIER_NAME "Subscription Identifier"
#define MQTT_PROP_SESSION_EXPIRY_INTERVAL 0x11
#define MQTT_PROP_SESSION_EXPIRY_INTERVAL_NAME "Session Expiry Interval"
#define MQTT_PROP_ASSIGNED_CLIENT_ID 0x12
#define MQTT_PROP_ASSIGNED_CLIENT_ID_NAME "Assigned Client Identifier"
#define MQTT_PROP_SERVER_KEEP_ALIVE 0x13
#define MQTT_PROP_SERVER_KEEP_ALIVE_NAME "Server Keep Alive"
#define MQTT_PROP_AUTH_METHOD 0x15
#define MQTT_PROP_AUTH_METHOD_NAME "Authentication Method"
#define MQTT_PROP_AUTH_DATA 0x16
#define MQTT_PROP_AUTH_DATA_NAME "Authentication Data"
#define MQTT_PROP_REQ_PROBLEM_INFO 0x17
#define MQTT_PROP_REQ_PROBLEM_INFO_NAME "Request Problem Information"
#define MQTT_PROP_WILL_DELAY_INTERVAL 0x18
#define MQTT_PROP_WIIL_DELAY_INTERVAL_NAME "Will Delay Interval"
#define MQTT_PROP_REQ_RESP_INFORMATION 0x19
#define MQTT_PROP_REQ_RESP_INFORMATION_NAME "Request Response Information"
#define MQTT_PROP_RESP_INFORMATION 0x1A
#define MQTT_PROP_RESP_INFORMATION_NAME "Response Information"
#define MQTT_PROP_SERVER_REF 0x1C
#define MQTT_PROP_SERVER_REF_NAME "Server Reference"
#define MQTT_PROP_REASON_STR 0x1F
#define MQTT_PROP_REASON_STR_NAME "Reason String"
#define MQTT_PROP_RECEIVE_MAX 0x21
#define MQTT_PROP_RECEIVE_MAX_NAME "Receive Maximum"
#define MQTT_PROP_TOPIC_ALIAS_MAX 0x22
#define MQTT_PROP_TOPIC_ALIAS_MAX_NAME "Topic Alias Maximum"
#define MQTT_PROP_TOPIC_ALIAS 0x23
#define MQTT_PROP_TOPIC_ALIAS_NAME "Topic Alias"
#define MQTT_PROP_MAX_QOS 0x24
#define MQTT_PROP_MAX_QOS_NAME "Maximum QoS"
#define MQTT_PROP_RETAIN_AVAIL 0x25
#define MQTT_PROP_RETAIN_AVAIL_NAME "Retain Available"
#define MQTT_PROP_USR 0x26
#define MQTT_PROP_USR_NAME "User Property"
#define MQTT_PROP_MAX_PKT_SIZE 0x27
#define MQTT_PROP_MAX_PKT_SIZE_NAME "Maximum Packet Size"
#define MQTT_PROP_WILDCARD_SUB_AVAIL 0x28
#define MQTT_PROP_WILDCARD_SUB_AVAIL_NAME "Wildcard Subscription Available"
#define MQTT_PROP_SUB_ID_AVAIL 0x29
#define MQTT_PROP_SUB_ID_AVAIL_NAME "Subscription Identifier Available"
#define MQTT_PROP_SHARED_SUB_AVAIL 0x2A
#define MQTT_PROP_SHARED_SUB_AVAIL_NAME "Shared Subscription Available"
#endif /* MQTT_CONSTANTS_H */

97
mqtt_websockets/src/include/mqtt_ng.h Normal file
View file

@ -0,0 +1,97 @@
#include <stdint.h>
#include <sys/types.h>
#include <time.h>
#include "ringbuffer.h"
#include "common_public.h"
#define MQTT_NG_MSGGEN_OK 0
// MQTT_NG_MSGGEN_USER_ERROR means parameters given to this function
// do not make sense or are out of MQTT specs
#define MQTT_NG_MSGGEN_USER_ERROR 1
#define MQTT_NG_MSGGEN_BUFFER_OOM 2
#define MQTT_NG_MSGGEN_MSG_TOO_BIG 3
struct mqtt_ng_client;
/* Converts integer to MQTT Variable Byte Integer as per 1.5.5 of MQTT 5 specs
* @param input value to be converted
* @param output pointer to memory where output will be written to. Must allow up to 4 bytes to be written.
* @return number of bytes written to output or <= 0 if error in which case contents of output are undefined
*/
int uint32_to_mqtt_vbi(uint32_t input, char *output);
struct mqtt_lwt_properties {
char *will_topic;
free_fnc_t will_topic_free;
void *will_message;
free_fnc_t will_message_free;
size_t will_message_size;
int will_qos;
int will_retain;
};
struct mqtt_auth_properties {
char *client_id;
free_fnc_t client_id_free;
char *username;
free_fnc_t username_free;
char *password;
free_fnc_t password_free;
};
int mqtt_ng_connect(struct mqtt_ng_client *client,
struct mqtt_auth_properties *auth,
struct mqtt_lwt_properties *lwt,
uint8_t clean_start,
uint16_t keep_alive);
int mqtt_ng_publish(struct mqtt_ng_client *client,
char *topic,
free_fnc_t topic_free,
void *msg,
free_fnc_t msg_free,
size_t msg_len,
uint8_t publish_flags,
uint16_t *packet_id);
struct mqtt_sub {
char *topic;
free_fnc_t topic_free;
uint8_t options;
};
int mqtt_ng_subscribe(struct mqtt_ng_client *client, struct mqtt_sub *subscriptions, size_t subscription_count);
int mqtt_ng_ping(struct mqtt_ng_client *client);
typedef ssize_t (*mqtt_ng_send_fnc_t)(void *user_ctx, const void* buf, size_t len);
struct mqtt_ng_init {
mqtt_wss_log_ctx_t log;
rbuf_t data_in;
mqtt_ng_send_fnc_t data_out_fnc;
void *user_ctx;
void (*puback_callback)(uint16_t packet_id);
void (*connack_callback)(void* user_ctx, int connack_reply);
void (*msg_callback)(const char *topic, const void *msg, size_t msglen, int qos);
};
struct mqtt_ng_client *mqtt_ng_init(struct mqtt_ng_init *settings);
void mqtt_ng_destroy(struct mqtt_ng_client *client);
int mqtt_ng_disconnect(struct mqtt_ng_client *client, uint8_t reason_code);
int mqtt_ng_sync(struct mqtt_ng_client *client);
time_t mqtt_ng_last_send_time(struct mqtt_ng_client *client);
void mqtt_ng_set_max_mem(struct mqtt_ng_client *client, size_t bytes);
void mqtt_ng_get_stats(struct mqtt_ng_client *client, struct mqtt_ng_stats *stats);
int mqtt_ng_set_topic_alias(struct mqtt_ng_client *client, const char *topic);

172
mqtt_websockets/src/include/mqtt_wss_client.h Normal file
View file

@ -0,0 +1,172 @@
// Copyright (C) 2020 Timotej Šiškovič
// SPDX-License-Identifier: GPL-3.0-only
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <https://www.gnu.org/licenses/>.
#ifndef MQTT_WSS_CLIENT_H
#define MQTT_WSS_CLIENT_H
#include <stdint.h>
#include <stddef.h> //size_t
#include "mqtt_wss_log.h"
#include "common_public.h"
// All OK call me at your earliest convinience
#define MQTT_WSS_OK 0
/* All OK, poll timeout you requested when calling mqtt_wss_service expired - you might want to know if timeout
* happened or we got some data or handle same as MQTT_WSS_OK
*/
#define MQTT_WSS_OK_TO 1
// Connection was closed by remote
#define MQTT_WSS_ERR_CONN_DROP -1
// Error in MQTT protocol (e.g. malformed packet)
#define MQTT_WSS_ERR_PROTO_MQTT -2
// Error in WebSocket protocol (e.g. malformed packet)
#define MQTT_WSS_ERR_PROTO_WS -3
#define MQTT_WSS_ERR_TX_BUF_TOO_SMALL -4
#define MQTT_WSS_ERR_RX_BUF_TOO_SMALL -5
#define MQTT_WSS_ERR_TOO_BIG_FOR_SERVER -6
// if client was initialized with MQTT 3 but MQTT 5 feature
// was requested by user of library
#define MQTT_WSS_ERR_CANT_DO -8
typedef struct mqtt_wss_client_struct *mqtt_wss_client;
typedef void (*msg_callback_fnc_t)(const char *topic, const void *msg, size_t msglen, int qos);
/* Creates new instance of MQTT over WSS. Doesn't start connection.
* @param log_prefix this is prefix to be used when logging to discern between multiple
* mqtt_wss instances. Can be NULL.
* @param log_callback is function pointer to fnc to be called when mqtt_wss wants
* to log. This allows plugging this library into your own logging system/solution.
* If NULL STDOUT/STDERR will be used.
* @param msg_callback is function pointer to function which will be called
* when application level message arrives from broker (for subscribed topics).
* Can be NULL if you are not interested about incoming messages.
* @param puback_callback is function pointer to function to be called when QOS1 Publish
* is acknowledged by server
*/
mqtt_wss_client mqtt_wss_new(const char *log_prefix,
mqtt_wss_log_callback_t log_callback,
msg_callback_fnc_t msg_callback,
void (*puback_callback)(uint16_t packet_id));
void mqtt_wss_set_max_buf_size(mqtt_wss_client client, size_t size);
void mqtt_wss_destroy(mqtt_wss_client client);
struct mqtt_connect_params;
struct mqtt_wss_proxy;
#define MQTT_WSS_SSL_CERT_CHECK_FULL 0x00
#define MQTT_WSS_SSL_ALLOW_SELF_SIGNED 0x01
#define MQTT_WSS_SSL_DONT_CHECK_CERTS 0x08
/* Will block until the MQTT over WSS connection is established or return error
* @param client mqtt_wss_client which should connect
* @param host to connect to (where MQTT over WSS server is listening)
* @param port to connect to (where MQTT over WSS server is listening)
* @param mqtt_params pointer to mqtt_connect_params structure which contains MQTT credentials and settings
* @param ssl_flags parameters for OpenSSL, 0=MQTT_WSS_SSL_CERT_CHECK_FULL
*/
int mqtt_wss_connect(mqtt_wss_client client, char *host, int port, struct mqtt_connect_params *mqtt_params, int ssl_flags, struct mqtt_wss_proxy *proxy);
int mqtt_wss_service(mqtt_wss_client client, int timeout_ms);
void mqtt_wss_disconnect(mqtt_wss_client client, int timeout_ms);
// we redefine this instead of using MQTT-C flags as in future
// we want to support different MQTT implementations if needed
enum mqtt_wss_publish_flags {
MQTT_WSS_PUB_QOS0 = 0x0,
MQTT_WSS_PUB_QOS1 = 0x1,
MQTT_WSS_PUB_QOS2 = 0x2,
MQTT_WSS_PUB_QOSMASK = 0x3,
MQTT_WSS_PUB_RETAIN = 0x4
};
struct mqtt_connect_params {
const char *clientid;
const char *username;
const char *password;
const char *will_topic;
const void *will_msg;
enum mqtt_wss_publish_flags will_flags;
size_t will_msg_len;
int keep_alive;
int drop_on_publish_fail;
};
enum mqtt_wss_proxy_type {
MQTT_WSS_DIRECT = 0,
MQTT_WSS_PROXY_HTTP
};
struct mqtt_wss_proxy {
enum mqtt_wss_proxy_type type;
const char *host;
int port;
const char *username;
const char *password;
};
/* TODO!!! update the description
* Publishes MQTT message and gets message id
* @param client mqtt_wss_client which should transfer the message
* @param topic MQTT topic to publish message to (0 terminated C string)
* @param msg Message to be published (no need for 0 termination)
* @param msg_len Length of the message to be published
* @param publish_flags see enum mqtt_wss_publish_flags e.g. (MQTT_WSS_PUB_QOS1 | MQTT_WSS_PUB_RETAIN)
* @param packet_id is 16 bit unsigned int representing ID that can be used to pair with PUBACK callback
* for usages where application layer wants to know which messages are delivered when
* @return Returns 0 on success
*/
int mqtt_wss_publish5(mqtt_wss_client client,
char *topic,
free_fnc_t topic_free,
void *msg,
free_fnc_t msg_free,
size_t msg_len,
uint8_t publish_flags,
uint16_t *packet_id);
int mqtt_wss_set_topic_alias(mqtt_wss_client client, const char *topic);
/* Subscribes to MQTT topic
* @param client mqtt_wss_client which should do the subscription
* @param topic MQTT topic to subscribe to
* @param max_qos_level maximum QOS level that broker can send to us on this subscription
* @return Returns 0 on success
*/
int mqtt_wss_subscribe(mqtt_wss_client client, char *topic, int max_qos_level);
struct mqtt_wss_stats {
uint64_t bytes_tx;
uint64_t bytes_rx;
#ifdef MQTT_WSS_CPUSTATS
uint64_t time_keepalive;
uint64_t time_read_socket;
uint64_t time_write_socket;
uint64_t time_process_websocket;
uint64_t time_process_mqtt;
#endif
struct mqtt_ng_stats mqtt;
};
struct mqtt_wss_stats mqtt_wss_get_stats(mqtt_wss_client client);
#ifdef MQTT_WSS_DEBUG
#include <openssl/ssl.h>
void mqtt_wss_set_SSL_CTX_keylog_cb(mqtt_wss_client client, void (*ssl_ctx_keylog_cb)(const SSL *ssl, const char *line));
#endif
#endif /* MQTT_WSS_CLIENT_H */

37
mqtt_websockets/src/include/mqtt_wss_log.h Normal file
View file

@ -0,0 +1,37 @@
#ifndef MQTT_WSS_LOG_H
#define MQTT_WSS_LOG_H
typedef enum mqtt_wss_log_type {
MQTT_WSS_LOG_DEBUG = 0x01,
MQTT_WSS_LOG_INFO = 0x02,
MQTT_WSS_LOG_WARN = 0x03,
MQTT_WSS_LOG_ERROR = 0x81,
MQTT_WSS_LOG_FATAL = 0x88
} mqtt_wss_log_type_t;
typedef void (*mqtt_wss_log_callback_t)(mqtt_wss_log_type_t, const char*);
typedef struct mqtt_wss_log_ctx *mqtt_wss_log_ctx_t;
/** Creates logging context with optional prefix and optional callback
* @param ctx_prefix String to be prefixed to every log message.
* This is useful if multiple clients are instantiated to be able to
* know which one this message belongs to. Can be `NULL` for no prefix.
* @param log_callback Callback to be called instead of logging to
* `STDOUT` or `STDERR` (if debug enabled otherwise silent). Callback has to be
* pointer to function of `void function(mqtt_wss_log_type_t, const char*)` type.
* If `NULL` default will be used (silent or STDERR/STDOUT).
* @return mqtt_wss_log_ctx_t or `NULL` on error */
mqtt_wss_log_ctx_t mqtt_wss_log_ctx_create(const char *ctx_prefix, mqtt_wss_log_callback_t log_callback);
/** Destroys logging context and cleans up the memory
* @param ctx Context to destroy */
void mqtt_wss_log_ctx_destroy(mqtt_wss_log_ctx_t ctx);
void mws_fatal(mqtt_wss_log_ctx_t ctx, const char *fmt, ...);
void mws_error(mqtt_wss_log_ctx_t ctx, const char *fmt, ...);
void mws_warn (mqtt_wss_log_ctx_t ctx, const char *fmt, ...);
void mws_info (mqtt_wss_log_ctx_t ctx, const char *fmt, ...);
void mws_debug(mqtt_wss_log_ctx_t ctx, const char *fmt, ...);
#endif /* MQTT_WSS_LOG_H */

130
mqtt_websockets/src/include/ws_client.h Normal file
View file

@ -0,0 +1,130 @@
// Copyright (C) 2020 Timotej Šiškovič
// SPDX-License-Identifier: GPL-3.0-only
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <https://www.gnu.org/licenses/>.
#ifndef WS_CLIENT_H
#define WS_CLIENT_H
#include "ringbuffer.h"
#include "mqtt_wss_log.h"
#include <stdint.h>
#define WS_CLIENT_NEED_MORE_BYTES 0x10
#define WS_CLIENT_PARSING_DONE 0x11
#define WS_CLIENT_CONNECTION_CLOSED 0x12
#define WS_CLIENT_PROTOCOL_ERROR -0x10
#define WS_CLIENT_BUFFER_FULL -0x11
#define WS_CLIENT_INTERNAL_ERROR -0x12
enum websocket_client_conn_state {
WS_RAW = 0,
WS_HANDSHAKE,
WS_ESTABLISHED,
WS_ERROR, // connection has to be restarted if this is reached
WS_CONN_CLOSED_GRACEFUL
};
enum websocket_client_hdr_parse_state {
WS_HDR_HTTP = 0, // need to check HTTP/1.1
WS_HDR_RC, // need to read HTTP code
WS_HDR_ENDLINE, // need to read rest of the first line
WS_HDR_PARSE_HEADERS, // rest of the header until CRLF CRLF
WS_HDR_PARSE_DONE,
WS_HDR_ALL_DONE
};
enum websocket_client_rx_ws_parse_state {
WS_FIRST_2BYTES = 0,
WS_PAYLOAD_EXTENDED_16,
WS_PAYLOAD_EXTENDED_64,
WS_PAYLOAD_DATA, // BINARY payload to be passed to MQTT
WS_PAYLOAD_CONNECTION_CLOSE,
WS_PAYLOAD_CONNECTION_CLOSE_EC,
WS_PAYLOAD_CONNECTION_CLOSE_MSG,
WS_PAYLOAD_SKIP_UNKNOWN_PAYLOAD,
WS_PAYLOAD_PING_REQ_PAYLOAD, // PING payload to be sent back as PONG
WS_PACKET_DONE
};
enum websocket_opcode {
WS_OP_CONTINUATION_FRAME = 0x0,
WS_OP_TEXT_FRAME = 0x1,
WS_OP_BINARY_FRAME = 0x2,
WS_OP_CONNECTION_CLOSE = 0x8,
WS_OP_PING = 0x9,
WS_OP_PONG = 0xA
};
struct ws_op_close_payload {
uint16_t ec;
char *reason;
};
struct http_header {
char *key;
char *value;
struct http_header *next;
};
typedef struct websocket_client {
enum websocket_client_conn_state state;
struct ws_handshake {
enum websocket_client_hdr_parse_state hdr_state;
char *nonce_reply;
int nonce_matched;
int http_code;
char *http_reply_msg;
struct http_header *headers;
struct http_header *headers_tail;
int hdr_count;
} hs;
struct ws_rx {
enum websocket_client_rx_ws_parse_state parse_state;
enum websocket_opcode opcode;
uint64_t payload_length;
uint64_t payload_processed;
union {
struct ws_op_close_payload op_close;
char *ping_msg;
} specific_data;
} rx;
rbuf_t buf_read; // from SSL
rbuf_t buf_write; // to SSL and then to socket
// TODO if ringbuffer gets multiple tail support
// we can work without buf_to_mqtt and thus reduce
// memory usage and remove one more memcpy buf_read->buf_to_mqtt
rbuf_t buf_to_mqtt; // RAW data for MQTT lib
int entropy_fd;
// careful host is borrowed, don't free
char **host;
mqtt_wss_log_ctx_t log;
} ws_client;
ws_client *ws_client_new(size_t buf_size, char **host, mqtt_wss_log_ctx_t log);
void ws_client_destroy(ws_client *client);
void ws_client_reset(ws_client *client);
int ws_client_start_handshake(ws_client *client);
int ws_client_want_write(ws_client *client);
int ws_client_process(ws_client *client);
int ws_client_send(ws_client *client, enum websocket_opcode frame_type, const char *data, size_t size);
#endif /* WS_CLIENT_H */

2233
mqtt_websockets/src/mqtt_ng.c Normal file
View file

File diff suppressed because it is too large Load diff

1138
mqtt_websockets/src/mqtt_wss_client.c Normal file
View file

File diff suppressed because it is too large Load diff

127
mqtt_websockets/src/mqtt_wss_log.c Normal file
View file

@ -0,0 +1,127 @@
#include "mqtt_wss_log.h"
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <stdio.h>
#include "common_internal.h"
struct mqtt_wss_log_ctx {
mqtt_wss_log_callback_t extern_log_fnc;
char *ctx_prefix;
char *buffer;
char *buffer_w_ptr;
size_t buffer_bytes_avail;
};
#define LOG_BUFFER_SIZE 1024 * 4
#define LOG_CTX_PREFIX_SEV_STR " : "
#define LOG_CTX_PREFIX_LIMIT 15
#define LOG_CTX_PREFIX_LIMIT_STR (LOG_CTX_PREFIX_LIMIT - (2 + strlen(LOG_CTX_PREFIX_SEV_STR))) // with [] characters and affixed ' ' it is total 15 chars
#if (LOG_CTX_PREFIX_LIMIT * 10) > LOG_BUFFER_SIZE
#error "LOG_BUFFER_SIZE too small"
#endif
mqtt_wss_log_ctx_t mqtt_wss_log_ctx_create(const char *ctx_prefix, mqtt_wss_log_callback_t log_callback)
{
mqtt_wss_log_ctx_t ctx = mw_calloc(1, sizeof(struct mqtt_wss_log_ctx));
if(!ctx)
return NULL;
if(log_callback) {
ctx->extern_log_fnc = log_callback;
ctx->buffer = mw_calloc(1, LOG_BUFFER_SIZE);
if(!ctx->buffer)
goto cleanup;
ctx->buffer_w_ptr = ctx->buffer;
if(ctx_prefix) {
*(ctx->buffer_w_ptr++) = '[';
strncpy(ctx->buffer_w_ptr, ctx_prefix, LOG_CTX_PREFIX_LIMIT_STR);
ctx->buffer_w_ptr += strnlen(ctx_prefix, LOG_CTX_PREFIX_LIMIT_STR);
*(ctx->buffer_w_ptr++) = ']';
}
strcpy(ctx->buffer_w_ptr, LOG_CTX_PREFIX_SEV_STR);
ctx->buffer_w_ptr += strlen(LOG_CTX_PREFIX_SEV_STR);
// no term '\0' -> calloc is used
ctx->buffer_bytes_avail = LOG_BUFFER_SIZE - strlen(ctx->buffer);
return ctx;
}
if(ctx_prefix) {
ctx->ctx_prefix = strndup(ctx_prefix, LOG_CTX_PREFIX_LIMIT_STR);
if(!ctx->ctx_prefix)
goto cleanup;
}
return ctx;
cleanup:
mw_free(ctx);
return NULL;
}
void mqtt_wss_log_ctx_destroy(mqtt_wss_log_ctx_t ctx)
{
mw_free(ctx->ctx_prefix);
mw_free(ctx->buffer);
mw_free(ctx);
}
static inline char severity_to_c(int severity)
{
switch (severity) {
case MQTT_WSS_LOG_FATAL:
return 'F';
case MQTT_WSS_LOG_ERROR:
return 'E';
case MQTT_WSS_LOG_WARN:
return 'W';
case MQTT_WSS_LOG_INFO:
return 'I';
case MQTT_WSS_LOG_DEBUG:
return 'D';
default:
return '?';
}
}
void mws_log(int severity, mqtt_wss_log_ctx_t ctx, const char *fmt, va_list args)
{
size_t size;
if(ctx->extern_log_fnc) {
size = vsnprintf(ctx->buffer_w_ptr, ctx->buffer_bytes_avail, fmt, args);
*(ctx->buffer_w_ptr - 3) = severity_to_c(severity);
ctx->extern_log_fnc(severity, ctx->buffer);
if(size >= ctx->buffer_bytes_avail)
mws_error(ctx, "Last message of this type was truncated! Consider what you log or increase LOG_BUFFER_SIZE if really needed.");
return;
}
if(ctx->ctx_prefix)
printf("[%s] ", ctx->ctx_prefix);
printf("%c: ", severity_to_c(severity));
vprintf(fmt, args);
putchar('\n');
}
#define DEFINE_MWS_SEV_FNC(severity_fncname, severity) \
void mws_ ## severity_fncname(mqtt_wss_log_ctx_t ctx, const char *fmt, ...) \
{ \
va_list args; \
va_start(args, fmt); \
mws_log(severity, ctx, fmt, args); \
va_end(args); \
}
DEFINE_MWS_SEV_FNC(fatal, MQTT_WSS_LOG_FATAL)
DEFINE_MWS_SEV_FNC(error, MQTT_WSS_LOG_ERROR)
DEFINE_MWS_SEV_FNC(warn, MQTT_WSS_LOG_WARN )
DEFINE_MWS_SEV_FNC(info, MQTT_WSS_LOG_INFO )
DEFINE_MWS_SEV_FNC(debug, MQTT_WSS_LOG_DEBUG)

100
mqtt_websockets/src/test.c Normal file
View file

@ -0,0 +1,100 @@
// Copyright (C) 2020 Timotej Šiškovič
// SPDX-License-Identifier: GPL-3.0-only
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <https://www.gnu.org/licenses/>.
#include <unistd.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "mqtt_wss_client.h"
int test_exit = 0;
int port = 0;
void mqtt_wss_log_cb(mqtt_wss_log_type_t log_type, const char* str)
{
(void)log_type;
puts(str);
}
#define TEST_MSGLEN_MAX 512
void msg_callback(const char *topic, const void *msg, size_t msglen, int qos)
{
char cmsg[TEST_MSGLEN_MAX];
size_t len = (msglen < TEST_MSGLEN_MAX - 1) ? msglen : (TEST_MSGLEN_MAX - 1);
memcpy(cmsg,
msg,
len);
cmsg[len] = 0;
if (!strcmp(cmsg, "shutdown"))
test_exit = 1;
printf("Got Message From Broker Topic \"%s\" QOS %d MSG: \"%s\"\n", topic, qos, cmsg);
}
#define TESTMSG "Hello World!"
int client_handle(mqtt_wss_client client)
{
struct mqtt_connect_params params = {
.clientid = "test",
.username = "anon",
.password = "anon",
.keep_alive = 10
};
/* struct mqtt_wss_proxy proxy = {
.host = "127.0.0.1",
.port = 3128,
.type = MQTT_WSS_PROXY_HTTP
};*/
while (mqtt_wss_connect(client, "127.0.0.1", port, &params, MQTT_WSS_SSL_ALLOW_SELF_SIGNED, NULL /*&proxy*/)) {
printf("Connect failed\n");
sleep(1);
printf("Attempting Reconnect\n");
}
printf("Connection succeeded\n");
mqtt_wss_subscribe(client, "test", 1);
while (!test_exit) {
if(mqtt_wss_service(client, -1) < 0)
return 1;
}
return 0;
}
int main(int argc, char **argv)
{
if (argc >= 2)
port = atoi(argv[1]);
if (!port)
port = 9002;
printf("Using port %d\n", port);
mqtt_wss_client client = mqtt_wss_new("main", mqtt_wss_log_cb, msg_callback, NULL);
if (!client) {
printf("Couldn't initialize mqtt_wss\n");
return 1;
}
while (!test_exit) {
printf("client_handle = %d\n", client_handle(client));
}
if (test_exit) {
mqtt_wss_disconnect(client, 2000);
}
mqtt_wss_destroy(client);
return 0;
}

744
mqtt_websockets/src/ws_client.c Normal file
View file

@ -0,0 +1,744 @@
// Copyright (C) 2020 Timotej Šiškovič
// SPDX-License-Identifier: GPL-3.0-only
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <https://www.gnu.org/licenses/>.
#include <fcntl.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
#include <ctype.h>
#include <openssl/evp.h>
#include "ws_client.h"
#include "common_internal.h"
#ifdef MQTT_WEBSOCKETS_DEBUG
#include "../c-rbuf/src/ringbuffer_internal.h"
#endif
#define UNIT_LOG_PREFIX "ws_client: "
#define FATAL(fmt, ...) mws_fatal(client->log, UNIT_LOG_PREFIX fmt, ##__VA_ARGS__)
#define ERROR(fmt, ...) mws_error(client->log, UNIT_LOG_PREFIX fmt, ##__VA_ARGS__)
#define WARN(fmt, ...) mws_warn (client->log, UNIT_LOG_PREFIX fmt, ##__VA_ARGS__)
#define INFO(fmt, ...) mws_info (client->log, UNIT_LOG_PREFIX fmt, ##__VA_ARGS__)
#define DEBUG(fmt, ...) mws_debug(client->log, UNIT_LOG_PREFIX fmt, ##__VA_ARGS__)
const char *websocket_upgrage_hdr = "GET /mqtt HTTP/1.1\x0D\x0A"
"Host: %s\x0D\x0A"
"Upgrade: websocket\x0D\x0A"
"Connection: Upgrade\x0D\x0A"
"Sec-WebSocket-Key: %s\x0D\x0A"
"Origin: http://example.com\x0D\x0A"
"Sec-WebSocket-Protocol: mqtt\x0D\x0A"
"Sec-WebSocket-Version: 13\x0D\x0A\x0D\x0A";
const char *mqtt_protoid = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
#define DEFAULT_RINGBUFFER_SIZE (1024*128)
#define ENTROPY_SOURCE "/dev/urandom"
ws_client *ws_client_new(size_t buf_size, char **host, mqtt_wss_log_ctx_t log)
{
ws_client *client;
if(!host)
return NULL;
client = mw_calloc(1, sizeof(ws_client));
if (!client)
return NULL;
client->host = host;
client->log = log;
client->buf_read = rbuf_create(buf_size ? buf_size : DEFAULT_RINGBUFFER_SIZE);
if (!client->buf_read)
goto cleanup;
client->buf_write = rbuf_create(buf_size ? buf_size : DEFAULT_RINGBUFFER_SIZE);
if (!client->buf_write)
goto cleanup_1;
client->buf_to_mqtt = rbuf_create(buf_size ? buf_size : DEFAULT_RINGBUFFER_SIZE);
if (!client->buf_to_mqtt)
goto cleanup_2;
client->entropy_fd = open(ENTROPY_SOURCE, O_RDONLY);
if (client->entropy_fd < 1) {
ERROR("Error opening entropy source \"" ENTROPY_SOURCE "\". Reason: \"%s\"", strerror(errno));
goto cleanup_3;
}
return client;
cleanup_3:
rbuf_free(client->buf_to_mqtt);
cleanup_2:
rbuf_free(client->buf_write);
cleanup_1:
rbuf_free(client->buf_read);
cleanup:
mw_free(client);
return NULL;
}
void ws_client_free_headers(ws_client *client)
{
struct http_header *ptr = client->hs.headers;
struct http_header *tmp;
while (ptr) {
tmp = ptr;
ptr = ptr->next;
mw_free(tmp);
}
client->hs.headers = NULL;
client->hs.headers_tail = NULL;
client->hs.hdr_count = 0;
}
void ws_client_destroy(ws_client *client)
{
ws_client_free_headers(client);
mw_free(client->hs.nonce_reply);
mw_free(client->hs.http_reply_msg);
close(client->entropy_fd);
rbuf_free(client->buf_read);
rbuf_free(client->buf_write);
rbuf_free(client->buf_to_mqtt);
mw_free(client);
}
void ws_client_reset(ws_client *client)
{
ws_client_free_headers(client);
mw_free(client->hs.nonce_reply);
client->hs.nonce_reply = NULL;
mw_free(client->hs.http_reply_msg);
client->hs.http_reply_msg = NULL;
rbuf_flush(client->buf_read);
rbuf_flush(client->buf_write);
rbuf_flush(client->buf_to_mqtt);
client->state = WS_RAW;
client->hs.hdr_state = WS_HDR_HTTP;
client->rx.parse_state = WS_FIRST_2BYTES;
}
#define MAX_HTTP_HDR_COUNT 128
int ws_client_add_http_header(ws_client *client, struct http_header *hdr)
{
if (client->hs.hdr_count > MAX_HTTP_HDR_COUNT) {
ERROR("Too many HTTP response header fields");
return -1;
}
if (client->hs.headers)
client->hs.headers_tail->next = hdr;
else
client->hs.headers = hdr;
client->hs.headers_tail = hdr;
client->hs.hdr_count++;
return 0;
}
int ws_client_want_write(ws_client *client)
{
return rbuf_bytes_available(client->buf_write);
}
#define RAND_SRC "/dev/urandom"
static int ws_client_get_nonce(ws_client *client, char *dest, unsigned int size)
{
// we do not need crypto secure random here
// it's just used for protocol negotiation
int rd;
int f = open(RAND_SRC, O_RDONLY);
if (f < 0) {
ERROR("Error opening \"%s\". Err: \"%s\"", RAND_SRC, strerror(errno));
return -2;
}
if ((rd = read(f, dest, size)) > 0) {
close(f);
return rd;
}
close(f);
return -1;
}
#define WEBSOCKET_NONCE_SIZE 16
#define TEMP_BUF_SIZE 4096
int ws_client_start_handshake(ws_client *client)
{
char nonce[WEBSOCKET_NONCE_SIZE];
char nonce_b64[256];
char second[TEMP_BUF_SIZE];
unsigned int md_len;
unsigned char *digest;
EVP_MD_CTX *md_ctx;
const EVP_MD *md;
if(!*client->host) {
ERROR("Hostname has not been set. We should not be able to come here!");
return 1;
}
ws_client_get_nonce(client, nonce, WEBSOCKET_NONCE_SIZE);
EVP_EncodeBlock((unsigned char *)nonce_b64, (const unsigned char *)nonce, WEBSOCKET_NONCE_SIZE);
snprintf(second, TEMP_BUF_SIZE, websocket_upgrage_hdr,
*client->host,
nonce_b64);
if(rbuf_bytes_free(client->buf_write) < strlen(second)) {
ERROR("Write buffer capacity too low.");
return 1;
}
rbuf_push(client->buf_write, second, strlen(second));
client->state = WS_HANDSHAKE;
//Calculating expected Sec-WebSocket-Accept reply
snprintf(second, TEMP_BUF_SIZE, "%s%s", nonce_b64, mqtt_protoid);
#if (OPENSSL_VERSION_NUMBER < OPENSSL_VERSION_110)
md_ctx = EVP_MD_CTX_create();
#else
md_ctx = EVP_MD_CTX_new();
#endif
if (md_ctx == NULL) {
ERROR("Cant create EVP_MD Context");
return 1;
}
md = EVP_get_digestbyname("sha1");
if (!md) {
ERROR("Unknown message digest");
return 1;
}
if ((digest = (unsigned char *)OPENSSL_malloc(EVP_MD_size(EVP_sha256()))) == NULL) {
ERROR("Cant alloc digest");
return 1;
}
EVP_DigestInit_ex(md_ctx, md, NULL);
EVP_DigestUpdate(md_ctx, second, strlen(second));
EVP_DigestFinal_ex(md_ctx, digest, &md_len);
EVP_EncodeBlock((unsigned char *)nonce_b64, digest, md_len);
mw_free(client->hs.nonce_reply);
client->hs.nonce_reply = mw_strdup(nonce_b64);
OPENSSL_free(digest);
#if (OPENSSL_VERSION_NUMBER < OPENSSL_VERSION_110)
EVP_MD_CTX_destroy(md_ctx);
#else
EVP_MD_CTX_free(md_ctx);
#endif
return 0;
}
#define BUF_READ_MEMCMP_CONST(const, err) \
if (rbuf_memcmp_n(client->buf_read, const, strlen(const))) { \
ERROR(err); \
rbuf_flush(client->buf_read); \
return WS_CLIENT_PROTOCOL_ERROR; \
}
#define BUF_READ_CHECK_AT_LEAST(x) \
if (rbuf_bytes_available(client->buf_read) < x) \
return WS_CLIENT_NEED_MORE_BYTES;
#define MAX_HTTP_LINE_LENGTH 1024*4
#define HTTP_SC_LENGTH 4 // "XXX " http status code as C string
#define WS_CLIENT_HTTP_HDR "HTTP/1.1 "
#define WS_CONN_ACCEPT "sec-websocket-accept"
#define HTTP_HDR_SEPARATOR ": "
#define WS_NONCE_STRLEN_B64 28
#define WS_HTTP_NEWLINE "\r\n"
#define HTTP_HEADER_NAME_MAX_LEN 256
#if HTTP_HEADER_NAME_MAX_LEN > MAX_HTTP_LINE_LENGTH
#error "Buffer too small"
#endif
#if WS_NONCE_STRLEN_B64 > MAX_HTTP_LINE_LENGTH
#error "Buffer too small"
#endif
#define HTTP_HDR_LINE_CHECK_LIMIT(x) if ((x) >= MAX_HTTP_LINE_LENGTH) \
{ \
ERROR("HTTP line received is too long. Maximum is %d", MAX_HTTP_LINE_LENGTH); \
return WS_CLIENT_PROTOCOL_ERROR; \
}
int ws_client_parse_handshake_resp(ws_client *client)
{
char buf[HTTP_SC_LENGTH];
int idx_crlf, idx_sep;
char *ptr;
size_t bytes;
switch (client->hs.hdr_state) {
case WS_HDR_HTTP:
BUF_READ_CHECK_AT_LEAST(strlen(WS_CLIENT_HTTP_HDR))
BUF_READ_MEMCMP_CONST(WS_CLIENT_HTTP_HDR, "Expected \"HTTP1.1\" header");
rbuf_bump_tail(client->buf_read, strlen(WS_CLIENT_HTTP_HDR));
client->hs.hdr_state = WS_HDR_RC;
break;
case WS_HDR_RC:
BUF_READ_CHECK_AT_LEAST(HTTP_SC_LENGTH); // "XXX " http return code
rbuf_pop(client->buf_read, buf, HTTP_SC_LENGTH);
if (buf[HTTP_SC_LENGTH - 1] != 0x20) {
ERROR("HTTP status code received is not terminated by space (0x20)");
return WS_CLIENT_PROTOCOL_ERROR;
}
buf[HTTP_SC_LENGTH - 1] = 0;
client->hs.http_code = atoi(buf);
if (client->hs.http_code < 100 || client->hs.http_code >= 600) {
ERROR("HTTP status code received not in valid range 100-600");
return WS_CLIENT_PROTOCOL_ERROR;
}
client->hs.hdr_state = WS_HDR_ENDLINE;
break;
case WS_HDR_ENDLINE:
ptr = rbuf_find_bytes(client->buf_read, WS_HTTP_NEWLINE, strlen(WS_HTTP_NEWLINE), &idx_crlf);
if (!ptr) {
bytes = rbuf_bytes_available(client->buf_read);
HTTP_HDR_LINE_CHECK_LIMIT(bytes);
return WS_CLIENT_NEED_MORE_BYTES;
}
HTTP_HDR_LINE_CHECK_LIMIT(idx_crlf);
client->hs.http_reply_msg = mw_malloc(idx_crlf+1);
rbuf_pop(client->buf_read, client->hs.http_reply_msg, idx_crlf);
client->hs.http_reply_msg[idx_crlf] = 0;
rbuf_bump_tail(client->buf_read, strlen(WS_HTTP_NEWLINE));
client->hs.hdr_state = WS_HDR_PARSE_HEADERS;
break;
case WS_HDR_PARSE_HEADERS:
ptr = rbuf_find_bytes(client->buf_read, WS_HTTP_NEWLINE, strlen(WS_HTTP_NEWLINE), &idx_crlf);
if (!ptr) {
bytes = rbuf_bytes_available(client->buf_read);
HTTP_HDR_LINE_CHECK_LIMIT(bytes);
return WS_CLIENT_NEED_MORE_BYTES;
}
HTTP_HDR_LINE_CHECK_LIMIT(idx_crlf);
if (!idx_crlf) { // empty line, header end
rbuf_bump_tail(client->buf_read, strlen(WS_HTTP_NEWLINE));
client->hs.hdr_state = WS_HDR_PARSE_DONE;
return 0;
}
ptr = rbuf_find_bytes(client->buf_read, HTTP_HDR_SEPARATOR, strlen(HTTP_HDR_SEPARATOR), &idx_sep);
if (!ptr || idx_sep > idx_crlf) {
ERROR("Expected HTTP hdr field key/value separator \": \" before endline in non empty HTTP header line");
return WS_CLIENT_PROTOCOL_ERROR;
}
if (idx_crlf == idx_sep + (int)strlen(HTTP_HDR_SEPARATOR)) {
ERROR("HTTP Header value cannot be empty");
return WS_CLIENT_PROTOCOL_ERROR;
}
if (idx_sep > HTTP_HEADER_NAME_MAX_LEN) {
ERROR("HTTP header too long (%d)", idx_sep);
return WS_CLIENT_PROTOCOL_ERROR;
}
struct http_header *hdr = mw_calloc(1, sizeof(struct http_header) + idx_crlf); //idx_crlf includes ": " that will be used as 2 \0 bytes
hdr->key = ((char*)hdr) + sizeof(struct http_header);
hdr->value = hdr->key + idx_sep + 1;
bytes = rbuf_pop(client->buf_read, hdr->key, idx_sep);
rbuf_bump_tail(client->buf_read, strlen(HTTP_HDR_SEPARATOR));
bytes = rbuf_pop(client->buf_read, hdr->value, idx_crlf - idx_sep - strlen(HTTP_HDR_SEPARATOR));
rbuf_bump_tail(client->buf_read, strlen(WS_HTTP_NEWLINE));
for (int i = 0; hdr->key[i]; i++)
hdr->key[i] = tolower(hdr->key[i]);
// DEBUG("HTTP header \"%s\" received. Value \"%s\"", hdr->key, hdr->value);
if (ws_client_add_http_header(client, hdr))
return WS_CLIENT_PROTOCOL_ERROR;
if (!strcmp(hdr->key, WS_CONN_ACCEPT)) {
if (strcmp(client->hs.nonce_reply, hdr->value)) {
ERROR("Received NONCE \"%s\" does not match expected nonce of \"%s\"", hdr->value, client->hs.nonce_reply);
return WS_CLIENT_PROTOCOL_ERROR;
}
client->hs.nonce_matched = 1;
}
break;
case WS_HDR_PARSE_DONE:
if (!client->hs.nonce_matched) {
ERROR("Missing " WS_CONN_ACCEPT " header");
return WS_CLIENT_PROTOCOL_ERROR;
}
if (client->hs.http_code != 101) {
ERROR("HTTP return code not 101. Received %d with msg \"%s\".", client->hs.http_code, client->hs.http_reply_msg);
return WS_CLIENT_PROTOCOL_ERROR;
}
client->state = WS_ESTABLISHED;
client->hs.hdr_state = WS_HDR_ALL_DONE;
INFO("Websocket Connection Accepted By Server");
return WS_CLIENT_PARSING_DONE;
case WS_HDR_ALL_DONE:
FATAL("This is error we should never come here!");
return WS_CLIENT_PROTOCOL_ERROR;
}
return 0;
}
#define BYTE_MSB 0x80
#define WS_FINAL_FRAG BYTE_MSB
#define WS_PAYLOAD_MASKED BYTE_MSB
static inline size_t get_ws_hdr_size(size_t payload_size)
{
size_t hdr_len = 2 + 4 /*mask*/;
if(payload_size > 125)
hdr_len += 2;
if(payload_size > 65535)
hdr_len += 6;
return hdr_len;
}
#define MAX_POSSIBLE_HDR_LEN 14
int ws_client_send(ws_client *client, enum websocket_opcode frame_type, const char *data, size_t size)
{
// TODO maybe? implement fragmenting, it is not necessary though
// as both tested MQTT brokers have no reuirement of one MQTT envelope
// be equal to one WebSockets envelope. Therefore there is no need to send
// one big MQTT message as single fragmented WebSocket envelope
char hdr[MAX_POSSIBLE_HDR_LEN];
char *ptr = hdr;
char *mask;
int size_written = 0;
size_t j = 0;
size_t w_buff_free = rbuf_bytes_free(client->buf_write);
size_t hdr_len = get_ws_hdr_size(size);
if (w_buff_free < hdr_len * 2) {
#ifdef DEBUG_ULTRA_VERBOSE
DEBUG("Write buffer full. Can't write requested %d size.", size);
#endif
return 0;
}
if (w_buff_free < (hdr_len + size)) {
#ifdef DEBUG_ULTRA_VERBOSE
DEBUG("Can't write whole MQTT packet of %d bytes into the buffer. Will do partial send of %d.", size, w_buff_free - hdr_len);
#endif
size = w_buff_free - hdr_len;
hdr_len = get_ws_hdr_size(size);
// the actual needed header size might decrease if we cut number of bytes
// if decrease of size crosses 65535 or 125 boundary
// but I can live with that at least for now
// worst case is we have 6 more bytes we could have written
// no bigus dealus
}
*ptr++ = frame_type | WS_FINAL_FRAG;
//generate length
*ptr = WS_PAYLOAD_MASKED;
if (size > 65535) {
*ptr++ |= 0x7f;
uint64_t be = htobe64(size);
memcpy(ptr, (void *)&be, sizeof(be));
ptr += sizeof(be);
} else if (size > 125) {
*ptr++ |= 0x7e;
uint16_t be = htobe16(size);
memcpy(ptr, (void *)&be, sizeof(be));
ptr += sizeof(be);
} else
*ptr++ |= size;
mask = ptr;
if (read(client->entropy_fd, mask, sizeof(uint32_t)) < (ssize_t)sizeof(uint32_t)) {
ERROR("Unable to get mask from \"" ENTROPY_SOURCE "\"");
return -2;
}
rbuf_push(client->buf_write, hdr, hdr_len);
if (!size)
return 0;
// copy and mask data in the write ringbuffer
while (size - size_written) {
size_t writable_bytes;
char *w_ptr = rbuf_get_linear_insert_range(client->buf_write, &writable_bytes);
if(!writable_bytes)
break;
writable_bytes = (writable_bytes > size) ? (size - size_written) : writable_bytes;
memcpy(w_ptr, &data[size_written], writable_bytes);
rbuf_bump_head(client->buf_write, writable_bytes);
for (size_t i = 0; i < writable_bytes; i++, j++)
w_ptr[i] ^= mask[j % 4];
size_written += writable_bytes;
}
return size_written;
}
static int check_opcode(ws_client *client,enum websocket_opcode oc)
{
switch(oc) {
case WS_OP_BINARY_FRAME:
case WS_OP_CONNECTION_CLOSE:
case WS_OP_PING:
return 0;
case WS_OP_CONTINUATION_FRAME:
FATAL("WS_OP_CONTINUATION_FRAME NOT IMPLEMENTED YET!!!!");
return 0;
case WS_OP_TEXT_FRAME:
FATAL("WS_OP_TEXT_FRAME NOT IMPLEMENTED YET!!!!");
return 0;
case WS_OP_PONG:
FATAL("WS_OP_PONG NOT IMPLEMENTED YET!!!!");
return 0;
default:
return WS_CLIENT_PROTOCOL_ERROR;
}
}
static inline void ws_client_rx_post_hdr_state(ws_client *client)
{
switch(client->rx.opcode) {
case WS_OP_BINARY_FRAME:
client->rx.parse_state = WS_PAYLOAD_DATA;
return;
case WS_OP_CONNECTION_CLOSE:
client->rx.parse_state = WS_PAYLOAD_CONNECTION_CLOSE;
return;
case WS_OP_PING:
client->rx.parse_state = WS_PAYLOAD_PING_REQ_PAYLOAD;
return;
default:
client->rx.parse_state = WS_PAYLOAD_SKIP_UNKNOWN_PAYLOAD;
return;
}
}
#define LONGEST_POSSIBLE_HDR_PART 8
int ws_client_process_rx_ws(ws_client *client)
{
char buf[LONGEST_POSSIBLE_HDR_PART];
size_t size;
switch (client->rx.parse_state) {
case WS_FIRST_2BYTES:
BUF_READ_CHECK_AT_LEAST(2);
rbuf_pop(client->buf_read, buf, 2);
client->rx.opcode = buf[0] & (char)~BYTE_MSB;
if (!(buf[0] & (char)~WS_FINAL_FRAG)) {
ERROR("Not supporting fragmented messages yet!");
return WS_CLIENT_PROTOCOL_ERROR;
}
if (check_opcode(client, client->rx.opcode) == WS_CLIENT_PROTOCOL_ERROR)
return WS_CLIENT_PROTOCOL_ERROR;
if (buf[1] & (char)WS_PAYLOAD_MASKED) {
ERROR("Mask is not allowed in Server->Client Websocket direction.");
return WS_CLIENT_PROTOCOL_ERROR;
}
switch (buf[1]) {
case 127:
client->rx.parse_state = WS_PAYLOAD_EXTENDED_64;
break;
case 126:
client->rx.parse_state = WS_PAYLOAD_EXTENDED_16;
break;
default:
client->rx.payload_length = buf[1];
ws_client_rx_post_hdr_state(client);
}
break;
case WS_PAYLOAD_EXTENDED_16:
BUF_READ_CHECK_AT_LEAST(2);
rbuf_pop(client->buf_read, buf, 2);
client->rx.payload_length = be16toh(*((uint16_t *)buf));
ws_client_rx_post_hdr_state(client);
break;
case WS_PAYLOAD_EXTENDED_64:
BUF_READ_CHECK_AT_LEAST(LONGEST_POSSIBLE_HDR_PART);
rbuf_pop(client->buf_read, buf, LONGEST_POSSIBLE_HDR_PART);
client->rx.payload_length = be64toh(*((uint64_t *)buf));
ws_client_rx_post_hdr_state(client);
break;
case WS_PAYLOAD_DATA:
// TODO not pretty?
while (client->rx.payload_processed < client->rx.payload_length) {
size_t remaining = client->rx.payload_length - client->rx.payload_processed;
if (!rbuf_bytes_available(client->buf_read))
return WS_CLIENT_NEED_MORE_BYTES;
char *insert = rbuf_get_linear_insert_range(client->buf_to_mqtt, &size);
if (!insert) {
#ifdef DEBUG_ULTRA_VERBOSE
DEBUG("BUFFER TOO FULL. Avail %d req %d", (int)size, (int)remaining);
#endif
return WS_CLIENT_BUFFER_FULL;
}
size = (size > remaining) ? remaining : size;
size = rbuf_pop(client->buf_read, insert, size);
rbuf_bump_head(client->buf_to_mqtt, size);
client->rx.payload_processed += size;
}
client->rx.parse_state = WS_PACKET_DONE;
break;
case WS_PAYLOAD_CONNECTION_CLOSE:
// for WS_OP_CONNECTION_CLOSE allowed is
// a) empty payload
// b) 2byte reason code
// c) 2byte reason code followed by message
if (client->rx.payload_length == 1) {
ERROR("WebScoket CONNECTION_CLOSE can't have payload of size 1");
return WS_CLIENT_PROTOCOL_ERROR;
}
if (!client->rx.payload_length) {
INFO("WebSocket server closed the connection without giving reason.");
client->rx.parse_state = WS_PACKET_DONE;
break;
}
client->rx.parse_state = WS_PAYLOAD_CONNECTION_CLOSE_EC;
break;
case WS_PAYLOAD_CONNECTION_CLOSE_EC:
BUF_READ_CHECK_AT_LEAST(sizeof(uint16_t));
rbuf_pop(client->buf_read, buf, sizeof(uint16_t));
client->rx.specific_data.op_close.ec = be16toh(*((uint16_t *)buf));
client->rx.payload_processed += sizeof(uint16_t);
if(client->rx.payload_processed == client->rx.payload_length) {
INFO("WebSocket server closed the connection with EC=%d. Without message.",
client->rx.specific_data.op_close.ec);
client->rx.parse_state = WS_PACKET_DONE;
break;
}
client->rx.parse_state = WS_PAYLOAD_CONNECTION_CLOSE_MSG;
break;
case WS_PAYLOAD_CONNECTION_CLOSE_MSG:
if (!client->rx.specific_data.op_close.reason)
client->rx.specific_data.op_close.reason = mw_malloc(client->rx.payload_length + 1);
while (client->rx.payload_processed < client->rx.payload_length) {
if (!rbuf_bytes_available(client->buf_read))
return WS_CLIENT_NEED_MORE_BYTES;
client->rx.payload_processed += rbuf_pop(client->buf_read,
&client->rx.specific_data.op_close.reason[client->rx.payload_processed - sizeof(uint16_t)],
client->rx.payload_length - client->rx.payload_processed);
}
client->rx.specific_data.op_close.reason[client->rx.payload_length] = 0;
INFO("WebSocket server closed the connection with EC=%d and reason \"%s\"",
client->rx.specific_data.op_close.ec,
client->rx.specific_data.op_close.reason);
mw_free(client->rx.specific_data.op_close.reason);
client->rx.specific_data.op_close.reason = NULL;
client->rx.parse_state = WS_PACKET_DONE;
break;
case WS_PAYLOAD_SKIP_UNKNOWN_PAYLOAD:
BUF_READ_CHECK_AT_LEAST(client->rx.payload_length);
WARN("Skipping Websocket Packet of unsupported/unknown type");
if (client->rx.payload_length)
rbuf_bump_tail(client->buf_read, client->rx.payload_length);
client->rx.parse_state = WS_PACKET_DONE;
return WS_CLIENT_PARSING_DONE;
case WS_PAYLOAD_PING_REQ_PAYLOAD:
if (client->rx.payload_length > rbuf_get_capacity(client->buf_read) / 2) {
ERROR("Ping arrived with payload which is too big!");
return WS_CLIENT_INTERNAL_ERROR;
}
BUF_READ_CHECK_AT_LEAST(client->rx.payload_length);
client->rx.specific_data.ping_msg = mw_malloc(client->rx.payload_length);
rbuf_pop(client->buf_read, client->rx.specific_data.ping_msg, client->rx.payload_length);
// TODO schedule this instead of sending right away
// then attempt to send as soon as buffer space clears up
size = ws_client_send(client, WS_OP_PONG, client->rx.specific_data.ping_msg, client->rx.payload_length);
if (size != client->rx.payload_length) {
ERROR("Unable to send the PONG as one packet back. Closing connection.");
return WS_CLIENT_PROTOCOL_ERROR;
}
client->rx.parse_state = WS_PACKET_DONE;
return WS_CLIENT_PARSING_DONE;
case WS_PACKET_DONE:
client->rx.parse_state = WS_FIRST_2BYTES;
client->rx.payload_processed = 0;
if (client->rx.opcode == WS_OP_CONNECTION_CLOSE)
return WS_CLIENT_CONNECTION_CLOSED;
return WS_CLIENT_PARSING_DONE;
default:
FATAL("Unknown parse state");
return WS_CLIENT_INTERNAL_ERROR;
}
return 0;
}
int ws_client_process(ws_client *client)
{
int ret;
switch(client->state) {
case WS_RAW:
if (ws_client_start_handshake(client))
return WS_CLIENT_INTERNAL_ERROR;
return WS_CLIENT_NEED_MORE_BYTES;
case WS_HANDSHAKE:
do {
ret = ws_client_parse_handshake_resp(client);
if (ret == WS_CLIENT_PROTOCOL_ERROR)
client->state = WS_ERROR;
if (ret == WS_CLIENT_PARSING_DONE && client->state == WS_ESTABLISHED)
ret = WS_CLIENT_NEED_MORE_BYTES;
} while (!ret);
break;
case WS_ESTABLISHED:
do {
ret = ws_client_process_rx_ws(client);
switch(ret) {
case WS_CLIENT_PROTOCOL_ERROR:
client->state = WS_ERROR;
break;
case WS_CLIENT_CONNECTION_CLOSED:
client->state = WS_CONN_CLOSED_GRACEFUL;
break;
}
// if ret == 0 we can continue parsing
// if ret == WS_CLIENT_PARSING_DONE we processed
// one websocket packet and attempt processing
// next one if data available in the buffer
} while (!ret || ret == WS_CLIENT_PARSING_DONE);
break;
case WS_ERROR:
ERROR("ws_client is in error state. Restart the connection!");
return WS_CLIENT_PROTOCOL_ERROR;
case WS_CONN_CLOSED_GRACEFUL:
ERROR("Connection has been gracefully closed. Calling this is useless (and probably bug) until you reconnect again.");
return WS_CLIENT_CONNECTION_CLOSED;
default:
FATAL("Unknown connection state! Probably memory corruption.");
return WS_CLIENT_INTERNAL_ERROR;
}
return ret;
}