• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //
2 //
3 // Copyright 2015 gRPC authors.
4 //
5 // Licensed under the Apache License, Version 2.0 (the "License");
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 //     http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 //
18 
19 #include <grpc/support/port_platform.h>
20 
21 #include "src/core/lib/channel/channel_args.h"
22 
23 #include <limits.h>
24 #include <stdlib.h>
25 #include <string.h>
26 
27 #include <algorithm>
28 #include <map>
29 #include <memory>
30 #include <string>
31 #include <vector>
32 
33 #include "absl/strings/match.h"
34 #include "absl/strings/str_cat.h"
35 #include "absl/strings/str_format.h"
36 #include "absl/strings/str_join.h"
37 
38 #include <grpc/impl/channel_arg_names.h>
39 #include <grpc/support/alloc.h>
40 #include <grpc/support/log.h>
41 #include <grpc/support/string_util.h>
42 
43 #include "src/core/lib/gpr/useful.h"
44 
45 namespace grpc_core {
46 
47 const grpc_arg_pointer_vtable ChannelArgs::Value::int_vtable_{
48     // copy
__anon47dd2d4f0102(void* p) 49     [](void* p) { return p; },
50     // destroy
__anon47dd2d4f0202(void*) 51     [](void*) {},
52     // cmp
__anon47dd2d4f0302(void* p1, void* p2) 53     [](void* p1, void* p2) -> int {
54       return QsortCompare(reinterpret_cast<intptr_t>(p1),
55                           reinterpret_cast<intptr_t>(p2));
56     },
57 };
58 
59 const grpc_arg_pointer_vtable ChannelArgs::Value::string_vtable_{
60     // copy
__anon47dd2d4f0402(void* p) 61     [](void* p) -> void* {
62       return static_cast<RefCountedString*>(p)->Ref().release();
63     },
64     // destroy
__anon47dd2d4f0502(void* p) 65     [](void* p) { static_cast<RefCountedString*>(p)->Unref(); },
66     // cmp
__anon47dd2d4f0602(void* p1, void* p2) 67     [](void* p1, void* p2) -> int {
68       return QsortCompare(static_cast<RefCountedString*>(p1)->as_string_view(),
69                           static_cast<RefCountedString*>(p2)->as_string_view());
70     },
71 };
72 
Pointer(void * p,const grpc_arg_pointer_vtable * vtable)73 ChannelArgs::Pointer::Pointer(void* p, const grpc_arg_pointer_vtable* vtable)
74     : p_(p), vtable_(vtable == nullptr ? EmptyVTable() : vtable) {}
75 
Pointer(const Pointer & other)76 ChannelArgs::Pointer::Pointer(const Pointer& other)
77     : p_(other.vtable_->copy(other.p_)), vtable_(other.vtable_) {}
78 
Pointer(Pointer && other)79 ChannelArgs::Pointer::Pointer(Pointer&& other) noexcept
80     : p_(other.p_), vtable_(other.vtable_) {
81   other.p_ = nullptr;
82   other.vtable_ = EmptyVTable();
83 }
84 
EmptyVTable()85 const grpc_arg_pointer_vtable* ChannelArgs::Pointer::EmptyVTable() {
86   static const grpc_arg_pointer_vtable vtable = {
87       // copy
88       [](void* p) { return p; },
89       // destroy
90       [](void*) {},
91       // cmp
92       [](void* p1, void* p2) -> int { return QsortCompare(p1, p2); },
93   };
94   return &vtable;
95 }
96 
97 ChannelArgs::ChannelArgs() = default;
98 ChannelArgs::~ChannelArgs() = default;
99 ChannelArgs::ChannelArgs(const ChannelArgs& other) = default;
100 ChannelArgs& ChannelArgs::operator=(const ChannelArgs& other) = default;
101 ChannelArgs::ChannelArgs(ChannelArgs&& other) noexcept = default;
102 ChannelArgs& ChannelArgs::operator=(ChannelArgs&& other) noexcept = default;
103 
Get(absl::string_view name) const104 const ChannelArgs::Value* ChannelArgs::Get(absl::string_view name) const {
105   return args_.Lookup(name);
106 }
107 
Contains(absl::string_view name) const108 bool ChannelArgs::Contains(absl::string_view name) const {
109   return Get(name) != nullptr;
110 }
111 
operator <(const ChannelArgs & other) const112 bool ChannelArgs::operator<(const ChannelArgs& other) const {
113   return args_ < other.args_;
114 }
115 
operator ==(const ChannelArgs & other) const116 bool ChannelArgs::operator==(const ChannelArgs& other) const {
117   return args_ == other.args_;
118 }
119 
operator !=(const ChannelArgs & other) const120 bool ChannelArgs::operator!=(const ChannelArgs& other) const {
121   return !(*this == other);
122 }
123 
WantMinimalStack() const124 bool ChannelArgs::WantMinimalStack() const {
125   return GetBool(GRPC_ARG_MINIMAL_STACK).value_or(false);
126 }
127 
ChannelArgs(AVL<RefCountedStringValue,Value> args)128 ChannelArgs::ChannelArgs(AVL<RefCountedStringValue, Value> args)
129     : args_(std::move(args)) {}
130 
Set(grpc_arg arg) const131 ChannelArgs ChannelArgs::Set(grpc_arg arg) const {
132   switch (arg.type) {
133     case GRPC_ARG_INTEGER:
134       return Set(arg.key, arg.value.integer);
135     case GRPC_ARG_STRING:
136       if (arg.value.string != nullptr) return Set(arg.key, arg.value.string);
137       return Set(arg.key, "");
138     case GRPC_ARG_POINTER:
139       return Set(arg.key,
140                  Pointer(arg.value.pointer.vtable->copy(arg.value.pointer.p),
141                          arg.value.pointer.vtable));
142   }
143   GPR_UNREACHABLE_CODE(return ChannelArgs());
144 }
145 
FromC(const grpc_channel_args * args)146 ChannelArgs ChannelArgs::FromC(const grpc_channel_args* args) {
147   ChannelArgs result;
148   if (args != nullptr) {
149     for (size_t i = 0; i < args->num_args; i++) {
150       result = result.Set(args->args[i]);
151     }
152   }
153   return result;
154 }
155 
MakeCArg(const char * name) const156 grpc_arg ChannelArgs::Value::MakeCArg(const char* name) const {
157   char* c_name = const_cast<char*>(name);
158   if (rep_.c_vtable() == &int_vtable_) {
159     return grpc_channel_arg_integer_create(
160         c_name, reinterpret_cast<intptr_t>(rep_.c_pointer()));
161   }
162   if (rep_.c_vtable() == &string_vtable_) {
163     return grpc_channel_arg_string_create(
164         c_name, const_cast<char*>(
165                     static_cast<RefCountedString*>(rep_.c_pointer())->c_str()));
166   }
167   return grpc_channel_arg_pointer_create(c_name, rep_.c_pointer(),
168                                          rep_.c_vtable());
169 }
170 
ToC() const171 ChannelArgs::CPtr ChannelArgs::ToC() const {
172   std::vector<grpc_arg> c_args;
173   args_.ForEach(
174       [&c_args](const RefCountedStringValue& key, const Value& value) {
175         c_args.push_back(value.MakeCArg(key.c_str()));
176       });
177   return CPtr(static_cast<const grpc_channel_args*>(
178       grpc_channel_args_copy_and_add(nullptr, c_args.data(), c_args.size())));
179 }
180 
Set(absl::string_view name,Pointer value) const181 ChannelArgs ChannelArgs::Set(absl::string_view name, Pointer value) const {
182   return Set(name, Value(std::move(value)));
183 }
184 
Set(absl::string_view name,int value) const185 ChannelArgs ChannelArgs::Set(absl::string_view name, int value) const {
186   return Set(name, Value(value));
187 }
188 
Set(absl::string_view name,Value value) const189 ChannelArgs ChannelArgs::Set(absl::string_view name, Value value) const {
190   if (const auto* p = args_.Lookup(name)) {
191     if (*p == value) return *this;  // already have this value for this key
192   }
193   return ChannelArgs(args_.Add(RefCountedStringValue(name), std::move(value)));
194 }
195 
Set(absl::string_view name,absl::string_view value) const196 ChannelArgs ChannelArgs::Set(absl::string_view name,
197                              absl::string_view value) const {
198   return Set(name, std::string(value));
199 }
200 
Set(absl::string_view name,const char * value) const201 ChannelArgs ChannelArgs::Set(absl::string_view name, const char* value) const {
202   return Set(name, std::string(value));
203 }
204 
Set(absl::string_view name,std::string value) const205 ChannelArgs ChannelArgs::Set(absl::string_view name, std::string value) const {
206   return Set(name, Value(std::move(value)));
207 }
208 
Remove(absl::string_view name) const209 ChannelArgs ChannelArgs::Remove(absl::string_view name) const {
210   if (args_.Lookup(name) == nullptr) return *this;
211   return ChannelArgs(args_.Remove(name));
212 }
213 
RemoveAllKeysWithPrefix(absl::string_view prefix) const214 ChannelArgs ChannelArgs::RemoveAllKeysWithPrefix(
215     absl::string_view prefix) const {
216   auto args = args_;
217   args_.ForEach([&](const RefCountedStringValue& key, const Value&) {
218     if (absl::StartsWith(key.as_string_view(), prefix)) args = args.Remove(key);
219   });
220   return ChannelArgs(std::move(args));
221 }
222 
GetInt(absl::string_view name) const223 absl::optional<int> ChannelArgs::GetInt(absl::string_view name) const {
224   auto* v = Get(name);
225   if (v == nullptr) return absl::nullopt;
226   return v->GetIfInt();
227 }
228 
GetDurationFromIntMillis(absl::string_view name) const229 absl::optional<Duration> ChannelArgs::GetDurationFromIntMillis(
230     absl::string_view name) const {
231   auto ms = GetInt(name);
232   if (!ms.has_value()) return absl::nullopt;
233   if (*ms == INT_MAX) return Duration::Infinity();
234   if (*ms == INT_MIN) return Duration::NegativeInfinity();
235   return Duration::Milliseconds(*ms);
236 }
237 
GetString(absl::string_view name) const238 absl::optional<absl::string_view> ChannelArgs::GetString(
239     absl::string_view name) const {
240   auto* v = Get(name);
241   if (v == nullptr) return absl::nullopt;
242   const auto s = v->GetIfString();
243   if (s == nullptr) return absl::nullopt;
244   return s->as_string_view();
245 }
246 
GetOwnedString(absl::string_view name) const247 absl::optional<std::string> ChannelArgs::GetOwnedString(
248     absl::string_view name) const {
249   absl::optional<absl::string_view> v = GetString(name);
250   if (!v.has_value()) return absl::nullopt;
251   return std::string(*v);
252 }
253 
GetVoidPointer(absl::string_view name) const254 void* ChannelArgs::GetVoidPointer(absl::string_view name) const {
255   auto* v = Get(name);
256   if (v == nullptr) return nullptr;
257   const auto* pp = v->GetIfPointer();
258   if (pp == nullptr) return nullptr;
259   return pp->c_pointer();
260 }
261 
GetBool(absl::string_view name) const262 absl::optional<bool> ChannelArgs::GetBool(absl::string_view name) const {
263   auto* v = Get(name);
264   if (v == nullptr) return absl::nullopt;
265   auto i = v->GetIfInt();
266   if (!i.has_value()) {
267     gpr_log(GPR_ERROR, "%s ignored: it must be an integer",
268             std::string(name).c_str());
269     return absl::nullopt;
270   }
271   switch (*i) {
272     case 0:
273       return false;
274     case 1:
275       return true;
276     default:
277       gpr_log(GPR_ERROR, "%s treated as bool but set to %d (assuming true)",
278               std::string(name).c_str(), *i);
279       return true;
280   }
281 }
282 
ToString(std::list<std::string> & backing_strings) const283 absl::string_view ChannelArgs::Value::ToString(
284     std::list<std::string>& backing_strings) const {
285   if (rep_.c_vtable() == &string_vtable_) {
286     return static_cast<RefCountedString*>(rep_.c_pointer())->as_string_view();
287   }
288   if (rep_.c_vtable() == &int_vtable_) {
289     backing_strings.emplace_back(
290         std::to_string(reinterpret_cast<intptr_t>(rep_.c_pointer())));
291     return backing_strings.back();
292   }
293   backing_strings.emplace_back(absl::StrFormat("%p", rep_.c_pointer()));
294   return backing_strings.back();
295 }
296 
ToString() const297 std::string ChannelArgs::ToString() const {
298   std::vector<absl::string_view> strings;
299   std::list<std::string> backing_strings;
300   strings.push_back("{");
301   bool first = true;
302   args_.ForEach([&strings, &first, &backing_strings](
303                     const RefCountedStringValue& key, const Value& value) {
304     if (!first) strings.push_back(", ");
305     first = false;
306     strings.push_back(key.as_string_view());
307     strings.push_back("=");
308     strings.push_back(value.ToString(backing_strings));
309   });
310   strings.push_back("}");
311   return absl::StrJoin(strings, "");
312 }
313 
UnionWith(ChannelArgs other) const314 ChannelArgs ChannelArgs::UnionWith(ChannelArgs other) const {
315   if (args_.Empty()) return other;
316   if (other.args_.Empty()) return *this;
317   if (args_.Height() <= other.args_.Height()) {
318     args_.ForEach(
319         [&other](const RefCountedStringValue& key, const Value& value) {
320           other.args_ = other.args_.Add(key, value);
321         });
322     return other;
323   } else {
324     auto result = *this;
325     other.args_.ForEach(
326         [&result](const RefCountedStringValue& key, const Value& value) {
327           if (result.args_.Lookup(key) == nullptr) {
328             result.args_ = result.args_.Add(key, value);
329           }
330         });
331     return result;
332   }
333 }
334 
FuzzingReferenceUnionWith(ChannelArgs other) const335 ChannelArgs ChannelArgs::FuzzingReferenceUnionWith(ChannelArgs other) const {
336   // DO NOT OPTIMIZE THIS!!
337   args_.ForEach([&other](const RefCountedStringValue& key, const Value& value) {
338     other.args_ = other.args_.Add(key, value);
339   });
340   return other;
341 }
342 
operator ()(const grpc_channel_args * p) const343 void ChannelArgs::ChannelArgsDeleter::operator()(
344     const grpc_channel_args* p) const {
345   grpc_channel_args_destroy(p);
346 }
347 
operator <<(std::ostream & out,const ChannelArgs & args)348 std::ostream& operator<<(std::ostream& out, const ChannelArgs& args) {
349   return out << args.ToString();
350 }
351 
352 }  // namespace grpc_core
353 
copy_arg(const grpc_arg * src)354 static grpc_arg copy_arg(const grpc_arg* src) {
355   grpc_arg dst;
356   dst.type = src->type;
357   dst.key = gpr_strdup(src->key);
358   switch (dst.type) {
359     case GRPC_ARG_STRING:
360       dst.value.string = gpr_strdup(src->value.string);
361       break;
362     case GRPC_ARG_INTEGER:
363       dst.value.integer = src->value.integer;
364       break;
365     case GRPC_ARG_POINTER:
366       dst.value.pointer = src->value.pointer;
367       dst.value.pointer.p =
368           src->value.pointer.vtable->copy(src->value.pointer.p);
369       break;
370   }
371   return dst;
372 }
373 
grpc_channel_args_copy_and_add(const grpc_channel_args * src,const grpc_arg * to_add,size_t num_to_add)374 grpc_channel_args* grpc_channel_args_copy_and_add(const grpc_channel_args* src,
375                                                   const grpc_arg* to_add,
376                                                   size_t num_to_add) {
377   return grpc_channel_args_copy_and_add_and_remove(src, nullptr, 0, to_add,
378                                                    num_to_add);
379 }
380 
grpc_channel_args_copy_and_remove(const grpc_channel_args * src,const char ** to_remove,size_t num_to_remove)381 grpc_channel_args* grpc_channel_args_copy_and_remove(
382     const grpc_channel_args* src, const char** to_remove,
383     size_t num_to_remove) {
384   return grpc_channel_args_copy_and_add_and_remove(src, to_remove,
385                                                    num_to_remove, nullptr, 0);
386 }
387 
should_remove_arg(const grpc_arg * arg,const char ** to_remove,size_t num_to_remove)388 static bool should_remove_arg(const grpc_arg* arg, const char** to_remove,
389                               size_t num_to_remove) {
390   for (size_t i = 0; i < num_to_remove; ++i) {
391     if (strcmp(arg->key, to_remove[i]) == 0) return true;
392   }
393   return false;
394 }
395 
grpc_channel_args_copy_and_add_and_remove(const grpc_channel_args * src,const char ** to_remove,size_t num_to_remove,const grpc_arg * to_add,size_t num_to_add)396 grpc_channel_args* grpc_channel_args_copy_and_add_and_remove(
397     const grpc_channel_args* src, const char** to_remove, size_t num_to_remove,
398     const grpc_arg* to_add, size_t num_to_add) {
399   // Figure out how many args we'll be copying.
400   size_t num_args_to_copy = 0;
401   if (src != nullptr) {
402     for (size_t i = 0; i < src->num_args; ++i) {
403       if (!should_remove_arg(&src->args[i], to_remove, num_to_remove)) {
404         ++num_args_to_copy;
405       }
406     }
407   }
408   // Create result.
409   grpc_channel_args* dst =
410       static_cast<grpc_channel_args*>(gpr_malloc(sizeof(grpc_channel_args)));
411   dst->num_args = num_args_to_copy + num_to_add;
412   if (dst->num_args == 0) {
413     dst->args = nullptr;
414     return dst;
415   }
416   dst->args =
417       static_cast<grpc_arg*>(gpr_malloc(sizeof(grpc_arg) * dst->num_args));
418   // Copy args from src that are not being removed.
419   size_t dst_idx = 0;
420   if (src != nullptr) {
421     for (size_t i = 0; i < src->num_args; ++i) {
422       if (!should_remove_arg(&src->args[i], to_remove, num_to_remove)) {
423         dst->args[dst_idx++] = copy_arg(&src->args[i]);
424       }
425     }
426   }
427   // Add args from to_add.
428   for (size_t i = 0; i < num_to_add; ++i) {
429     dst->args[dst_idx++] = copy_arg(&to_add[i]);
430   }
431   GPR_ASSERT(dst_idx == dst->num_args);
432   return dst;
433 }
434 
grpc_channel_args_copy(const grpc_channel_args * src)435 grpc_channel_args* grpc_channel_args_copy(const grpc_channel_args* src) {
436   return grpc_channel_args_copy_and_add(src, nullptr, 0);
437 }
438 
grpc_channel_args_union(const grpc_channel_args * a,const grpc_channel_args * b)439 grpc_channel_args* grpc_channel_args_union(const grpc_channel_args* a,
440                                            const grpc_channel_args* b) {
441   if (a == nullptr) return grpc_channel_args_copy(b);
442   if (b == nullptr) return grpc_channel_args_copy(a);
443   const size_t max_out = (a->num_args + b->num_args);
444   grpc_arg* uniques =
445       static_cast<grpc_arg*>(gpr_malloc(sizeof(*uniques) * max_out));
446   for (size_t i = 0; i < a->num_args; ++i) uniques[i] = a->args[i];
447 
448   size_t uniques_idx = a->num_args;
449   for (size_t i = 0; i < b->num_args; ++i) {
450     const char* b_key = b->args[i].key;
451     if (grpc_channel_args_find(a, b_key) == nullptr) {  // not found
452       uniques[uniques_idx++] = b->args[i];
453     }
454   }
455   grpc_channel_args* result =
456       grpc_channel_args_copy_and_add(nullptr, uniques, uniques_idx);
457   gpr_free(uniques);
458   return result;
459 }
460 
cmp_arg(const grpc_arg * a,const grpc_arg * b)461 static int cmp_arg(const grpc_arg* a, const grpc_arg* b) {
462   int c = grpc_core::QsortCompare(a->type, b->type);
463   if (c != 0) return c;
464   c = strcmp(a->key, b->key);
465   if (c != 0) return c;
466   switch (a->type) {
467     case GRPC_ARG_STRING:
468       return strcmp(a->value.string, b->value.string);
469     case GRPC_ARG_INTEGER:
470       return grpc_core::QsortCompare(a->value.integer, b->value.integer);
471     case GRPC_ARG_POINTER:
472       return grpc_core::channel_args_detail::PointerCompare(
473           a->value.pointer.p, a->value.pointer.vtable, b->value.pointer.p,
474           b->value.pointer.vtable);
475   }
476   GPR_UNREACHABLE_CODE(return 0);
477 }
478 
479 // stabilizing comparison function: since channel_args ordering matters for
480 // keys with the same name, we need to preserve that ordering
cmp_key_stable(const void * ap,const void * bp)481 static int cmp_key_stable(const void* ap, const void* bp) {
482   const grpc_arg* const* a = static_cast<const grpc_arg* const*>(ap);
483   const grpc_arg* const* b = static_cast<const grpc_arg* const*>(bp);
484   int c = strcmp((*a)->key, (*b)->key);
485   if (c == 0) c = grpc_core::QsortCompare(*a, *b);
486   return c;
487 }
488 
grpc_channel_args_normalize(const grpc_channel_args * src)489 grpc_channel_args* grpc_channel_args_normalize(const grpc_channel_args* src) {
490   grpc_arg** args =
491       static_cast<grpc_arg**>(gpr_malloc(sizeof(grpc_arg*) * src->num_args));
492   for (size_t i = 0; i < src->num_args; i++) {
493     args[i] = &src->args[i];
494   }
495   if (src->num_args > 1) {
496     qsort(args, src->num_args, sizeof(grpc_arg*), cmp_key_stable);
497   }
498 
499   grpc_channel_args* b =
500       static_cast<grpc_channel_args*>(gpr_malloc(sizeof(grpc_channel_args)));
501   b->num_args = src->num_args;
502   b->args = static_cast<grpc_arg*>(gpr_malloc(sizeof(grpc_arg) * b->num_args));
503   for (size_t i = 0; i < src->num_args; i++) {
504     b->args[i] = copy_arg(args[i]);
505   }
506 
507   gpr_free(args);
508   return b;
509 }
510 
grpc_channel_args_destroy(grpc_channel_args * a)511 void grpc_channel_args_destroy(grpc_channel_args* a) {
512   size_t i;
513   if (!a) return;
514   for (i = 0; i < a->num_args; i++) {
515     switch (a->args[i].type) {
516       case GRPC_ARG_STRING:
517         gpr_free(a->args[i].value.string);
518         break;
519       case GRPC_ARG_INTEGER:
520         break;
521       case GRPC_ARG_POINTER:
522         a->args[i].value.pointer.vtable->destroy(a->args[i].value.pointer.p);
523         break;
524     }
525     gpr_free(a->args[i].key);
526   }
527   gpr_free(a->args);
528   gpr_free(a);
529 }
530 
grpc_channel_args_compare(const grpc_channel_args * a,const grpc_channel_args * b)531 int grpc_channel_args_compare(const grpc_channel_args* a,
532                               const grpc_channel_args* b) {
533   if (a == nullptr && b == nullptr) return 0;
534   if (a == nullptr || b == nullptr) return a == nullptr ? -1 : 1;
535   int c = grpc_core::QsortCompare(a->num_args, b->num_args);
536   if (c != 0) return c;
537   for (size_t i = 0; i < a->num_args; i++) {
538     c = cmp_arg(&a->args[i], &b->args[i]);
539     if (c != 0) return c;
540   }
541   return 0;
542 }
543 
grpc_channel_args_find(const grpc_channel_args * args,const char * name)544 const grpc_arg* grpc_channel_args_find(const grpc_channel_args* args,
545                                        const char* name) {
546   if (args != nullptr) {
547     for (size_t i = 0; i < args->num_args; ++i) {
548       if (strcmp(args->args[i].key, name) == 0) {
549         return &args->args[i];
550       }
551     }
552   }
553   return nullptr;
554 }
555 
grpc_channel_arg_get_integer(const grpc_arg * arg,const grpc_integer_options options)556 int grpc_channel_arg_get_integer(const grpc_arg* arg,
557                                  const grpc_integer_options options) {
558   if (arg == nullptr) return options.default_value;
559   if (arg->type != GRPC_ARG_INTEGER) {
560     gpr_log(GPR_ERROR, "%s ignored: it must be an integer", arg->key);
561     return options.default_value;
562   }
563   if (arg->value.integer < options.min_value) {
564     gpr_log(GPR_ERROR, "%s ignored: it must be >= %d", arg->key,
565             options.min_value);
566     return options.default_value;
567   }
568   if (arg->value.integer > options.max_value) {
569     gpr_log(GPR_ERROR, "%s ignored: it must be <= %d", arg->key,
570             options.max_value);
571     return options.default_value;
572   }
573   return arg->value.integer;
574 }
575 
grpc_channel_args_find_integer(const grpc_channel_args * args,const char * name,const grpc_integer_options options)576 int grpc_channel_args_find_integer(const grpc_channel_args* args,
577                                    const char* name,
578                                    const grpc_integer_options options) {
579   const grpc_arg* arg = grpc_channel_args_find(args, name);
580   return grpc_channel_arg_get_integer(arg, options);
581 }
582 
grpc_channel_arg_get_string(const grpc_arg * arg)583 char* grpc_channel_arg_get_string(const grpc_arg* arg) {
584   if (arg == nullptr) return nullptr;
585   if (arg->type != GRPC_ARG_STRING) {
586     gpr_log(GPR_ERROR, "%s ignored: it must be an string", arg->key);
587     return nullptr;
588   }
589   return arg->value.string;
590 }
591 
grpc_channel_args_find_string(const grpc_channel_args * args,const char * name)592 char* grpc_channel_args_find_string(const grpc_channel_args* args,
593                                     const char* name) {
594   const grpc_arg* arg = grpc_channel_args_find(args, name);
595   return grpc_channel_arg_get_string(arg);
596 }
597 
grpc_channel_arg_get_bool(const grpc_arg * arg,bool default_value)598 bool grpc_channel_arg_get_bool(const grpc_arg* arg, bool default_value) {
599   if (arg == nullptr) return default_value;
600   if (arg->type != GRPC_ARG_INTEGER) {
601     gpr_log(GPR_ERROR, "%s ignored: it must be an integer", arg->key);
602     return default_value;
603   }
604   switch (arg->value.integer) {
605     case 0:
606       return false;
607     case 1:
608       return true;
609     default:
610       gpr_log(GPR_ERROR, "%s treated as bool but set to %d (assuming true)",
611               arg->key, arg->value.integer);
612       return true;
613   }
614 }
615 
grpc_channel_args_find_bool(const grpc_channel_args * args,const char * name,bool default_value)616 bool grpc_channel_args_find_bool(const grpc_channel_args* args,
617                                  const char* name, bool default_value) {
618   const grpc_arg* arg = grpc_channel_args_find(args, name);
619   return grpc_channel_arg_get_bool(arg, default_value);
620 }
621 
grpc_channel_args_want_minimal_stack(const grpc_channel_args * args)622 bool grpc_channel_args_want_minimal_stack(const grpc_channel_args* args) {
623   return grpc_channel_arg_get_bool(
624       grpc_channel_args_find(args, GRPC_ARG_MINIMAL_STACK), false);
625 }
626 
grpc_channel_arg_string_create(char * name,char * value)627 grpc_arg grpc_channel_arg_string_create(char* name, char* value) {
628   grpc_arg arg;
629   arg.type = GRPC_ARG_STRING;
630   arg.key = name;
631   arg.value.string = value;
632   return arg;
633 }
634 
grpc_channel_arg_integer_create(char * name,int value)635 grpc_arg grpc_channel_arg_integer_create(char* name, int value) {
636   grpc_arg arg;
637   arg.type = GRPC_ARG_INTEGER;
638   arg.key = name;
639   arg.value.integer = value;
640   return arg;
641 }
642 
grpc_channel_arg_pointer_create(char * name,void * value,const grpc_arg_pointer_vtable * vtable)643 grpc_arg grpc_channel_arg_pointer_create(
644     char* name, void* value, const grpc_arg_pointer_vtable* vtable) {
645   grpc_arg arg;
646   arg.type = GRPC_ARG_POINTER;
647   arg.key = name;
648   arg.value.pointer.p = value;
649   arg.value.pointer.vtable = vtable;
650   return arg;
651 }
652 
grpc_channel_args_string(const grpc_channel_args * args)653 std::string grpc_channel_args_string(const grpc_channel_args* args) {
654   return grpc_core::ChannelArgs::FromC(args).ToString();
655 }
656 
657 namespace grpc_core {
ChannelArgsBuiltinPrecondition(const grpc_channel_args * src)658 ChannelArgs ChannelArgsBuiltinPrecondition(const grpc_channel_args* src) {
659   if (src == nullptr) return ChannelArgs();
660   ChannelArgs output;
661   std::map<absl::string_view, std::vector<absl::string_view>>
662       concatenated_values;
663   for (size_t i = 0; i < src->num_args; i++) {
664     absl::string_view key = src->args[i].key;
665     // User-agent strings were traditionally multi-valued and concatenated.
666     // We preserve this behavior for backwards compatibility.
667     if (key == GRPC_ARG_PRIMARY_USER_AGENT_STRING ||
668         key == GRPC_ARG_SECONDARY_USER_AGENT_STRING) {
669       if (src->args[i].type != GRPC_ARG_STRING) {
670         gpr_log(GPR_ERROR, "Channel argument '%s' should be a string",
671                 std::string(key).c_str());
672       } else {
673         concatenated_values[key].push_back(src->args[i].value.string);
674       }
675       continue;
676     } else if (absl::StartsWith(key, "grpc.internal.")) {
677       continue;
678     }
679     if (!output.Contains(key)) {
680       output = output.Set(src->args[i]);
681     } else {
682       // Traditional grpc_channel_args_find behavior was to pick the first
683       // value.
684       // For compatibility with existing users, we will do the same here.
685     }
686   }
687   // Concatenate the concatenated values.
688   for (const auto& concatenated_value : concatenated_values) {
689     output = output.Set(concatenated_value.first,
690                         absl::StrJoin(concatenated_value.second, " "));
691   }
692   return output;
693 }
694 
695 }  // namespace grpc_core
696 
697 namespace {
698 grpc_channel_args_client_channel_creation_mutator g_mutator = nullptr;
699 }  // namespace
700 
grpc_channel_args_set_client_channel_creation_mutator(grpc_channel_args_client_channel_creation_mutator cb)701 void grpc_channel_args_set_client_channel_creation_mutator(
702     grpc_channel_args_client_channel_creation_mutator cb) {
703   GPR_DEBUG_ASSERT(g_mutator == nullptr);
704   g_mutator = cb;
705 }
706 grpc_channel_args_client_channel_creation_mutator
grpc_channel_args_get_client_channel_creation_mutator()707 grpc_channel_args_get_client_channel_creation_mutator() {
708   return g_mutator;
709 }
710