etherpkt.hh revision 2566
112771Sqtt2@cornell.edu/*
212771Sqtt2@cornell.edu * Copyright (c) 2002-2005 The Regents of The University of Michigan
312771Sqtt2@cornell.edu * All rights reserved.
412771Sqtt2@cornell.edu *
512771Sqtt2@cornell.edu * Redistribution and use in source and binary forms, with or without
612771Sqtt2@cornell.edu * modification, are permitted provided that the following conditions are
712771Sqtt2@cornell.edu * met: redistributions of source code must retain the above copyright
812771Sqtt2@cornell.edu * notice, this list of conditions and the following disclaimer;
912771Sqtt2@cornell.edu * redistributions in binary form must reproduce the above copyright
1012771Sqtt2@cornell.edu * notice, this list of conditions and the following disclaimer in the
1112771Sqtt2@cornell.edu * documentation and/or other materials provided with the distribution;
1212771Sqtt2@cornell.edu * neither the name of the copyright holders nor the names of its
1312771Sqtt2@cornell.edu * contributors may be used to endorse or promote products derived from
1412771Sqtt2@cornell.edu * this software without specific prior written permission.
1512771Sqtt2@cornell.edu *
1612771Sqtt2@cornell.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1712771Sqtt2@cornell.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1812771Sqtt2@cornell.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
1912771Sqtt2@cornell.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2012771Sqtt2@cornell.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2112771Sqtt2@cornell.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2212771Sqtt2@cornell.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2312771Sqtt2@cornell.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2412771Sqtt2@cornell.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2512771Sqtt2@cornell.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2612771Sqtt2@cornell.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2712771Sqtt2@cornell.edu */
2812771Sqtt2@cornell.edu
2912771Sqtt2@cornell.edu/* @file
3012771Sqtt2@cornell.edu * Reference counted class containing ethernet packet data
3112771Sqtt2@cornell.edu */
3212771Sqtt2@cornell.edu
3312771Sqtt2@cornell.edu#ifndef __ETHERPKT_HH__
3412771Sqtt2@cornell.edu#define __ETHERPKT_HH__
3512771Sqtt2@cornell.edu
3612771Sqtt2@cornell.edu#include <iosfwd>
3712771Sqtt2@cornell.edu#include <memory>
3812771Sqtt2@cornell.edu#include <assert.h>
3912771Sqtt2@cornell.edu
4012771Sqtt2@cornell.edu#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