Changed ControlMatcher to use PCRE2 (#12376)

Author: bryancall

include/proxy/ControlMatcher.h

@@ -97,13 +97,8 @@
 #include "tsutil/Regex.h"
 #include "proxy/hdrs/URL.h"
 
-#if __has_include("pcre/pcre.h")
-#include <pcre/pcre.h>
-#elif __has_include("pcre.h")
-#include <pcre.h>
-#else
-#error "Unable to locate PCRE heeader"
-#endif
+#define PCRE2_CODE_UNIT_WIDTH 8
+#include "pcre2.h"
 
 #include <swoc/swoc_ip.h>
 
@@ -159,7 +154,7 @@ class HttpRequestData : public RequestData
 };
 
 // Mixin class for shared info across all templates. This just wraps the
-// shared members such that we don't have to duplicate all these initialixers
+// shared members such that we don't have to duplicate all these initializers
 // etc. If someone wants to rewrite all this code to use setters and getters,
 // by all means, please do so. The plumbing is in place :).
 template <class Data> class BaseMatcher
@@ -209,7 +204,6 @@ template <class Data, class MatchResult> class RegexMatcher : protected BaseMatc
 
 public:
   RegexMatcher(const char *name, const char *filename);
-  ~RegexMatcher();
 
   void   AllocateSpace(int num_entries);
   Result NewEntry(matcher_line *line_info);
@@ -224,8 +218,8 @@ template <class Data, class MatchResult> class RegexMatcher : protected BaseMatc
   using super::num_el;
 
 protected:
-  pcre **re_array = nullptr; // array of compiled regexs
-  char **re_str   = nullptr; // array of uncompiled regex strings
+  std::vector<Regex>       regex_array;   // array of regexs
+  std::vector<std::string> regex_strings; // array of regex strings
 };
 
 template <class Data, class MatchResult> class HostRegexMatcher : public RegexMatcher<Data, MatchResult>

src/proxy/ControlMatcher.cc

@@ -152,9 +152,8 @@ HostMatcher<Data, MatchResult>::Match(RequestData *rdata, MatchResult *result) c
   Data *data_ptr;
   bool  r;
 
-  // Check to see if there is any work to do before making
-  //   the string copy
-  if (num_el <= 0) {
+  // Check to see if there is any work to do before making the string copy
+  if (this->num_el <= 0) {
     return;
   }
 
@@ -335,8 +334,7 @@ UrlMatcher<Data, MatchResult>::Match(RequestData *rdata, MatchResult *result) co
 {
   char *url_str;
 
-  // Check to see there is any work to before we copy the
-  //   URL
+  // Check to see there is any work to before we copy the URL
   if (num_el <= 0) {
     return;
   }
@@ -365,19 +363,6 @@ RegexMatcher<Data, MatchResult>::RegexMatcher(const char *name, const char *file
 {
 }
 
-//
-// RegexMatcher<Data,MatchResult>::~RegexMatcher()
-//
-template <class Data, class MatchResult> RegexMatcher<Data, MatchResult>::~RegexMatcher()
-{
-  for (int i = 0; i < num_el; i++) {
-    pcre_free(re_array[i]);
-    ats_free(re_str[i]);
-  }
-  delete[] re_str;
-  ats_free(re_array);
-}
-
 //
 // void RegexMatcher<Data,MatchResult>::Print() const
 //
@@ -389,7 +374,7 @@ RegexMatcher<Data, MatchResult>::Print() const
 {
   printf("\tRegex Matcher with %d elements\n", num_el);
   for (int i = 0; i < num_el; i++) {
-    printf("\t\tRegex: %s\n", re_str[i]);
+    printf("\t\tRegex: %s\n", regex_strings[i].c_str());
     data_array[i].Print();
   }
 }
@@ -404,14 +389,11 @@ RegexMatcher<Data, MatchResult>::AllocateSpace(int num_entries)
   // Should not have been allocated before
   ink_assert(array_len == -1);
 
-  re_array = static_cast<pcre **>(ats_malloc(sizeof(pcre *) * num_entries));
-  memset(re_array, 0, sizeof(pcre *) * num_entries);
+  regex_array.resize(num_entries);
+  regex_strings.resize(num_entries);
 
   data_array = new Data[num_entries];
 
-  re_str = new char *[num_entries];
-  memset(re_str, 0, sizeof(char *) * num_entries);
-
   array_len = num_entries;
   num_el    = 0;
 }
@@ -425,7 +407,7 @@ RegexMatcher<Data, MatchResult>::NewEntry(matcher_line *line_info)
 {
   Data       *cur_d;
   char       *pattern;
-  const char *errptr;
+  std::string error_msg;
   int         erroffset;
   Result      error = Result::ok();
 
@@ -442,12 +424,12 @@ RegexMatcher<Data, MatchResult>::NewEntry(matcher_line *line_info)
   ink_assert(pattern != nullptr);
 
   // Create the compiled regular expression
-  re_array[num_el] = pcre_compile(pattern, 0, &errptr, &erroffset, nullptr);
-  if (!re_array[num_el]) {
+  regex_array[num_el].compile(pattern, error_msg, erroffset);
+  if (regex_array[num_el].empty()) {
     return Result::failure("%s regular expression error at line %d position %d : %s", matcher_name, line_info->line_num, erroffset,
-                           errptr);
+                           error_msg.c_str());
   }
-  re_str[num_el] = ats_strdup(pattern);
+  regex_strings[num_el] = pattern;
 
   // Remove our consumed label from the parsed line
   line_info->line[0][line_info->dest_entry] = nullptr;
@@ -459,10 +441,7 @@ RegexMatcher<Data, MatchResult>::NewEntry(matcher_line *line_info)
 
   if (error.failed()) {
     // There was a problem so undo the effects this function
-    ats_free(re_str[num_el]);
-    re_str[num_el] = nullptr;
-    pcre_free(re_array[num_el]);
-    re_array[num_el] = nullptr;
+    regex_strings[num_el] = ""; // reset the string
   } else {
     num_el++;
   }
@@ -473,23 +452,19 @@ RegexMatcher<Data, MatchResult>::NewEntry(matcher_line *line_info)
 //
 // void RegexMatcher<Data,MatchResult>::Match(RequestData* rdata, MatchResult* result)
 //
-//   Coduncts a linear search through the regex array and
+//   Conducts a linear search through the regex array and
 //     updates arg result for each regex that matches arg URL
 //
 template <class Data, class MatchResult>
 void
 RegexMatcher<Data, MatchResult>::Match(RequestData *rdata, MatchResult *result) const
 {
-  char *url_str;
-  int   r;
-
-  // Check to see there is any work to before we copy the
-  //   URL
+  // Check to see there is any work to before we copy the URL
   if (num_el <= 0) {
     return;
   }
 
-  url_str = rdata->get_string();
+  char *url_str = rdata->get_string();
 
   // Can't do a regex match with a NULL string so
   //  use an empty one instead
@@ -500,15 +475,13 @@ RegexMatcher<Data, MatchResult>::Match(RequestData *rdata, MatchResult *result)
   // INKqa12980
   // The function unescapifyStr() is already called in
   // HttpRequestData::get_string(); therefore, no need to call again here.
-
   for (int i = 0; i < num_el; i++) {
-    r = pcre_exec(re_array[i], nullptr, url_str, strlen(url_str), 0, 0, nullptr, 0);
-    if (r > -1) {
+    if (regex_array[i].exec(url_str) == true) {
       Dbg(dbg_ctl_matcher, "%s Matched %s with regex at line %d", matcher_name, url_str, data_array[i].line_num);
       data_array[i].UpdateMatch(result, rdata);
-    } else if (r < -1) {
+    } else {
       // An error has occurred
-      Warning("Error [%d] matching regex at line %d.", r, data_array[i].line_num);
+      Warning("Error matching regex at line %d.", data_array[i].line_num);
     } // else it's -1 which means no match was found.
   }
   ats_free(url_str);
@@ -534,10 +507,8 @@ void
 HostRegexMatcher<Data, MatchResult>::Match(RequestData *rdata, MatchResult *result) const
 {
   const char *url_str;
-  int         r;
 
-  // Check to see there is any work to before we copy the
-  //   URL
+  // Check to see there is any work to before we copy the URL
   if (this->num_el <= 0) {
     return;
   }
@@ -549,9 +520,8 @@ HostRegexMatcher<Data, MatchResult>::Match(RequestData *rdata, MatchResult *resu
   if (url_str == nullptr) {
     url_str = "";
   }
-  for (int i = 0; i < this->num_el; i++) {
-    r = pcre_exec(this->re_array[i], nullptr, url_str, strlen(url_str), 0, 0, nullptr, 0);
-    if (r != -1) {
+  for (int i = 0; i < num_el; i++) {
+    if (this->regex_array[i].exec(url_str) == true) {
       Dbg(dbg_ctl_matcher, "%s Matched %s with regex at line %d", const_cast<char *>(this->matcher_name), url_str,
           this->data_array[i].line_num);
       this->data_array[i].UpdateMatch(result, rdata);

src/traffic_server/traffic_server.cc

@@ -1786,9 +1786,6 @@ main(int /* argc ATS_UNUSED */, const char **argv)
   // Override default swoc::Errata settings.
   Initialize_Errata_Settings();
 
-  pcre_malloc = ats_malloc;
-  pcre_free   = ats_free;
-
   // Define the version info
   auto &version = AppVersionInfo::setup_version("traffic_server");