Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 1 | # Copyright 2020 The Pigweed Authors |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may not |
| 4 | # use this file except in compliance with the License. You may obtain a copy of |
| 5 | # the License at |
| 6 | # |
| 7 | # https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 | # License for the specific language governing permissions and limitations under |
| 13 | # the License. |
| 14 | |
Armando Montanez | fb3d3fb | 2020-06-09 18:12:12 -0700 | [diff] [blame] | 15 | # gn-format disable |
| 16 | import("//build_overrides/pigweed.gni") |
| 17 | |
Alexei Frolov | edd2f14 | 2020-06-09 19:11:27 -0700 | [diff] [blame] | 18 | import("$dir_pw_build/target_types.gni") |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 19 | import("$dir_pw_docgen/docs.gni") |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 20 | import("$dir_pw_protobuf_compiler/proto.gni") |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 21 | import("$dir_pw_unit_test/test.gni") |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 22 | config("default_config") { |
| 23 | include_dirs = [ "public" ] |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 24 | visibility = [ ":*" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 25 | } |
| 26 | |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 27 | # pw_rpc servers depend on the protobuf library used to encode and decode |
| 28 | # requests and responses when invoking methods. This template is used to create |
| 29 | # instances of the pw_rpc server library with different implementations. |
| 30 | # |
| 31 | # The implementation parameter must refer to a library that provides the |
| 32 | # definition of the Method class in pw_rpc/internal/method.h. The Method class |
| 33 | # provides the Invoke function, which handles the server use to call into the |
| 34 | # RPC functions themselves. |
| 35 | template("_pw_rpc_server_library") { |
| 36 | assert(defined(invoker.implementation), |
| 37 | "_pw_rpc_server_library requires an implementation to be set") |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame] | 38 | _target_name = target_name |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 39 | |
Alexei Frolov | edd2f14 | 2020-06-09 19:11:27 -0700 | [diff] [blame] | 40 | pw_source_set(_target_name) { |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 41 | forward_variables_from(invoker, "*") |
| 42 | |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 43 | public_deps = [ |
Wyatt Hepler | 3e2d719 | 2020-06-11 08:28:21 -0700 | [diff] [blame] | 44 | ":server_library_deps", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 45 | implementation, |
| 46 | ] |
| 47 | deps = [ |
| 48 | dir_pw_assert, |
| 49 | dir_pw_log, |
| 50 | ] |
| 51 | public = [ |
| 52 | "public/pw_rpc/server.h", |
| 53 | "public/pw_rpc/server_context.h", |
| 54 | ] |
| 55 | sources = [ |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 56 | "base_server_writer.cc", |
| 57 | "public/pw_rpc/internal/base_server_writer.h", |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 58 | "public/pw_rpc/internal/server.h", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 59 | "server.cc", |
| 60 | "service.cc", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 61 | ] |
| 62 | allow_circular_includes_from = [ implementation ] |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 63 | friend = [ "./*" ] |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 64 | } |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame] | 65 | |
Wyatt Hepler | 8aa0292 | 2020-07-17 08:54:37 -0700 | [diff] [blame] | 66 | pw_source_set("internal_test_utils_$_target_name") { |
| 67 | public = [ "pw_rpc_private/internal_test_utils.h" ] |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame] | 68 | public_configs = [ ":private_includes" ] |
| 69 | public_deps = [ |
| 70 | ":$_target_name", |
| 71 | ":common", |
| 72 | dir_pw_span, |
Wyatt Hepler | 712d367 | 2020-07-13 15:52:11 -0700 | [diff] [blame] | 73 | dir_pw_unit_test, |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame] | 74 | ] |
| 75 | visibility = [ "./*" ] |
| 76 | } |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 77 | } |
| 78 | |
Alexei Frolov | 9a4d6bf | 2020-08-04 10:33:26 -0700 | [diff] [blame] | 79 | # Provides the public RPC service definition (but not implementation). Can be |
| 80 | # used to expose global service registration without depending on the complete |
| 81 | # RPC library. |
Wyatt Hepler | d159142 | 2020-09-15 10:04:41 -0700 | [diff] [blame^] | 82 | # TODO(hepler): Remove this after making the RPC implementation classes fully |
| 83 | # independent of the particular implementation. Targets needing the service |
| 84 | # should be able to depend on the main RPC library. |
| 85 | group("service") { |
| 86 | deps = [ ":common" ] |
Alexei Frolov | 9a4d6bf | 2020-08-04 10:33:26 -0700 | [diff] [blame] | 87 | } |
| 88 | |
Wyatt Hepler | 3e2d719 | 2020-06-11 08:28:21 -0700 | [diff] [blame] | 89 | # Put these dependencies into a group since they need to be shared by the server |
| 90 | # library and its implementation library. |
| 91 | group("server_library_deps") { |
| 92 | public_configs = [ ":default_config" ] |
| 93 | public_deps = [ |
| 94 | ":common", |
Alexei Frolov | 9a4d6bf | 2020-08-04 10:33:26 -0700 | [diff] [blame] | 95 | ":service", |
Wyatt Hepler | 3e2d719 | 2020-06-11 08:28:21 -0700 | [diff] [blame] | 96 | dir_pw_span, |
| 97 | dir_pw_status, |
| 98 | ] |
| 99 | visibility = [ "./*" ] |
| 100 | } |
| 101 | |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 102 | # Classes with no dependencies on the protobuf library for method invocations. |
Alexei Frolov | edd2f14 | 2020-06-09 19:11:27 -0700 | [diff] [blame] | 103 | pw_source_set("common") { |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 104 | public_configs = [ ":default_config" ] |
| 105 | public_deps = [ |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 106 | ":protos_pwpb", |
Wyatt Hepler | d159142 | 2020-09-15 10:04:41 -0700 | [diff] [blame^] | 107 | "$dir_pw_containers:intrusive_list", |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 108 | dir_pw_assert, |
| 109 | dir_pw_span, |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 110 | dir_pw_status, |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 111 | ] |
Wyatt Hepler | d159142 | 2020-09-15 10:04:41 -0700 | [diff] [blame^] | 112 | public = [ |
| 113 | "public/pw_rpc/channel.h", |
| 114 | "public/pw_rpc/service.h", |
| 115 | ] |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 116 | sources = [ |
| 117 | "channel.cc", |
| 118 | "packet.cc", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 119 | "public/pw_rpc/internal/base_method.h", |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame] | 120 | "public/pw_rpc/internal/call.h", |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 121 | "public/pw_rpc/internal/channel.h", |
Wyatt Hepler | 1532e52 | 2020-07-30 11:44:58 -0700 | [diff] [blame] | 122 | "public/pw_rpc/internal/hash.h", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 123 | "public/pw_rpc/internal/packet.h", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 124 | ] |
Wyatt Hepler | d159142 | 2020-09-15 10:04:41 -0700 | [diff] [blame^] | 125 | deps = [ dir_pw_log ] |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 126 | friend = [ "./*" ] |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | # RPC server that uses Nanopb to encode and decode protobufs. RPCs use Nanopb |
| 130 | # structs as their requests and responses. |
| 131 | _pw_rpc_server_library("nanopb_server") { |
| 132 | implementation = "nanopb" |
| 133 | } |
| 134 | |
| 135 | config("private_includes") { |
| 136 | include_dirs = [ "." ] |
Wyatt Hepler | 7da973a | 2020-06-09 10:04:48 -0700 | [diff] [blame] | 137 | visibility = [ ":*" ] |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 138 | } |
| 139 | |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 140 | pw_proto_library("protos") { |
| 141 | sources = [ "pw_rpc_protos/packet.proto" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 142 | } |
| 143 | |
Alexei Frolov | 7c7a386 | 2020-07-16 15:36:02 -0700 | [diff] [blame] | 144 | pw_proto_library("echo_service_proto") { |
| 145 | sources = [ "pw_rpc_protos/echo.proto" ] |
| 146 | inputs = [ "pw_rpc_protos/echo.options" ] |
| 147 | } |
| 148 | |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 149 | # Source files for pw_protobuf's protoc plugin. |
| 150 | pw_input_group("nanopb_protoc_plugin") { |
| 151 | inputs = [ |
| 152 | "py/pw_rpc/codegen_nanopb.py", |
| 153 | "py/pw_rpc/plugin.py", |
| 154 | "py/pw_rpc/ids.py", |
| 155 | ] |
Alexei Frolov | 15255c5 | 2020-07-17 08:25:49 -0700 | [diff] [blame] | 156 | deps = [ "$dir_pw_protobuf:codegen_protoc_lib" ] |
Alexei Frolov | 79b7cb0 | 2020-07-06 13:51:43 -0700 | [diff] [blame] | 157 | } |
| 158 | |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 159 | pw_doc_group("docs") { |
| 160 | sources = [ "docs.rst" ] |
Alexei Frolov | 7c7a386 | 2020-07-16 15:36:02 -0700 | [diff] [blame] | 161 | inputs = [ |
| 162 | "pw_rpc_protos/echo.proto", |
| 163 | "pw_rpc_protos/packet.proto", |
| 164 | ] |
| 165 | group_deps = [ "nanopb:docs" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 166 | } |
| 167 | |
| 168 | pw_test_group("tests") { |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 169 | tests = [ |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 170 | ":base_server_writer_test", |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 171 | ":channel_test", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 172 | ":packet_test", |
| 173 | ":server_test", |
Wyatt Hepler | d159142 | 2020-09-15 10:04:41 -0700 | [diff] [blame^] | 174 | ":service_test", |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 175 | ] |
Wyatt Hepler | af83568 | 2020-06-17 11:42:53 -0700 | [diff] [blame] | 176 | group_deps = [ "nanopb:tests" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 177 | } |
| 178 | |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 179 | # RPC server for tests only. A mock method implementation is used. |
| 180 | _pw_rpc_server_library("test_server") { |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 181 | implementation = "test_impl" |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 182 | visibility = [ ":*" ] |
| 183 | } |
| 184 | |
Wyatt Hepler | 948f547 | 2020-06-02 16:52:28 -0700 | [diff] [blame] | 185 | pw_proto_library("test_protos") { |
| 186 | sources = [ "pw_rpc_test_protos/test.proto" ] |
| 187 | visibility = [ "./*" ] |
Alexei Frolov | 26e3ae6 | 2020-05-04 17:06:17 -0700 | [diff] [blame] | 188 | } |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 189 | |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 190 | pw_test("base_server_writer_test") { |
| 191 | deps = [ |
Wyatt Hepler | 8aa0292 | 2020-07-17 08:54:37 -0700 | [diff] [blame] | 192 | ":internal_test_utils_test_server", |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 193 | ":test_server", |
Wyatt Hepler | cb9d957 | 2020-06-01 11:25:58 -0700 | [diff] [blame] | 194 | ] |
| 195 | sources = [ "base_server_writer_test.cc" ] |
| 196 | } |
| 197 | |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 198 | pw_test("channel_test") { |
| 199 | deps = [ |
| 200 | ":common", |
Wyatt Hepler | 8aa0292 | 2020-07-17 08:54:37 -0700 | [diff] [blame] | 201 | ":internal_test_utils_test_server", |
Wyatt Hepler | 671946e | 2020-06-09 14:39:33 -0700 | [diff] [blame] | 202 | ] |
| 203 | sources = [ "channel_test.cc" ] |
| 204 | } |
| 205 | |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 206 | pw_test("packet_test") { |
| 207 | deps = [ |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 208 | ":common", |
Wyatt Hepler | 0f26235 | 2020-07-29 09:51:27 -0700 | [diff] [blame] | 209 | dir_pw_bytes, |
Alexei Frolov | 5d6d392 | 2020-05-08 13:57:02 -0700 | [diff] [blame] | 210 | dir_pw_protobuf, |
| 211 | ] |
| 212 | sources = [ "packet_test.cc" ] |
| 213 | } |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 214 | |
Wyatt Hepler | d159142 | 2020-09-15 10:04:41 -0700 | [diff] [blame^] | 215 | pw_test("service_test") { |
| 216 | deps = [ |
| 217 | ":common", |
| 218 | ":protos_pwpb", |
| 219 | ":test_server", |
| 220 | dir_pw_assert, |
| 221 | ] |
| 222 | sources = [ "service_test.cc" ] |
| 223 | } |
| 224 | |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 225 | pw_test("server_test") { |
| 226 | deps = [ |
Wyatt Hepler | 8aa0292 | 2020-07-17 08:54:37 -0700 | [diff] [blame] | 227 | ":internal_test_utils_test_server", |
Wyatt Hepler | 80f26ff | 2020-06-01 09:30:17 -0700 | [diff] [blame] | 228 | ":protos_pwpb", |
| 229 | ":test_server", |
| 230 | dir_pw_assert, |
| 231 | ] |
| 232 | sources = [ "server_test.cc" ] |
| 233 | } |