2. 当子句

当子句由一个布尔表达式和一组指令组成。在每次确认后，数据路径会检查布尔表达式，如果它评估为 true，则运行指令集。例如，以下当子句会在每个 rtt 后发送报告（即调用 on_report 函数）。

(when (> Micros Flow.rtt_sample_us)
    (report)
)

综合起来

一个示例算法定义，显示完整的 API

import portus

# Class must sublcass portus.AlgBase
class SampleCCAlg(portus.AlgBase):
  # Init must take exactly these parameters
  def __init__(self, datapath, datapath_info):
    # Store a copy of the datapath and info for later
    self.datapath = datapath
    self.datapath_info = datapath_info
    
    # Internally store an initial cwnd value
    self.cwnd = 10 * self.datapath_info.mss
    
    # Install an initial datapath program to keep track of the RTT and report it once per RTT
    # The first when clause is true on every single ack,
    #    which means the 'Report.rtt' field will always keep the latest rtt sample
    # The second when clause is true once one rtt's worth of time has passed, 
    #    at which point it will trigger on_report, and Micros (and Report.rtt) will be reset to 0
    self.datapath.install("""\
    (def
        (Report.rtt 0)
    )
    (when true
        (:= Report.rtt Flow.rtt_sample_us)
        (fallthrough)
    )
    (when (> Micros Flow.rtt_sample_us)
        (report)
    )
    """)

  # This function will be called once per RTT, and the report struct `r` will contain:
  # "rtt", "Cwnd", and "Rate"
  def on_report(self, r):
      # Compute new cwnd internally 
      # If the rtt has decreased, increase the cwnd by 1 packet, else decrease by 1 packet
      if self.last_rtt < r.rtt:
          self.cwnd += self.datapath_info.mss
      else:
          self.cwnd -= self.datapath_info.mss
      self.last_rtt = r.rtt
      
      # Send this new value of cwnd to the datapath
      self.datapath.update_field("Cwnd", self.cwnd)
    

重要提示

1. 您应该在您的 __init__ 实现中安装一个初始数据路径程序，否则您将不会收到任何报告，也不会发生任何事情。您可以在处理 on_report 时稍后安装不同的数据路径程序。
2. 如果您想打印任何内容，应使用 sys.stderr.write()（注意您需要 import sys，并且它不会像 print 那样自动添加新行）。
3. 您 必须 在 self 中存储对 datapath 的引用，名为 "datapath"（即 self.datapath = datapath），因为库内部使用它来访问数据路径结构。

启动 CCP

CCP 的入口点是 portus.connect(ipc_type, class, debug, blocking)

• ipc_type (string)：在 Linux 上为（netlink | unix | char），在 macOS 上为（unix）
• class：您的算法类，例如 SampleCCAlg
• debug (bool)：如果为 true，则 CCP 将记录 ccp 和数据路径之间传递的所有消息
• blocking (bool)：如果为 true，则使用阻塞 ipc 读取，否则使用非阻塞

例如： portus.connect("netlink", SampleCCAlg, debug=True, blocking=True)。

无论您使用阻塞或非阻塞套接字，connect都将永久阻塞（要停止CCP，请发送ctrl+c或终止进程）。

示例

有关定义算法和运行CCP的完整示例，请参阅./aimd.py中的简单AIMD方案，并尝试运行它： sudo python aimd.py。