blob: 5b8a7562c943204841a7866be91d753a6dc44d5f [file] [log] [blame]
andresp@webrtc.orga36ad692014-05-14 12:24:04 +00001// Copyright (c) 2014 The WebRTC project authors. All Rights Reserved.
2//
3// Use of this source code is governed by a BSD-style license
4// that can be found in the LICENSE file in the root of the source
5// tree. An additional intellectual property rights grant can be found
6// in the file PATENTS. All contributing project authors may
7// be found in the AUTHORS file in the root of the source tree.
8//
9
Karl Wiberg79eb1d92017-11-08 12:26:07 +010010#include "system_wrappers/include/field_trial.h"
andresp@webrtc.orga36ad692014-05-14 12:24:04 +000011
Yves Gerey988cc082018-10-23 12:03:01 +020012#include <stddef.h>
Jonas Olsson5b2eda42019-06-11 14:29:40 +020013
14#include <map>
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000015#include <string>
16
Jonas Olsson5b2eda42019-06-11 14:29:40 +020017#include "absl/strings/string_view.h"
18#include "rtc_base/checks.h"
19#include "rtc_base/logging.h"
20
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000021// Simple field trial implementation, which allows client to
22// specify desired flags in InitFieldTrialsFromString.
andresp@webrtc.orga36ad692014-05-14 12:24:04 +000023namespace webrtc {
24namespace field_trial {
25
Karl Wiberg79eb1d92017-11-08 12:26:07 +010026static const char* trials_init_string = NULL;
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000027
Mirko Bonadei92e00382018-09-15 10:37:11 +020028#ifndef WEBRTC_EXCLUDE_FIELD_TRIAL_DEFAULT
Jonas Olsson5b2eda42019-06-11 14:29:40 +020029namespace {
30constexpr char kPersistentStringSeparator = '/';
31// Validates the given field trial string.
32// E.g.:
33// "WebRTC-experimentFoo/Enabled/WebRTC-experimentBar/Enabled100kbps/"
34// Assigns the process to group "Enabled" on WebRTCExperimentFoo trial
35// and to group "Enabled100kbps" on WebRTCExperimentBar.
36//
37// E.g. invalid config:
38// "WebRTC-experiment1/Enabled" (note missing / separator at the end).
39bool FieldTrialsStringIsValid(const absl::string_view trials) {
40 if (trials.empty())
41 return true;
42
43 size_t next_item = 0;
44 std::map<absl::string_view, absl::string_view> field_trials;
45 while (next_item < trials.length()) {
46 size_t name_end = trials.find(kPersistentStringSeparator, next_item);
47 if (name_end == trials.npos || next_item == name_end)
48 return false;
49 size_t group_name_end =
50 trials.find(kPersistentStringSeparator, name_end + 1);
51 if (group_name_end == trials.npos || name_end + 1 == group_name_end)
52 return false;
53 absl::string_view name = trials.substr(next_item, name_end - next_item);
54 absl::string_view group_name =
55 trials.substr(name_end + 1, group_name_end - name_end - 1);
56
57 next_item = group_name_end + 1;
58
59 // Fail if duplicate with different group name.
60 if (field_trials.find(name) != field_trials.end() &&
61 field_trials.find(name)->second != group_name) {
62 return false;
63 }
64
65 field_trials[name] = group_name;
66 }
67
68 return true;
69}
70} // namespace
71
andresp@webrtc.orga36ad692014-05-14 12:24:04 +000072std::string FindFullName(const std::string& name) {
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000073 if (trials_init_string == NULL)
74 return std::string();
75
76 std::string trials_string(trials_init_string);
77 if (trials_string.empty())
78 return std::string();
79
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000080 size_t next_item = 0;
81 while (next_item < trials_string.length()) {
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000082 // Find next name/value pair in field trial configuration string.
Karl Wiberg79eb1d92017-11-08 12:26:07 +010083 size_t field_name_end =
84 trials_string.find(kPersistentStringSeparator, next_item);
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000085 if (field_name_end == trials_string.npos || field_name_end == next_item)
86 break;
Karl Wiberg79eb1d92017-11-08 12:26:07 +010087 size_t field_value_end =
88 trials_string.find(kPersistentStringSeparator, field_name_end + 1);
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000089 if (field_value_end == trials_string.npos ||
90 field_value_end == field_name_end + 1)
91 break;
92 std::string field_name(trials_string, next_item,
Karl Wiberg79eb1d92017-11-08 12:26:07 +010093 field_name_end - next_item);
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000094 std::string field_value(trials_string, field_name_end + 1,
Karl Wiberg79eb1d92017-11-08 12:26:07 +010095 field_value_end - field_name_end - 1);
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +000096 next_item = field_value_end + 1;
97
98 if (name == field_name)
99 return field_value;
100 }
andresp@webrtc.orga36ad692014-05-14 12:24:04 +0000101 return std::string();
102}
Mirko Bonadei92e00382018-09-15 10:37:11 +0200103#endif // WEBRTC_EXCLUDE_FIELD_TRIAL_DEFAULT
andresp@webrtc.orga36ad692014-05-14 12:24:04 +0000104
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +0000105// Optionally initialize field trial from a string.
106void InitFieldTrialsFromString(const char* trials_string) {
Jonas Olsson5b2eda42019-06-11 14:29:40 +0200107 RTC_LOG(LS_INFO) << "Setting field trial string:" << trials_string;
108#ifndef WEBRTC_EXCLUDE_FIELD_TRIAL_DEFAULT
109 if (trials_string) {
110 RTC_DCHECK(FieldTrialsStringIsValid(trials_string))
111 << "Invalid field trials string:" << trials_string;
112 };
113#endif // WEBRTC_EXCLUDE_FIELD_TRIAL_DEFAULT
glaznev@webrtc.org669bc7e2015-02-09 18:17:46 +0000114 trials_init_string = trials_string;
115}
116
phoglund37ebcf02016-01-08 05:04:57 -0800117const char* GetFieldTrialString() {
118 return trials_init_string;
119}
120
andresp@webrtc.orga36ad692014-05-14 12:24:04 +0000121} // namespace field_trial
122} // namespace webrtc