Blame - c_gen/codegen.py - onos-loxi

2013-12-06 17:37:39 -0800

[diff] [blame]

1

2

#

3

# LoxiGen is licensed under the Eclipse Public License, version 1.0 (EPL), with

4

# the following special exception:

#

# LOXI Exception

#

# As a special exception to the terms of the EPL, you may distribute libraries

9

# generated by LoxiGen (LoxiGen Libraries) under the terms of your choice, provided

10

# that copyright and licensing notices generated by LoxiGen are not altered or removed

11

# from the LoxiGen Libraries and the notice provided below is (i) included in

12

# the LoxiGen Libraries, if distributed in source code form and (ii) included in any

13

# documentation for the LoxiGen Libraries, if distributed in binary form.

#

#

# You may not use this file except in compliance with the EPL or LOXI Exception. You may obtain

18

# a copy of the EPL at:

19

#

20

# http://www.eclipse.org/legal/epl-v10.html

21

#

22

# Unless required by applicable law or agreed to in writing, software

23

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

24

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

25

# EPL for the specific language governing permissions and limitations

# under the EPL.

"""

Code generation

These functions extract data from the IR and render templates with it.

32

"""

33

34

from collections import namedtuple

35

from itertools import groupby

Rich Lane

def2e51

2013-12-15 15:54:02 -0800

[diff] [blame]

36

from StringIO import StringIO

Rich Lane

2013-12-06 17:37:39 -0800

[diff] [blame]

37

import template_utils

Rich Lane

2014-02-24 23:08:26 -0800

[diff] [blame]

38

from generic_utils import chunks

Rich Lane

2013-12-06 17:37:39 -0800

[diff] [blame]

39

import loxi_globals

40

import loxi_ir.ir as ir

41

import util

Rich Lane

ce2e464

2013-12-15 12:05:45 -0800

[diff] [blame]

42

import c_code_gen

Rich Lane

2013-12-15 13:22:13 -0800

[diff] [blame]

43

import c_gen.of_g_legacy as of_g

Rich Lane

cce961d

2013-12-15 14:20:42 -0800

[diff] [blame]

44

import c_gen.type_maps as type_maps

Rich Lane

c0e20ff

2013-12-15 23:40:31 -0800

[diff] [blame]

45

import c_gen.c_type_maps as c_type_maps

Rich Lane

2013-12-06 17:37:39 -0800

[diff] [blame]

46

Rich Lane

2014-02-24 23:08:26 -0800

[diff] [blame]

47

CLASS_CHUNK_SIZE = 32

48

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

49

PushWireTypesData = namedtuple('PushWireTypesData',

Rich Lane

2013-12-06 17:37:39 -0800

[diff] [blame]

50

['class_name', 'versioned_type_members'])

51

PushWireTypesMember = namedtuple('PushWireTypesMember',

52

['name', 'offset', 'length', 'value'])

53

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

54

def push_wire_types_data(uclass):

55

if uclass.virtual or not uclass.has_type_members:

56

return None

Rich Lane

2013-12-06 17:37:39 -0800

[diff] [blame]

57

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

58

# Generate a dict of version -> list of PushWireTypesMember

59

type_members_by_version = {}

60

for version, ofclass in sorted(uclass.version_classes.items()):

61

pwtms = []

62

for m in ofclass.members:

63

if isinstance(m, ir.OFTypeMember):

64

if m.name == "version" and m.value == version.wire_version:

65

# Special case for version

66

pwtms.append(PushWireTypesMember(m.name, m.offset, m.length, "obj->version"))

67

else:

Rich Lane

d0c5871

2013-12-18 10:02:47 -0800

[diff] [blame]

68

pwtms.append(PushWireTypesMember(m.name, m.offset, m.length, hex(m.value)))

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

69

type_members_by_version[version] = pwtms

Rich Lane

2013-12-06 17:37:39 -0800

[diff] [blame]

70

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

71

# Merge versions with identical type members

72

all_versions = sorted(type_members_by_version.keys())

73

versioned_type_members = []

74

for pwtms, versions in groupby(all_versions, type_members_by_version.get):

75

versioned_type_members.append((pwtms, list(versions)))

Rich Lane

2013-12-06 17:37:39 -0800

[diff] [blame]

76

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

77

return PushWireTypesData(

78

class_name=uclass.name,

79

versioned_type_members=versioned_type_members)

Rich Lane

ce2e464

2013-12-15 12:05:45 -0800

[diff] [blame]

80

Rich Lane

2014-03-04 18:44:08 -0800

[diff] [blame]

81

ParseWireTypesData = namedtuple('ParseWireTypesData',

82

['class_name', 'versioned'])

83

ParseWireTypesVersion = namedtuple('ParseWireTypesVersion',

84

['discriminator', 'subclasses'])

85

ParseWireTypesSubclass = namedtuple('ParseWireTypesSubclass',

86

['class_name', 'value', 'virtual'])

87

88

def parse_wire_types_data(uclass):

89

if not uclass.virtual:

90

return None

91

Rich Lane

2014-03-04 18:44:08 -0800

[diff] [blame]

92

# Generate a dict of version -> ParseWireTypesVersion

93

versioned = {}

94

for version, ofclass in sorted(uclass.version_classes.items()):

Rich Lane

a4b6830

2014-03-12 15:17:58 -0700

[diff] [blame]

95

discriminator = ofclass.discriminator

Rich Lane

2014-03-04 18:44:08 -0800

[diff] [blame]

96

subclasses = [ParseWireTypesSubclass(class_name=subclass.name,

97

value=subclass.member_by_name(discriminator.name).value,

98

virtual=subclass.virtual)

99

for subclass in ofclass.protocol.classes if subclass.superclass and subclass.superclass.name == ofclass.name]

100

101

subclasses.sort(key=lambda x: x.value)

102

versioned[version] = ParseWireTypesVersion(discriminator=discriminator,

103

subclasses=subclasses)

104

105

return ParseWireTypesData(class_name=uclass.name,

106

versioned=sorted(versioned.items()))

107

Rich Lane

2014-02-24 23:08:26 -0800

[diff] [blame]

108

# Output multiple LOCI classes into each C file. This reduces the overhead of

109

# parsing header files, which takes longer than compiling the actual code

110

# for many classes. It also reduces the compiled code size.

Rich Lane

ce2e464

2013-12-15 12:05:45 -0800

[diff] [blame]

111

def generate_classes(install_dir):

Rich Lane

2014-02-24 23:08:26 -0800

[diff] [blame]

112

for i, chunk in enumerate(chunks(loxi_globals.unified.classes, CLASS_CHUNK_SIZE)):

113

with template_utils.open_output(install_dir, "loci/src/class%02d.c" % i) as out:

114

for uclass in chunk:

115

util.render_template(out, "class.c",

Rich Lane

2014-03-04 18:44:08 -0800

[diff] [blame]

116

push_wire_types_data=push_wire_types_data(uclass),

117

parse_wire_types_data=parse_wire_types_data(uclass))

Rich Lane

2014-02-24 23:08:26 -0800

[diff] [blame]

118

# Append legacy generated code

119

c_code_gen.gen_new_function_definitions(out, uclass.name)

120

c_code_gen.gen_accessor_definitions(out, uclass.name)

Rich Lane

2013-12-15 13:22:13 -0800

[diff] [blame]

121

Rich Lane

573d2b2

2013-12-15 13:31:27 -0800

[diff] [blame]

122

# TODO remove header classes and use the corresponding class instead

123

def generate_header_classes(install_dir):

124

for cls in of_g.standard_class_order:

125

if cls.find("_header") < 0:

126

continue

127

with template_utils.open_output(install_dir, "loci/src/%s.c" % cls) as out:

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

128

util.render_template(out, "class.c",

Rich Lane

2014-03-04 18:44:08 -0800

[diff] [blame]

129

push_wire_types_data=None,

130

parse_wire_types_data=None)

Rich Lane

573d2b2

2013-12-15 13:31:27 -0800

[diff] [blame]

131

# Append legacy generated code

132

c_code_gen.gen_new_function_definitions(out, cls)

133

c_code_gen.gen_accessor_definitions(out, cls)

134

Rich Lane

def2e51

2013-12-15 15:54:02 -0800

[diff] [blame]

135

def generate_classes_header(install_dir):

136

# Collect legacy code

137

tmp = StringIO()

138

c_code_gen.gen_struct_typedefs(tmp)

139

c_code_gen.gen_new_function_declarations(tmp)

140

c_code_gen.gen_accessor_declarations(tmp)

Rich Lane

def2e51

2013-12-15 15:54:02 -0800

[diff] [blame]

141

c_code_gen.gen_generics(tmp)

142

143

with template_utils.open_output(install_dir, "loci/inc/loci/loci_classes.h") as out:

144

util.render_template(out, "loci_classes.h",

145

legacy_code=tmp.getvalue())

146

Rich Lane

2013-12-15 13:22:13 -0800

[diff] [blame]

147

def generate_lists(install_dir):

148

for cls in of_g.ordered_list_objects:

149

with template_utils.open_output(install_dir, "loci/src/%s.c" % cls) as out:

Rich Lane

2013-12-15 15:28:03 -0800

[diff] [blame]

150

util.render_template(out, "class.c",

Rich Lane

2014-03-04 18:44:08 -0800

[diff] [blame]

151

push_wire_types_data=None,

152

parse_wire_types_data=None)

Rich Lane

2013-12-15 13:22:13 -0800

[diff] [blame]

153

# Append legacy generated code

Rich Lane

b604e33

2013-12-15 13:23:51 -0800

[diff] [blame]

154

c_code_gen.gen_new_function_definitions(out, cls)

Rich Lane