regex_revalidate c++ and lifecycle message reload and print

Author: traeak

doc/admin-guide/plugins/regex_revalidate.en.rst

@@ -40,36 +40,34 @@ regular expression against your origin URLs permits. Thus, individual cache
 objects may have rules created for them, or entire path prefixes, or even any
 cache objects with a particular file extension.
 
-Installation
-============
-
-To make this plugin available, you must enable experimental plugins when
-building |TS|::
-
-    ./configure --enable-experimental-plugins
-
 Configuration
 =============
+.. program:: regex_revalidate.so
 
-This plugin is enabled via the :file:`plugin.config` configuration file, with
-two required arguments: the path to a rules file, and the path to a log file::
+``Regex Revalidate`` is a global plugin and is configured via :file:`plugin.config`.
+    .. option:: --config <path to revalidate rules> (also -c)
 
-    regex_revalidate.so -c <path to rules> -l <path to log>
+    (`required`) - specifies the file which contains the revalidation rules.
+    The rule configuration file format is described below in
+    `Revalidation Rules`_.  These rules are always reloaded when
+    ``traffic_ctl config reload`` is invoked.
 
-The rule configuration file format is described below in `Revalidation Rules`_.
+    .. option:: --log <path to log> (also -l)
 
-By default The plugin regularly (every 60 seconds) checks its rules configuration
-file for changes and it will also check for changes when ``traffic_ctl config reload``
-is run. If the file has been modified since its last scan, the contents
-are read and the in-memory rules list is updated. Thus, new rules may be added and
-existing ones modified without requiring a service restart.
+    (`optional`) - specifies path to rule logging. This log is written to
+    after rule changes and contains the current active ruleset.  If missing
+    no log file is generated.
 
-The configuration parameter `--disable-timed-updates` or `-d` may be used to configure
-the plugin to disable timed config file change checks.  With timed checks disabled,
-config file changes are checked are only when ``traffic_ctl config reload`` is run.::
+    .. option:: --disable-timed-reload (also -d)
 
-    regex_revalidate.so -d -c <path to rules> -l <path to log>
+    (`optional`) - default plugin behaviour is to check the revalidate
+    rules file for changes every 60 seconds.  This option disables the
+    checking.
 
+``traffic_ctl`` <command>
+    * ``traffic_ctl config reload`` - triggers a reload of the rules file.  If there are no changes then the loaded rules are discarded.
+    * ``traffic_ctl plugin msg regex_revalidate config_reload`` - triggers a reload of the rules file apart from a full config reload.
+    * ``traffic_ctl plugin msg regex_revalidate config_print`` - writes the current active ruleset to :file:`traffic.out`
 
 Revalidation Rules
 ==================
@@ -111,11 +109,11 @@ the fact that the plugin uses :c:data:`TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK`.
 Removing Rules
 --------------
 
-While new rules are added dynamically (the configuration file is checked every
-60 seconds for changes), rule lines removed from the configuration file do not
-currently lead to that rule being removed from the running plugin. In these
-cases, if the rule must be taken out of service, a service restart may be
-necessary.
+While new rules are added dynamically (the configuration file is checked
+every 60 seconds for changes), rule lines removed from the configuration
+file do not currently lead to that rule being removed from the running
+plugin. To take these rules out of service the rule should be assigned a
+new time in the past which will cause it to be pruned during reload phase.
 
 Examples
 ========

plugins/regex_revalidate/Makefile.inc

@@ -15,4 +15,4 @@
 #  limitations under the License.
 
 pkglib_LTLIBRARIES += regex_revalidate/regex_revalidate.la
-regex_revalidate_regex_revalidate_la_SOURCES = regex_revalidate/regex_revalidate.c
+regex_revalidate_regex_revalidate_la_SOURCES = regex_revalidate/regex_revalidate.cc regex_revalidate/regex.cc

plugins/regex_revalidate/regex.cc

@@ -0,0 +1,115 @@
+/** @file
+
+  PCRE support wrapper.
+
+  @section license License
+
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you 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
+
+      http://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.
+ */
+
+#include "regex.h"
+
+#ifdef PCRE_CONFIG_JIT
+#include <pthread.h>
+
+struct RegexThreadKey {
+  RegexThreadKey() { pthread_key_create(&this->key, reinterpret_cast<void (*)(void *)>(&pcre_jit_stack_free)); }
+  pthread_key_t key;
+};
+
+static RegexThreadKey k;
+
+static pcre_jit_stack *
+get_jit_stack(void *)
+{
+  pcre_jit_stack *jit_stack;
+
+  if ((jit_stack = static_cast<pcre_jit_stack *>(pthread_getspecific(k.key))) == nullptr) {
+    jit_stack = pcre_jit_stack_alloc(8192, 1024 * 1024); // 1 page min and 1MB max
+    pthread_setspecific(k.key, (void *)jit_stack);
+  }
+
+  return jit_stack;
+}
+#endif
+
+bool
+Regex::compile(const char *pattern, const unsigned flags)
+{
+  const char *error;
+  int erroffset;
+  int options    = 0;
+  int study_opts = 0;
+
+  if (nullptr != this->regex) {
+    return false;
+  }
+
+  if (flags & CASE_INSENSITIVE) {
+    options |= PCRE_CASELESS;
+  }
+
+  if (flags & ANCHORED) {
+    options |= PCRE_ANCHORED;
+  }
+
+  this->regex = pcre_compile(pattern, options, &error, &erroffset, nullptr);
+  if (error) {
+    this->regex = nullptr;
+    return false;
+  }
+
+#ifdef PCRE_CONFIG_JIT
+  study_opts |= PCRE_STUDY_JIT_COMPILE;
+#endif
+
+  this->regex_extra = pcre_study(this->regex, study_opts, &error);
+
+#ifdef PCRE_CONFIG_JIT
+  if (nullptr != this->regex_extra) {
+    pcre_assign_jit_stack(this->regex_extra, &get_jit_stack, nullptr);
+  }
+#endif
+
+  return true;
+}
+
+bool
+Regex::matches(std::string_view const &src) const
+{
+  return 0 <= exec(src, nullptr, 0);
+}
+
+int
+Regex::exec(std::string_view const &src, int *ovector, int const ovecsize) const
+{
+  return pcre_exec(this->regex, this->regex_extra, src.data(), src.size(), 0, 0, ovector, ovecsize);
+}
+
+Regex::~Regex()
+{
+  if (regex_extra) {
+#ifdef PCRE_CONFIG_JIT
+    pcre_free_study(regex_extra);
+#else
+    pcre_free(regex_extra);
+#endif
+  }
+  if (regex) {
+    pcre_free(regex);
+  }
+}

plugins/regex_revalidate/regex.h

@@ -0,0 +1,81 @@
+/** @file
+
+  Wrapper to make PCRE handling easier.
+
+  @section license License
+
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you 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
+
+      http://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.
+ */
+
+#pragma once
+
+#include <pcre.h>
+#include <algorithm>
+#include <string_view>
+
+class Regex
+{
+public:
+  enum Flag {
+    CASE_INSENSITIVE = 0x0001, // default is case sensitive
+    UNANCHORED       = 0x0002, // default (for DFA) is to anchor at the first matching position
+    ANCHORED         = 0x0004, // default (for Regex) is unanchored
+  };
+
+  Regex() = default;
+  Regex(Regex &&that);
+  Regex &operator=(Regex &&that);
+
+  bool compile(const char *pattern, const unsigned flags = 0);
+
+  // check if valid regex
+  bool is_valid() const;
+
+  // check for simple match
+  bool matches(std::string_view const &src) const;
+
+  // match returning substring positions.
+  int exec(std::string_view const &src, int *ovector, int const ovecsize) const;
+
+  ~Regex();
+
+private:
+  pcre *regex             = nullptr;
+  pcre_extra *regex_extra = nullptr;
+};
+
+inline Regex::Regex(Regex &&that)
+{
+  std::swap(regex, that.regex);
+  std::swap(regex_extra, that.regex_extra);
+}
+
+inline Regex &
+Regex::operator=(Regex &&that)
+{
+  if (&that != this) {
+    std::swap(regex, that.regex);
+    std::swap(regex_extra, that.regex_extra);
+  }
+  return *this;
+}
+
+inline bool
+Regex::is_valid() const
+{
+  return nullptr != regex;
+}