lookup_structures.h

Go to the documentation of this file.

/* Copyright 2013-present Barefoot Networks, Inc.
 *
 * 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
 *
 *   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.
 */
 
/*
 * Gordon Bailey (gb@gordonbailey.net)
 *
 */
 
 
#ifndef BM_BM_SIM_LOOKUP_STRUCTURES_H_
#define BM_BM_SIM_LOOKUP_STRUCTURES_H_
 
#include <memory>
 
#include "match_key_types.h"
#include "bytecontainer.h"
 
namespace bm {
 
template <typename K>
class LookupStructure {
 public:
  virtual ~LookupStructure() = default;
 
  virtual bool lookup(const ByteContainer &key_data,
                      internal_handle_t *handle) const = 0;
 
  virtual bool entry_exists(const K &key) const = 0;
 
  virtual bool retrieve_handle(const K &key,
                               internal_handle_t *handle) const = 0;
 
  virtual void add_entry(const K &key, internal_handle_t handle) = 0;
 
  virtual void delete_entry(const K &key) = 0;
 
  virtual void clear() = 0;
};
 
// Convenience alias declarations to simplify the code needed to override
// LookupStructure and LookupStructureFactory
using ExactLookupStructure = LookupStructure<ExactMatchKey>;
using LPMLookupStructure = LookupStructure<LPMMatchKey>;
using TernaryLookupStructure = LookupStructure<TernaryMatchKey>;
using RangeLookupStructure = LookupStructure<RangeMatchKey>;
 
class LookupStructureFactory {
 public:
  explicit LookupStructureFactory(bool enable_ternary_cache = true);
 
  virtual ~LookupStructureFactory() = default;
 
  template <typename K>
  static std::unique_ptr<LookupStructure<K> > create(
      LookupStructureFactory *f, size_t size, size_t nbytes_key);
 
  virtual std::unique_ptr<ExactLookupStructure>
  create_for_exact(size_t size, size_t nbytes_key);
 
  virtual std::unique_ptr<LPMLookupStructure>
  create_for_LPM(size_t size, size_t nbytes_key);
 
  virtual std::unique_ptr<TernaryLookupStructure>
  create_for_ternary(size_t size, size_t nbytes_key);
 
  virtual std::unique_ptr<RangeLookupStructure>
  create_for_range(size_t size, size_t nbytes_key);
 
 private:
  bool enable_ternary_cache;
};
 
 
}  // namespace bm
 
 
#endif  // BM_BM_SIM_LOOKUP_STRUCTURES_H_