etherpkt.hh revision 10923 
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Nathan Binkert
29 *          Lisa Hsu
30 */
31
32/* @file
33 * Reference counted class containing ethernet packet data
34 */
35
36#ifndef __ETHERPKT_HH__
37#define __ETHERPKT_HH__
38
39#include <cassert>
40#include <iosfwd>
41#include <memory>
42
43#include "base/types.hh"
44#include "sim/serialize.hh"
45
46/*
47 * Reference counted class containing ethernet packet data
48 */
49class EthPacketData
50{
51  public:
52    /*
53     * Pointer to packet data will be deleted
54     */
55    uint8_t *data;
56
57    /*
58     * Length of the current packet
59     */
60    unsigned length;
61
62  public:
63    EthPacketData()
64        : data(NULL), length(0)
65    { }
66
67    explicit EthPacketData(unsigned size)
68        : data(new uint8_t[size]), length(0)
69    { }
70
71    ~EthPacketData() { if (data) delete [] data; }
72
73  public:
74    /**
75     * This function pulls out the MAC source and destination addresses from
76     * the packet data and stores them in the caller specified buffers.
77     *
78     * @param src_addr The buffer to store the source MAC address.
79     * @param dst_addr The buffer to store the destination MAC address.
80     * @param length This is an inout parameter. The caller stores in this
81     * the size of the address buffers. On return, this will contain the
82     * actual address size stored in the buffers. (We assume that source
83     * address size is equal to that of the destination address.)
84     */
85    void packAddress(uint8_t *src_addr, uint8_t *dst_addr, unsigned &length);
86
87    void serialize(const std::string &base, CheckpointOut &cp) const;
88    void unserialize(const std::string &base, CheckpointIn &cp);
89
90    unsigned size() const { return length; }
91};
92
93typedef std::shared_ptr<EthPacketData> EthPacketPtr;
94
95#endif // __ETHERPKT_HH__
96