trema 0.2.5 → 0.2.6

data/ruby/trema/list-switches-reply.c

@@ -24,7 +24,7 @@
 
 void
 handle_list_switches_reply( const list_element *switches, void *controller ) {
-  if ( rb_respond_to( ( VALUE ) controller, rb_intern( "list_switches_reply" ) ) == Qfalse ) { 
+  if ( rb_respond_to( ( VALUE ) controller, rb_intern( "list_switches_reply" ) ) == Qfalse ) {
    return;
   }
   VALUE dpids = rb_ary_new();

data/ruby/trema/mac.rb

@@ -152,7 +152,7 @@ module Trema
 
 
     def validate_value_range
-      if not ( @value >= 0 and @value <= 0xffffffffffff )
+      unless ( @value >= 0 and @value <= 0xffffffffffff )
         raise ArgumentError, "Invalid MAC address: #{ @value }"
       end
     end

data/ruby/trema/match.c

@@ -43,8 +43,7 @@ ofp_match *get_match( VALUE self ) {
 
 /*
  * Creates a {Match} instance from packet_in's data, the method accepts an
- * additional single argument whose type is an array of symbols to wildcard set
- * to don't care and ignore while matching flow entries.
+ * additional list of symbols to wildcard set and ignore while matching flow entries.
  *
  * @overload match_from(message, *options)
  *
@@ -52,7 +51,7 @@ ofp_match *get_match( VALUE self ) {
  *     def packet_in datapath_id, message
  *       send_flow_mod(
  *         datapath_id,
- *         :match => Match.from( message, [ :dl_type, :nw_proto ] ),
+ *         :match => Match.from( message, :dl_type, :nw_proto ),
  *         :actions => Trema::ActionOutput.new( 2 )
  *       )
  *     end
@@ -60,10 +59,10 @@ ofp_match *get_match( VALUE self ) {
  *   @param [PacketIn] message
  *     the {PacketIn}'s message content.
  *
- *   @param [optional, Array] options
- *     If supplied an array of symbol ids indicating fields to be wildcarded.
+ *   @param [optional, list] options
+ *     If supplied a comma-separated list of symbol ids indicating fields to be wildcarded.
  *
- *     [:inport]
+ *     [:in_port]
  *       the physical port number to wildcard.
  *
  *     [:dl_src]
@@ -117,7 +116,7 @@ match_from( int argc, VALUE *argv, VALUE self ) {
     int i;
     for ( i = 0; i < RARRAY_LEN( options ); i++ ) {
       wildcard_id = SYM2ID( RARRAY_PTR( options )[ i ] );
-      if ( rb_intern( "inport" ) == wildcard_id ) {
+      if ( rb_intern( "in_port" ) == wildcard_id ) {
         wildcards |= OFPFW_IN_PORT;
       }
       if ( rb_intern( "dl_src" ) == wildcard_id ) {
@@ -166,7 +165,7 @@ match_from( int argc, VALUE *argv, VALUE self ) {
  * @example
  *   def packet_in datapath_id, message
  *     match = Match.new( :dl_type => 0x0800, :nw_src => "192.168.0.1" )
- *     if match.compare( ExactMatch.form( message ) )
+ *     if match.compare( ExactMatch.from( message ) )
  *       info "Received packet from 192.168.0.1"
  *     end
  *   end
@@ -187,7 +186,7 @@ match_compare( VALUE self, VALUE other ) {
  */
 static VALUE
 match_replace( VALUE self, VALUE other ) {
-  memcpy( get_match( self ), get_match( other ), sizeof ( struct ofp_match ) );
+  memcpy( get_match( self ), get_match( other ), sizeof( struct ofp_match ) );
   return self;
 }
 
@@ -199,7 +198,7 @@ static VALUE
 match_to_s( VALUE self ) {
   char match_str[ 1024 ];
 
-  match_to_string( get_match( self ), match_str, sizeof ( match_str ) );
+  match_to_string( get_match( self ), match_str, sizeof( match_str ) );
   return rb_str_new2( match_str );
 }
 
@@ -232,7 +231,8 @@ match_dl( VALUE self, uint8_t which ) {
   match = get_match( self );
   if ( which ) {
     dl_addr = match->dl_src;
-  } else {
+  }
+  else {
     dl_addr = match->dl_dst;
   }
   return rb_funcall( rb_eval_string( "Trema::Mac" ), rb_intern( "new" ), 1, ULL2NUM( mac_to_uint64( dl_addr ) ) );
@@ -312,7 +312,8 @@ match_nw( VALUE self, uint8_t which ) {
   if ( which ) {
     nw_addr = match->nw_src;
     masklen = ( match->wildcards & OFPFW_NW_SRC_MASK ) >> OFPFW_NW_SRC_SHIFT;
-  } else {
+  }
+  else {
     nw_addr = match->nw_dst;
     masklen = ( match->wildcards & OFPFW_NW_DST_MASK ) >> OFPFW_NW_DST_SHIFT;
   }
@@ -387,7 +388,7 @@ match_tp_dst( VALUE self ) {
  *
  *   @param [Hash] options the options hash.
  *
- *   @option options [Number] :inport
+ *   @option options [Number] :in_port
  *     the physical port number to match.
  *
  *   @option options [String,Number,Trema::Mac] :dl_src
@@ -450,7 +451,7 @@ match_init( int argc, VALUE *argv, VALUE self ) {
   // Always clear the memory as the unused memory locations are
   // exposed to both the user and the OpenFlow controller.
   Data_Get_Struct( self, struct ofp_match, match );
-  memset( match, 0, sizeof ( *match ) );
+  memset( match, 0, sizeof( *match ) );
 
   // Default matches all packets.
   match->wildcards = ( OFPFW_ALL & ~( OFPFW_NW_SRC_MASK | OFPFW_NW_DST_MASK ) )

data/ruby/trema/monkey-patch/module/deprecation.rb

@@ -1,6 +1,4 @@
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify

data/ruby/trema/netns.rb

@@ -0,0 +1,127 @@
+#
+# Copyright (C) 2008-2012 NEC Corporation
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+
+
+require "trema/network-component"
+
+
+module Trema
+  #
+  # The controller class of network namespace
+  #
+  class Netns < NetworkComponent
+    #
+    # Set a network interface
+    #
+    # @example
+    #   netns.interface #=> "trema0-1"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    attr_accessor :interface
+
+
+    #
+    # Creates a new Trema netns from {DSL::Netns}
+    #
+    # @example
+    #   netns = Trema::Netns.new( stanza )
+    #
+    # @return [Netns]
+    #
+    # @api public
+    #
+    def initialize stanza
+      @stanza = stanza
+      Netns.add self
+    end
+
+
+    #
+    # Define netns attribute accessors
+    #
+    # @example
+    #   netns.name  # delegated to @stanza[ :name ]
+    #
+    # @return an attribute value
+    #
+    # @api public
+    #
+    def method_missing message, *args
+      @stanza.__send__ :[], message
+    end
+
+
+    #
+    # Returns netmask
+    #
+    # @example
+    #   host.netmask #=> "255.255.0.0"
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def netmask
+      @stanza[ :netmask ] || "255.255.255.255"
+    end
+
+
+    #
+    # Runs a netns process
+    #
+    # @example
+    #   netns.run! => self
+    #
+    # @return [Netns]
+    #
+    # @api public
+    #
+    def run!
+      sh "sudo ip netns add #{ name }"
+      sh "sudo ip link set dev #{ interface } netns #{ name }"
+      sh "sudo ip netns exec #{ name } ifconfig lo 127.0.0.1"
+      sh "sudo ip netns exec #{ name } ifconfig #{ interface } #{ @stanza[ :ip ] } netmask #{ netmask }" if @stanza[ :ip ]
+      sh "sudo ip netns exec #{ name } route add -net #{ @stanza[ :net ] } gw #{ @stanza[ :gw ] }" if @stanza[ :net ] and @stanza[ :gw ]
+      self
+    end
+
+
+    #
+    # Kills running netns
+    #
+    # @example
+    #   netns.shutdown!
+    #
+    # @return [undefined]
+    #
+    # @api public
+    #
+    def shutdown!
+      sh "sudo ip netns delete #{ name }"
+    end
+  end
+end
+
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8-unix
+### indent-tabs-mode: nil
+### End:

data/ruby/trema/ordered-hash.rb

@@ -1,6 +1,4 @@
 #
-# Author: Yasuhito Takamiya <yasuhito@gmail.com>
-#
 # Copyright (C) 2008-2012 NEC Corporation
 #
 # This program is free software; you can redistribute it and/or modify
@@ -20,6 +18,9 @@
 
 module Trema
   class OrderedHash
+    attr_reader :keys
+
+
     def initialize
       @keys = Array.new
       @content = Hash.new
@@ -38,11 +39,11 @@ module Trema
 
     def []= key, value
       @content[ key ] = value
-      if not @keys.include?( key )
+      unless @keys.include?( key )
         @keys << key
       end
     end
-    
+
 
     def values
       @keys.map do | each |

data/ruby/trema/packet-in.c

@@ -42,7 +42,8 @@ VALUE cPacketIn;
   {                                                                     \
     if ( get_packet_in_info( self )->format & flag ) {                  \
       return func( get_packet_in_info( self )->packet_member );         \
-    } else {                                                            \
+    }                                                                   \
+    else {                                                              \
       return Qnil;                                                      \
     }                                                                   \
   }
@@ -109,8 +110,7 @@ packet_in_buffer_id( VALUE self ) {
 /*
  * A buffer_id value either than +UINT32_MAX+ marks the packet_in as buffered.
  *
- * @return [true] if packet_in is buffered.
- * @return [false] if packet_in is not buffered.
+ * @return [Boolean] whether the packet_in is buffered or not.
  */
 static VALUE
 packet_in_is_buffered( VALUE self ) {
@@ -170,9 +170,9 @@ packet_in_reason( VALUE self ) {
 
 
 /*
- * The MAC source address.
+ * The source MAC address.
  *
- * @return [Trema::Mac] macsa MAC source address.
+ * @return [Trema::Mac] the value of source MAC address as a Trema::MAC object.
  */
 static VALUE
 packet_in_macsa( VALUE self ) {
@@ -181,9 +181,10 @@ packet_in_macsa( VALUE self ) {
 
 
 /*
- * The MAC destination address.
+ * The destination MAC address.
  *
- * @return [Trema::Mac] macda MAC destination address.
+ * @return [Trema::Mac] the value of destination MAC address as a
+ *   Trema::MAC object.
  */
 static VALUE
 packet_in_macda( VALUE self ) {
@@ -194,7 +195,7 @@ packet_in_macda( VALUE self ) {
 /*
  * The ethernet type.
  *
- * @return [integer] eth_type The ehternet type.
+ * @return [Integer] the value of ethernet type.
  */
 static VALUE
 packet_in_eth_type( VALUE self ) {
@@ -203,9 +204,9 @@ packet_in_eth_type( VALUE self ) {
 
 
 /*
- * Is a packet with VLAN tag?
+ * Is it an IEEE 802.1q packet?
  *
- * @return [bool] vtag? Is a packet with VLAN tag?
+ * @return [Boolean] whether the packet is an IEEE 802.1q or not.
  */
 static VALUE
 packet_in_is_vtag( VALUE self ) {
@@ -219,9 +220,9 @@ packet_in_is_vtag( VALUE self ) {
 
 
 /*
- * The vlan tpid.
+ * The vlan tag protocol identifier (tpid).
  *
- * @return [integer] vlan_tpid The vlan tpid
+ * @return [Integer] the value of the vlan tag protocol identifier.
  */
 static VALUE
 packet_in_vlan_tpid( VALUE self ) {
@@ -230,9 +231,9 @@ packet_in_vlan_tpid( VALUE self ) {
 
 
 /*
- * The vlan tci.
+ * The vlan tag control identifier (tci).
  *
- * @return [integer] vlan_tci The vlan tci
+ * @return [Integer] the value of the vlan tag control identifier.
  */
 static VALUE
 packet_in_vlan_tci( VALUE self ) {
@@ -241,9 +242,9 @@ packet_in_vlan_tci( VALUE self ) {
 
 
 /*
- * The vlan prio.
+ * The vlan priority.
  *
- * @return [integer] vlan_prio The vlan prio
+ * @return [Integer] the value of the vlan priority.
  */
 static VALUE
 packet_in_vlan_prio( VALUE self ) {
@@ -252,9 +253,9 @@ packet_in_vlan_prio( VALUE self ) {
 
 
 /*
- * The vlan cfi.
+ * The vlan canonical format indicator (cfi).
  *
- * @return [integer] vlan_cfi The vlan cfi
+ * @return [Integer] the value of the vlan canonical format indicator.
  */
 static VALUE
 packet_in_vlan_cfi( VALUE self ) {
@@ -263,9 +264,9 @@ packet_in_vlan_cfi( VALUE self ) {
 
 
 /*
- * The vlan vid.
+ * The vlan identifier.
  *
- * @return [integer] vlan_vid The vlan vid
+ * @return [Integer] the value of the vlan identifier.
  */
 static VALUE
 packet_in_vlan_vid( VALUE self ) {
@@ -274,9 +275,9 @@ packet_in_vlan_vid( VALUE self ) {
 
 
 /*
- * Is an ARP packet?
+ * Is it an ARP packet?
  *
- * @return [bool] arp? Is an ARP packet?
+ * @return [Boolean] whether the packet is an ARP packet or not.
  */
 static VALUE
 packet_in_is_arp( VALUE self ) {
@@ -290,9 +291,9 @@ packet_in_is_arp( VALUE self ) {
 
 
 /*
- * Is an ARP request packet?
+ * Is it an ARP request packet?
  *
- * @return [bool] arp_request? Is an ARP request packet?
+ * @return [Boolean] whether the packet is an ARP request packet or not.
  */
 static VALUE
 packet_in_is_arp_request( VALUE self ) {
@@ -306,9 +307,9 @@ packet_in_is_arp_request( VALUE self ) {
 
 
 /*
- * Is an ARP reply packet?
+ * Is it an ARP reply packet?
  *
- * @return [bool] arp_reply? Is an ARP reply packet?
+ * @return [Boolean] whether the packet is an ARP reply packet or not.
  */
 static VALUE
 packet_in_is_arp_reply( VALUE self ) {
@@ -324,7 +325,7 @@ packet_in_is_arp_reply( VALUE self ) {
 /*
  * The ARP operation code.
  *
- * @return [integer] arp_oper Operation code.
+ * @return [Integer] the value of the ARP opcode field.
  */
 static VALUE
 packet_in_arp_oper( VALUE self ) {
@@ -333,9 +334,11 @@ packet_in_arp_oper( VALUE self ) {
 
 
 /*
- * The ARP source hardware address.
+ * The ARP source hardware address of a packet.
  *
- * @return [Trema::Mac] arp_sha MAC hardware address.
+ * @return [Trema::Mac, nil]
+ *   the value of the ARP source hardware address as a Trema::Mac object or nil
+ *   if packet not an ARP.
  */
 static VALUE
 packet_in_arp_sha( VALUE self ) {
@@ -349,9 +352,11 @@ packet_in_arp_sha( VALUE self ) {
 
 
 /*
- * The ARP source protocol address.
+ * The ARP source protocol address of a packet.
  *
- * @return [Trema::IP] arp_spa IP protocol address.
+ * @return [Trema::IP, nil]
+ *   the value of ARP source protocol address as a Trema::IP object or nil if
+ *   packet is not an ARP.
  */
 static VALUE
 packet_in_arp_spa( VALUE self ) {
@@ -365,9 +370,11 @@ packet_in_arp_spa( VALUE self ) {
 
 
 /*
- * The ARP target hardware address.
+ * The ARP target hardware address of a packet.
  *
- * @return [Trema::Mac] arp_tha MAC hardware address.
+ * @return [Trema::Mac]
+ *   the value of ARP target hardware address as a Trema::Mac object or nil if
+ *   packet is not an ARP.
  */
 static VALUE
 packet_in_arp_tha( VALUE self ) {
@@ -381,9 +388,11 @@ packet_in_arp_tha( VALUE self ) {
 
 
 /*
- * The ARP target protocol address.
+ * The ARP target protocol address of a packet.
  *
- * @return [Trema::IP] arp_tpa IP protocol address.
+ * @return [Trema::IP]
+ *   the value of ARP target protocol address as a Trema::IP object or nil if
+ *   packet is not an ARP.
  */
 static VALUE
 packet_in_arp_tpa( VALUE self ) {
@@ -397,9 +406,9 @@ packet_in_arp_tpa( VALUE self ) {
 
 
 /*
- * Is an IPV4 packet?
+ * Is it an IPv4 packet?
  *
- * @return [bool] ipv4? Is an IPV4 packet?
+ * @return [Boolean] whether the packet is an IPv4 packet or not.
  */
 static VALUE
 packet_in_is_ipv4( VALUE self ) {
@@ -413,9 +422,9 @@ packet_in_is_ipv4( VALUE self ) {
 
 
 /*
- * The IPv4 version number.
+ * The IPv4 version number (version).
  *
- * @return [Integer] ipv4_version The IPv4 version number.
+ * @return [Integer] the value of IPv4 version number.
  */
 static VALUE
 packet_in_ipv4_version( VALUE self ) {
@@ -424,9 +433,9 @@ packet_in_ipv4_version( VALUE self ) {
 
 
 /*
- * The IPv4 internet header length.
+ * The IPv4 internet header length (ihl).
  *
- * @return [Integer] ipv4_ihl The IPv4 internet header length.
+ * @return [Integer] the value of IPv4 internet header length.
  */
 static VALUE
 packet_in_ipv4_ihl( VALUE self ) {
@@ -435,9 +444,9 @@ packet_in_ipv4_ihl( VALUE self ) {
 
 
 /*
- * The IPv4 tos value.
+ * The IPv4 type of service (tos).
  *
- * @return [Integer] ipv4_tos The IPv4 tos value.
+ * @return [Integer] the value of IPv4 type of service.
  */
 static VALUE
 packet_in_ipv4_tos( VALUE self ) {
@@ -446,9 +455,9 @@ packet_in_ipv4_tos( VALUE self ) {
 
 
 /*
- * The IPv4 total length.
+ * The IPv4 total length, the length of the datagram.
  *
- * @return [Integer] ipv4_tot_len The IPv4 total length.
+ * @return [Integer] the value of IPv4 total length.
  */
 static VALUE
 packet_in_ipv4_tot_len( VALUE self ) {
@@ -457,9 +466,9 @@ packet_in_ipv4_tot_len( VALUE self ) {
 
 
 /*
- * The IPv4 identifier.
+ * The IPv4 identification.
  *
- * @return [Integer] ipv4_id The IPv4 identifier.
+ * @return [Integer] the value of IPv4 identification.
  */
 static VALUE
 packet_in_ipv4_id( VALUE self ) {
@@ -470,7 +479,7 @@ packet_in_ipv4_id( VALUE self ) {
 /*
  * The IPv4 fragment offset.
  *
- * @return [Integer] ipv4_frag_off The IPv4 fragment offset.
+ * @return [Integer] the value of IPv4 fragment offset.
  */
 static VALUE
 packet_in_ipv4_frag_off( VALUE self ) {
@@ -479,9 +488,9 @@ packet_in_ipv4_frag_off( VALUE self ) {
 
 
 /*
- * The IPv4 ttl value.
+ * The IPv4 time to live (ttl).
  *
- * @return [Integer] ipv4_ttl The IPv4 ttl value.
+ * @return [Integer] the value of IPv4 time to live.
  */
 static VALUE
 packet_in_ipv4_ttl( VALUE self ) {
@@ -492,7 +501,7 @@ packet_in_ipv4_ttl( VALUE self ) {
 /*
  * The IPv4 protocol number.
  *
- * @return [Integer] ipv4_protocol The IPv4 protocol number.
+ * @return [Integer] the value of IPv4 protocol number.
  */
 static VALUE
 packet_in_ipv4_protocol( VALUE self ) {
@@ -503,7 +512,7 @@ packet_in_ipv4_protocol( VALUE self ) {
 /*
  * The IPv4 checksum.
  *
- * @return [Integer] ipv4_checksum The IPv4 checksum.
+ * @return [Integer] the value of IPv4 checksum.
  */
 static VALUE
 packet_in_ipv4_checksum( VALUE self ) {
@@ -512,9 +521,11 @@ packet_in_ipv4_checksum( VALUE self ) {
 
 
 /*
- * The IPV4 source protocol address.
+ * The IPv4 source IP address of a packet.
  *
- * @return [Trema::IP] ipv4_saddr IP protocol address.
+ * @return [Trema::IP,nil]
+ *   the value of IPv4 source IP address as a Trema::IP object or nil if
+ *   packet is not an IPv4.
  */
 static VALUE
 packet_in_ipv4_saddr( VALUE self ) {
@@ -528,9 +539,11 @@ packet_in_ipv4_saddr( VALUE self ) {
 
 
 /*
- * The IPV4 destination protocol address.
+ * The IPV4 destination IP address of a packet.
  *
- * @return [Trema::IP] ipv4_daddr IP protocol address.
+ * @return [Trema::IP, nil]
+ *   the value of IPv4 destination IP address as a Trema::IP object or nil if
+ *   packet is not an IPv4.
  */
 static VALUE
 packet_in_ipv4_daddr( VALUE self ) {
@@ -544,9 +557,9 @@ packet_in_ipv4_daddr( VALUE self ) {
 
 
 /*
- * Is an ICMPv4 packet?
+ * Is it an ICMPv4 packet?
  *
- * @return [bool] icmpv4? Is an ICMPv4 packet?
+ * @return [Boolean] whether the packet is an ICMPv4 packet or not.
  */
 static VALUE
 packet_in_is_icmpv4( VALUE self ) {
@@ -560,9 +573,9 @@ packet_in_is_icmpv4( VALUE self ) {
 
 
 /*
- * The ICMPv4 message type.
+ * The ICMPv4 message type, ie echo_reply, echo_request.
  *
- * @return [Integer] icmpv4_type The ICMPv4 message type.
+ * @return [Integer] the value of ICMPv4 message type.
  */
 static VALUE
 packet_in_icmpv4_type( VALUE self ) {
@@ -571,9 +584,9 @@ packet_in_icmpv4_type( VALUE self ) {
 
 
 /*
- * The ICMPv4 message code.
+ * The ICMPv4 message code the further qualifies the message type.
  *
- * @return [Integer] icmpv4_code The ICMPv4 message code.
+ * @return [Integer] the value of ICMPv4 message code.
  */
 static VALUE
 packet_in_icmpv4_code( VALUE self ) {
@@ -584,7 +597,7 @@ packet_in_icmpv4_code( VALUE self ) {
 /*
  * The ICMPv4 message checksum.
  *
- * @return [Integer] icmpv4_checksum The ICMPv4 message checksum.
+ * @return [Integer] the value of ICMPv4 message checksum.
  */
 static VALUE
 packet_in_icmpv4_checksum( VALUE self ) {
@@ -593,9 +606,9 @@ packet_in_icmpv4_checksum( VALUE self ) {
 
 
 /*
- * The identifier of ICMPv4 echo.
+ * The ICMPv4 echo identifier to be used to match echo requests to echo replies.
  *
- * @return [Integer] icmpv4_id The identifier of ICMPv4 echo.
+ * @return [Integer] the value of ICMPv4 echo identifier.
  */
 static VALUE
 packet_in_icmpv4_id( VALUE self ) {
@@ -604,9 +617,9 @@ packet_in_icmpv4_id( VALUE self ) {
 
 
 /*
- * The sequence number of ICMPv4 echo.
+ * The ICMPv4 echo sequence number.
  *
- * @return [Integer] icmpv4_id The sequence number of ICMPv4 echo.
+ * @return [Integer] the value of ICMPv4 echo sequence number.
  */
 static VALUE
 packet_in_icmpv4_seq( VALUE self ) {
@@ -615,9 +628,11 @@ packet_in_icmpv4_seq( VALUE self ) {
 
 
 /*
- * The gateway address of ICMPv4 redicect.
+ * The ICMPv4 redirect message gateway IP address.
  *
- * @return [Trema::IP] icmp_gateway The gateway address of ICMPv4 redicect.
+ * @return [Trema::IP, nil]
+ *   the value of ICMPv4 redirect message IP gateway address as a Trema::IP
+ *   object or nil if packet is not ICMPv4.
  */
 static VALUE
 packet_in_icmpv4_gateway( VALUE self ) {
@@ -631,9 +646,9 @@ packet_in_icmpv4_gateway( VALUE self ) {
 
 
 /*
- * Is an ICMPv4 echo reply packet?
+ * Is it an ICMPv4 echo reply packet?
  *
- * @return [bool] icmpv4_echo_reply? Is an ICMP echo reply packet?
+ * @return [Boolean] whether the packet is an ICMPv4 echo reply packet or not.
  */
 static VALUE
 packet_in_is_icmpv4_echo_reply( VALUE self ) {
@@ -647,9 +662,10 @@ packet_in_is_icmpv4_echo_reply( VALUE self ) {
 
 
 /*
- * Is an ICMPv4 destination unreachable packet?
+ * Is it an ICMPv4 destination unreachable packet?
  *
- * @return [bool] icmpv4_dst_unreach? Is an ICMP destination unreachable packet?
+ * @return [Boolean] whether the packet is an ICMPv4 destination
+ *   unreachable packet or not.
  */
 static VALUE
 packet_in_is_icmpv4_dst_unreach( VALUE self ) {
@@ -663,9 +679,9 @@ packet_in_is_icmpv4_dst_unreach( VALUE self ) {
 
 
 /*
- * Is an ICMPv4 redirect packet?
+ * Is it an ICMPv4 redirect packet?
  *
- * @return [bool] icmpv4_redirect? Is an ICMP redirect packet?
+ * @return [Boolean] whether the packet is an ICMPv4 redirect packet or not.
  */
 static VALUE
 packet_in_is_icmpv4_redirect( VALUE self ) {
@@ -679,9 +695,9 @@ packet_in_is_icmpv4_redirect( VALUE self ) {
 
 
 /*
- * Is an ICMPv4 echo request packet?
+ * Is it an ICMPv4 echo request packet?
  *
- * @return [bool] icmpv4_echo_request? Is an ICMP echo request packet?
+ * @return [Boolean] whether the packet is an ICMPv4 echo request packet or not.
  */
 static VALUE
 packet_in_is_icmpv4_echo_request( VALUE self ) {
@@ -695,9 +711,9 @@ packet_in_is_icmpv4_echo_request( VALUE self ) {
 
 
 /*
- * Is an IGMP packet?
+ * Is it an IGMP packet?
  *
- * @return [bool] igmp? Is an IGMP packet?
+ * @return [Boolean] whether the packet is an IGMP packet or not.
  */
 static VALUE
 packet_in_is_igmp( VALUE self ) {
@@ -711,9 +727,10 @@ packet_in_is_igmp( VALUE self ) {
 
 
 /*
- * Is an IGMP membership query packet?
+ * Is it an IGMP membership query packet?
  *
- * @return [bool] igmp_membership_query? Is an IGMP membership query packet?
+ * @return [Boolean] whether the packet is an IGMP membership query
+ *   packet or not.
  */
 static VALUE
 packet_in_is_igmp_membership_query( VALUE self ) {
@@ -727,9 +744,10 @@ packet_in_is_igmp_membership_query( VALUE self ) {
 
 
 /*
- * Is an IGMP v1 membership report packet?
+ * Is it an IGMP v1 membership report packet?
  *
- * @return [bool] igmp_v1_membership_report? Is an IGMP v1 membership report packet?
+ * @return [Boolean] whether the packet is an IGMP v1 membership report packet
+ *   or not.
  */
 static VALUE
 packet_in_is_igmp_v1_membership_report( VALUE self ) {
@@ -743,9 +761,10 @@ packet_in_is_igmp_v1_membership_report( VALUE self ) {
 
 
 /*
- * Is an IGMP v2 membership report packet?
+ * Is it an IGMP v2 membership report packet?
  *
- * @return [bool] igmp_v2_membership_report? Is an IGMP v2 membership report packet?
+ * @return [Boolean] whether the packet is an IGMP v2 membership report packet
+ *   or not.
  */
 static VALUE
 packet_in_is_igmp_v2_membership_report( VALUE self ) {
@@ -759,9 +778,10 @@ packet_in_is_igmp_v2_membership_report( VALUE self ) {
 
 
 /*
- * Is an IGMP v2 leave group packet?
+ * Is it an IGMP v2 leave group packet?
  *
- * @return [bool] igmp_v2_leave_group? Is an IGMP v2 leave group packet?
+ * @return [Boolean] whether the packet is an IGMP v2 leave group packet
+ *   or not.
  */
 static VALUE
 packet_in_is_igmp_v2_leave_group( VALUE self ) {
@@ -775,9 +795,10 @@ packet_in_is_igmp_v2_leave_group( VALUE self ) {
 
 
 /*
- * Is an IGMP v3 membership report packet?
+ * Is it an IGMP v3 membership report packet?
  *
- * @return [bool] igmp_v3_membership_report? Is an IGMP v3 membership report packet?
+ * @return [Boolean] whether the packet is an IGMP v3 membership report packet
+ *   or not.
  */
 static VALUE
 packet_in_is_igmp_v3_membership_report( VALUE self ) {
@@ -793,7 +814,7 @@ packet_in_is_igmp_v3_membership_report( VALUE self ) {
 /*
  * The IGMP message type.
  *
- * @return [Integer] igmp_type IGMP type.
+ * @return [Integer] the value of IGMP message type.
  */
 static VALUE
 packet_in_igmp_type( VALUE self ) {
@@ -804,7 +825,9 @@ packet_in_igmp_type( VALUE self ) {
 /*
  * The IGMP group address.
  *
- * @return [Trema::IP] igmp_group an IGMP group address.
+ * @return [Trema::IP, nil]
+ *   the value of IGMP IP group address as a Trema::IP object
+ *   or nil if packet is not IGMP.
  */
 static VALUE
 packet_in_igmp_group( VALUE self ) {
@@ -820,7 +843,7 @@ packet_in_igmp_group( VALUE self ) {
 /*
  * The IGMP checksum.
  *
- * @return [Integer] igmp_checksum a IGMP checksum.
+ * @return [Integer] the value of IGMP checksum.
  */
 static VALUE
 packet_in_igmp_checksum( VALUE self ) {
@@ -829,9 +852,9 @@ packet_in_igmp_checksum( VALUE self ) {
 
 
 /*
- * Is a TCP packet?
+ * Is it a TCP packet?
  *
- * @return [bool] tcp? Is a TCP packet?
+ * @return [Boolean] whether the packet is a TCP packet or not.
  */
 static VALUE
 packet_in_is_tcp( VALUE self ) {
@@ -847,7 +870,7 @@ packet_in_is_tcp( VALUE self ) {
 /*
  * The TCP source port.
  *
- * @return [Integer] tcp_src_port TCP port.
+ * @return [Integer] the value of TCP source port.
  */
 static VALUE
 packet_in_tcp_src_port( VALUE self ) {
@@ -858,7 +881,7 @@ packet_in_tcp_src_port( VALUE self ) {
 /*
  * The TCP destination port.
  *
- * @return [Integer] tcp_dst_port TCP port.
+ * @return [Integer] the value of TCP destination port.
  */
 static VALUE
 packet_in_tcp_dst_port( VALUE self ) {
@@ -869,7 +892,7 @@ packet_in_tcp_dst_port( VALUE self ) {
 /*
  * The TCP sequence number.
  *
- * @return [Integer] tcp_seq_no a TCP sequence number.
+ * @return [Integer] the value of TCP sequence number.
  */
 static VALUE
 packet_in_tcp_seq_no( VALUE self ) {
@@ -878,9 +901,9 @@ packet_in_tcp_seq_no( VALUE self ) {
 
 
 /*
- * The TCP acknowledge number.
+ * The TCP acknowledgment number.
  *
- * @return [Integer] tcp_ack_no a TCP acknowkedge number.
+ * @return [Integer] the value of TCP acknowledgment number.
  */
 static VALUE
 packet_in_tcp_ack_no( VALUE self ) {
@@ -889,9 +912,9 @@ packet_in_tcp_ack_no( VALUE self ) {
 
 
 /*
- * The TCP offset.
+ * The TCP data offset.
  *
- * @return [Integer] tcp_offset a TCP offset.
+ * @return [Integer] the value of TCP data offset.
  */
 static VALUE
 packet_in_tcp_offset( VALUE self ) {
@@ -902,7 +925,7 @@ packet_in_tcp_offset( VALUE self ) {
 /*
  * The TCP flags.
  *
- * @return [Integer] tcp_flags TCP flags.
+ * @return [Integer] the value of TCP flags.
  */
 static VALUE
 packet_in_tcp_flags( VALUE self ) {
@@ -913,7 +936,7 @@ packet_in_tcp_flags( VALUE self ) {
 /*
  * The TCP window.
  *
- * @return [Integer] tcp_window a TCP window.
+ * @return [Integer] the value of TCP window.
  */
 static VALUE
 packet_in_tcp_window( VALUE self ) {
@@ -924,7 +947,7 @@ packet_in_tcp_window( VALUE self ) {
 /*
  * The TCP checksum.
  *
- * @return [Integer] tcp_checksum a TCP checksum.
+ * @return [Integer] the value of TCP checksum.
  */
 static VALUE
 packet_in_tcp_checksum( VALUE self ) {
@@ -933,9 +956,9 @@ packet_in_tcp_checksum( VALUE self ) {
 
 
 /*
- * The TCP urgent.
+ * The TCP urgent pointer.
  *
- * @return [Integer] tcp_urgent a TCP urgent.
+ * @return [Integer] the value of TCP urgent pointer.
  */
 static VALUE
 packet_in_tcp_urgent( VALUE self ) {
@@ -944,9 +967,9 @@ packet_in_tcp_urgent( VALUE self ) {
 
 
 /*
- * Is an UDP packet?
+ * Is it a UDP packet?
  *
- * @return [bool] udp? Is an UDP packet?
+ * @return [Boolean] whether the packet is a UDP packet or not.
  */
 static VALUE
 packet_in_is_udp( VALUE self ) {
@@ -975,7 +998,7 @@ packet_in_udp_payload( VALUE self ) {
 /*
  * The UDP source port.
  *
- * @return [Integer] udp_src_port UDP port.
+ * @return [Integer] the value of UDP source port.
  */
 static VALUE
 packet_in_udp_src_port( VALUE self ) {
@@ -986,7 +1009,7 @@ packet_in_udp_src_port( VALUE self ) {
 /*
  * The UDP destination port.
  *
- * @return [Integer] udp_dst_port UDP port.
+ * @return [Integer] the value of UDP destination port.
  */
 static VALUE
 packet_in_udp_dst_port( VALUE self ) {
@@ -995,9 +1018,9 @@ packet_in_udp_dst_port( VALUE self ) {
 
 
 /*
- * The UDP length.
+ * The UDP length
  *
- * @return [Integer] udp_len a UDP length.
+ * @return [Integer] the value in bytes of UDP header and data.
  */
 static VALUE
 packet_in_udp_len( VALUE self ) {
@@ -1008,7 +1031,7 @@ packet_in_udp_len( VALUE self ) {
 /*
  * The UDP checksum.
  *
- * @return [Integer] udp_checksum a UDP checksum.
+ * @return [Integer] the value of UDP checksum.
  */
 static VALUE
 packet_in_udp_checksum( VALUE self ) {