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