Safe Haskell	Safe-Infered

Frenetic.NetCore.Types

Contents

Basic types
Actions
- Basic actions
- Inspecting actions
Patterns
Predicates
Packets
Policies
Tools

Synopsis

Basic types

type Switch = Word64 Source

A switch's unique identifier.

type Port = Word16 Source

The number of a physical port.

type Vlan = Word16 Source

VLAN tags. Only the lower 12-bits are used.

data Loc Source

Loc uniquely identifies a port at a switch.

Constructors

Loc Switch Port

Instances

Eq Loc
Ord Loc
Show Loc

data PseudoPort Source

Logical ports.

Constructors

Physical Port
AllPorts

Instances

Eq PseudoPort
Ord PseudoPort
Show PseudoPort

type Word48 = EthernetAddress Source

Ethernet addresses are 48-bits wide.

Actions

data Action Source

Actions to perform on packets.

Constructors

Action
Fields actionForwards :: MultiSet (PseudoPort, Modification) actionQueries :: MultiSet Query

Instances

Eq Action
Ord Action
Show Action
Monoid Action

data Query Source

Constructors

NumPktQuery
Fields idOfQuery :: QueryID numPktQueryChan :: Chan (Switch, Integer) queryInterval :: Int countField :: Counter totalVal :: IORef Integer lastVal :: IORef Integer
PktQuery
Fields pktQueryChan :: Chan (Switch, Packet) idOfQuery :: QueryID

Instances

Eq Query
Ord Query
Show Query

data Counter Source

Constructors

CountPackets
CountBytes

Instances

Eq Counter
Ord Counter

data Modification Source

For each fields with a value Just v, modify that field to be v. If the field is Nothing then there is no modification of that field.

Constructors

Modification
Fields modifyDlSrc :: Maybe Word48 modifyDlDst :: Maybe Word48 modifyDlVlan :: Maybe (Maybe Vlan) modifyDlVlanPcp :: Maybe Word8 modifyNwSrc :: Maybe Word32 modifyNwDst :: Maybe Word32 modifyNwTos :: Maybe Word8 modifyTpSrc :: Maybe Word16 modifyTpDst :: Maybe Word16

Instances

Eq Modification
Ord Modification
Show Modification

unmodified :: Modification Source

isPktQuery :: Query -> Bool Source

Basic actions

countPkts Source

Arguments

:: Int	polling interval, in milliseconds
-> IO (Chan (Switch, Integer), Action)

Periodically polls the network to counts the number of bytes received.

Returns an Action and a channel. When the Action is used in the active Policy, the controller periodically reads the packet counters on the network. The controller returns the number of matching packets on each switch.

countBytes Source

Arguments

:: Int	polling interval, in milliseconds
-> IO (Chan (Switch, Integer), Action)

Sends packets to the controller.

Returns an Action and a channel. When the Action is used in the active Policy, all matching packets are sent to the controller. These packets are written into the channel.

getPkts :: IO (Chan (Switch, Packet), Action)Source

Inspecting actions

actionForwardsTo :: Action -> MultiSet PseudoPort Source

Patterns

data Pattern Source

Patterns to match packets. Patterns translate directly to a single OpenFlow match rule.

Constructors

Pattern
Fields ptrnDlSrc :: Wildcard Word48 ptrnDlDst :: Wildcard Word48 ptrnDlTyp :: Wildcard Word16 ptrnDlVlan :: Wildcard (Maybe Vlan) ptrnDlVlanPcp :: Wildcard Word8 ptrnNwSrc :: Prefix Word32 ptrnNwDst :: Prefix Word32 ptrnNwProto :: Wildcard Word8 ptrnNwTos :: Wildcard Word8 ptrnTpSrc :: Wildcard Word16 ptrnTpDst :: Wildcard Word16 ptrnInPort :: Wildcard Port

Instances

Eq Pattern
Ord Pattern
Show Pattern
Matchable Pattern

Predicates

data Predicate Source

Predicates to match packets.

Constructors

PrPattern Pattern	Match with a simple pattern.
PrTo Switch	Match only at this switch.
PrUnion Predicate Predicate	Match either predicates.
PrIntersect Predicate Predicate	Match both predicates.
PrNegate Predicate	PrNegate P matches packets that do not match P.

Instances

Eq Predicate
Ord Predicate
Show Predicate
Matchable Predicate

exactMatch :: Packet -> Predicate Source

A predicate that exactly matches a packet's headers.

Packets

data Packet Source

Packets' headers.

Constructors

Packet

Fields

pktDlSrc :: Word48: source ethernet address
pktDlDst :: Word48: destination ethernet address
pktDlTyp :: Word16: ethernet type code (e.g., 0x800 for IP packets)
pktDlVlan :: Maybe Vlan: VLAN tag
pktDlVlanPcp :: Word8: VLAN priority code
pktNwSrc :: Maybe Word32: source IP address for IP packets
pktNwDst :: Maybe Word32: destination IP address for IP packets
pktNwProto :: Word8: IP protocol number (e.g., 6 for TCP segments)
pktNwTos :: Word8: IP TOS field
pktTpSrc :: Maybe Word16: source port for IP packets
pktTpDst :: Maybe Word16: destination port for IP packets
pktInPort :: Port: ingress port on the switch where the packet was received

Instances

Eq Packet
Ord Packet
Show Packet

Policies

data Policy Source

Policies denote functions from (switch, packet) to packets.

Constructors

PoBottom	Performs no actions.
PoBasic Predicate Action	Performs the given action on packets matching the given predicate.
PoUnion Policy Policy	Performs the actions of both P1 and P2.

Instances

Eq Policy
Ord Policy
Show Policy
Monoid Policy

Tools

interesting :: String -> Pattern -> [String]Source

Build a list of the non-wildcarded patterns with sep between field and value

modifiedFields :: Modification -> Set FieldSource

prUnIntersect :: Predicate -> [Predicate]Source

Get back all predicates in the intersection. Does not return any naked intersections.

prUnUnion :: Predicate -> [Predicate]Source

Get back all predicates in the union. Does not return any naked unions.

poUnUnion :: Policy -> [Policy]Source

Get back all basic policies in the union. Does not return any unions.

poDom :: Policy -> Predicate Source

Returns a predicate that matches the domain of the policy.

module Frenetic.EthernetAddress

size :: Policy -> Int Source

Returns the approximate size of the policy