[Qemu-devel] Re: [RFC][RESEND][PATCH v1 00/15] virtproxy: host/guest communication layer

[Michael Roth]

On 11/03/2010 06:44 PM, Adam Litke wrote:
> You've got a lot of "objects" interacting with one another in virtproxy.
> I think it would help other reviewers if you could describe the
> relationships between the entities such as: VPDriver, VPConn, VPChannel,
> VPIForward, VPOForward, etc.  This patch series is really wiring a lot
> of things together.  Your documentation could end up as a nice ASCII art
> diagram and associated commentary at the top of virtproxy.c.

Hmm, yah, at the very least I should document these a bit better 
somewhere. virtproxy.c or maybe even docs/virtproxy.txt.

For the benefit of anyone reviewing these patches though:

VPDriver: encompasses the virtproxy state, which manages connections 
coming in/out of a data channel between the host and the guest, such as 
a virtio-serial or isa-serial port. Additional virtproxy/VPDriver 
instances can be set up to manage additional data channels. In the 
integrated version of these patches this channel will be accessed via an 
encapsulated virtproxy character device in the host, or an fd in the guest.

VPConn: encapsulates a bit of state, and client fds connected to 
forwarding sockets/ports that virtproxy set up or server fds that 
virtproxy established a connection to and is forwarding connections to.

VPOForward: encapsulates a listening forwarding port/socket that was 
passed to it, and an associated service_id. connections to the 
port/socket cause a VPConn to be set up, and data is proxied to the 
service on the other end of the channel that this service_id maps to.

VPIForward: maps a service_id to a local socket/port.