diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..26b37e7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +bin +build +lib +gen/**/*.pb.cc +gen/**/*.pb.h +gen/roah_rsbb_msgs.h +CMakeCache.txt +CMakeFiles +cmake_install.cmake +Makefile +*~ +**/*~ +*.orig +**/*.orig +.kdev4 +*.kdev4 +.kdev_include_paths +.cproject +.project diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..e8ff414 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,15 @@ +cmake_minimum_required (VERSION 2.8.7) +project (RoAH_RSBB_Comm) + +set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) +set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) + +add_definitions("-std=c++0x") + +add_subdirectory(gen/roah_rsbb_msgs/) +add_subdirectory(libs/) +add_subdirectory(include/) +include_directories(${INCLUDE_DIRS}) + +add_executable(capture_comm src/capture_comm.cpp) +target_link_libraries(capture_comm roah_rsbb_msgs protobuf_comm) diff --git a/README.md b/README.md new file mode 100644 index 0000000..7638586 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +RoAH RSBB Comm +============== + +This repository contains the basic files needed to communicate with +the RoCKIn@Home Referee, Scoring and Benchmarking Box. + +Here are provided: + +- The proto files used to communicate; +- A reduced version of the protobuf_comm library by Tim Niemueller +(http://www.robocup-logistics.org/refbox), containing only the files +needed to communicate over UDP; +- A C++ header to ease the task of communicating specifically with +RoAH RSBB. + + +## Dependencies + +You need to have installed a C++11 compiler, CMake, Boost, Protobuf +and OpenSSL. + +If you are using Ubuntu, install the dependencies with: +``` +sudo apt-get install build-essential cmake libboost-all-dev libprotoc-dev libssl-dev +``` + +This was tested with Ubuntu 12.04.5 LTS (Precise Pangolin) and +14.04.1 LTS (Trusty Tahr). + +## Compiling + +To compile, use: +``` +cmake . +make +``` + +Two libraries will be compiled, that you can use on your projects: +``` +lib/libroah_rsbb_msgs.a +lib/libprotobuf_comm.a +``` + +## Using roah_rsbb.h + +This C++ header file provides a small decorator on top of +protobuf_comm specifically for RoAH. The classes `PublicChannel` and +`PrivateChannel` adapt the use of each channel specifically. They +provide a pooling interface for the last messages of the allowed +types received on each channel as well as a specific signal for each +one. Be careful with synchronization, the callbacks will be called +from different threads. diff --git a/cleanup b/cleanup new file mode 100755 index 0000000..348fab7 --- /dev/null +++ b/cleanup @@ -0,0 +1,51 @@ +#!/bin/bash + +DIRS="include src" +SOURCE_FILES=`find -L $DIRS -iname "*\.[ch]pp" -or -iname "*\.[ch]" | grep -v "/\."` +HEADER_FILES=`find -L $DIRS -iname "*\.hpp" -or -iname "*\.h" | grep -v "/\."` + + +# astyle +if [ "$(astyle -V 2>&1)" != "Artistic Style Version 2.04" ]; then + echo "Please update astyle to version 2.04:" + echo + echo 'mkdir -p $HOME/bin/ &&' + echo 'cd /tmp &&' + echo 'wget -c -T 20 -t 20 -O "astyle_2.04_linux.tar.gz" \' + echo '"http://sourceforge.net/projects/astyle/files/astyle/astyle%202.04/astyle_2.04_linux.tar.gz/download" &&' + echo 'tar xavf astyle_*_linux.tar.* &&' + echo 'cd astyle/build/gcc/ &&' + echo 'make -j5 &&' + echo 'cp bin/astyle $HOME/bin/ &&' + echo 'cd ../../.. &&' + echo 'rm -rfv astyle &&' + echo 'cd' + echo + exit 2 +fi +astyle -s2 -A8 -C -S -N -L -w -y -p -d -U -c -E -j -H -k1 -Y $SOURCE_FILES + + +# Empty lines +echo At least one empty line at and of files +sed -n '1x;1!H;${x;s/$/\n/;p}' -i $SOURCE_FILES +echo At least three empty lines between functions +echo Only one empty line before \#include +echo No empty lines at beginning of blocks +echo No empty lines at end of blocks +echo No empty lines at beginning of files +echo One empty line at end of files +sed -n '1x;1!H;${x;s/\([^\n]\)\n\{2,3\}\([^\n]\)/\1\n\n\n\n\2/g;s/\n\n\n*#include/\n\n#include/g;s/{\(\n *\)*\n/{\n/g;s/\(\n *\)*\n\( *\)}/\n\2}/g;s/^\n*//;s/\n*$//;p}' -i $SOURCE_FILES +echo Only one empty line before \#ifndef in hpps +echo Only one empty line before \#endif in hpps +sed -n '1x;1!H;${x;s/\n\n\n*#ifndef/\n\n#ifndef/g;s/\n\n\n*#endif/\n\n#endif/g;p}' -i $HEADER_FILES + + +# remove spaces in empty lines +astyle -s2 -A8 -C -S -N -L -w -y -p -d -U -c -j -H -k1 -Y $SOURCE_FILES + + +# remove garbage +find -L -name "*~" -print -delete +find -L -name "*\.orig" -print -delete +find -L -name "#*#" -print -delete diff --git a/gen/roah_rsbb_msgs/CMakeLists.txt b/gen/roah_rsbb_msgs/CMakeLists.txt new file mode 100644 index 0000000..ef2e685 --- /dev/null +++ b/gen/roah_rsbb_msgs/CMakeLists.txt @@ -0,0 +1,18 @@ +find_package(Protobuf REQUIRED) +include_directories(${PROTOBUF_INCLUDE_DIRS}) + +file(GLOB ROAH_RSBB_MSGS_PROTOS ${CMAKE_CURRENT_SOURCE_DIR}/../../proto/*.proto) +protobuf_generate_cpp(RSBB_PROTO_SRCS RSBB_PROTO_HDRS ${ROAH_RSBB_MSGS_PROTOS}) +add_library(roah_rsbb_msgs STATIC ${RSBB_PROTO_SRCS}) +target_link_libraries(roah_rsbb_msgs ${PROTOBUF_LIBRARIES}) + +set(ROAH_RSBB_MSGS_HPP "${CMAKE_CURRENT_BINARY_DIR}/../roah_rsbb_msgs.h") +file(REMOVE ${ROAH_RSBB_MSGS_HPP}) +foreach(PB_H ${RSBB_PROTO_HDRS}) + get_filename_component(FILE_PB_H ${PB_H} NAME) + file(APPEND ${ROAH_RSBB_MSGS_HPP} "#include \"roah_rsbb_msgs/${FILE_PB_H}\"\n") +endforeach() + +include_directories(${CMAKE_CURRENT_BINARY_DIR}/../) + +set(INCLUDE_DIRS ${INCLUDE_DIRS} ${CMAKE_CURRENT_BINARY_DIR}/../ PARENT_SCOPE) diff --git a/gpl.txt b/gpl.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/gpl.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/include/CMakeLists.txt b/include/CMakeLists.txt new file mode 100644 index 0000000..7a480ee --- /dev/null +++ b/include/CMakeLists.txt @@ -0,0 +1 @@ +set(INCLUDE_DIRS ${INCLUDE_DIRS} ${CMAKE_CURRENT_SOURCE_DIR} PARENT_SCOPE) diff --git a/include/roah_rsbb.h b/include/roah_rsbb.h new file mode 100644 index 0000000..daec0f7 --- /dev/null +++ b/include/roah_rsbb.h @@ -0,0 +1,379 @@ +/* + * Copyright 2014 Instituto de Sistemas e Robotica, Instituto Superior Tecnico + * + * This file is part of RoAH RSBB Comm. + * + * RoAH RSBB Comm is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * RoAH RSBB Comm 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with RoAH RSBB Comm. If not, see . + */ + +#ifndef __ROAH_RSBB_H__ +#define __ROAH_RSBB_H__ + +#include + +#include + +#include "roah_rsbb_msgs.h" + + + +namespace roah_rsbb +{ + void + now (::roah_rsbb_msgs::Time* time_msg) + { + boost::posix_time::ptime now = boost::posix_time::microsec_clock::universal_time(); + boost::posix_time::time_duration diff = now - boost::posix_time::from_time_t (0); + time_msg->set_sec (diff.total_seconds()); +#if defined(BOOST_DATE_TIME_HAS_NANOSECONDS) + time_msg->set_nsec (diff.fractional_seconds()); +#else + time_msg->set_nsec (diff.fractional_seconds() * 1000); +#endif + } + + + + class CerrErrorHandler + { + public: + CerrErrorHandler (std::string const& name, + protobuf_comm::ProtobufBroadcastPeer& channel) : + name_ (name) + { + channel.signal_recv_error().connect (boost::bind (&CerrErrorHandler::recv_error, this, _1, _2)); + channel.signal_send_error().connect (boost::bind (&CerrErrorHandler::send_error, this, _1)); + } + + void + unknown_msg (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + std::shared_ptr msg) + { + std::cerr << "On channel " << name_ + << ": Unknown message from " << endpoint.address().to_string() + << ":" << endpoint.port() + << ", COMP_ID " << comp_id + << ", MSG_TYPE " << msg_type + << ", of type " << typeid (*msg).name() << std::endl << std::flush; + } + + private: + std::string name_; + + void + recv_error (boost::asio::ip::udp::endpoint& endpoint, + std::string msg) + { + std::cerr << "On channel " << name_ + << ": Receive error from " << endpoint.address().to_string() + << ":" << endpoint.port() + << ": " << msg << std::endl << std::flush; + } + + void + send_error (std::string msg) + { + std::cerr << "On channel " << name_ + << ": Send error: " << msg << std::endl << std::flush; + } + }; + + + + template + class Channel : + public protobuf_comm::ProtobufBroadcastPeer + { + public: + Channel (std::string const& name, + std::string const& host, + unsigned short port) : + protobuf_comm::ProtobufBroadcastPeer (host, port), + name_ (name), + host_ (host), + port_ (port), + error_handler_ (name, *this) + { + signal_received().connect (boost::bind (&Channel::recv_msg_base, this, _1, _2, _3, _4)); + } + + Channel (std::string const& name, + std::string const& host, + unsigned short port, + std::string const& key, + std::string const& cypher) : + protobuf_comm::ProtobufBroadcastPeer (host, port, key, cypher), + name_ (name), + host_ (host), + port_ (port), + error_handler_ (name, *this) + { + signal_received().connect (boost::bind (&Channel::recv_msg_base, this, _1, _2, _3, _4)); + } + + std::string const& name() const + { + return name_; + } + + std::string const& host() const + { + return host_; + } + + unsigned short port() const + { + return port_; + } + + protected: + virtual bool + recv_msg (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + std::shared_ptr msg) = 0; + + private: + std::string name_; + std::string host_; + unsigned short port_; + ErrorHandler error_handler_; + + void + recv_msg_base (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + std::shared_ptr msg) + { + if (! recv_msg (endpoint, comp_id, msg_type, msg)) { + error_handler_.unknown_msg (endpoint, comp_id, msg_type, msg); + } + } + }; + + + + template + class PublicChannel : + public Channel + { + public: + PublicChannel (std::string const& host, + unsigned short port) : + Channel ("roah_rsbb::PublicChannel(" + host + ":" + boost::lexical_cast (port) + ")", host, port) + { + protobuf_comm::MessageRegister& mr = this->message_register(); + mr.add_message_type(); + mr.add_message_type(); + } + + typedef + boost::signals2::signal) > + signal_robot_beacon_received_type; + + signal_robot_beacon_received_type& signal_robot_beacon_received() + { + return signal_robot_beacon_received_; + } + + std::shared_ptr + last_robot_beacon() const + { + std::shared_ptr ret; + { + std::lock_guard lock (robot_beacon_mutex_); + ret = last_robot_beacon_; + } + return ret; + } + + typedef + boost::signals2::signal) > + signal_rsbb_beacon_received_type; + + signal_rsbb_beacon_received_type& signal_rsbb_beacon_received() + { + return signal_rsbb_beacon_received_; + } + + std::shared_ptr + last_rsbb_beacon() const + { + std::shared_ptr ret; + { + std::lock_guard lock (rsbb_beacon_mutex_); + ret = last_rsbb_beacon_; + } + return ret; + } + + private: + signal_robot_beacon_received_type signal_robot_beacon_received_; + std::mutex robot_beacon_mutex_; + std::shared_ptr last_robot_beacon_; + + signal_rsbb_beacon_received_type signal_rsbb_beacon_received_; + std::mutex rsbb_beacon_mutex_; + std::shared_ptr last_rsbb_beacon_; + + bool + recv_msg (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + std::shared_ptr msg) + { + auto robot_beacon = std::dynamic_pointer_cast (msg); + if (robot_beacon) { + { + std::lock_guard lock (robot_beacon_mutex_); + last_robot_beacon_ = robot_beacon; + } + + signal_robot_beacon_received_ (endpoint, comp_id, msg_type, robot_beacon); + + return true; + } + + auto rsbb_beacon = std::dynamic_pointer_cast (msg); + if (rsbb_beacon) { + { + std::lock_guard lock (rsbb_beacon_mutex_); + last_rsbb_beacon_ = rsbb_beacon; + } + + signal_rsbb_beacon_received_ (endpoint, comp_id, msg_type, rsbb_beacon); + + return true; + } + + return false; + } + }; + + + template + class PrivateChannel : + public Channel + { + public: + PrivateChannel (std::string const& host, + unsigned short port, + std::string const& key, + std::string const& cypher) : + Channel ("roah_rsbb::PrivateChannel(" + host + ":" + boost::lexical_cast (port) + ")", host, port, key, cypher) + { + protobuf_comm::MessageRegister& mr = this->message_register(); + mr.add_message_type(); + mr.add_message_type(); + } + + typedef + boost::signals2::signal) > + signal_benchmark_state_received_type; + + signal_benchmark_state_received_type& signal_benchmark_state_received() + { + return signal_benchmark_state_received_; + } + + std::shared_ptr + last_benchmark_state() const + { + std::shared_ptr ret; + { + std::lock_guard lock (benchmark_state_mutex_); + ret = last_benchmark_state_; + } + return ret; + } + + typedef + boost::signals2::signal) > + signal_robot_state_received_type; + + signal_robot_state_received_type& signal_robot_state_received() + { + return signal_robot_state_received_; + } + + std::shared_ptr + last_robot_state() const + { + std::shared_ptr ret; + { + std::lock_guard lock (robot_state_mutex_); + ret = last_robot_state_; + } + return ret; + } + + private: + signal_benchmark_state_received_type signal_benchmark_state_received_; + std::mutex benchmark_state_mutex_; + std::shared_ptr last_benchmark_state_; + + signal_robot_state_received_type signal_robot_state_received_; + std::mutex robot_state_mutex_; + std::shared_ptr last_robot_state_; + + bool + recv_msg (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + std::shared_ptr msg) + { + auto benchmark_state = std::dynamic_pointer_cast (msg); + if (benchmark_state) { + { + std::lock_guard lock (benchmark_state_mutex_); + last_benchmark_state_ = benchmark_state; + } + + signal_benchmark_state_received_ (endpoint, comp_id, msg_type, benchmark_state); + + return true; + } + + auto robot_state = std::dynamic_pointer_cast (msg); + if (robot_state) { + { + std::lock_guard lock (robot_state_mutex_); + last_robot_state_ = robot_state; + } + + signal_robot_state_received_ (endpoint, comp_id, msg_type, robot_state); + + return true; + } + + return false; + } + }; +} + +#endif diff --git a/lgpl.txt b/lgpl.txt new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/lgpl.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. diff --git a/libs/CMakeLists.txt b/libs/CMakeLists.txt new file mode 100644 index 0000000..a94f3a9 --- /dev/null +++ b/libs/CMakeLists.txt @@ -0,0 +1,15 @@ +find_package(Boost 1.46.1 REQUIRED thread system) +include_directories(${Boost_INCLUDE_DIRS}) +link_directories(${Boost_LIBRARY_DIRS}) + +find_package(OpenSSL REQUIRED) +include_directories(${OPENSSL_INCLUDE_DIR}) +add_definitions("-DHAVE_LIBCRYPTO") + +include_directories(${CMAKE_CURRENT_SOURCE_DIR}) + +file(GLOB PROTOBUF_COMM_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/protobuf_comm/*.cpp) +add_library(protobuf_comm STATIC ${PROTOBUF_COMM_SOURCES}) +target_link_libraries(protobuf_comm ${OPENSSL_LIBRARIES} ${Boost_LIBRARIES}) + +set(INCLUDE_DIRS ${INCLUDE_DIRS} ${CMAKE_CURRENT_SOURCE_DIR} PARENT_SCOPE) diff --git a/libs/protobuf_comm/crypto.cpp b/libs/protobuf_comm/crypto.cpp new file mode 100644 index 0000000..d42aead --- /dev/null +++ b/libs/protobuf_comm/crypto.cpp @@ -0,0 +1,349 @@ + +/*************************************************************************** + * crypto.cpp - Protobuf stream protocol - crypto utils + * + * Created: Tue Mar 11 21:14:58 2014 + * Copyright 2014 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include +#include + +#include +#ifdef HAVE_LIBCRYPTO +# include +# include +# include +# include +#endif + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + +/** @class BufferEncryptor + * Encrypt buffers using AES128 in ECB mode. + * @author Tim Niemueller + */ + +/** Constructor. + * @param key encryption key, can be any string, will be processed to meet + * the cipher's requirements. + * @param cipher_name Cipher combination to use, currently supported are + * aes-128-ecb, aes-128-cbc, aes-256-ecb, and aes-256-cbc + */ +BufferEncryptor::BufferEncryptor(const std::string &key, std::string cipher_name) +{ + cipher_ = cipher_by_name(cipher_name.c_str()); + cipher_id_ = cipher_name_to_id(cipher_name.c_str()); + + const size_t key_size = EVP_CIPHER_key_length(cipher_); + const size_t iv_size = EVP_CIPHER_iv_length(cipher_); + key_ = (unsigned char *)malloc(key_size); + unsigned char iv[iv_size]; + if( ! EVP_BytesToKey(cipher_, EVP_sha256(), NULL, + (const unsigned char *)key.c_str(), key.size(), 8, key_, iv)) + { + throw std::runtime_error("Failed to generate key"); + } + + if (!RAND_bytes((unsigned char *)&iv_, sizeof(iv_))) { + throw std::runtime_error("Failed to generate IV"); + } +} + + +/** Destructor. */ +BufferEncryptor::~BufferEncryptor() +{ + free(key_); +} + + +/** Encrypt a buffer. + * Uses the cipher set in the constructor. + * @param plain plain text data + * @param enc upon return contains encrypted buffer + */ +void +BufferEncryptor::encrypt(const std::string &plain, std::string &enc) +{ +#ifdef HAVE_LIBCRYPTO + const EVP_CIPHER *evp_cipher = cipher_by_id(cipher_id_); + + const size_t iv_size = EVP_CIPHER_iv_length(evp_cipher); + unsigned char iv_hash[SHA256_DIGEST_LENGTH]; + + unsigned char *enc_m = (unsigned char *)enc.c_str(); + + if (iv_size > 0) { + iv_ += 1; + + if (! SHA256((unsigned char *)&iv_, sizeof(iv_), iv_hash)) { + throw std::runtime_error("Failed to generate IV"); + } + enc.replace(0, iv_size, (char *)iv_hash, iv_size); + enc_m += iv_size; + } + + EVP_CIPHER_CTX ctx; + if ( ! EVP_EncryptInit(&ctx, evp_cipher, key_, iv_hash)) + { + throw std::runtime_error("Could not initialize cipher context"); + } + + int outl = enc.size() - iv_size; + if ( ! EVP_EncryptUpdate(&ctx, enc_m, &outl, + (unsigned char *)plain.c_str(), plain.size()) ) + { + throw std::runtime_error("EncryptUpdate failed"); + } + + int plen = 0; + if ( ! EVP_EncryptFinal_ex(&ctx, enc_m + outl, &plen) ) { + throw std::runtime_error("EncryptFinal failed"); + } + outl += plen; + + enc.resize(outl + iv_size); +#else + throw std::runtime_error("Encryption support not available"); +#endif + +} + + +/** Get required size for an encrypted buffer of the given plain text length. + * @param plain_length length of the plain text buffer to encrypt + * @return length of encrypted buffer required + */ +size_t +BufferEncryptor::encrypted_buffer_size(size_t plain_length) +{ +#ifdef HAVE_LIBCRYPTO + const EVP_CIPHER *evp_cipher = cipher_by_id(cipher_id_); + + const size_t iv_size = EVP_CIPHER_iv_length(evp_cipher); + size_t block_size = EVP_CIPHER_block_size(evp_cipher); + + return (((plain_length / block_size) + 1) * block_size) + iv_size; +#else + throw std::runtime_error("Encryption not supported"); +#endif +} + + +/** @class BufferDecryptor + * Decrypt buffers encrypted with BufferEncryptor. + * @author Tim Niemueller + */ + + +/** Constructor. + * @param key encryption key, can be any string, will be processed to meet + * AES128 requirements. + */ +BufferDecryptor::BufferDecryptor(const std::string &key) + : key_(key) +{ +} + + +/** Destructor. */ +BufferDecryptor::~BufferDecryptor() +{ +} + + +void +BufferDecryptor::generate_key(int cipher) +{ + const EVP_CIPHER *evp_cipher = cipher_by_id(cipher); + + const size_t key_size = EVP_CIPHER_key_length(evp_cipher); + const size_t iv_size = EVP_CIPHER_iv_length(evp_cipher); + unsigned char *key = (unsigned char *)malloc(key_size); + unsigned char iv[iv_size]; + if( ! EVP_BytesToKey(evp_cipher, EVP_sha256(), NULL, + (const unsigned char *)key_.c_str(), key_.size(), 8, key, iv)) + { + free(key); + throw std::runtime_error("Failed to generate key"); + } + + std::string ks((const char *)key, key_size); + free(key); + + keys_[cipher] = ks; +} + + +/** Decrypt a buffer. + * @param cipher cipher ID + * @param enc encrypted buffer + * @param enc_size number of bytes in @p enc + * @param plain on return contains plain text data + * @param plain_size size in bytes of @p plain + * @return number of bytes that were in the encrypted buffer (this can be shorter if the data + * did not exactly fit the AES block size. + */ +size_t +BufferDecryptor::decrypt(int cipher, const void *enc, size_t enc_size, void *plain, size_t plain_size) +{ +#ifdef HAVE_LIBCRYPTO + if (keys_.find(cipher) == keys_.end()) { + generate_key(cipher); + } + + const EVP_CIPHER *evp_cipher = cipher_by_id(cipher); + + const size_t iv_size = EVP_CIPHER_iv_length(evp_cipher); + const unsigned char *iv = (const unsigned char *)enc; + unsigned char *enc_m = (unsigned char *)enc + iv_size; + enc_size -= iv_size; + + EVP_CIPHER_CTX ctx; + if ( ! EVP_DecryptInit(&ctx, evp_cipher, (const unsigned char *)keys_[cipher].c_str(), iv)) + { + throw std::runtime_error("Could not initialize cipher context"); + } + + int outl = plain_size; + if ( ! EVP_DecryptUpdate(&ctx, + (unsigned char *)plain, &outl, enc_m, enc_size)) + { + throw std::runtime_error("DecryptUpdate failed"); + } + + int plen = 0; + if ( ! EVP_DecryptFinal(&ctx, (unsigned char *)plain + outl, &plen) ) { + throw std::runtime_error("DecryptFinal failed"); + } + outl += plen; + + return outl; +#else + throw std::runtime_error("Decryption support not available"); +#endif +} + + +/** Get cipher name for PB_ENCRYPTION_* constants. + * @param cipher cipher ID + * @return string representing the cipher + */ +const char * +cipher_name_by_id(int cipher) +{ + switch (cipher) { + case PB_ENCRYPTION_AES_128_ECB: + return SN_aes_128_ecb; + case PB_ENCRYPTION_AES_128_CBC: + return SN_aes_128_cbc; + + case PB_ENCRYPTION_AES_256_ECB: + return SN_aes_256_ecb; + case PB_ENCRYPTION_AES_256_CBC: + return SN_aes_256_cbc; + + default: + throw std::runtime_error("Unknown cipher type"); + } +} + + +/** Get cipher for PB_ENCRYPTION_* constants. + * @param cipher cipher ID + * @return cipher engine + */ +const EVP_CIPHER * +cipher_by_id(int cipher) +{ + switch (cipher) { + case PB_ENCRYPTION_AES_128_ECB: + return EVP_aes_128_ecb(); + case PB_ENCRYPTION_AES_128_CBC: + return EVP_aes_128_cbc(); + + case PB_ENCRYPTION_AES_256_ECB: + return EVP_aes_256_ecb(); + case PB_ENCRYPTION_AES_256_CBC: + return EVP_aes_256_cbc(); + + default: + throw std::runtime_error("Unknown cipher type"); + } +} + +/** Get cipher by name constants. + * @param cipher cipher name + * @return cipher engine + */ +int +cipher_name_to_id(const char *cipher) +{ + if (strcmp(cipher, LN_aes_128_ecb) == 0) { + return PB_ENCRYPTION_AES_128_ECB; + } else if (strcmp(cipher, LN_aes_128_cbc) == 0) { + return PB_ENCRYPTION_AES_128_CBC; + } else if (strcmp(cipher, LN_aes_256_ecb) == 0) { + return PB_ENCRYPTION_AES_256_ECB; + } else if (strcmp(cipher, LN_aes_256_cbc) == 0) { + return PB_ENCRYPTION_AES_256_CBC; + } else { + throw std::runtime_error("Unknown cipher type"); + } +} + + +/** Get cipher by name constants. + * @param cipher cipher name + * @return cipher engine + */ +const EVP_CIPHER * +cipher_by_name(const char *cipher) +{ + if (strcmp(cipher, LN_aes_128_ecb) == 0) { + return EVP_aes_128_ecb(); + } else if (strcmp(cipher, LN_aes_128_cbc) == 0) { + return EVP_aes_128_cbc(); + } else if (strcmp(cipher, LN_aes_256_ecb) == 0) { + return EVP_aes_256_ecb(); + } else if (strcmp(cipher, LN_aes_256_cbc) == 0) { + return EVP_aes_256_cbc(); + } else { + throw std::runtime_error("Unknown cipher type"); + } +} + + +} // end namespace fawkes diff --git a/libs/protobuf_comm/crypto.h b/libs/protobuf_comm/crypto.h new file mode 100644 index 0000000..ade310f --- /dev/null +++ b/libs/protobuf_comm/crypto.h @@ -0,0 +1,101 @@ + +/*************************************************************************** + * crypto.h - Protobuf stream protocol - crypto utils + * + * Created: Tue Mar 11 21:12:35 2014 + * Copyright 2014 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __PROTOBUF_COMM_CRYPTO_H_ +#define __PROTOBUF_COMM_CRYPTO_H_ + +#include +#include + +#ifdef HAVE_LIBCRYPTO +# include +#endif + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + +class BufferEncryptor { + public: + BufferEncryptor(const std::string &key, std::string cipher_name = "AES-128-ECB"); + ~BufferEncryptor(); + + void encrypt(const std::string &plain, std::string &enc); + + /** Get cipher ID. + * @return cipher ID */ + int cipher_id() const + { return cipher_id_; } + + size_t encrypted_buffer_size(size_t plain_length); + + private: + unsigned char *key_; + long long unsigned int iv_; + + const EVP_CIPHER *cipher_; + + int cipher_id_; +}; + + +class BufferDecryptor { + public: + BufferDecryptor(const std::string &key); + ~BufferDecryptor(); + + size_t decrypt(int cipher, const void *enc, size_t enc_size, void *plain, size_t plain_size); + + private: + void generate_key(int cipher); + + private: + std::string key_; + std::map keys_; +}; + +const char * cipher_name_by_id(int cipher); +int cipher_name_to_id(const char *cipher); + +#ifdef HAVE_LIBCRYPTO +const EVP_CIPHER * cipher_by_id(int cipher); +const EVP_CIPHER * cipher_by_name(const char *cipher); +#endif + +} // end namespace fawkes + +#endif diff --git a/libs/protobuf_comm/frame_header.h b/libs/protobuf_comm/frame_header.h new file mode 100644 index 0000000..4d040a5 --- /dev/null +++ b/libs/protobuf_comm/frame_header.h @@ -0,0 +1,130 @@ + +/*************************************************************************** + * frame_header.h - Basic framing header or each message + * + * Created: Mon Jan 21 12:05:03 2013 + * Copyright 2013 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __PROTOBUF_COMM_FRAME_HEADER_H_ +#define __PROTOBUF_COMM_FRAME_HEADER_H_ + +#include + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + +#pragma pack(push,4) + +#define PB_ENCRYPTION_NONE 0x00 +#define PB_ENCRYPTION_AES_128_ECB 0x01 +#define PB_ENCRYPTION_AES_128_CBC 0x02 +#define PB_ENCRYPTION_AES_256_ECB 0x03 +#define PB_ENCRYPTION_AES_256_CBC 0x04 + +/** Network frame header version to use. + * V1 is the old version which for example is required to communicate with the + * LLSF Referee Box before RC2014 + * V2 supports data encryption. + */ +typedef enum { + PB_FRAME_V1 = 1, ///< Version 1 + PB_FRAME_V2 = 2 ///< Version 2 +} frame_header_version_t; + +/** Network framing header. + * Header that is prepended to all messages. The payload size does + * not include the size of the header. All numbers are given in + * network byte order (big endian). The encryption type can be set if + * encryption is used. If the mode requires an initialization vector + * (IV) it is appended directly after the frame header (and not + * counted in the payload size). + * @author Tim Niemueller + */ +typedef struct { + /// Frame header version + uint8_t header_version; + /// One of PB_ENCRYPTION_* + uint8_t cipher; + /// reserved for future use + uint8_t reserved_2; + /// reserved for future use + uint8_t reserved_3; + /// payload size in bytes + /// includes message and + /// header, _not_ IV + uint32_t payload_size; +} frame_header_t; + +/** Network message header. + * Header that is prepended to all messages. + * The component ID can be used to route a message to a particular + * software component. The component then can use the message type to + * determine how the message must be parse the payload. It is appended + * immediately following the header. The payload size does not include + * the size of the header. + * All numbers are given in network byte order (big endian). + * @author Tim Niemueller + */ +typedef struct { + /// component id + uint16_t component_id; + /// message type + uint16_t msg_type; +} message_header_t; + + +/** Old network message framing header. + * Header that is prepended to all messages. + * The component ID can be used to route a message to a particular + * software component. The component then can use the message type to + * determine how the message must be parse the payload. It is appended + * immediately following the header. The payload size does not include + * the size of the header. + * All numbers are given in network byte order (big endian). + * @author Tim Niemueller + */ +typedef struct { + /** component id */ + uint16_t component_id; + /** message type */ + uint16_t msg_type; + /** payload size in bytes */ + uint32_t payload_size; +} frame_header_v1_t; + +#pragma pack(pop) + +} // end namespace protobuf_comm + +#endif diff --git a/libs/protobuf_comm/message_register.cpp b/libs/protobuf_comm/message_register.cpp new file mode 100644 index 0000000..a6c56cd --- /dev/null +++ b/libs/protobuf_comm/message_register.cpp @@ -0,0 +1,317 @@ + +/*************************************************************************** + * message_register.cpp - Protobuf stream protocol - message register + * + * Created: Fri Feb 01 15:48:36 2013 + * Copyright 2013 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include + +#include +#include +#include +#include +#include +#include + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + + +/** @class MessageRegister + * Register to map msg type numbers to Protobuf messages. + * The register is used to automatically parse incoming messages to the + * appropriate type. In your application, you need to register any + * message you want to read. All unknown messages are silently dropped. + * @author Tim Niemueller + */ + +/** Constructor. */ +MessageRegister::MessageRegister() +{ + pb_srctree_ = NULL; + pb_importer_ = NULL; + pb_factory_ = NULL; +} + + +/** Constructor. + * @param proto_path file paths to search for proto files. All message types + * within these files will automatically be registered and available for dynamic + * message creation. + */ +MessageRegister::MessageRegister(std::vector &proto_path) +{ + pb_srctree_ = new google::protobuf::compiler::DiskSourceTree(); + for (size_t i = 0; i < proto_path.size(); ++i) { + pb_srctree_->MapPath("", proto_path[i]); + } + pb_importer_ = new google::protobuf::compiler::Importer(pb_srctree_, NULL); + pb_factory_ = new google::protobuf::DynamicMessageFactory(pb_importer_->pool()); + + for (size_t i = 0; i < proto_path.size(); ++i) { + DIR *dir; + struct dirent *ent; + if ((dir = opendir(proto_path[i].c_str())) != NULL) { + while ((ent = readdir(dir)) != NULL) { + if (fnmatch("*.proto", ent->d_name, FNM_PATHNAME) != FNM_NOMATCH) { + //printf ("%s\n", ent->d_name); + const google::protobuf::FileDescriptor *fd = + pb_importer_->Import(ent->d_name); + for (int i = 0; i < fd->message_type_count(); ++i) { + const google::protobuf::Descriptor *desc = fd->message_type(i); + //printf(" Type: %s\n", desc->full_name().c_str()); + if (! desc->FindEnumTypeByName("CompType")) continue; + + try { + add_message_type(desc->full_name()); + } catch (std::logic_error &e) { + // cannot open for some reason + failed_to_load_types_.insert(std::make_pair(desc->full_name(), e.what())); + } + } + } + } + closedir (dir); + } + } +} + +/** Destructor. */ +MessageRegister::~MessageRegister() +{ + TypeMap::iterator m; + for (m = message_by_comp_type_.begin(); m != message_by_comp_type_.end(); ++m) { + delete m->second; + } + delete pb_factory_; + delete pb_importer_; + delete pb_srctree_; +} + + +google::protobuf::Message * +MessageRegister::create_msg(std::string &msg_type) +{ + const google::protobuf::DescriptorPool *pool = + google::protobuf::DescriptorPool::generated_pool(); + google::protobuf::MessageFactory *factory = + google::protobuf::MessageFactory::generated_factory(); + + const google::protobuf::Descriptor *desc = pool->FindMessageTypeByName(msg_type); + if (desc) { + return factory->GetPrototype(desc)->New(); + } else if (pb_importer_) { + pool = pb_importer_->pool(); + factory = pb_factory_; + + const google::protobuf::Descriptor *cdesc = pool->FindMessageTypeByName(msg_type); + if (cdesc) { + return factory->GetPrototype(cdesc)->New(); + } + } + return NULL; +} + +/** Add a message type from generated pool. + * This will check all message libraries for a type of the given name + * and if found registers it. + * @param msg_type the full name of the message type to add, i.e. including + * a package name if the message type has one. The message must have been + * registered with either the generated messages pool or with the pool + * associated with the proto paths passed to the constructor. + */ +void +MessageRegister::add_message_type(std::string msg_type) +{ + google::protobuf::Message *m = create_msg(msg_type); + if (m) { + KeyType key = key_from_desc(m->GetDescriptor()); + std::lock_guard lock(maps_mutex_); + if (message_by_comp_type_.find(key) != message_by_comp_type_.end()) { + std::string msg = "Message type " + std::to_string(key.first) + ":" + + std::to_string(key.second) + " already registered"; + throw std::runtime_error(msg); + } + //printf("Registering %s (%u:%u)\n", msg_type.c_str(), key.first, key.second); + message_by_comp_type_[key] = m; + message_by_typename_[m->GetTypeName()] = m; + } else { + throw std::runtime_error("Unknown message type"); + } +} + + +/** Remove the given message type. + * @param component_id ID of component this message type belongs to + * @param msg_type message type + */ +void +MessageRegister::remove_message_type(uint16_t component_id, uint16_t msg_type) +{ + KeyType key(component_id, msg_type); + std::lock_guard lock(maps_mutex_); + if (message_by_comp_type_.find(key) != message_by_comp_type_.end()) { + message_by_typename_.erase(message_by_comp_type_[key]->GetDescriptor()->full_name()); + message_by_comp_type_.erase(key); + } +} + + +MessageRegister::KeyType +MessageRegister::key_from_desc(const google::protobuf::Descriptor *desc) +{ + const google::protobuf::EnumDescriptor *enumdesc = desc->FindEnumTypeByName("CompType"); + if (! enumdesc) { + throw std::logic_error("Message does not have CompType enum"); + } + const google::protobuf::EnumValueDescriptor *compdesc = + enumdesc->FindValueByName("COMP_ID"); + const google::protobuf::EnumValueDescriptor *msgtdesc = + enumdesc->FindValueByName("MSG_TYPE"); + if (! compdesc || ! msgtdesc) { + throw std::logic_error("Message CompType enum hs no COMP_ID or MSG_TYPE value"); + } + int comp_id = compdesc->number(); + int msg_type = msgtdesc->number(); + if (comp_id < 0 || comp_id > std::numeric_limits::max()) { + throw std::logic_error("Message has invalid COMP_ID"); + } + if (msg_type < 0 || msg_type > std::numeric_limits::max()) { + throw std::logic_error("Message has invalid MSG_TYPE"); + } + return KeyType(comp_id, msg_type); +} + +/** Create a new message instance. + * @param component_id ID of component this message type belongs to + * @param msg_type message type + * @return new instance of a protobuf message that has been registered + * for the given message type. + */ +std::shared_ptr +MessageRegister::new_message_for(uint16_t component_id, uint16_t msg_type) +{ + KeyType key(component_id, msg_type); + + std::lock_guard lock(maps_mutex_); + if (message_by_comp_type_.find(key) == message_by_comp_type_.end()) { + std::string msg = "Message type " + std::to_string(component_id) + ":" + + std::to_string(msg_type) + " not registered"; + throw std::runtime_error(msg); + } + + google::protobuf::Message *m = message_by_comp_type_[key]->New(); + return std::shared_ptr(m); +} + + +/** Create a new message instance. + * @param full_name full message type name, i.e. the message type name + * possibly with a package name prefix. + * @return new instance of a protobuf message that has been registered + * for the given message type. + */ +std::shared_ptr +MessageRegister::new_message_for(std::string &full_name) +{ + std::lock_guard lock(maps_mutex_); + if (message_by_typename_.find(full_name) == message_by_typename_.end()) { + google::protobuf::Message *m = create_msg(full_name); + if (m) { + return std::shared_ptr(m); + } else { + throw std::runtime_error("Message type not registered"); + } + } else { + google::protobuf::Message *m = message_by_typename_[full_name]->New(); + return std::shared_ptr(m); + } +} + + +/** Serialize a message. + * @param component_id ID of component this message type belongs to + * @param msg_type message type + * @param msg message to seialize + * @param frame_header upon return, the frame header is filled out according to + * the given information and message. + * @param message_header upon return, the frame header is filled out according to + * the given information and message. + * @param data upon return, contains the serialized message + */ +void +MessageRegister::serialize(uint16_t component_id, uint16_t msg_type, + google::protobuf::Message &msg, + frame_header_t &frame_header, + message_header_t &message_header, + std::string &data) +{ + if (msg.SerializeToString(&data)) { + message_header.component_id = htons(component_id); + message_header.msg_type = htons(msg_type); + frame_header.payload_size = htonl(sizeof(message_header) + data.size()); + } else { + throw std::runtime_error("Cannot serialize message"); + } +} + + +/** Deserialize message. + * @param frame_header incoming message's frame header + * @param message_header incoming message's message header + * @param data incoming message's data buffer + * @return new instance of a protobuf message type that has been registered + * for the given type. + * @exception std::runtime_error thrown if anything goes wrong when + * deserializing the message, e.g. if no protobuf message has been registered + * for the given component ID and message type. + */ +std::shared_ptr +MessageRegister::deserialize(frame_header_t &frame_header, message_header_t &message_header, void *data) +{ + uint16_t comp_id = ntohs(message_header.component_id); + uint16_t msg_type = ntohs(message_header.msg_type); + size_t data_size = ntohl(frame_header.payload_size) - sizeof(message_header); + + std::shared_ptr m = + new_message_for(comp_id, msg_type); + if (! m->ParseFromArray(data, data_size)) { + throw std::runtime_error("Failed to parse message"); + } + + return m; +} + +} // end namespace protobuf_comm diff --git a/libs/protobuf_comm/message_register.h b/libs/protobuf_comm/message_register.h new file mode 100644 index 0000000..7e61c32 --- /dev/null +++ b/libs/protobuf_comm/message_register.h @@ -0,0 +1,170 @@ + +/*************************************************************************** + * message_register.h - Protobuf stream protocol - message register + * + * Created: Fri Feb 01 15:43:36 2013 + * Copyright 2013 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __PROTOBUF_COMM_MESSAGE_REGISTER_H_ +#define __PROTOBUF_COMM_MESSAGE_REGISTER_H_ + +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +namespace google { + namespace protobuf { + namespace compiler { + class Importer; + class DiskSourceTree; + } + } +} + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + +class MessageRegister : boost::noncopyable +{ + public: + MessageRegister(); + MessageRegister(std::vector &proto_path); + ~MessageRegister(); + + void add_message_type(std::string msg_type); + + /** Add a new message type. + * The template parameter must be a sub-class of google::protobuf::Message. + * An instance is spawned and kept internally to spawn more on incoming messages. + * @param component_id ID of component this message type belongs to + * @param msg_type message type + */ + template + typename std::enable_if::value, void>::type + add_message_type(uint16_t component_id, uint16_t msg_type) + { + KeyType key(component_id, msg_type); + if (message_by_comp_type_.find(key) != message_by_comp_type_.end()) { + std::string msg = "Message type " + std::to_string(component_id) + ":" + + std::to_string(msg_type) + " already registered"; + throw std::runtime_error(msg); + } + MT *m = new MT(); + message_by_comp_type_[key] = m; + message_by_typename_[m->GetDescriptor()->full_name()] = m; + } + + /** Add a new message type. + * The template parameter must be a sub-class of google::protobuf::Message. + * An instance is spawned and kept internally to spawn more on incoming messages. + */ + template + typename std::enable_if::value, void>::type + add_message_type() + { + MT m; + const google::protobuf::Descriptor *desc = m.GetDescriptor(); + KeyType key = key_from_desc(desc); + if (message_by_comp_type_.find(key) != message_by_comp_type_.end()) { + std::string msg = "Message type " + std::to_string(key.first) + ":" + + std::to_string(key.second) + " already registered"; + throw std::runtime_error(msg); + } + MT *new_m = new MT(); + message_by_comp_type_[key] = new_m; + message_by_typename_[new_m->GetTypeName()] = new_m; + } + + void remove_message_type(uint16_t component_id, uint16_t msg_type); + + std::shared_ptr + new_message_for(uint16_t component_id, uint16_t msg_type); + + std::shared_ptr + new_message_for(std::string &full_name); + + void serialize(uint16_t component_id, uint16_t msg_type, + google::protobuf::Message &msg, + frame_header_t &frame_header, + message_header_t &message_header, + std::string &data); + std::shared_ptr + deserialize(frame_header_t &frame_header, + message_header_t &message_header, + void *data); + + /** Mapping from message type to load error message. */ + typedef std::multimap LoadFailMap; + + /** Get failure messages from loading. + * If the proto path constructor is used this function returns a list + * of loading errors after construction. + * @return map of loading failures + */ + const LoadFailMap & load_failures() const + { return failed_to_load_types_; } + + private: // members + typedef std::pair KeyType; + typedef std::map TypeMap; + typedef std::map TypeNameMap; + + KeyType key_from_desc(const google::protobuf::Descriptor *desc); + google::protobuf::Message * create_msg(std::string &msg_type); + + std::mutex maps_mutex_; + TypeMap message_by_comp_type_; + TypeNameMap message_by_typename_; + + google::protobuf::compiler::DiskSourceTree *pb_srctree_; + google::protobuf::compiler::Importer *pb_importer_; + google::protobuf::MessageFactory *pb_factory_; + std::multimap failed_to_load_types_; +}; + +} // end namespace protobuf_comm + + +#endif diff --git a/libs/protobuf_comm/peer.cpp b/libs/protobuf_comm/peer.cpp new file mode 100644 index 0000000..596847e --- /dev/null +++ b/libs/protobuf_comm/peer.cpp @@ -0,0 +1,695 @@ +/*************************************************************************** + * peer.cpp - Protobuf stream protocol - broadcast peer + * + * Created: Mon Feb 04 17:19:17 2013 + * Copyright 2013 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include +#include + +#include +#include + +using namespace boost::asio; +using namespace boost::system; + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + +/** @class ProtobufBroadcastPeer + * Communicate by broadcasting protobuf messages. + * This class allows to communicate via UDP by broadcasting messages to the + * network. + * @author Tim Niemueller + */ + +/** Constructor. + * @param address IPv4 broadcast address to send to + * @param port IPv4 UDP port to listen on and to send to + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, unsigned short port) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), port)) +{ + ctor(address, port); + message_register_ = new MessageRegister(); + own_message_register_ = true; +} + + +/** Testing constructor. + * This constructor listens and sends to different ports. It can be used to + * send and receive on the same host or even from within the same process. + * It is most useful for communication tests. + * @param address IPv4 address to send to + * @param send_to_port IPv4 UDP port to send data to + * @param recv_on_port IPv4 UDP port to receive data on + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, + unsigned short send_to_port, + unsigned short recv_on_port) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), recv_on_port)) +{ + ctor(address, send_to_port); + message_register_ = new MessageRegister(); + own_message_register_ = true; +} + +/** Constructor. + * @param address IPv4 broadcast address to send to + * @param port IPv4 UDP port to listen on and to send to + * @param proto_path list of file system paths where to look for proto files + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, unsigned short port, + std::vector &proto_path) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), port)) +{ + ctor(address, port); + message_register_ = new MessageRegister(proto_path); + own_message_register_ = true; +} + + +/** Testing constructor. + * This constructor listens and sends to different ports. It can be used to + * send and receive on the same host or even from within the same process. + * It is most useful for communication tests. + * @param address IPv4 address to send to + * @param send_to_port IPv4 UDP port to send data to + * @param recv_on_port IPv4 UDP port to receive data on + * @param proto_path list of file system paths where to look for proto files + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, + unsigned short send_to_port, + unsigned short recv_on_port, + std::vector &proto_path) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), recv_on_port)) +{ + ctor(address, send_to_port); + message_register_ = new MessageRegister(proto_path); + own_message_register_ = true; +} + + +/** Constructor. + * @param address IPv4 broadcast address to send to + * @param port IPv4 UDP port to listen on and to send to + * @param mr message register to query for message types + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, unsigned short port, + MessageRegister *mr) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), port)), + message_register_(mr), own_message_register_(false) +{ + ctor(address, port); +} + +/** Constructor with encryption. + * @param address IPv4 broadcast address to send to + * @param send_to_port IPv4 UDP port to send data to + * @param recv_on_port IPv4 UDP port to receive data on + * @param crypto_key encryption key for messages + * @param cipher cipher to use for encryption + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, + unsigned short send_to_port, unsigned short recv_on_port, + const std::string crypto_key, const std::string cipher) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), recv_on_port)) +{ + ctor(address, send_to_port, crypto_key, cipher); + message_register_ = new MessageRegister(); + own_message_register_ = true; +} + +/** Constructor with encryption. + * @param address IPv4 broadcast address to send to + * @param send_to_port IPv4 UDP port to send data to + * @param recv_on_port IPv4 UDP port to receive data on + * @param mr message register to query for message types + * @param crypto_key encryption key for messages + * @param cipher cipher to use for encryption + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, + unsigned short send_to_port, unsigned short recv_on_port, + MessageRegister *mr, + const std::string crypto_key, const std::string cipher) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), recv_on_port)), + message_register_(mr), own_message_register_(false) +{ + ctor(address, send_to_port, crypto_key, cipher); +} + +/** Constructor with encryption. + * @param address IPv4 broadcast address to send to + * @param port IPv4 UDP port to listen on and to send to + * @param crypto_key encryption key for messages + * @param cipher cipher to use for encryption + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, unsigned short port, + const std::string crypto_key, const std::string cipher) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), port)) +{ + ctor(address, port, crypto_key, cipher); + message_register_ = new MessageRegister(); + own_message_register_ = true; +} + +/** Constructor with encryption. + * @param address IPv4 broadcast address to send to + * @param port IPv4 UDP port to listen on and to send to + * @param mr message register to query for message types + * @param crypto_key encryption key for messages + * @param cipher cipher to use for encryption + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, unsigned short port, + MessageRegister *mr, + const std::string crypto_key, const std::string cipher) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), port)), + message_register_(mr), own_message_register_(false) +{ + ctor(address, port, crypto_key, cipher); +} + + +/** Testing constructor. + * This constructor listens and sends to different ports. It can be used to + * send and receive on the same host or even from within the same process. + * It is most useful for communication tests. + * @param address IPv4 address to send to + * @param send_to_port IPv4 UDP port to send data to + * @param recv_on_port IPv4 UDP port to receive data on + * @param mr message register to query for message types + * @param header_version which frame header version to send, use with caution + */ +ProtobufBroadcastPeer::ProtobufBroadcastPeer(const std::string address, + unsigned short send_to_port, + unsigned short recv_on_port, + MessageRegister *mr, + frame_header_version_t header_version) + : io_service_(), resolver_(io_service_), + socket_(io_service_, ip::udp::endpoint(ip::udp::v4(), recv_on_port)), + message_register_(mr), own_message_register_(false) +{ + ctor(address, send_to_port, "", "", header_version); +} + + +/** Constructor helper. + * @param address hostname/address to send to + * @param send_to_port UDP port to send messages to + * @param crypto_key encryption key for messages + * @param cipher cipher to use for encryption + * @þaram header_version which frame header version to send, use with caution + */ +void +ProtobufBroadcastPeer::ctor(const std::string &address, unsigned int send_to_port, + const std::string crypto_key, const std::string cipher, + frame_header_version_t header_version) +{ + filter_self_ = true; + crypto_ = false; + crypto_enc_ = NULL; + crypto_dec_ = NULL; + frame_header_version_ = header_version; + + in_data_size_ = max_packet_length; + in_data_ = malloc(in_data_size_); + enc_in_data_ = NULL; + + socket_.set_option(socket_base::broadcast(true)); + socket_.set_option(socket_base::reuse_address(true)); + determine_local_endpoints(); + + outbound_active_ = true; + ip::udp::resolver::query query(address, boost::lexical_cast(send_to_port)); + resolver_.async_resolve(query, + boost::bind(&ProtobufBroadcastPeer::handle_resolve, this, + boost::asio::placeholders::error, + boost::asio::placeholders::iterator)); + + if (! crypto_key.empty()) setup_crypto(crypto_key, cipher); + + start_recv(); + asio_thread_ = std::thread(&ProtobufBroadcastPeer::run_asio, this); +} + + +/** Destructor. */ +ProtobufBroadcastPeer::~ProtobufBroadcastPeer() +{ + if (asio_thread_.joinable()) { + io_service_.stop(); + asio_thread_.join(); + } + free(in_data_); + if (enc_in_data_) free(enc_in_data_); + if (own_message_register_) { + delete message_register_; + } + + delete crypto_enc_; + delete crypto_dec_; +} + + +/** Setup encryption. + * After this call communication will be encrypted. Note that the first + * received message might be considered invalid because we are still + * listening for plain text messages. To avoid this use the constructor + * which takes the encryption key as parameter. + * @param key encryption key + * @param cipher cipher to use for encryption + * @see BufferEncryptor for supported ciphers + */ +void +ProtobufBroadcastPeer::setup_crypto(const std::string &key, const std::string &cipher) +{ + if (frame_header_version_ == PB_FRAME_V1) { + throw std::runtime_error("Crypto support only available with V2+ frame header"); + } + + delete crypto_enc_; + delete crypto_dec_; + crypto_enc_ = NULL; + crypto_dec_ = NULL; + crypto_ = false; + crypto_buf_ = false; + + if (key != "" && cipher != "") { + crypto_enc_ = new BufferEncryptor(key, cipher); + + if (! enc_in_data_) { + // this depends on the cipher, but nothing is two times the incoming buffer... + enc_in_data_size_ = 2 * in_data_size_; + enc_in_data_ = malloc(enc_in_data_size_); + } + + crypto_dec_ = new BufferDecryptor(key); + crypto_ = true; + crypto_buf_ = false; + } +} + +void +ProtobufBroadcastPeer::determine_local_endpoints() +{ + struct ifaddrs *ifap; + if (getifaddrs(&ifap) == 0){ + for (struct ifaddrs *iter = ifap; iter != NULL; iter = iter->ifa_next){ + if (iter->ifa_addr == NULL) continue; + if (iter->ifa_addr->sa_family == AF_INET) { + boost::asio::ip::address_v4 + addr(ntohl(reinterpret_cast(iter->ifa_addr)->sin_addr.s_addr)); + + local_endpoints_.push_back( + boost::asio::ip::udp::endpoint(addr, socket_.local_endpoint().port())); + } + } + freeifaddrs(ifap); + } + local_endpoints_.sort(); +} + + +/** Set if to filter out own messages. + * @param filter true to filter out own messages, false to receive them + */ +void +ProtobufBroadcastPeer::set_filter_self(bool filter) +{ + filter_self_ = filter; +} + + +/** ASIO thread runnable. */ +void +ProtobufBroadcastPeer::run_asio() +{ +#if BOOST_ASIO_VERSION > 100409 + while (! io_service_.stopped()) { +#endif + usleep(0); + io_service_.reset(); + io_service_.run(); +#if BOOST_ASIO_VERSION > 100409 + } +#endif +} + + +void +ProtobufBroadcastPeer::handle_resolve(const boost::system::error_code& err, + ip::udp::resolver::iterator endpoint_iterator) +{ + if (! err) { + std::lock_guard lock(outbound_mutex_); + outbound_active_ = false; + outbound_endpoint_ = endpoint_iterator->endpoint(); + } else { + sig_send_error_("Resolving endpoint failed"); + } + start_send(); +} + +void +ProtobufBroadcastPeer::handle_recv(const boost::system::error_code& error, + size_t bytes_rcvd) +{ + const size_t expected_min_size = + (frame_header_version_ == PB_FRAME_V1) + ? sizeof(frame_header_v1_t) : (sizeof(frame_header_t) + sizeof(message_header_t)); + + if (!error && bytes_rcvd >= expected_min_size ) { + frame_header_t frame_header; + size_t header_size; + if (frame_header_version_ == PB_FRAME_V1) { + frame_header_v1_t *frame_header_v1 = static_cast(in_data_); + frame_header.header_version = PB_FRAME_V1; + frame_header.cipher = PB_ENCRYPTION_NONE; + frame_header.payload_size = frame_header_v1->payload_size; + header_size = sizeof(frame_header_v1_t); + } else { + memcpy(&frame_header, crypto_buf_ ? enc_in_data_ : in_data_, sizeof(frame_header_t)); + header_size = sizeof(frame_header_t); + + if (crypto_buf_) { + sig_rcvd_raw_(in_endpoint_, frame_header, + (unsigned char *)enc_in_data_ + sizeof(frame_header_t), + bytes_rcvd - sizeof(frame_header_t)); + } else { + sig_rcvd_raw_(in_endpoint_, frame_header, + (unsigned char *)in_data_ + sizeof(frame_header_t), + bytes_rcvd - sizeof(frame_header_t)); + } + + if (sig_rcvd_.num_slots() > 0) { + if (! crypto_buf_ && (frame_header.cipher != PB_ENCRYPTION_NONE)) { + sig_recv_error_(in_endpoint_, "Received encrypted message but encryption is disabled"); + } else if (crypto_buf_ && (frame_header.cipher == PB_ENCRYPTION_NONE)) { + sig_recv_error_(in_endpoint_, "Received plain text message but encryption is enabled"); + } else { + + if (crypto_buf_ && (frame_header.cipher != PB_ENCRYPTION_NONE)) { + // we need to decrypt first + try { + memcpy(in_data_, enc_in_data_, sizeof(frame_header_t)); + size_t to_decrypt = bytes_rcvd - sizeof(frame_header_t); + bytes_rcvd = crypto_dec_->decrypt(frame_header.cipher, + (unsigned char *)enc_in_data_ + sizeof(frame_header_t), to_decrypt, + (unsigned char *)in_data_ + sizeof(frame_header_t), in_data_size_); + frame_header.payload_size = htonl(bytes_rcvd); + bytes_rcvd += sizeof(frame_header_t); + } catch (std::runtime_error &e) { + sig_recv_error_(in_endpoint_, std::string("Decryption fail: ") + e.what()); + bytes_rcvd = 0; + } + } + } + } // else nobody cares about deserialized message + } + + size_t payload_size = ntohl(frame_header.payload_size); + + if (sig_rcvd_.num_slots() > 0) { + if (bytes_rcvd == (header_size + payload_size)) { + if (! filter_self_ || + ! std::binary_search(local_endpoints_.begin(), local_endpoints_.end(), in_endpoint_)) + { + void *data; + message_header_t message_header; + + if (frame_header_version_ == PB_FRAME_V1) { + frame_header_v1_t *frame_header_v1 = static_cast(in_data_); + message_header.component_id = frame_header_v1->component_id; + message_header.msg_type = frame_header_v1->msg_type; + data = (char *)in_data_ + sizeof(frame_header_v1_t); + // message register expects payload size to include message header + frame_header.payload_size = htonl(ntohl(frame_header.payload_size) + sizeof(message_header_t)); + } else { + message_header_t *msg_header = + static_cast((void*)((char *)in_data_ + sizeof(frame_header_t))); + message_header.component_id = msg_header->component_id; + message_header.msg_type = msg_header->msg_type; + data = (char *)in_data_ + sizeof(frame_header_t) + sizeof(message_header_t); + } + + uint16_t comp_id = ntohs(message_header.component_id); + uint16_t msg_type = ntohs(message_header.msg_type); + + try { + std::shared_ptr m = + message_register_->deserialize(frame_header, message_header, data); + + sig_rcvd_(in_endpoint_, comp_id, msg_type, m); + } catch (std::runtime_error &e) { + sig_recv_error_(in_endpoint_, std::string("Deserialization fail: ") + e.what()); + } + } + } else { + sig_recv_error_(in_endpoint_, "Invalid number of bytes received"); + } + } // else nobody cares (no one registered to signal) + + } else { + sig_recv_error_(in_endpoint_, "General receiving error or truncated message"); + } + + start_recv(); +} + + +void +ProtobufBroadcastPeer::handle_sent(const boost::system::error_code& error, + size_t bytes_transferred, QueueEntry *entry) +{ + delete entry; + + { + std::lock_guard lock(outbound_mutex_); + outbound_active_ = false; + } + + if (error) { + sig_send_error_("Sending message failed"); + } + + start_send(); +} + + +/** Send a message to other peers. + * @param component_id ID of the component to address + * @param msg_type numeric message type + * @param m message to send + */ +void +ProtobufBroadcastPeer::send(uint16_t component_id, uint16_t msg_type, + google::protobuf::Message &m) +{ + QueueEntry *entry = new QueueEntry(); + message_register_->serialize(component_id, msg_type, m, + entry->frame_header, entry->message_header, + entry->serialized_message); + + if (entry->serialized_message.size() > max_packet_length) { + throw std::runtime_error("Serialized message too big"); + } + + if (frame_header_version_ == PB_FRAME_V1) { + entry->frame_header_v1.component_id = entry->message_header.component_id; + entry->frame_header_v1.msg_type = entry->message_header.msg_type; + entry->frame_header_v1.payload_size = entry->frame_header.payload_size; + + entry->buffers[0] = boost::asio::buffer(&entry->frame_header_v1, sizeof(frame_header_v1_t)); + entry->buffers[1] = boost::asio::const_buffer(); + } else { + entry->buffers[0] = boost::asio::buffer(&entry->frame_header, sizeof(frame_header_t)); + entry->buffers[1] = boost::asio::buffer(&entry->message_header, sizeof(message_header_t)); + } + entry->buffers[2] = boost::asio::buffer(entry->serialized_message); + + { + std::lock_guard lock(outbound_mutex_); + outbound_queue_.push(entry); + } + start_send(); +} + +/** Send a raw message. + * The message is sent as-is (frame_header appended by message data) over the wire. + * @param frame_header frame header to prepend, must be completely and properly + * setup. + * @param data data buffer, maybe encrypted (if indicated in frame header) + * @param data_size size in bytes of @p data + */ +void +ProtobufBroadcastPeer::send_raw(const frame_header_t &frame_header, + const void *data, size_t data_size) +{ + QueueEntry *entry = new QueueEntry(); + entry->frame_header = frame_header; + entry->serialized_message = std::string(reinterpret_cast(data), data_size); + + entry->buffers[0] = boost::asio::buffer(&entry->frame_header, sizeof(frame_header_t)); + entry->buffers[1] = boost::asio::const_buffer(); + entry->buffers[2] = boost::asio::buffer(entry->serialized_message); + + { + std::lock_guard lock(outbound_mutex_); + outbound_queue_.push(entry); + } + start_send(); +} + + +/** Send a message to other peers. + * @param component_id ID of the component to address + * @param msg_type numeric message type + * @param m message to send + */ +void +ProtobufBroadcastPeer::send(uint16_t component_id, uint16_t msg_type, + std::shared_ptr m) +{ + send(component_id, msg_type, *m); +} + + +/** Send a message to other peers. + * @param m Message to send, the message must have an CompType enum type to + * specify component ID and message type. + */ +void +ProtobufBroadcastPeer::send(std::shared_ptr m) +{ + send(*m); +} + + +/** Send a message to other peers. + * @param m Message to send, the message must have an CompType enum type to + * specify component ID and message type. + */ +void +ProtobufBroadcastPeer::send(google::protobuf::Message &m) +{ + const google::protobuf::Descriptor *desc = m.GetDescriptor(); + const google::protobuf::EnumDescriptor *enumdesc = desc->FindEnumTypeByName("CompType"); + if (! enumdesc) { + throw std::logic_error("Message does not have CompType enum"); + } + const google::protobuf::EnumValueDescriptor *compdesc = + enumdesc->FindValueByName("COMP_ID"); + const google::protobuf::EnumValueDescriptor *msgtdesc = + enumdesc->FindValueByName("MSG_TYPE"); + if (! compdesc || ! msgtdesc) { + throw std::logic_error("Message CompType enum hs no COMP_ID or MSG_TYPE value"); + } + int comp_id = compdesc->number(); + int msg_type = msgtdesc->number(); + if (comp_id < 0 || comp_id > std::numeric_limits::max()) { + throw std::logic_error("Message has invalid COMP_ID"); + } + if (msg_type < 0 || msg_type > std::numeric_limits::max()) { + throw std::logic_error("Message has invalid MSG_TYPE"); + } + + send(comp_id, msg_type, m); +} + +void +ProtobufBroadcastPeer::start_recv() +{ + crypto_buf_ = crypto_; + socket_.async_receive_from(boost::asio::buffer(crypto_ ? enc_in_data_ : in_data_, in_data_size_), + in_endpoint_, + boost::bind(&ProtobufBroadcastPeer::handle_recv, + this, boost::asio::placeholders::error, + boost::asio::placeholders::bytes_transferred)); +} + +void +ProtobufBroadcastPeer::start_send() +{ + std::lock_guard lock(outbound_mutex_); + if (outbound_queue_.empty() || outbound_active_) return; + + outbound_active_ = true; + + QueueEntry *entry = outbound_queue_.front(); + outbound_queue_.pop(); + + if (crypto_) { + size_t plain_size = boost::asio::buffer_size(entry->buffers[1]) + + boost::asio::buffer_size(entry->buffers[2]); + size_t enc_size = crypto_enc_->encrypted_buffer_size(plain_size); + + std::string plain_buf = std::string(plain_size, '\0'); + + plain_buf.replace(0, + boost::asio::buffer_size(entry->buffers[1]), + boost::asio::buffer_cast(entry->buffers[1]), + boost::asio::buffer_size(entry->buffers[1])); + + plain_buf.replace(boost::asio::buffer_size(entry->buffers[1]), + boost::asio::buffer_size(entry->buffers[2]), + boost::asio::buffer_cast(entry->buffers[2]), + boost::asio::buffer_size(entry->buffers[2])); + + entry->encrypted_message.resize(enc_size); + crypto_enc_->encrypt(plain_buf, entry->encrypted_message); + + entry->frame_header.payload_size = htonl(entry->encrypted_message.size()); + entry->frame_header.cipher = crypto_enc_->cipher_id(); + entry->buffers[1] = boost::asio::buffer(entry->encrypted_message); + entry->buffers[2] = boost::asio::const_buffer(); + } + + socket_.async_send_to(entry->buffers, outbound_endpoint_, + boost::bind(&ProtobufBroadcastPeer::handle_sent, this, + boost::asio::placeholders::error, + boost::asio::placeholders::bytes_transferred, + entry)); +} + + +} // end namespace protobuf_comm diff --git a/libs/protobuf_comm/peer.h b/libs/protobuf_comm/peer.h new file mode 100644 index 0000000..257ce93 --- /dev/null +++ b/libs/protobuf_comm/peer.h @@ -0,0 +1,212 @@ + +/*************************************************************************** + * server.h - Protobuf stream protocol - broadcast peer + * + * Created: Wed Jan 30 16:41:22 2013 + * Copyright 2013 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __PROTOBUF_COMM_PEER_H_ +#define __PROTOBUF_COMM_PEER_H_ + +#include +#include +#include + +#include +#include +#include + +#include +#include +#include + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + +class BufferEncryptor; +class BufferDecryptor; + +class ProtobufBroadcastPeer +{ + public: + enum { max_packet_length = 1024 }; + + ProtobufBroadcastPeer(const std::string address, unsigned short port); + ProtobufBroadcastPeer(const std::string address, unsigned short send_to_port, + unsigned short recv_on_port); + ProtobufBroadcastPeer(const std::string address, unsigned short port, + std::vector &proto_path); + ProtobufBroadcastPeer(const std::string address, unsigned short send_to_port, + unsigned short recv_on_port, std::vector &proto_path); + ProtobufBroadcastPeer(const std::string address, unsigned short port, MessageRegister *mr); + ProtobufBroadcastPeer(const std::string address, unsigned short send_to_port, + unsigned short recv_on_port, MessageRegister *mr, + frame_header_version_t header_version = PB_FRAME_V2); + ProtobufBroadcastPeer(const std::string address, unsigned short port, + const std::string crypto_key, const std::string cipher = "aes-128-ecb"); + ProtobufBroadcastPeer(const std::string address, unsigned short port, MessageRegister *mr, + const std::string crypto_key, const std::string cipher = "aes-128-ecb"); + ProtobufBroadcastPeer(const std::string address, unsigned short send_to_port, + unsigned short recv_on_port, + const std::string crypto_key, const std::string cipher = "aes-128-ecb"); + ProtobufBroadcastPeer(const std::string address, unsigned short send_to_port, + unsigned short recv_on_port, MessageRegister *mr, + const std::string crypto_key, const std::string cipher = "aes-128-ecb"); + ~ProtobufBroadcastPeer(); + + void set_filter_self(bool filter); + + void send(uint16_t component_id, uint16_t msg_type, + google::protobuf::Message &m); + void send(uint16_t component_id, uint16_t msg_type, + std::shared_ptr m); + void send(std::shared_ptr m); + void send(google::protobuf::Message &m); + + void send_raw(const frame_header_t &frame_header, const void *data, size_t data_size); + + void setup_crypto(const std::string &key, const std::string &cipher); + + /** Get the server's message register. + * @return message register + */ + MessageRegister & message_register() + { return *message_register_; } + + /** Boost signal for a received message. */ + typedef + boost::signals2::signal)> + signal_received_type; + + /** Boost signal for a received raw message. */ + typedef + boost::signals2::signal + signal_received_raw_type; + + /** Boost signal for an error during receiving a message. */ + typedef + boost::signals2::signal + signal_recv_error_type; + + /** Boost signal for an error during sending a message. */ + typedef + boost::signals2::signal + signal_send_error_type; + + /** Signal that is invoked when a message has been received. + * @return signal + */ + signal_received_type & signal_received() + { return sig_rcvd_; } + + /** Signal that is invoked when a message has been received. + * This allows access to the raw packet data. This allows, for example, + * to write an ecryption agnostic repeater. + * @return signal + */ + signal_received_raw_type & signal_received_raw() + { return sig_rcvd_raw_; } + + /** Signal that is invoked when receiving a message failed. + * @return signal + */ + signal_recv_error_type & signal_recv_error() + { return sig_recv_error_; } + + /** Signal that is invoked when sending a message failed. + * @return signal + */ + signal_send_error_type & signal_send_error() + { return sig_send_error_; } + + + private: // methods + void ctor(const std::string &address, unsigned int send_to_port, + const std::string crypto_key = "", const std::string cipher = "aes-128-ecb", + frame_header_version_t = PB_FRAME_V2); + void determine_local_endpoints(); + void run_asio(); + void start_send(); + void start_recv(); + void handle_resolve(const boost::system::error_code& err, + boost::asio::ip::udp::resolver::iterator endpoint_iterator); + void handle_sent(const boost::system::error_code& error, + size_t /*bytes_transferred*/, QueueEntry *entry); + void handle_recv(const boost::system::error_code& error, size_t bytes_rcvd); + + private: // members + boost::asio::io_service io_service_; + boost::asio::ip::udp::resolver resolver_; + boost::asio::ip::udp::socket socket_; + + std::list local_endpoints_; + + signal_received_type sig_rcvd_; + signal_received_raw_type sig_rcvd_raw_; + signal_recv_error_type sig_recv_error_; + signal_send_error_type sig_send_error_; + + std::string send_to_address_; + + std::queue outbound_queue_; + std::mutex outbound_mutex_; + bool outbound_active_; + + boost::asio::ip::udp::endpoint outbound_endpoint_; + boost::asio::ip::udp::endpoint in_endpoint_; + + void * in_data_; + void * enc_in_data_; + size_t in_data_size_; + size_t enc_in_data_size_; + + bool filter_self_; + + std::thread asio_thread_; + MessageRegister *message_register_; + bool own_message_register_; + + frame_header_version_t frame_header_version_; + + bool crypto_; + bool crypto_buf_; + BufferEncryptor *crypto_enc_; + BufferDecryptor *crypto_dec_; +}; + +} // end namespace protobuf_comm + +#endif diff --git a/libs/protobuf_comm/queue_entry.h b/libs/protobuf_comm/queue_entry.h new file mode 100644 index 0000000..4a21b1f --- /dev/null +++ b/libs/protobuf_comm/queue_entry.h @@ -0,0 +1,68 @@ + +/*************************************************************************** + * queue_entry.h - Protobuf stream protocol - send queue entry + * + * Created: Fri Feb 01 22:07:14 2013 + * Copyright 2013 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef __PROTOBUF_COMM_QUEUE_ENTRY_H_ +#define __PROTOBUF_COMM_QUEUE_ENTRY_H_ + +#include +#include + +namespace protobuf_comm { +#if 0 /* just to make Emacs auto-indent happy */ +} +#endif + +/** Outgoing queue entry. */ +struct QueueEntry { +public: + /** Constructor. */ + QueueEntry() + { + frame_header.header_version = PB_FRAME_V2; + frame_header.cipher = PB_ENCRYPTION_NONE; + }; + std::string serialized_message; ///< serialized protobuf message + frame_header_t frame_header; ///< Frame header (network byte order), never encrypted + frame_header_v1_t frame_header_v1; ///< Frame header (network byte order), never encrypted + message_header_t message_header; ///< Frame header (network byte order) + std::array buffers; ///< outgoing buffers + std::string encrypted_message; ///< encrypted buffer if encryption is used +}; + + +} // end namespace protobuf_comm + +#endif diff --git a/proto/BenchmarkState.proto b/proto/BenchmarkState.proto new file mode 100644 index 0000000..febe65e --- /dev/null +++ b/proto/BenchmarkState.proto @@ -0,0 +1,36 @@ +/* + * Copyright 2014 Instituto de Sistemas e Robotica, Instituto Superior Tecnico + * + * This file is part of RoAH RSBB Comm. + * + * RoAH RSBB Comm is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * RoAH RSBB Comm 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with RoAH RSBB Comm. If not, see . + */ + +package roah_rsbb_msgs; + +option java_package = "eu.rockin.roah_rsbb_msgs"; +option java_outer_classname = "BenchmarkStateProtos"; + +message BenchmarkState { + enum CompType { + COMP_ID = 6666; + MSG_TYPE = 20; + } + + // The type of benchmark ([tf][123]) + required string benchmark_type = 1; + + // The state TODO + required string benchmark_state = 2; +} diff --git a/proto/RoahRsbbBeacon.proto b/proto/RoahRsbbBeacon.proto new file mode 100644 index 0000000..6d097e2 --- /dev/null +++ b/proto/RoahRsbbBeacon.proto @@ -0,0 +1,49 @@ +/* + * Copyright 2014 Instituto de Sistemas e Robotica, Instituto Superior Tecnico + * + * This file is part of RoAH RSBB Comm. + * + * RoAH RSBB Comm is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * RoAH RSBB Comm 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with RoAH RSBB Comm. If not, see . + */ + +package roah_rsbb_msgs; + +option java_package = "eu.rockin.roah_rsbb_msgs"; +option java_outer_classname = "RoahRsbbBeaconProtos"; + +message RoahRsbbBeacon { + enum CompType { + COMP_ID = 6666; + MSG_TYPE = 10; + } + + // The teams that should be active benchmarking + repeated BenchmarkingTeam benchmarking_teams = 1; +} + +message BenchmarkingTeam { + enum CompType { + COMP_ID = 6666; + MSG_TYPE = 11; + } + + // The team name that should be benchmarking + required string team_name = 1; + + // The specific robot in the team + required string robot_name = 2; + + // The RSBB port to connect the private channel + required uint32 rsbb_port = 3; +} diff --git a/proto/RobotBeacon.proto b/proto/RobotBeacon.proto new file mode 100644 index 0000000..d2aed80 --- /dev/null +++ b/proto/RobotBeacon.proto @@ -0,0 +1,42 @@ +/* + * Copyright 2014 Instituto de Sistemas e Robotica, Instituto Superior Tecnico + * + * This file is part of RoAH RSBB Comm. + * + * RoAH RSBB Comm is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * RoAH RSBB Comm 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with RoAH RSBB Comm. If not, see . + */ + +package roah_rsbb_msgs; + +import "Time.proto"; + +option java_package = "eu.rockin.roah_rsbb_msgs"; +option java_outer_classname = "RobotBeaconProtos"; + +message RobotBeacon { + enum CompType { + COMP_ID = 6666; + MSG_TYPE = 30; + } + + // The team name + required string team_name = 1; + + // The specific robot in the team + // (can be empty, only needed if the team has more than one robot) + required string robot_name = 2; + + // UTC time, to check clock synchronization + required Time time = 3; +} diff --git a/proto/RobotState.proto b/proto/RobotState.proto new file mode 100644 index 0000000..fd2dbd4 --- /dev/null +++ b/proto/RobotState.proto @@ -0,0 +1,40 @@ +/* + * Copyright 2014 Instituto de Sistemas e Robotica, Instituto Superior Tecnico + * + * This file is part of RoAH RSBB Comm. + * + * RoAH RSBB Comm is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * RoAH RSBB Comm 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with RoAH RSBB Comm. If not, see . + */ + +package roah_rsbb_msgs; + +import "Time.proto"; + +option java_package = "eu.rockin.roah_rsbb_msgs"; +option java_outer_classname = "RobotStateProtos"; + +message RobotState { + enum CompType { + COMP_ID = 6666; + MSG_TYPE = 40; + } + + // UTC time, to check clock synchronization + required Time time = 1; + + // Number of messages saved by the offline data saver + required uint32 messages_saved = 2; + + // TODO robot state +} diff --git a/proto/Time.proto b/proto/Time.proto new file mode 100644 index 0000000..7bb26ad --- /dev/null +++ b/proto/Time.proto @@ -0,0 +1,72 @@ +/* + * Copyright 2014 Instituto de Sistemas e Robotica, Instituto Superior Tecnico + * + * This file is part of RoAH RSBB Comm. + * + * RoAH RSBB Comm is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * RoAH RSBB Comm 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with RoAH RSBB Comm. If not, see . + */ + +/*************************************************************************** + * Time.proto - LLSF Protocol - Time Structure + * + * Created: Mon Feb 11 16:35:46 2013 + * Copyright 2013 Tim Niemueller [www.niemueller.de] + ****************************************************************************/ + +/* Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * - Neither the name of the authors nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +package roah_rsbb_msgs; + +option java_package = "eu.rockin.roah_rsbb_msgs"; +option java_outer_classname = "TimeProtos"; + +// Time stamp and duration structure. +// Can be used for absolute times or +// durations alike. +message Time { + + // Time in seconds since the Unix epoch + // in UTC or seconds part of duration + required int64 sec = 1; + + // Nano seconds after seconds for a time + // or nanoseconds part for duration + required int64 nsec = 2; +} diff --git a/src/capture_comm.cpp b/src/capture_comm.cpp new file mode 100644 index 0000000..8610906 --- /dev/null +++ b/src/capture_comm.cpp @@ -0,0 +1,186 @@ +/* + * Copyright 2014 Instituto de Sistemas e Robotica, Instituto Superior Tecnico + * + * This file is part of RoAH RSBB Comm. + * + * RoAH RSBB Comm is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * RoAH RSBB Comm 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 Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with RoAH RSBB Comm. If not, see . + */ + +#include + +#include "roah_rsbb.h" + + + +using namespace std; +using namespace roah_rsbb; + + + +const string TEAM_NAME = "DumpTeam"; +const string ROBOT_NAME = "The Listener"; +const string CRYPTO_KEY = "randomkey"; +const string CRYPTO_CIPHER = "aes-128-cbc"; + + + +class DumpComm +{ + string host_; + unsigned short port_; + PublicChannel<> public_channel_; + mutex private_channel_mutex_; + shared_ptr> private_channel_; + + static void + receive_benchmark_state (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + shared_ptr msg) + { + cout << "Received BenchmarkState from " << endpoint.address().to_string() + << ":" << endpoint.port() + << ", COMP_ID " << comp_id + << ", MSG_TYPE " << msg_type << endl + << " benchmark_type: " << msg->benchmark_type() << endl + << " benchmark_state: " << msg->benchmark_state() << endl + << flush; + } + + static void + receive_robot_state (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + shared_ptr msg) + { + cout << "Received RobotState from " << endpoint.address().to_string() + << ":" << endpoint.port() + << ", COMP_ID " << comp_id + << ", MSG_TYPE " << msg_type << endl + << " time: " << msg->time().sec() << "." << msg->time().nsec() << endl + << " messages_saved: " << msg->messages_saved() << endl + << flush; + } + + void + receive_rsbb_beacon (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + shared_ptr rsbb_beacon) + { + cout << "Received RobotState from " << endpoint.address().to_string() + << ":" << endpoint.port() + << ", COMP_ID " << comp_id + << ", MSG_TYPE " << msg_type << endl; + + unsigned short connect_port = 0; + for (auto const& bt : rsbb_beacon->benchmarking_teams()) { + cout << " team_name: " << bt.team_name() + << ", robot_name: " << bt.robot_name() + << ", rsbb_port: " << bt.rsbb_port() << endl; + if ( (bt.team_name() == TEAM_NAME) && (bt.robot_name() == ROBOT_NAME)) { + connect_port = bt.rsbb_port(); + // break; // Commented to show all entries + } + } + + lock_guard lock (private_channel_mutex_); + if (connect_port != (private_channel_ ? private_channel_->port() : 0)) { + if (private_channel_) { + cout << "Disconnecting private channel" << endl; + private_channel_.reset(); + } + if (connect_port) { + cout << "Connecting private channel to " << endpoint.address().to_string() + << ":" << connect_port << endl; + private_channel_ = make_shared> (endpoint.address().to_string(), connect_port, CRYPTO_KEY, CRYPTO_CIPHER); + private_channel_->signal_benchmark_state_received().connect (&DumpComm::receive_benchmark_state); + private_channel_->signal_robot_state_received().connect (&DumpComm::receive_robot_state); + } + } + + cout << flush; + } + + static void + receive_robot_beacon (boost::asio::ip::udp::endpoint& endpoint, + uint16_t comp_id, + uint16_t msg_type, + shared_ptr msg) + { + cout << "Received RobotBeacon from " << endpoint.address().to_string() + << ":" << endpoint.port() + << ", COMP_ID " << comp_id + << ", MSG_TYPE " << msg_type << endl + << " team_name: " << msg->team_name() << endl + << " robot_name: " << msg->robot_name() << endl + << " time: " << msg->time().sec() << "." << msg->time().nsec() << endl + << flush; + } + + public: + DumpComm (string const& host, + unsigned short port) : + host_ (host), + port_ (port), + public_channel_ (host, port), + private_channel_mutex_(), + private_channel_() + { + cout << "Connected public channel to " << host + << ":" << port << endl << flush; + public_channel_.signal_rsbb_beacon_received().connect (boost::bind (&DumpComm::receive_rsbb_beacon, this, _1, _2, _3, _4)); + public_channel_.signal_robot_beacon_received().connect (&DumpComm::receive_robot_beacon); + } + + void run() + { + boost::posix_time::ptime loop_time = boost::posix_time::microsec_clock::universal_time(); + while (true) { + shared_ptr> private_channel; + { + lock_guard lock (private_channel_mutex_); + private_channel = private_channel_; + } + if (private_channel) { + roah_rsbb_msgs::RobotState msg; + roah_rsbb::now (msg.mutable_time()); + msg.set_messages_saved (0); + cout << "Sending RobotState" << endl << flush; + private_channel->send (msg); + } + else { + roah_rsbb_msgs::RobotBeacon msg; + msg.set_team_name (TEAM_NAME); + msg.set_robot_name (ROBOT_NAME); + roah_rsbb::now (msg.mutable_time()); + cout << "Sending RobotBeacon" << endl << flush; + public_channel_.send (msg); + } + + loop_time += boost::posix_time::milliseconds (1000); + boost::this_thread::sleep (loop_time); + } + } +}; + + + +int +main (int argc, + char** argv) +{ + DumpComm comm ("10.255.255.255", 6666); + comm.run(); +} diff --git a/update_protobuf_comm b/update_protobuf_comm new file mode 100755 index 0000000..a52bd58 --- /dev/null +++ b/update_protobuf_comm @@ -0,0 +1,11 @@ +#!/bin/bash + +TEMPDIR=$(mktemp -d) +DESTDIR=./libs/protobuf_comm + +git clone http://git.fawkesrobotics.org/llsf-refbox.git ${TEMPDIR} && +rm -rfv ${DESTDIR} && +cp -rv ${TEMPDIR}/src/libs/protobuf_comm/ ${DESTDIR} && +rm -rfv ${TEMPDIR} && +rm -rfv ${DESTDIR}/qa/ ${DESTDIR}/Makefile ${DESTDIR}/server.* ${DESTDIR}/client.* && +echo === Done updating protobuf_comm