ceph/src/seastar/include/seastar/net/dpdk.hh

   1 /*
   2  * This file is open source software, licensed to you under the terms
   3  * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
   4  * distributed with this work for additional information regarding copyright
   5  * ownership.  You may not use this file except in compliance with the License.
   6  *
   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,
  12  * software distributed under the License is distributed on an
  13  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14  * KIND, either express or implied.  See the License for the
  15  * specific language governing permissions and limitations
  16  * under the License.
  17  */
  18 /*
  19  * Copyright (C) 2014 Cloudius Systems, Ltd.
  20  */
  21
  22 #pragma once
  23
  24 #include <memory>
  25 #include <seastar/net/config.hh>
  26 #include <seastar/net/net.hh>
  27 #include <seastar/core/sstring.hh>
  28 #include <seastar/util/program-options.hh>
  29
  30 namespace seastar {
  31
  32 namespace net {
  33
  34 /// DPDK configuration.
  35 struct dpdk_options : public program_options::option_group {
  36     /// DPDK Port Index.
  37     ///
  38     /// Default: 0.
  39     program_options::value<unsigned> dpdk_port_index;
  40     /// \brief Enable HW Flow Control (on / off).
  41     ///
  42     /// Default: \p on.
  43     program_options::value<std::string> hw_fc;
  44
  45     /// \cond internal
  46     dpdk_options(program_options::option_group* parent_group);
  47     /// \endcond
  48 };
  49
  50 }
  51
  52 /// \cond internal
  53
  54 #ifdef SEASTAR_HAVE_DPDK
  55
  56 std::unique_ptr<net::device> create_dpdk_net_device(
  57                                     uint16_t port_idx = 0,
  58                                     uint16_t num_queues = 1,
  59                                     bool use_lro = true,
  60                                     bool enable_fc = true);
  61
  62 std::unique_ptr<net::device> create_dpdk_net_device(
  63                                     const net::hw_config& hw_cfg);
  64
  65 namespace dpdk {
  66 /**
  67  * @return Number of bytes needed for mempool objects of each QP.
  68  */
  69 uint32_t qp_mempool_obj_size(bool hugetlbfs_membackend);
  70 }
  71
  72 /// \endcond
  73
  74 #endif // SEASTAR_HAVE_DPDK
  75
  76 }