etherpkt.hh revision 2566 
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
29/* @file
30 * Reference counted class containing ethernet packet data
31 */
32
33#ifndef __ETHERPKT_HH__
34#define __ETHERPKT_HH__
35
36#include <iosfwd>
37#include <memory>
38#include <assert.h>
39
40#include "base/refcnt.hh"
41#include "sim/host.hh"
42
43/*
44 * Reference counted class containing ethernet packet data
45 */
46class Checkpoint;
47class EthPacketData : public RefCounted
48{
49  public:
50    /*
51     * Pointer to packet data will be deleted
52     */
53    uint8_t *data;
54
55    /*
56     * Length of the current packet
57     */
58    int length;
59
60    /*
61     * Extra space taken up by the packet in whatever data structure
62     * it is in.
63     *
64     * NOTE: This can only be use by *one* data structure at a time!
65     */
66    int slack;
67
68  public:
69    EthPacketData() : data(NULL), length(0), slack(0) { }
70    explicit EthPacketData(size_t size)
71        : data(new uint8_t[size]), length(0), slack(0) { }
72    EthPacketData(std::auto_ptr<uint8_t> d, int l, int s = 0)
73        : data(d.release()), length(l), slack(s) { }
74    ~EthPacketData() { if (data) delete [] data; }
75
76  public:
77    void serialize(const std::string &base, std::ostream &os);
78    void unserialize(const std::string &base, Checkpoint *cp,
79                     const std::string &section);
80};
81
82typedef RefCountingPtr<EthPacketData> EthPacketPtr;
83
84#endif // __ETHERPKT_HH__
85