diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..dd07ddc67c632ebb7d054362ac9c3d32add83406 --- /dev/null +++ b/.gitignore @@ -0,0 +1,23 @@ +.built +.built_check +.configured_ +.dep_files +.git_update +.prepared_* +ipkg-* +*.o +tags +qosmngr +.configured_* +.pkgdir +*.html +*.gcda +*.gcov +*.gcno +*.log +*.so +*.xml +.DS_Store +include/version.h +test/cmocka/unit_test_qos +test/cmocka/functional_test_qos diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000000000000000000000000000000000000..b9b68c5899a5c4e37a572ed3595797a22f5154ab --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,61 @@ +include: + - project: 'iopsys/gitlab-ci-pipeline' + file: '/static-code-analysis.yml' + +stages: + - static_code_analysis + - unit_test + - functional_test + - api_test + +variables: + DEBUG: 'TRUE' + SOURCE_FOLDER: "." + +run_api_test: + stage: api_test + image: iopsys/code-analysis-dev + allow_failure: false + script: + - "./gitlab-ci/install-dependencies.sh" + - "./gitlab-ci/setup.sh" + - "./gitlab-ci/functional-api-test.sh" + + artifacts: + when: always + reports: + junit: ./report/tap.xml + paths: + - api-test-coverage.xml + - api-test-memory-report.xml + - timestamp.log + +run_unit_test: + stage: unit_test + image: iopsys/code-analysis-dev + allow_failure: false + script: + - "./gitlab-ci/install-dependencies.sh" + - "./gitlab-ci/setup.sh" + - "./gitlab-ci/unit-test.sh" + + artifacts: + when: always + paths: + - unit-test-coverage.xml + - timestamp.log + +run_functional_test: + stage: functional_test + image: iopsys/code-analysis-dev + allow_failure: false + script: + - "./gitlab-ci/install-dependencies.sh" + - "./gitlab-ci/setup.sh" + - "./gitlab-ci/functional-test.sh" + + artifacts: + when: always + paths: + - functional-test-coverage.xml + - timestamp.log diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..85863ee330bd0a62c0c4aa181e9ae7d175fa5017 --- /dev/null +++ b/LICENSE @@ -0,0 +1,308 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + qosmngr - QoS Manager + Copyright (C) 2020 iopsys Software Solutions AB + + 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 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..4d475ae42d2409e1fcf9628ccc631d45ca9ca0bd --- /dev/null +++ b/Makefile @@ -0,0 +1,64 @@ +# Makefile for qosmngr +include common.mk + +QOSMNGR_LIB=libqosmngr.so + +GCOV=gcov +SRC_DIR = src + +CODECOVERAGE_SRC = $(addprefix $(SRC_DIR), qosmngr.c ) +PROG = $(PROJECT_TOPLEVEL)/qosmngr +SHARED_LIB = $(PROJECT_TOPLEVEL)/libqosmngr.so +OBJS = $(addprefix $(SRC_DIR)/, main.o qosmngr.o ) + +PROG_CFLAGS = $(CFLAGS) -I$(INCLUDE_DIR) -Wall -fstrict-aliasing +PROG_LDFLAGS = $(LDFLAGS) +PROG_LIBS = $(COMMON_LDFLAGS) -lgcov + +.PHONY: all clean + +all: version $(PROG) + +$(PROG): $(INCLUDE_DIR)/version.h $(OBJS) + $(CC) $(PROG_LDFLAGS) -o $@ $^ $(PROG_LIBS) + +${QOSMNGR_LIB}: + $(CC) $(PROG_LDFLAGS) -shared -o $@ $^ $(PROG_LIBS) + +$(SHARED_LIB): $(INCLUDE_DIR)/version.h $(OBJS) + +version: $(INCLUDE_DIR)/version.h + +$(INCLUDE_DIR)/version.h: $(PROJECT_TOPLEVEL)/VERSION + @(dirty=$(shell (git status --porcelain | grep -q .) && echo -dirty); \ + [ -f $(PROJECT_TOPLEVEL)/VERSION ] && basever=$(shell cat $(PROJECT_TOPLEVEL)/VERSION) || \ + basever=Unknown; \ + xver=$(shell date +'%y%V%u-%H%M'); \ + echo "const char *qosmngr_base_version = \"$$basever\";" > $@; \ + echo "const char *qosmngr_xtra_version = \"$$xver$$dirty\";" >> $@; \ + ) + +test: ${QOSMNGR_LIB} + +coverage: CFLAGS += -g -O0 -fprofile-arcs -ftest-coverage -fPIC +coverage: LDFLAGS += --coverage +coverage: test $(PROG) + $(foreach testprog, $(CODECOVERAGE_SRC), $(GCOV) $(testprog);) + +unit-test: test + $(MAKE) -C test/cmocka unit-test + +functional-test: test + $(MAKE) -C test/cmocka functional-test + +%.o: %.c + $(CC) $(PROG_CFLAGS) $(FPIC) -c -o $@ $< + +clean: + rm -f *.o $(SHARED_LIB) $(PROG) $(INCLUDE_DIR)/version.h + rm -f *.xml *.html + find -name '*.gcda' -exec rm {} -fv \; + find -name '*.gcno' -exec rm {} -fv \; + find -name '*.gcov' -exec rm {} -fv \; + make -C test/cmocka clean + diff --git a/README.md b/README.md index 65316ed46e3108eae9f7372f15f98f1b553847d3..6ac35a2b59f678a5a5ba7a74e4cd468e4dac93c4 100644 --- a/README.md +++ b/README.md @@ -447,3 +447,418 @@ root@iopsys:~# ubus -S call qos reload '{"section":"shaper"}' root@iopsys:~# ```` +- `queue_stats : {"ifname":"String","qid":"Integer"}` + - `ifname`: interface name for which we want to get the QoS statistics. Optional argument: if not provided, the statistics of all ports for all queues are returned. + - `qid`: the TX queue ID for which we want to get the statistics. Optional argument: if not provided, the statistics of all queues for a given interface are returned. + + The response given by this method is a JSON-formatted dump as such: + ``` + root@iopsys:~# ubus call qos queue_stats '{"ifname":"eth1","qid":1}' + { + "queues": [ + { + "iface": "eth1", + "qid": 1, + "tx_packets": 13632, + "tx_bytes": 1377736, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + } + ] + } + root@iopsys:~# ubus call qos queue_stats '{"ifname":"eth0"}' + { + "queues": [ + { + "iface": "eth0", + "qid": 0, + "tx_packets": 20, + "tx_bytes": 4436, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 1, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 2, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 3, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 4, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 5, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 6, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 7, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + } + ] + } + root@iopsys:~# ubus call qos queue_stats + { + "queues": [ + { + "iface": "eth1", + "qid": 0, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth1", + "qid": 1, + "tx_packets": 7575, + "tx_bytes": 1186770, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth1", + "qid": 2, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth1", + "qid": 3, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth1", + "qid": 4, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth1", + "qid": 5, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth1", + "qid": 6, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth1", + "qid": 7, + "tx_packets": 199, + "tx_bytes": 20540, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 0, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 1, + "tx_packets": 2852, + "tx_bytes": 295268, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 2, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 3, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 4, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 5, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 6, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth2", + "qid": 7, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 0, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 1, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 2, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 3, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 4, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 5, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 6, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth3", + "qid": 7, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 0, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 1, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 2, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 3, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 4, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 5, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 6, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth4", + "qid": 7, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 0, + "tx_packets": 3, + "tx_bytes": 1038, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 1, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 2, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 3, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 4, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 5, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 6, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + }, + { + "iface": "eth0", + "qid": 7, + "tx_packets": 0, + "tx_bytes": 0, + "tx_dropped_packets": 0, + "tx_dropped_bytes": 0 + } + ] + } + + ``` diff --git a/VERSION b/VERSION new file mode 100644 index 0000000000000000000000000000000000000000..c227083464fb9af8955c90d2924774ee50abb547 --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +0 \ No newline at end of file diff --git a/common.mk b/common.mk new file mode 100644 index 0000000000000000000000000000000000000000..2069d995aa3ca88ec33b63e567bc9a444a94935e --- /dev/null +++ b/common.mk @@ -0,0 +1,10 @@ +# Useful to refer to headers not located in the same directory as the source files being compiled +PROJECT_TOPLEVEL := $(dir $(CURDIR)/$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))) +INCLUDE_DIR = $(PROJECT_TOPLEVEL)/include + +# Common compiler options +CC=gcc # gcc || clang + +COMMON_LDFLAGS = -luci -lubus -lubox -ljson-c -lblobmsg_json -lnl-genl-3 -lnl-3 -lqos +QOSMNGR_LIB_DIR ?= $(shell dirname $(PWD)) +QOSMNGR_LDFLAGS = -lqosmngr -L$(QOSMNGR_LIB_DIR) diff --git a/gitlab-ci/functional-api-test.sh b/gitlab-ci/functional-api-test.sh new file mode 100755 index 0000000000000000000000000000000000000000..8bc036a7e5f7d6b3d8077735deca17588648b9f5 --- /dev/null +++ b/gitlab-ci/functional-api-test.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +echo "preparation script" +pwd + +make coverage -C ./ +supervisorctl status all +supervisorctl update +sleep 3 +supervisorctl status all + +# run API validation +ubus-api-validator -d ./test/api/json/ > ./api-result.log + +supervisorctl stop all +supervisorctl status + +#report part +gcovr -r . --xml -o ./api-test-coverage.xml +gcovr -r . +cp /opt/work/memory-report.xml /builds/iopsys/qosmngr/api-test-memory-report.xml +tap-junit --input ./api-result.log --output report +date +%s > timestamp.log + + + diff --git a/gitlab-ci/functional-test.sh b/gitlab-ci/functional-test.sh new file mode 100755 index 0000000000000000000000000000000000000000..1546ec5993c7a01389b4193f4e18e267bce159a5 --- /dev/null +++ b/gitlab-ci/functional-test.sh @@ -0,0 +1,22 @@ +#!/bin/bash + +echo "preparation script" +pwd + +supervisorctl status all +supervisorctl update +sleep 3 +supervisorctl status all + +make functional-test -C ./ + +supervisorctl stop all +supervisorctl status + +#report part +#GitLab-CI output +gcovr -r . +# Artefact +gcovr -r . --xml -o ./functional-test-coverage.xml +date +%s > timestamp.log + diff --git a/gitlab-ci/install-dependencies.sh b/gitlab-ci/install-dependencies.sh new file mode 100755 index 0000000000000000000000000000000000000000..c89057c8097afd9fa1eb941c484bccc44f41a4ec --- /dev/null +++ b/gitlab-ci/install-dependencies.sh @@ -0,0 +1,22 @@ +#!/bin/bash + +echo "install dependencies" + +pwd + +# libqos +cd /opt/dev +rm -fr easy-soc-libs +git clone https://dev.iopsys.eu/iopsys/easy-soc-libs.git +cd easy-soc-libs +git checkout wip/libqos/subject-to-rebase +cd libeasy +make CFLAGS+="-I/usr/include/libnl3" +mkdir -p /usr/include/easy +cp easy.h event.h utils.h /usr/include/easy +cp -a libeasy*.so* /usr/lib +cd ../libqos +make PLATFORM=TEST +cp qos.h /usr/include +cp -a libqos.so* /usr/lib +sudo ldconfig diff --git a/gitlab-ci/iopsys-supervisord.conf b/gitlab-ci/iopsys-supervisord.conf new file mode 100644 index 0000000000000000000000000000000000000000..85bb9c784d51e7ab23316dcc7cf9b61740dad1fc --- /dev/null +++ b/gitlab-ci/iopsys-supervisord.conf @@ -0,0 +1,5 @@ +[program:ubusd] +command=/bin/bash -c "/usr/sbin/ubusd" + +[program:qos] +command=/bin/bash -c "mkdir -p /opt/work && /usr/bin/valgrind --xml=yes --xml-file=/opt/work/memory-report.xml --leak-check=full --show-reachable=yes --show-leak-kinds=all --errors-for-leak-kinds=all --error-exitcode=1 --track-origins=yes /builds/iopsys/qosmngr/qosmngr" diff --git a/gitlab-ci/setup.sh b/gitlab-ci/setup.sh new file mode 100755 index 0000000000000000000000000000000000000000..41b5c2c8fcf0370985e6d52e13838fa65333ca45 --- /dev/null +++ b/gitlab-ci/setup.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +echo "preparation script" + +pwd + +cp -r ./test/files/etc/* /etc/ +cp -r ./schemas/ubus/* /usr/share/rpcd/schemas +cp ./gitlab-ci/iopsys-supervisord.conf /etc/supervisor/conf.d/ + +ls /etc/config/ +ls /usr/share/rpcd/schemas/ +ls /etc/supervisor/conf.d/ + diff --git a/gitlab-ci/unit-test.sh b/gitlab-ci/unit-test.sh new file mode 100755 index 0000000000000000000000000000000000000000..b0207dabcde93257d1c5b1e79732e845be2213a3 --- /dev/null +++ b/gitlab-ci/unit-test.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +echo "preparation script" +pwd + +make unit-test -C ./ + +#report part +#GitLab-CI output +gcovr -r . +# Artefact +gcovr -r . --xml -o ./unit-test-coverage.xml +date +%s > timestamp.log \ No newline at end of file diff --git a/include/qosmngr.h b/include/qosmngr.h new file mode 100644 index 0000000000000000000000000000000000000000..494715974ac8f924b385d3b9f565a46408984d07 --- /dev/null +++ b/include/qosmngr.h @@ -0,0 +1,68 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * qosmngr.h - definitions used in qosmngr + * + * Copyright (C) 2020 iopsys Software Solutions AB. All rights reserved. + * + * Author: Oskar Viljasaar <oskar.viljasaar@iopsys.eu> + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * version 2 as published by the Free Software Foundation. + * + * 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, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA + */ + +#ifndef QOSMNGR_H +#define QOSMNGR_H + +/* Needed to get the IFNAMSIZ define */ +#include <net/if.h> + +#include <qos.h> + +/* logging though syslog */ +#include <syslog.h> + +/* UCI definitions, used to parse the config files at their right location */ +#define UCI_CONFIG_QOS "qos" + +#define QOS_SECTION_NAME "queue" + +#define OPT_ENABLE "enable" +#define OPT_IFNAME "ifname" +#define OPT_PRECEDENCE "precedence" +#define OPT_SCHEDULING "scheduling" +#define OPT_RATE "rate" +#define OPT_BURST_SIZE "burst_size" +#define OPT_WEIGHT "weight" + +enum { + QOS_POLICY_IFNAME, + QOS_POLICY_QID, + QOS_POLICY_MAX, + NUM_QOS_POLICY = QOS_POLICY_MAX, +}; + +extern const struct blobmsg_policy get_status_policy[NUM_QOS_POLICY]; + +/* A QoS queue. */ +struct qos_queue { + char name[IFNAMSIZ]; + bool enable; + struct qos_queue_config config; +}; + +int qosmngr_get_stats(struct ubus_context *ctx, struct ubus_object *obj, + struct ubus_request_data *req, const char *method, + struct blob_attr *msg); + +#endif /* QOSMNGR_H */ diff --git a/src/main.c b/src/main.c new file mode 100644 index 0000000000000000000000000000000000000000..118b3e4aaeb710040b0dd9da9810cedc548a73ff --- /dev/null +++ b/src/main.c @@ -0,0 +1,133 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * main.c - qosmngr's boilerplate and entry point + * + * Copyright (C) 2020 iopsys Software Solutions AB. All rights reserved. + * + * Author: Oskar Viljasaar <oskar.viljasaar@iopsys.eu> + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * version 2 as published by the Free Software Foundation. + * + * 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, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA + */ + +#include <stdio.h> +#include <stdlib.h> + +#include <libubus.h> + +#include "qosmngr.h" +#include "version.h" + +const char *ubus_socket; + +struct ubus_context *ctx = NULL; + +const struct blobmsg_policy get_status_policy[NUM_QOS_POLICY] = { + [QOS_POLICY_IFNAME] = { .name = "ifname", .type = BLOBMSG_TYPE_STRING }, + [QOS_POLICY_QID] = { .name = "qid", .type = BLOBMSG_TYPE_INT32}, +}; + +static const struct ubus_method qos_methods[] = { + UBUS_METHOD("queue_stats", qosmngr_get_stats, get_status_policy), +}; + +static struct ubus_object_type qos_object_type = + UBUS_OBJECT_TYPE("qos", qos_methods); + +static struct ubus_object test_object = { + .name = "qos", + .type = &qos_object_type, + .methods = qos_methods, + .n_methods = ARRAY_SIZE(qos_methods), +}; + +/** + * To get the qosmngr version + * @param : none + * return : none + */ +void qosmngr_version() +{ + syslog(LOG_ERR, "version : %s.%s\n", qosmngr_base_version, qosmngr_xtra_version); +} + +/** + * To expose the qosmngr object on ubus i.e., qos with method queue_stats + * @param ctx input parameter pointer to ubus context + * retrun integer value 0 on success and -1 on failure + */ +static int qosmngr_publish_object(struct ubus_context *ctx) +{ + int ret; + ret = ubus_add_object(ctx, &test_object); + if (ret) { + syslog(LOG_ERR, "Failed to add 'qos' ubus object: %s\n", + ubus_strerror(ret)); + } + + return ret; +} + +/** + * Main function for qosmngr, everything starts here + * @param argc input number of input arguments + * @param argv input double pointer array of optional command line arguments + * retrun integer value 0 on success and -1 on failure + */ +int main(int argc, char **argv) +{ + int ret; + int ch; + + /* Logging to syslog */ + openlog("qosmngr", LOG_PID|LOG_CONS, LOG_LOCAL1); + + while ((ch = getopt(argc, argv, "vs:e:")) != -1) { + switch (ch) { + case 'v': + qosmngr_version(); + exit(0); + case 's': + ubus_socket = optarg; + break; + default: + break; + } + } + + argc -= optind; + argv += optind; + + uloop_init(); + ctx = ubus_connect(ubus_socket); + if (!ctx) { + syslog(LOG_ERR, "Failed to connect to ubus\n"); + return -1; + } + + ubus_add_uloop(ctx); + + ret = qosmngr_publish_object(ctx); + if (ret) + goto out; + + /* Main loop of qosmngr */ + uloop_run(); + + out: + ubus_free(ctx); + uloop_done(); + + return 0; +} diff --git a/src/qosmngr.c b/src/qosmngr.c new file mode 100644 index 0000000000000000000000000000000000000000..e6b044f3247fa680c6d25b19f466b77fba60883f --- /dev/null +++ b/src/qosmngr.c @@ -0,0 +1,366 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * qosmngr.c - main qosmngr's code + * + * Copyright (C) 2020 iopsys Software Solutions AB. All rights reserved. + * + * Author: Oskar Viljasaar <oskar.viljasaar@iopsys.eu> + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * version 2 as published by the Free Software Foundation. + * + * 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, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA + */ + +#include <libubus.h> +#include <uci.h> + +/* Needed to get the IFNAMSIZ define */ +#include <net/if.h> + +#include "qosmngr.h" + +/* Used as an internal value to query all the queues */ +#define QOS_QUEUE_ANY -1 + +/* Used for getting interface indexes for global q_stat array */ +#define MIN_INDEX 48 +#define MAX_INDEX 57 + +static int init_flag = 1; +static struct qos_stats **q_stat = {0}; + +/** + * get_no_queues function for getting number of queues on device by calling uci qos config + * @param ifname input parameter pointer to char for which number of queues needed + * retrun integer value 0 on success and -1 on failure + */ +static int get_no_queues(const char *ifname) +{ + int queues = 0; + + struct uci_package *uci_pkg = NULL; + struct uci_element *uci_elmnt = NULL; + struct uci_context *uci_ctx = uci_alloc_context(); + + uci_load(uci_ctx, "qos", &uci_pkg); + if (!uci_pkg) { + syslog(LOG_ERR, "Failed to load configuration\n"); + queues = -1; + goto done; + } + + uci_foreach_element(&uci_pkg->sections, uci_elmnt) { + struct uci_section *uci_sec = uci_to_section(uci_elmnt); + if (uci_sec && !strcmp(uci_sec->type, "queue")) { + struct uci_element *e = NULL; + uci_foreach_element(&uci_sec->options, e) { + struct uci_option *uci_opn = uci_to_option(e); + if (uci_opn && !strcmp(uci_opn->v.string, ifname)) + queues++; + } + } + } + + uci_unload(uci_ctx, uci_pkg); +done: + uci_free_context(uci_ctx); + return queues; +} + +/** + * get_interface_index function for getting interface index i.e., eth0 having index 0 + * @param ifname input parameter pointer to char for which index needs to be fetched + * retrun integer value 0 on success and -1 on failure + */ +static int get_interface_index(const char *ifname) +{ + int i; + + for (i = 0; i < strlen(ifname); i++) { + if ((ifname[i] >= MIN_INDEX) && (ifname[i] <= MAX_INDEX)) { + return atoi(ifname + i); + } + } + + return -1; +} + +/** + * get_no_ports function for getting number of ports on device by calling uci port config + * @param none + * retrun integer value 0 on success and -1 on failure + */ +static int get_no_ports() +{ + int ports = 0; + + struct uci_package *uci_pkg = NULL; + struct uci_element *uci_elmnt = NULL; + struct uci_context *uci_ctx = uci_alloc_context(); + + uci_load(uci_ctx, "ports", &uci_pkg); + if (!uci_pkg) { + syslog(LOG_ERR, "Failed to load configuration\n"); + ports = -1; + goto done; + } + + uci_foreach_element(&uci_pkg->sections, uci_elmnt) { + struct uci_section *uci_sec = uci_to_section(uci_elmnt); + if (uci_sec) + ports++; + } + +done: + uci_unload(uci_ctx, uci_pkg); + uci_free_context(uci_ctx); + return ports; +} + +/** + * init_qstat function for initializing global q_stat structure for sustainable stats + * @param none + * retrun integer value 0 on success and -1 on failure + */ +static int init_qstat() +{ + int ret = 0; + int index = 0; + + syslog(LOG_ERR, "Initializing global stat structure.\n"); + + int ports = get_no_ports(); + q_stat = (struct qos_stats **)calloc(ports, sizeof(struct qos_stats *)); + if (q_stat == NULL) { + syslog(LOG_ERR, "Initialization failed during memory allocation.\n"); + ret = -1; + return ret; + } + + struct uci_package *uci_pkg = NULL; + struct uci_element *uci_elmnt = NULL; + struct uci_context *uci_ctx = uci_alloc_context(); + + uci_load(uci_ctx, "ports", &uci_pkg); + if (!uci_pkg) { + syslog(LOG_ERR, "Failed to load configuration\n"); + ret = -1; + goto done; + } + + uci_foreach_element(&uci_pkg->sections, uci_elmnt) { + struct uci_section *uci_sec = uci_to_section(uci_elmnt); + if (uci_sec) { + struct uci_option *uci_opn = uci_lookup_option(uci_ctx, uci_sec, "ifname"); + index = get_interface_index(uci_opn->v.string); + int queues = get_no_queues(uci_opn->v.string); + q_stat[index] = (struct qos_stats *)calloc(queues, sizeof(struct qos_stats)); + if (q_stat[index] == NULL) { + syslog(LOG_ERR, "Initialization failed during memory allocation.\n"); + ret = -1; + uci_unload(uci_ctx, uci_pkg); + goto done; + } + } + } + + uci_unload(uci_ctx, uci_pkg); +done: + uci_free_context(uci_ctx); + return ret; +} + +/** + * prapare_stats_blob function for getting stats by calling libqos function prepare_stats_blob + * @param b output parameter pointer to blob_buf + * @param stats output parameter pointer to qos_stats actually queue stats container + * @param dd output parameter pointer to void used for blob buffer array elements + * @param ifname input parameter pointer to char for which to get stats + * @param qid input parameter integer queue identifier for which to get stats + * retrun integer value 0 on success and -1 on failure + */ +static int prepare_stats_blob(struct blob_buf *b, struct qos_stats *stats, void *dd, + char *ifname, int qid) +{ + int index; + int ret = 0; + + // Initialize global q_stat global struct + if (init_flag) { + ret = init_qstat(); + if (ret) { + syslog(LOG_ERR, "Failed to initialize gobal q_stat.\n"); + } + syslog(LOG_ERR, "Initialized gobal q_stat successfully.\n"); + init_flag = 0; + } + + ret = qos_get_stats(ifname, qid, stats); + if (ret != 0) { + syslog(LOG_ERR, "blob_get_status: ret %d\n", ret); + return ret; + } + + index = get_interface_index(ifname); + + q_stat[index][qid].tx_packets += stats->tx_packets; + q_stat[index][qid].tx_bytes += stats->tx_bytes; + q_stat[index][qid].tx_dropped_packets += stats->tx_dropped_packets; + q_stat[index][qid].tx_dropped_bytes += stats->tx_dropped_bytes; + + dd = blobmsg_open_table(b, ""); + + blobmsg_add_string(b, "iface", ifname); + blobmsg_add_u32(b, "qid", qid); + blobmsg_add_u32(b, "tx_packets", q_stat[index][qid].tx_packets); + blobmsg_add_u32(b, "tx_bytes", q_stat[index][qid].tx_bytes); + blobmsg_add_u32(b, "tx_dropped_packets", q_stat[index][qid].tx_dropped_packets); + blobmsg_add_u32(b, "tx_dropped_bytes", q_stat[index][qid].tx_dropped_bytes); + + blobmsg_close_table(b, dd); + + return ret; +} + +/** + * get_stats_by_ifname function for getting specific interface stats + * @param b output parameter pointer to blob_buf + * @param stats output parameter pointer to qos_stats actually queue stats container + * @param dd output parameter pointer to void used for blob buffer array elements + * @param ifname input parameter pointer to char for which to get stats + * @param qid input parameter integer queue identifier for which to get stats + * retrun integer value 0 on success and -1 on failure + */ +static int get_stats_by_ifname(struct blob_buf *b, struct qos_stats *stats, void *dd, + char *ifname, int qid) +{ + int queues = 0; + int i, ret = 0; + + if (qid >= 0) { + ret = prepare_stats_blob(b, stats, dd, ifname, qid); + } else { + queues = get_no_queues(ifname); + for (i = 0; i < queues; i++) { + ret = prepare_stats_blob(b, stats, dd, ifname, i); + if (ret != 0) + return ret; + } + } + + return ret; +} + +/** + * get_stats_for_all_intf function for getting all interface stats + * @param b output parameter pointer to blob_buf + * @param stats output parameter pointer to qos_stats actually queue stats container + * @param dd output parameter pointer to void used for blob buffer array elements + * retrun integer value 0 on success and -1 on failure + */ +static int get_stats_for_all_intf(struct blob_buf *b, struct qos_stats *stats, void *dd) +{ + int ret = 0; + char ifname[IFNAMSIZ] = {0}; + + struct uci_package *uci_pkg = NULL; + struct uci_element *uci_elmnt = NULL; + struct uci_context *uci_ctx = uci_alloc_context(); + + uci_load(uci_ctx, "ports", &uci_pkg); + if (!uci_pkg) { + syslog(LOG_ERR, "Failed to load configuration\n"); + ret = -1; + return ret; + } + + uci_foreach_element(&uci_pkg->sections, uci_elmnt) { + struct uci_section *uci_sec = uci_to_section(uci_elmnt); + if (uci_sec) { + struct uci_option *uci_opn = uci_lookup_option(uci_ctx, uci_sec, "ifname"); + strcpy(ifname, uci_opn->v.string); + ret = get_stats_by_ifname(b, stats, dd, ifname, QOS_QUEUE_ANY); + if (ret != 0) { + syslog(LOG_ERR, "get_stats_by_ifname : ret %d\n", ret); + return ret; + } + } + } + + return ret; +} + +/** + * qosmngr_get_stats function callback on ubus method queue_stats + * @param ctx input parameter pointer to ubus context + * @param obj input parameter pointer to ubus object in out case qos + * @param req input parameter pointer to ubus requested data + * @param method input parameter pointer to char method i.e., queue_stats + * @param msg input parameter pointer containing qid and ifname + * retrun integer value 0 on success and -1 on failure + */ +int qosmngr_get_stats(struct ubus_context *ctx, struct ubus_object *obj, + struct ubus_request_data *req, const char *method, + struct blob_attr *msg) +{ + int ret; + int qid = QOS_QUEUE_ANY; + char ifname[IFNAMSIZ] = {0}; + + struct blob_attr *tb[NUM_QOS_POLICY]; + struct blob_buf b = {0}; + struct qos_stats stats = {0}; + + /* These are for the blobbuf array elements */ + void *d = NULL, *dd = NULL; + + blobmsg_parse(get_status_policy, QOS_POLICY_MAX, tb, blob_data(msg), + blob_len(msg)); + + if (tb[QOS_POLICY_IFNAME]) + strncpy(ifname, blobmsg_data(tb[QOS_POLICY_IFNAME]), sizeof(ifname)-1); + + /* Parse optional arguments */ + if (tb[QOS_POLICY_QID]) + qid = blobmsg_get_u32(tb[QOS_POLICY_QID]); + + /* Can't have a queue id specified without an interface */ + if (tb[QOS_POLICY_QID] && !tb[QOS_POLICY_IFNAME]) + return UBUS_STATUS_INVALID_ARGUMENT; + + blob_buf_init(&b, 0); + + d = blobmsg_open_array(&b, "queues"); + + if (tb[QOS_POLICY_IFNAME]) { + ret = get_stats_by_ifname(&b, &stats, &dd, ifname, qid); + if (ret != 0) { + syslog(LOG_ERR, "get_stats_by_ifname : ret %d\n", ret); + goto fail_get_status; + } + } else { + ret = get_stats_for_all_intf(&b, &stats, &dd); + if (ret != 0) { + syslog(LOG_ERR, "get_stats_for_all_intf : ret %d\n", ret); + goto fail_get_status; + } + } + + blobmsg_close_array(&b, d); + + ubus_send_reply(ctx, req, b.head); + + fail_get_status: + blob_buf_free(&b); + return ret; +} diff --git a/test/api/json/qos.json b/test/api/json/qos.json new file mode 100644 index 0000000000000000000000000000000000000000..1932eea48be187bb424d2f34406033e2a3b46eda --- /dev/null +++ b/test/api/json/qos.json @@ -0,0 +1,21 @@ +{ + "object": "qos", + "methods": [ + { + "method": "get_status", + "args": { + "ifname": "test" + }, + "rc": 0 + }, + { + "method": "get_status", + "args": { + "ifname": "test", + "qid": 0 + }, + "rc": 0 + } + ] +} + diff --git a/test/cmocka/Makefile b/test/cmocka/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..5f5240e7f35e86cc3a5bd1b92913928bf917c8d2 --- /dev/null +++ b/test/cmocka/Makefile @@ -0,0 +1,33 @@ +include ../../common.mk + +QOSMNGR_LIB_DIR = $(PROJECT_TOPLEVEL) +CMOCKA_LIB = -lcmocka +LIBS = $(QOSMNGR_LDFLAGS) $(CMOCKA_LIB) -lpthread $(COMMON_LDFLAGS) -ljson-validator -ljson-schema-validator -ljson-editor +CFLAGS = -g -Wall -O0 -fprofile-arcs -ftest-coverage -fPIC -I$(INCLUDE_DIR) +LDFLAGS = $(LIBS) -Wl,-rpath=$(QOSMNGR_LIB_DIR) -I$(QOSMNGR_LIB_DIR) --coverage +UNIT_TESTS = unit_test_qos +FUNCTIONAL_TESTS = functional_test_qos + +VALGRIND = valgrind --leak-check=full --show-reachable=no \ + --show-leak-kinds=all --errors-for-leak-kinds=all \ + --error-exitcode=1 --track-origins=yes + +%.o: %.c + $(CC) $(CFLAGS) $(FPIC) -c -o $@ $< + +unit_test_qos: unit_test_qos.o + $(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS) + +functional_test_qos: functional_test_qos.o + $(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS) + +unit-test: $(UNIT_TESTS) + $(foreach testprog, $(UNIT_TESTS), sudo $(VALGRIND) ./$(testprog);) + +functional-test: $(FUNCTIONAL_TESTS) + $(foreach testprog, $(FUNCTIONAL_TESTS), sudo $(VALGRIND) ./$(testprog);) + +.PHONY: clean + +clean: + rm $(UNIT_TESTS) $(FUNCTIONAL_TESTS) *.o *.gcno *.gcda -fv diff --git a/test/cmocka/functional_test_qos.c b/test/cmocka/functional_test_qos.c new file mode 100644 index 0000000000000000000000000000000000000000..a307218bd34eb96a52e87f95dec9c1488ab8ad80 --- /dev/null +++ b/test/cmocka/functional_test_qos.c @@ -0,0 +1,57 @@ +#include <stdarg.h> +#include <stddef.h> +#include <setjmp.h> +#include <cmocka.h> + +#include <libubus.h> +#include <libubox/blobmsg_json.h> +#include <libubox/blobmsg.h> + +#include <json-validator.h> +#include <json-c/json.h> +#include <json-editor.h> + +#include <json-c/json_tokener.h> +#include <easy/easy.h> +#include <qos.h> + +#include "qosmngr.h" + +struct test_ctx { + FILE *fp; +}; + +int qosmngr_event_main(const char *evmap_file); + +static int group_setup(void **state) +{ + struct test_ctx *ctx = calloc(1, sizeof(struct test_ctx)); + + if (!ctx) + return -1; + + remove("/tmp/test.log"); + + *state = ctx; + return 0; +} + +static int group_teardown(void **state) +{ + struct test_ctx *ctx = (struct test_ctx *) *state; + + free(ctx); + remove("/tmp/test.log"); + + /* TODO: fix event poll file */ + //if (ctx->fp) + //fclose(ctx->fp); + return 0; +} + +int main(void) +{ + const struct CMUnitTest tests[] = { }; + + return cmocka_run_group_tests(tests, group_setup, group_teardown); +} diff --git a/test/cmocka/unit_test_qos.c b/test/cmocka/unit_test_qos.c new file mode 100644 index 0000000000000000000000000000000000000000..e3019885cc9f820decdd86231b4f88d045abb361 --- /dev/null +++ b/test/cmocka/unit_test_qos.c @@ -0,0 +1,137 @@ +#include <stdarg.h> +#include <stddef.h> +#include <setjmp.h> +#include <cmocka.h> + +#include <libubus.h> +#include <libubox/blobmsg_json.h> +#include <libubox/blobmsg.h> + +#include <json-validator.h> +#include <json-c/json.h> +#include <json-editor.h> + +#include <json-c/json_tokener.h> +#include <easy/easy.h> +#include <qos.h> + +#include <qosmngr.h> + +struct test_ctx { + struct blob_buf bb; + struct ubus_object qos; + FILE *fp; +}; + +/* declare qosmngr functions */ +int qosmngr_event_main(const char *evmap_file); + +/* overload ubus_send_reply to prevent segfault*/ +int ubus_send_reply(struct ubus_context *ctx, struct ubus_request_data *req, + struct blob_attr *msg) +{ + return 0; +} + + +char *multi_tok(char *input, char *delimiter) +{ + static char *string; + char *end, *temp; + + if (input) + string = input; + + if (!string) + return string; + + end = strstr(string, delimiter); + + if (!end) { + char *temp = string; + + string = NULL; + return temp; + } + + temp = string; + + *end = '\0'; + string = end + strlen(delimiter); + + return temp; +} + + +/* TODO: how to fix events without fopen and fclose every poll? */ +struct json_object *poll_test_log(FILE *fp, const char *prefix) +{ + char line[256] = {0}; + char msg[256] = {0}; + struct json_object *obj = NULL; + + fp = fopen("/tmp/test.log", "r"); + if (!fp) { + return NULL; + } + + while (fgets(line, 256, fp)) { + char *ptr, *s; + char appended[32]; + + snprintf(appended, sizeof(appended), "%s:", prefix); + + ptr = strstr(line, appended); + if (!ptr) + continue; + + s = multi_tok(ptr, appended); + s = multi_tok(NULL, appended); + strncpy(msg, s, sizeof(msg)); + } + + if (strlen(msg)) + obj = json_tokener_parse(msg); + + fclose(fp); + return obj; +} + +static int group_setup(void **state) +{ + struct test_ctx *ctx = calloc(1, sizeof(struct test_ctx)); + + if (!ctx) + return -1; + + remove("/tmp/test.log"); + + ctx->qos.name = "qos"; + + memset(&ctx->bb, 0, sizeof(struct blob_buf)); + + *state = ctx; + return 0; +} + +static int group_teardown(void **state) +{ + struct test_ctx *ctx = (struct test_ctx *) *state; + + blob_buf_free(&ctx->bb); + free(ctx); + remove("/tmp/test.log"); + + /* TODO: fix event poll file */ + //if (ctx->fp) + //fclose(ctx->fp); + return 0; +} + +int main(void) +{ + const struct CMUnitTest tests[] = { + }; + + return cmocka_run_group_tests(tests, group_setup, group_teardown); +} diff --git a/test/files/etc/config/qos b/test/files/etc/config/qos new file mode 100644 index 0000000000000000000000000000000000000000..68b0209d787f79cab8c3df32023ec6244cf5a639 --- /dev/null +++ b/test/files/etc/config/qos @@ -0,0 +1,360 @@ +config queue 'q_0_eth1' + option enable '1' + option ifname 'eth1' + option precedence '0' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_1_eth1' + option enable '1' + option ifname 'eth1' + option precedence '1' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_2_eth1' + option enable '1' + option ifname 'eth1' + option precedence '2' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_3_eth1' + option enable '1' + option ifname 'eth1' + option precedence '3' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_4_eth1' + option enable '1' + option ifname 'eth1' + option precedence '4' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_5_eth1' + option enable '1' + option ifname 'eth1' + option precedence '5' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_6_eth1' + option enable '1' + option ifname 'eth1' + option precedence '6' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_7_eth1' + option enable '1' + option ifname 'eth1' + option precedence '7' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_0_eth2' + option enable '1' + option ifname 'eth2' + option precedence '0' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_1_eth2' + option enable '1' + option ifname 'eth2' + option precedence '1' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_2_eth2' + option enable '1' + option ifname 'eth2' + option precedence '2' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_3_eth2' + option enable '1' + option ifname 'eth2' + option precedence '3' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_4_eth2' + option enable '1' + option ifname 'eth2' + option precedence '4' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_5_eth2' + option enable '1' + option ifname 'eth2' + option precedence '5' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_6_eth2' + option enable '1' + option ifname 'eth2' + option precedence '6' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_7_eth2' + option enable '1' + option ifname 'eth2' + option precedence '7' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_0_eth3' + option enable '1' + option ifname 'eth3' + option precedence '0' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_1_eth3' + option enable '1' + option ifname 'eth3' + option precedence '1' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_2_eth3' + option enable '1' + option ifname 'eth3' + option precedence '2' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_3_eth3' + option enable '1' + option ifname 'eth3' + option precedence '3' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_4_eth3' + option enable '1' + option ifname 'eth3' + option precedence '4' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_5_eth3' + option enable '1' + option ifname 'eth3' + option precedence '5' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_6_eth3' + option enable '1' + option ifname 'eth3' + option precedence '6' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_7_eth3' + option enable '1' + option ifname 'eth3' + option precedence '7' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_0_eth4' + option enable '1' + option ifname 'eth4' + option precedence '0' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_1_eth4' + option enable '1' + option ifname 'eth4' + option precedence '1' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_2_eth4' + option enable '1' + option ifname 'eth4' + option precedence '2' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_3_eth4' + option enable '1' + option ifname 'eth4' + option precedence '3' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_4_eth4' + option enable '1' + option ifname 'eth4' + option precedence '4' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_5_eth4' + option enable '1' + option ifname 'eth4' + option precedence '5' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_6_eth4' + option enable '1' + option ifname 'eth4' + option precedence '6' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_7_eth4' + option enable '1' + option ifname 'eth4' + option precedence '7' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_0_eth0' + option enable '1' + option ifname 'eth0' + option precedence '0' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_1_eth0' + option enable '1' + option ifname 'eth0' + option precedence '1' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_2_eth0' + option enable '1' + option ifname 'eth0' + option precedence '2' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_3_eth0' + option enable '1' + option ifname 'eth0' + option precedence '3' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_4_eth0' + option enable '1' + option ifname 'eth0' + option precedence '4' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_5_eth0' + option enable '1' + option ifname 'eth0' + option precedence '5' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_6_eth0' + option enable '1' + option ifname 'eth0' + option precedence '6' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' + +config queue 'q_7_eth0' + option enable '1' + option ifname 'eth0' + option precedence '7' + option scheduling 'SP' + option rate '0' + option burst_size '-1' + option weight '1' +