aboutsummaryrefslogtreecommitdiff
path: root/pw_log_tokenized/BUILD.gn
blob: 3e2b16181575b772fe94d65425758b3d11504ff9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# Copyright 2020 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.

import("//build_overrides/pigweed.gni")

import("$dir_pw_build/facade.gni")
import("$dir_pw_build/module_config.gni")
import("$dir_pw_build/target_types.gni")
import("$dir_pw_docgen/docs.gni")
import("$dir_pw_log/backend.gni")
import("$dir_pw_log_tokenized/backend.gni")
import("$dir_pw_tokenizer/backend.gni")
import("$dir_pw_unit_test/test.gni")

declare_args() {
  # The build target that overrides the default configuration options for this
  # module. This should point to a source set that provides defines through a
  # public config (which may -include a file or add defines directly).
  pw_log_tokenized_CONFIG = pw_build_DEFAULT_MODULE_CONFIG
}

config("public_include_path") {
  include_dirs = [ "public" ]
  visibility = [ ":*" ]
}

config("backend_config") {
  include_dirs = [ "public_overrides" ]
  visibility = [ ":*" ]
}

# This target provides the backend for pw_log.
pw_source_set("pw_log_tokenized") {
  public_configs = [ ":backend_config" ]
  public_deps = [
    ":handler.facade",  # Depend on the facade to avoid circular dependencies.
    ":headers",
  ]
  public = [ "public_overrides/pw_log_backend/log_backend.h" ]

  sources = [ "log_tokenized.cc" ]
}

config("backwards_compatibility_config") {
  defines = [ "_PW_LOG_TOKENIZED_GLOBAL_HANDLER_BACKWARDS_COMPAT" ]
  visibility = [ ":*" ]
}

pw_source_set("headers") {
  visibility = [ ":*" ]
  public_configs = [ ":public_include_path" ]
  public_deps = [
    ":config",
    ":metadata",

    # TODO(hepler): Remove this dependency when all projects have migrated to
    #     the new pw_log_tokenized handler.
    "$dir_pw_tokenizer:global_handler_with_payload",
    dir_pw_preprocessor,
    dir_pw_tokenizer,
  ]
  public = [ "public/pw_log_tokenized/log_tokenized.h" ]
}

# The old pw_tokenizer_GLOBAL_HANDLER_WITH_PAYLOAD_BACKEND backend may still be
# in use by projects that have not switched to the new pw_log_tokenized facade.
# Use the old backend as a stand-in for the new backend if it is set.
_old_backend_is_set = pw_tokenizer_GLOBAL_HANDLER_WITH_PAYLOAD_BACKEND != ""
_new_backend_is_set = pw_log_tokenized_HANDLER_BACKEND != ""

pw_facade("handler") {
  public_configs = [ ":public_include_path" ]
  public_deps = [
    # TODO(hepler): Remove this dependency when all projects have migrated to
    #     the new pw_log_tokenized handler.
    "$dir_pw_tokenizer:global_handler_with_payload",
    dir_pw_preprocessor,
  ]

  public = [ "public/pw_log_tokenized/handler.h" ]

  # If the global handler backend is set, redirect the new facade to the old
  # facade. If no backend is set, the old facade may still be in use through
  # link deps, so provide the compatibility layer.
  #
  # TODO(hepler): Remove these backwards compatibility workarounds when projects
  #     have migrated.
  if (_old_backend_is_set || (!_old_backend_is_set && !_new_backend_is_set)) {
    assert(pw_log_tokenized_HANDLER_BACKEND == "",
           "pw_tokenizer_GLOBAL_HANDLER_WITH_PAYLOAD_BACKEND is deprecated; " +
               "only pw_log_tokenized_HANDLER_BACKEND should be set")

    backend = pw_tokenizer_GLOBAL_HANDLER_WITH_PAYLOAD_BACKEND

    # There is only one pw_log_tokenized backend in Pigweed, and it has been
    # updated to the new API.
    if (_old_backend_is_set &&
        get_label_info(pw_tokenizer_GLOBAL_HANDLER_WITH_PAYLOAD_BACKEND,
                       "label_no_toolchain") ==
        get_label_info(":base64_over_hdlc", "label_no_toolchain")) {
      defines = [ "PW_LOG_TOKENIZED_BACKEND_USES_NEW_API=1" ]
    } else {
      defines = [ "PW_LOG_TOKENIZED_BACKEND_USES_NEW_API=0" ]
    }

    public_configs += [ ":backwards_compatibility_config" ]
    deps = [ dir_pw_tokenizer ]
    sources = [ "compatibility.cc" ]
  } else {
    backend = pw_log_tokenized_HANDLER_BACKEND
  }
}

pw_source_set("metadata") {
  public_configs = [ ":public_include_path" ]
  public_deps = [ ":config" ]
  public = [ "public/pw_log_tokenized/metadata.h" ]
}

pw_source_set("config") {
  public_configs = [ ":public_include_path" ]
  public_deps = [
    "$dir_pw_log:facade",
    pw_log_tokenized_CONFIG,
  ]
  public = [ "public/pw_log_tokenized/config.h" ]
}

# The log backend deps that might cause circular dependencies, since
# pw_log is so ubiquitous. These deps are kept separate so they can be
# depended on from elsewhere.
pw_source_set("pw_log_tokenized.impl") {
  deps = [ ":pw_log_tokenized" ]

  if (_new_backend_is_set || _old_backend_is_set) {
    deps += [ ":handler" ]
  }
}

# This target provides a backend for pw_tokenizer that encodes tokenized logs as
# Base64, encodes them into HDLC frames, and writes them over sys_io.
pw_source_set("base64_over_hdlc") {
  public_configs = [ ":public_include_path" ]
  public = [ "public/pw_log_tokenized/base64_over_hdlc.h" ]
  sources = [ "base64_over_hdlc.cc" ]
  deps = [
    ":handler.facade",
    "$dir_pw_hdlc:encoder",
    "$dir_pw_stream:sys_io_stream",
    "$dir_pw_tokenizer:base64",
    dir_pw_span,
  ]
}

pw_test_group("tests") {
  tests = [
    ":log_tokenized_test",
    ":metadata_test",
  ]
}

pw_test("log_tokenized_test") {
  sources = [
    "log_tokenized_test.cc",
    "log_tokenized_test_c.c",
    "pw_log_tokenized_private/test_utils.h",
  ]
  deps = [
    ":headers",
    dir_pw_preprocessor,
  ]
}

pw_test("metadata_test") {
  sources = [ "metadata_test.cc" ]
  deps = [ ":metadata" ]
}

pw_doc_group("docs") {
  sources = [ "docs.rst" ]
  other_deps = [ "py" ]
}