VIRTUTECH CONFIDENTIAL    Previous - Up - Next

ethernet-link

Provided by
ethernet-link
Class Hierarchy
conf-objectlog-objectethernet-link
Interfaces Implemented
log_object, ethernet_link, event_poster
Description
ethernet_link device

Attributes

Attributes inherited from class conf-object
attributes, classname, component, iface, name, object_id, queue
Attributes inherited from class log-object
access_count, log_buffer, log_buffer_last, log_buffer_size, log_group_mask, log_groups, log_level, log_type_mask
Attribute List
central
Optional attribute; read/write access; type: Object or Nil.

The Simics Central client object used for distributing the simulation.

devices
Optional attribute; read/write access; type: [[i|n,i,s,o|n,[[[ss]*],i]]*].

The connected devices. It is a list of entries, where each entry is a list [global id,local id,name,obj,info]. The obj is either a reference to the device object for local devices, or nil if the device was in another Simics process. The info field is a list [macs,promisc], where macs is a a list of pairs [addr,mask].

filter_enable
Optional attribute; read/write access; type: Integer.

A flag controlling whether the MAC information is used to only deliver frames to devices that will handle them. A change in this flag might change the result of the simulation in some corner cases, but is usually transparent. If it is enabled, it may help simulation efficiency.

frame_echo
Optional attribute; read/write access; type: Integer.

This flag defines if the link will echo frames back to the sender. Default is not to echo frames.

frequency
Optional attribute; read/write access; type: Integer.

The frequency of the clock used by the link to time stamp traffic and state changes. This defines the granularity of the time of any event on the link. The frequency is given as number of ticks per second.

last_frame
Pseudo attribute; read/write access; type: d|n.

This attribute contains the next frame to deliver, when read from an Ethernet_Frame hap handler. It can also be set from the hap handler, which will modify the packet being sent. If it is set to nil or to an empty buffer, the packet will be dropped. From anywhere else than an Ethernet_Frame hap handler, this attribute is nil and can't be set.

latency
Optional attribute; read/write access; type: f|i.

The latency on the link. Every packet that is sent over this link is delayed by at least the time specified in this attribute. Other simulated state changes, such as auto-negotiation and registered MAC addresses also propagate over the link with the same delay. The type of this attribute is either an integer number of clock ticks in the time base specified in the frequency attribute, or a floating point number which defines the latency in seconds.

link_id
Pseudo attribute; read/write access; type: Integer.

The ID number of the link this link object belongs to.

link_obj_id
Pseudo attribute; read/write access; type: Integer.

The local ID number of this link object on the link.

master_obj_id
Pseudo attribute; read/write access; type: Integer.

The local ID number of the master link object on the link.

min_latency
Pseudo attribute; read/write access; type: Integer.

The minimum latency allowed. This is an integer number of clock ticks in the time base specified in the frequency attribute. In a distributed the value is given by Simics Central server. This attribute can not be changed.

nbytes
Optional attribute; read/write access; type: Integer.

The number of bytes transmitted over the network. This does not include any frames still in transfer.

next_seq
Optional attribute; read/write access; type: Integer.

The sequence number assigned to the next frame sent over the link

nframes
Optional attribute; read/write access; type: Integer.

The number of frames transmitted over the network. This does not include any frames still in transfer.

pending_frames
Optional attribute; read/write access; type: [[iiiiid]*].

Frames in transfer

promisc_default
Optional attribute; read/write access; type: Integer.

This attribute is internal and may go away in the future

Command List

Commands defined by interface log_object
log, log-group, log-level, log-size, log-type
Commands
connect-real-network-bridgeconnect to the real network
connect-real-network-hostconnect to the real network
connect-real-network-naptenable NAPT from simulated network
connect-real-network-routerconnect to the real network
disconnect-real-networkdisconnect from the real network
infoprint information about the device
statusprint status of the device

Command Descriptions

<ethernet-link>.connect-real-network-bridge
Synopsis
<ethernet-link>.connect-real-network-bridge ["interface"] ["host-access"] [-no-mac-xlate] [-persistent] [-propagate-link-status]
connect-real-network-bridge ["interface"] ["host-access"] [-no-mac-xlate] [-persistent] [-propagate-link-status]
Description
Creates an Ethernet bridge between a simulated Ethernet link and a real network through an Ethernet interface of the simulation host.

The optional interface argument specifies the Ethernet or TAP interface of the host to use.

By default a TAP interface is used, but if the host-access argument is raw, raw access to an Ethernet interface is used.

MAC address translation can be disabled with the -no-mac-xlate flag.

The -persistent is for backward compatibility and should not be used.

If -propagate-link-status is specified, link status changes on the host interface will be propagated to all devices on the link that implements the link-status interface. For TUN/TAP, only 'up' and 'down' status will be propagated (and not 'unconnected'). Link status propagation is only supported on Linux.

See the Connecting to a Real Network chapter of the Simics User Guide for more information about how to connect to a real network.

See Also
connect-real-network, <ethernet-link>.connect-real-network-bridge, connect-real-network-host, connect-real-network-router
<ethernet-link>.connect-real-network-host
Synopsis
<ethernet-link>.connect-real-network-host ["interface"] [-persistent]
connect-real-network-host ["interface"] [-persistent]
Description
Connects a TAP interface of the simulation host to a simulated Ethernet link.

The optional interface argument specifies the TAP interface of the host to use.

The -persistent is for backward compatibility and should not be used.

See the Connecting to a Real Network chapter of the Simics User Guide for more information about how to connect to a real network.

This command is currently not supported on Solaris hosts.

See Also
connect-real-network, <ethernet-link>.connect-real-network-host, connect-real-network-bridge, connect-real-network-router
<ethernet-link>.connect-real-network-napt
Synopsis
<ethernet-link>.connect-real-network-napt
connect-real-network-napt ethernet-link
Description
Enables machines on the simulated network to initiate accesses to real hosts without the need to configure the simulated machine with a real IP address. NAPT (Network Address Port Translation) uses the IP address and a port number of the host that Simics is running on to perform the access. Replies are then translated back to match the request from the simulated machine. This command also enables NAPT for accesses that are initiated from the simulated machine.
See Also
connect-real-network, connect-real-network-port-in, connect-real-network-port-out, connect-real-network-host, connect-real-network-bridge, connect-real-network-router
<ethernet-link>.connect-real-network-router
Synopsis
<ethernet-link>.connect-real-network-router "ip" ["netmask"] ["gateway"] ["interface"]
connect-real-network-router "ip" ["netmask"] ["gateway"] ["interface"]
Description
Creates a routed connection between a simulated Ethernet link and a real network through an Ethernet interface of the simulation host.

The optional interface argument specifies the Ethernet interface of the host to use.

The ip and netmask arguments specify the IP address and netmask that the router should use on the simulated Ethernet link.

The gateway argument specifies the gateway on the simulated Ethernet link that router should use for packets from the real network that are not in the router's subnet.

See the Connecting to a Real Network chapter of the Simics User Guide for more information about how to connect to a real network.

See Also
connect-real-network, <ethernet-link>.connect-real-network-router, connect-real-network-host, connect-real-network-bridge
<ethernet-link>.disconnect-real-network
Synopsis
<ethernet-link>.disconnect-real-network
disconnect-real-network
Description
Closes all connections to real networks except port forwarding and NAPT.
See Also
<ethernet-link>.disconnect-real-network, connect-real-network-host, connect-real-network-bridge, connect-real-network-router
<ethernet-link>.info
Synopsis
<ethernet-link>.info
Description
Print detailed information about the configuration of the device.
<ethernet-link>.status
Synopsis
<ethernet-link>.status
Description
Print detailed information about the current status of the device.

VIRTUTECH CONFIDENTIAL    Previous - Up - Next