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
;-----------------------------------------------------------------------
;     Copyright (c) 2020-2024 by Altair Engineering, Inc.
;     Author: Heinz Bruederlin
;
; Install a TCP socket based server in the Cadence environment which accepts
; Skill commands to be executed.
;
; Load this script into the Cadence CIW with:
; > load("<path/to/script>/skillServer.il")
;
; To use the socket the *Vision Skill Client plugin needs to be activated.
;
; All procedures of this script have the prefix 'CeSkillServer' which should
; not be used elsewhere.

;-----------------------------------------------------------------------
; debug func
; use CeSkillServerVerbose = 1 to enable debug output
;
CeSkillServerVerbose = 0

;-----------------------------------------------------------------------
; support procedures
;
CeSkillServerSupport = list("schematicProcedures.il" "layoutProcedures.il")

;-----------------------------------------------------------------------
; current server process id
;
CeSkillServerId = nil

putd('CeSkillServerMsg nil)
procedure(CeSkillServerMsg(str)
  prog( ()
      printf("MSG: %s\n" str)
  )
)

;-----------------------------------------------------------------------
; print debug messages
;
putd('CeSkillServerDbg nil)
procedure(CeSkillServerDbg(msg)
  prog( ()
    if(CeSkillServerVerbose > 0 then
      printf("%s\n" msg)
    )
  )
)

;-----------------------------------------------------------------------
; print connection info
;
putd('CeSkillServerConnection nil)
procedure(CeSkillServerConnection(addr port)
  prog( ()
    if(CeSkillServerVerbose then
      CeSkillServerDbg(
        sprintf(nil "Connection received from address %s, port %s" addr port))
    )
  )
)

;-----------------------------------------------------------------------
; process incoming tcl cmd commands
; (ignore results from internal commands like CeSkillServerConnection)
; (replace newlines in result or error messages by " ")
;
putd('CeSkillServerDataListener nil)
procedure(CeSkillServerDataListener(ipcId data)
  prog( (channel command result buf ok)
    rexCompile("^\\([^ ]*\\) \\(.*\\)$")
    channel = rexReplace(data "\\1" 1)
    command = rexReplace(data "\\2" 1)
    CeSkillServerDbg(sprintf(nil "COMMAND: %L" command))
    if(errset(result = evalstring(command)) then
      if(substring(command 1 13) != "CeSkillServer" then
        CeSkillServerDbg(sprintf(nil "RESULT: %L" result))
        buf = sprintf(nil "%s %L\n" channel result)
        rexCompile("\n")
        rexReplace(buf " " 0)
        ok = ipcWriteProcess(ipcId buf)
      )
    else
      CeSkillServerDbg(sprintf(nil "ERROR: %L" errset.errset))
      buf = sprintf(nil "%s ERROR {%L}" channel errset.errset)
      rexCompile("\n")
      rexReplace(buf " " 0)
      ok = ipcWriteProcess(ipcId sprintf(nil "%s\n" buf))
    )
    if(!ok then
      CeSkillServerDbg("ipcWriteProcess returned nil")
    )
    CeSkillServerDbg("End of Command processing")
  )
)

;-----------------------------------------------------------------------
; process incoming tcl error
;
putd('CeSkillServerErrorListener nil)
procedure(CeSkillServerErrorListener(ipcId data)
  prog( ()
    CeSkillServerMsg(sprintf(nil "TCL ERROR: %s %L" ipcId data))
  )
)

;-----------------------------------------------------------------------
; process ended tcl server
;
putd('CeSkillServerPostListener nil)
procedure(CeSkillServerPostListener(ipcId data)
  prog( ()
    CeSkillServerDbg(sprintf(nil "TCL POST: %s %L" ipcId data))
  )
)

;-----------------------------------------------------------------------
; get full filename relative to this script
;
putd('CeSkillServerFullFileName nil)
procedure(CeSkillServerFullFileName(fname)
  prog( (scriptFname fullFname splitList pathList fullList)
    ; get filename of script
    scriptFname = #.get_filename(piport)
    ; resolve links, make absolute
    fullFname = simplifyFilename(scriptFname)
    ; split into parts
    splitList = parseString(fullFname "/")
    ; remove file name
    pathList = reverse(cdr(reverse(splitList)))
    ; append tcl server file name
    fullList = append(pathList list(fname))
    ; recreate full path string
    fullFname = strcat("/" buildString(fullList "/"))

    CeSkillServerDbg(sprintf(nil "scriptFname: %s" scriptFname))
    CeSkillServerDbg(sprintf(nil "fullFname: %s" fullFname))

    return(fullFname)
  )
)

;-----------------------------------------------------------------------
; start server
;
putd('CeSkillServerStart nil)
procedure(CeSkillServerStart()
  prog( (tclServer)
    if(CeSkillServerId then
      printf("SkillServer is already running\n")
    else
      printf("Starting SkillServer\n")
      tclServer = CeSkillServerFullFileName("skillServer.tcl")
      CeSkillServerId = ipcBeginProcess(
        tclServer ""
        'CeSkillServerDataListener
        'CeSkillServerErrorListener
        'CeSkillServerPostListener
      )
    )
  )
)

;-----------------------------------------------------------------------
; stop server
;
putd('CeSkillServerStop nil)
procedure(CeSkillServerStop()
  prog( ()
    if(CeSkillServerId then
      printf("Stopping SkillServer\n")
      ipcKillProcess(CeSkillServerId)
      CeSkillServerId = nil
    else
      printf("SkillServer is not running\n")
    )
  )
)


;-----------------------------------------------------------------------
; search for tools menu and append one entry 
;
putd('CeSkillServerAddMenu nil)
procedure(CeSkillServerAddMenu()
  prog( (bannerMenuList pulldownItem menuList menuItem
         toolsPulldownItem isInstalled startItem stopItem serverMenu
         serverMenuItem)
    CeSkillServerDbg("CeSkillServerAddMenu")
    bannerMenuList = hiGetBannerMenus(window(1)) 
    toolsPulldownItem = nil
    isInstalled = nil
    while(bannerMenuList
      pulldownItem = eval(car(bannerMenuList))
      CeSkillServerDbg(
        sprintf(nil "scanning pulldown %s" pulldownItem->_menuTitle))
      if(pulldownItem->_menuTitle == "&Tools" then
        toolsPulldownItem = pulldownItem
      )
      bannerMenuList = cdr(bannerMenuList)
      menuList = pulldownItem->_menuItemList
      while(menuList
        menuItem = car(menuList)
        menuList = cdr(menuList)
        if(menuItem == 'CeSkillServerMenuItem then
          isInstalled = pulldownItem
        )
      )
    )
    if(isInstalled then 
      CeSkillServerDbg(sprintf(nil "SkillServer Menu already installed in %s"
                       isInstalled->_menuTitle))
    else 
      startItem = hiCreateMenuItem(
        ?name 'CeStartItem
        ?itemText "Start"
        ?callback "CeSkillServerStart()")
      stopItem = hiCreateMenuItem(
        ?name 'CeStopItem
        ?itemText "Stop"
        ?callback "CeSkillServerStop()")
      serverMenu = hiCreatePulldownMenu(
        'CeSkillServerMenu
        ""
        list(startItem stopItem))
      serverMenuItem = hiCreateSliderMenuItem(
        ?name 'CeSkillServerMenuItem
        ?itemText "&SkillServer"
        ?subMenu serverMenu)
      if(!toolsPulldownItem then
        CeSkillServerDbg("Creating Tools with SkillServer submenu")
        toolsPulldownItem = hiCreatePulldownMenu(
                                'CeToolsMenu "&Tools"
                                list(serverMenuItem))
        hiInsertBannerMenu(window(1) toolsPulldownItem 99)
      else
        CeSkillServerDbg("Adding SkillServer submenu to Tools menu")
        hiInsertMenuItem(toolsPulldownItem serverMenuItem 99)
      )
    )
  )
)


;-----------------------------------------------------------------------
; load support procedures
;
foreach(p CeSkillServerSupport
  prog( (fname) 
    fname = CeSkillServerFullFileName(p)
    CeSkillServerDbg(sprintf(nil "Loading %s" fname))
    load(fname)
  )
)

;-----------------------------------------------------------------------
; Add a Tools menu to manually start/stop the server.
;
CeSkillServerAddMenu()

;-----------------------------------------------------------------------
; Start the server.
;
CeSkillServerStart()