-
Notifications
You must be signed in to change notification settings - Fork 3
/
gen_sch_tbl.py
271 lines (228 loc) · 9.51 KB
/
gen_sch_tbl.py
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
#
# GSC-18128-1, "Core Flight Executive Version 6.6"
#
# Copyright (c) 2006-2019 United States Government as represented by
# the Administrator of the National Aeronautics and Space Administration.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#!/usr/bin/env python
#===============================================================================
# File: gen_sch_tbl.py
# Author: Steve Duran
# Date: 2014-06-23
#
# This script will convert a simple input file of the format:
# The first two lines define the number of minor frames per major frame and
# the max number of activity messages that the scheduler can send per minor
# frame time slot
# SCH_MAX_MINOR_FRAMES max_num_minor_frames
# MSGS_PER_MINOR_FRAMES messages_per_minor_frame
#
# The rest of the file is one line per app of the following form
# APP_ID PRIO RATE_Hz INITIAL_MF MSG_TYPE(WU_HK)
#
# where:
# APP_ID: app ID or prefix (i.e. SCH, DS, GNC, etc)
# PRIO: priority in the range of 1 to 255 (high to low)
# RATE_Hz: cycle rate for the app
# INITIAL_MF: initial minor frame number to start in (basically
# start offset into major frame)
# MSG_TYPE(WU_HK): activity message type to send, currently supported are
# either WU for a wakeup message or HK for a housekeeping
# message
#
# USAGE:
# gen_sch_tbl.py sch_input_config_file sch_def_file.c
# ex:
# gen_sch_tbl.py sch.in sch_def_schtbl.c
#
#===============================================================================
import os, sys
#===============================================================================
# Global Variables - only global to this file
gSchConfig = []
gSchCfgFileContent = []
gSchTbl = []
# line and within line index values for parsing 'sch.in' file
# NOTE: If the sch.in file format changes these may have to change too
SCH_MAX_MINOR_FRAMES_LINE = 0
SCH_MAX_MINOR_FRAMES_IDX = 1
MSGS_PER_MINOR_FRAMES_LINE = 1
MSGS_PER_MINOR_FRAMES_IDX = 1
APP_PARAM_LIST_START_LINE = 3 # app sch params list start on line 3
APP_ID_IDX = 0
APP_PRIORITY_IDX = 1
APP_RATE_Hz_IDX = 2
APP_INITIAL_MF_IDX = 3
APP_MSG_TYPE_IDX = 4
#===============================================================================
def Init():
#print str(sys.argv)
if(len(sys.argv) < 3):
print "usage: gen_sch_tbl.py schCfgFile schTblFile\n"
return
#===============================================================================
def LoadSchConfigFile(cfgFileName):
fp = open(cfgFileName, "r")
gSchCfgFileContent = list(fp)
for line in gSchCfgFileContent:
gSchConfig.append(line.split())
fp.close()
return
#===============================================================================
def GenerateSchTable():
numMinorFrames = int(gSchConfig[SCH_MAX_MINOR_FRAMES_LINE][SCH_MAX_MINOR_FRAMES_IDX], 10)
numMsgsPerMinorFrame = int(gSchConfig[MSGS_PER_MINOR_FRAMES_LINE][MSGS_PER_MINOR_FRAMES_IDX], 10)
# initialize schedule table with all empty entries
# "{ SCH_UNUSED, 0, 0, 0, 0, SCH_GROUP_NONE },"
for i in range(0, numMinorFrames):
for j in range(0, numMsgsPerMinorFrame):
gSchTbl.append("{ SCH_UNUSED, 0, 0, 0, 0, SCH_GROUP_NONE },")
# print gSchTbl
# for each app entry in priority order (so that activity messages
# are filled in priority order), scan through sch table and fill in its
# entries based on the app rate and initial minor frame
for appIdx in range(APP_PARAM_LIST_START_LINE, len(gSchConfig)):
# determine which minor frames this app needs to be
# messaged from the scheduler, starting on its initial minor frame
mfIncr = numMinorFrames / int(gSchConfig[appIdx][APP_RATE_Hz_IDX], 10)
# starting at initial minor frame from sch.in, add a msg entry
# for the current app, every
mfIdx = int(gSchConfig[appIdx][APP_INITIAL_MF_IDX], 10)
while mfIdx < numMinorFrames:
# print appIdx, gSchConfig[appIdx][APP_ID_IDX], mfIdx, mfIncr
for msgIdx in range(0, numMsgsPerMinorFrame):
idx = (mfIdx * numMsgsPerMinorFrame) + msgIdx
# Look for SCH_UNUSED activity slots at the current
# minor frame index for this app
if(gSchTbl[idx].find("SCH_UNUSED") > -1):
# add either wakeup or HK activity message to sch table
if(gSchConfig[appIdx][APP_MSG_TYPE_IDX] == "WU"):
gSchTbl[idx] = "{ SCH_ENABLED, SCH_ACTIVITY_SEND_MSG, 1, 0, " + \
gSchConfig[appIdx][APP_ID_IDX] + "_WAKEUP_MIDX, SCH_GROUP_MISC },"
elif(gSchConfig[appIdx][APP_MSG_TYPE_IDX] == "HK"):
gSchTbl[idx] = "{ SCH_ENABLED, SCH_ACTIVITY_SEND_MSG, 1, 0, " + \
gSchConfig[appIdx][APP_ID_IDX] + "_SEND_HK_MIDX, SCH_GROUP_MISC },"
#else
# WU and HK are the only options, anything else would
# be a user input error, so just leave default table
# entry
# print mfIdx, msgIdx, idx, gSchTbl[idx]
# found the next available msg slot open, now exit msgs
# per minor frame loop
break;
# increment minor frame index for next minor frame that this
# app should be scheduled
mfIdx += mfIncr
return
#===============================================================================
def SaveSchTbl(schTblFileName):
numMinorFrames = int(gSchConfig[SCH_MAX_MINOR_FRAMES_LINE][SCH_MAX_MINOR_FRAMES_IDX], 10)
numMsgsPerMinorFrame = int(gSchConfig[MSGS_PER_MINOR_FRAMES_LINE][MSGS_PER_MINOR_FRAMES_IDX], 10)
fp = open(schTblFileName, "w")
# write sch table file header and top level constant struct defs
fp.write("""
/*==============================================================================
** File Name: sch_def_schtbl.c
**
** Title: CFS scheduler table
**
** $Author: Auto-generated by gen_sch_tbl
** $Revision: 1.1 $
** $Date: 2014/08/28 12:53:20GMT-05:00 $
**
** Purpose:
**\n""")
fp.write("** Schedule table configuration parameters:\n")
fp.write("** %s %s\n" %(gSchConfig[SCH_MAX_MINOR_FRAMES_LINE][0], \
gSchConfig[SCH_MAX_MINOR_FRAMES_LINE][SCH_MAX_MINOR_FRAMES_IDX]))
fp.write("** %s %s\n" %(gSchConfig[MSGS_PER_MINOR_FRAMES_LINE][0], \
gSchConfig[MSGS_PER_MINOR_FRAMES_LINE][MSGS_PER_MINOR_FRAMES_LINE]))
for i in range(2, len(gSchConfig)):
fp.write("** %s %s %s %s %s\n" %(gSchConfig[i][0],\
gSchConfig[i][1],gSchConfig[i][2],gSchConfig[i][3],gSchConfig[i][4]))
fp.write("""
**============================================================================*/
/*
** Pragmas
*/
/*
** Include Files
*/
#include "cfe.h"
#include "cfe_tbl_filedef.h"
#include "sch_platform_cfg.h"
#include "sch_msgdefs.h"
#include "sch_tbldefs.h"
#include "sch_grpids.h"
#include "sch_tblidx.h"
/*
** Local Defines
*/
/*
** Local Structure Declarations
*/
/*
** External Global Variables
*/
/*
** Global Variables
*/
/* Table file header */
static CFE_TBL_FileDef_t CFE_TBL_FileDef =
{
"SCH_DefaultScheduleTable", "SCH.SCHED_DEF", "SCH schedule table",
"sch_def_schtbl.tbl", (sizeof(SCH_ScheduleEntry_t) * SCH_TABLE_ENTRIES)
};
/* Default schedule table data */
SCH_ScheduleEntry_t SCH_DefaultScheduleTable[SCH_TABLE_ENTRIES] =
{
/*
** Structure definition...
**
** uint8 EnableState -- SCH_UNUSED, SCH_ENABLED, SCH_DISABLED
** uint8 Type -- 0 or SCH_ACTIVITY_SEND_MSG
** uint16 Frequency -- how many seconds between Activity execution
** uint16 Remainder -- seconds offset to perform Activity
** uint16 MessageIndex -- Message Index into Message Definition table
** uint32 GroupData -- Group and Multi-Group membership definitions
*/
""")
# write table content
for i in range(0, numMinorFrames):
fp.write("\n /* Slot #%d */\n" %(i))
for j in range(0, numMsgsPerMinorFrame):
fp.write(" %s\n" %(gSchTbl[(i * numMsgsPerMinorFrame) + j]))
# write sch table struct closing bracket
fp.write("};\n")
fp.write(
"""
/*==============================================================================
** End of file %s
**============================================================================*/
""" %(schTblFileName)
)
fp.close()
return
#===============================================================================
# "main" - init, load sch table input file, generate sch table .c file,
# save sch table file to sch tbl.c
Init()
LoadSchConfigFile(sys.argv[1])
GenerateSchTable()
SaveSchTbl(sys.argv[2])
#===============================================================================
# End of gen_sch_tbl.py
#===============================================================================