summaryrefslogtreecommitdiffstats
path: root/src/java/com/sun/gluegen/StructLayout.java
blob: fb7ff4d82e98efde12ef8ab411e324f3a063a2cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
 * Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 * Sun gratefully acknowledges that this software was originally authored
 * and developed by Kenneth Bradley Russell and Christopher John Kline.
 */

package com.sun.gluegen;

import com.sun.gluegen.cgram.types.*;

/** Encapsulates algorithm for laying out data structures. Note that
    this ends up embedding code in various places via SizeThunks. If
    the 32-bit and 64-bit ports on a given platform differ
    fundamentally in their handling of struct layout then this code
    will need to be updated and, most likely, two versions of the
    SizeThunks maintained in various places. */

public class StructLayout {
  private int baseOffset;
  private int structAlignment;

  protected StructLayout(int baseOffset,
                         int structAlignment) {
    this.baseOffset = baseOffset;
    this.structAlignment = structAlignment;
  }

  public void layout(CompoundType t) {
    int n = t.getNumFields();
    SizeThunk curOffset = SizeThunk.constant(baseOffset);
    SizeThunk maxSize   = SizeThunk.constant(0);
    for (int i = 0; i < n; i++) {
      Field f = t.getField(i);
      Type ft = f.getType();
      if (ft.isInt() || ft.isFloat() || ft.isDouble() || ft.isPointer()) {
        SizeThunk sz = ft.getSize();
        curOffset = SizeThunk.roundUp(curOffset, sz);
        f.setOffset(curOffset);
        if (t.isUnion()) {
          maxSize = SizeThunk.max(maxSize, sz);
        } else {
          curOffset = SizeThunk.add(curOffset, sz);
        }
      } else if (ft.isCompound()) {
        new StructLayout(0, structAlignment).layout(ft.asCompound());
        curOffset = SizeThunk.roundUp(curOffset, SizeThunk.constant(structAlignment));
        f.setOffset(curOffset);
        if (t.isUnion()) {
          maxSize = SizeThunk.max(maxSize, ft.getSize());
        } else {
          curOffset = SizeThunk.add(curOffset, ft.getSize());
        }
      } else if (ft.isArray()) {
        ArrayType arrayType = ft.asArray();
        CompoundType compoundElementType = arrayType.getBaseElementType().asCompound();
        if (compoundElementType != null) {
          new StructLayout(0, structAlignment).layout(compoundElementType);
          arrayType.recomputeSize();
        }
        // Note: not sure how this rounding is done
        curOffset = SizeThunk.roundUp(curOffset, SizeThunk.constant(structAlignment));
        f.setOffset(curOffset);
        curOffset = SizeThunk.add(curOffset, ft.getSize());
      } else {
        // FIXME
        String name = t.getName();
        if (name == null) {
          name = t.toString();
        }
        throw new RuntimeException("Complicated field types (" + ft +
                                   " " + f.getName() +
                                   " in type " + name +
                                   ") not implemented yet");
      }
    }
    // FIXME: I think the below is wrong; better check with some examples
    //    if ((curOffset % structAlignment) != 0) {
    //      curOffset += structAlignment - (curOffset % structAlignment);
    //    }
    if (t.isUnion()) {
      t.setSize(maxSize);
    } else {
      t.setSize(curOffset);
    }
  }

  

  public static StructLayout createForCurrentPlatform() {
    // Note: this code is replicated in CPU.java
    String os = System.getProperty("os.name").toLowerCase();
    String cpu = System.getProperty("os.arch").toLowerCase();
    if ((os.startsWith("windows") && cpu.equals("x86"))) {
      // It appears that Windows uses a packing alignment of 4 bytes in 32-bit mode
      return new StructLayout(0, 4);
    } else if ((os.startsWith("windows") && cpu.equals("amd64")) ||
               (os.startsWith("linux") && cpu.equals("i386")) ||
               (os.startsWith("linux") && cpu.equals("x86")) ||
               (os.startsWith("linux") && cpu.equals("amd64")) ||
               (os.startsWith("linux") && cpu.equals("x86_64")) ||
               (os.startsWith("linux") && cpu.equals("ia64")) ||
               (os.startsWith("sunos") && cpu.equals("sparc")) ||
               (os.startsWith("sunos") && cpu.equals("sparcv9")) ||
               (os.startsWith("sunos") && cpu.equals("x86")) ||
               (os.startsWith("sunos") && cpu.equals("amd64")) ||
               (os.startsWith("mac os") && cpu.equals("ppc")) ||
               (os.startsWith("mac os") && cpu.equals("i386")) ||
               (os.startsWith("freebsd") && cpu.equals("i386")) ||
               (os.startsWith("hp-ux") && cpu.equals("pa_risc2.0"))
               ) {
      // FIXME: make struct alignment configurable? May need to change
      // packing rules on a per-type basis?
      return new StructLayout(0, 8);
    } else {
      // FIXME: add more ports
      throw new RuntimeException("Please port StructLayout to your OS (" + os + ") and CPU (" + cpu + ")");
    }
  }
}