lib/vconn.h

   1 /*
   2  * Copyright (c) 2008, 2009 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef VCONN_H
  18 #define VCONN_H 1
  19
  20 #include <assert.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24
  25 #include "flow.h"
  26
  27 struct ofpbuf;
  28 struct ofp_action_header;
  29 struct ofp_header;
  30 struct ofp_match;
  31 struct ofp_stats_reply;
  32 struct pvconn;
  33 struct vconn;
  34
  35 void vconn_usage(bool active, bool passive, bool bootstrap);
  36
  37 /* Active vconns: virtual connections to OpenFlow devices. */
  38 int vconn_open(const char *name, int min_version, struct vconn **);
  39 void vconn_close(struct vconn *);
  40 const char *vconn_get_name(const struct vconn *);
  41 uint32_t vconn_get_remote_ip(const struct vconn *);
  42 uint16_t vconn_get_remote_port(const struct vconn *);
  43 uint32_t vconn_get_local_ip(const struct vconn *);
  44 uint16_t vconn_get_local_port(const struct vconn *);
  45 int vconn_connect(struct vconn *);
  46 int vconn_recv(struct vconn *, struct ofpbuf **);
  47 int vconn_send(struct vconn *, struct ofpbuf *);
  48 int vconn_recv_xid(struct vconn *, uint32_t xid, struct ofpbuf **);
  49 int vconn_transact(struct vconn *, struct ofpbuf *, struct ofpbuf **);
  50
  51 void vconn_run(struct vconn *);
  52 void vconn_run_wait(struct vconn *);
  53
  54 int vconn_open_block(const char *name, int min_version, struct vconn **);
  55 int vconn_send_block(struct vconn *, struct ofpbuf *);
  56 int vconn_recv_block(struct vconn *, struct ofpbuf **);
  57
  58 enum vconn_wait_type {
  59     WAIT_CONNECT,
  60     WAIT_RECV,
  61     WAIT_SEND
  62 };
  63 void vconn_wait(struct vconn *, enum vconn_wait_type);
  64 void vconn_connect_wait(struct vconn *);
  65 void vconn_recv_wait(struct vconn *);
  66 void vconn_send_wait(struct vconn *);
  67
  68 /* Passive vconns: virtual listeners for incoming OpenFlow connections. */
  69 int pvconn_open(const char *name, struct pvconn **);
  70 const char *pvconn_get_name(const struct pvconn *);
  71 void pvconn_close(struct pvconn *);
  72 int pvconn_accept(struct pvconn *, int min_version, struct vconn **);
  73 void pvconn_wait(struct pvconn *);
  74
  75 /* OpenFlow protocol utility functions. */
  76 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
  77 void *make_openflow_xid(size_t openflow_len, uint8_t type,
  78                         uint32_t xid, struct ofpbuf **);
  79 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
  80 void *put_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
  81                        struct ofpbuf *);
  82 void update_openflow_length(struct ofpbuf *);
  83 struct ofpbuf *make_flow_mod(uint16_t command, const flow_t *,
  84                              size_t actions_len);
  85 struct ofpbuf *make_add_flow(const flow_t *, uint32_t buffer_id,
  86                              uint16_t max_idle, size_t actions_len);
  87 struct ofpbuf *make_del_flow(const flow_t *);
  88 struct ofpbuf *make_add_simple_flow(const flow_t *,
  89                                     uint32_t buffer_id, uint16_t out_port,
  90                                     uint16_t max_idle);
  91 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
  92                               uint8_t reason,
  93                               const struct ofpbuf *payload, int max_send_len);
  94 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
  95                                uint16_t in_port,
  96                                const struct ofp_action_header *,
  97                                size_t n_actions);
  98 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
  99                                         uint16_t in_port, uint16_t out_port);
 100 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
 101                                           uint16_t in_port, uint16_t out_port);
 102 struct ofpbuf *make_echo_request(void);
 103 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 104 int check_ofp_message(const struct ofp_header *, uint8_t type, size_t size);
 105 int check_ofp_message_array(const struct ofp_header *, uint8_t type,
 106                             size_t size, size_t array_elt_size,
 107                             size_t *n_array_elts);
 108 int check_ofp_packet_out(const struct ofp_header *, struct ofpbuf *data,
 109                          int *n_actions, int max_ports);
 110
 111 struct flow_stats_iterator {
 112     const uint8_t *pos, *end;
 113 };
 114 const struct ofp_flow_stats *flow_stats_first(struct flow_stats_iterator *,
 115                                               const struct ofp_stats_reply *);
 116 const struct ofp_flow_stats *flow_stats_next(struct flow_stats_iterator *);
 117
 118 struct actions_iterator {
 119     const union ofp_action *pos, *end;
 120 };
 121 const union ofp_action *actions_first(struct actions_iterator *,
 122                                       const union ofp_action *,
 123                                       size_t n_actions);
 124 const union ofp_action *actions_next(struct actions_iterator *);
 125 int validate_actions(const union ofp_action *, size_t n_actions,
 126                      int max_ports);
 127
 128 void normalize_match(struct ofp_match *);
 129
 130 static inline int
 131 ofp_mkerr(uint16_t type, uint16_t code)
 132 {
 133     assert(type > 0 && type <= 0x7fff);
 134     return (type << 16) | code;
 135 }
 136
 137 #endif /* vconn.h */