AnalysisServer.curry 12.9 KB
Newer Older
1
2
3
4
5
6
7
--------------------------------------------------------------------------
--- This is the main module of the analysis system.
--- One can either use the 'main' operation to start the system
--- in "server mode" or "batch mode" or use one of the operations below
--- to use the analysis system in another Curry program.
---
--- @author Heiko Hoffmann, Michael Hanus
8
--- @version June 2016
9
10
--------------------------------------------------------------------------

11
module AnalysisServer(mainServer, initializeAnalysisSystem, analyzeModuleAsText,
12
                      analyzeModuleForBrowser, analyzeFunctionForBrowser,
13
14
                      analyzeGeneric, analyzePublic, analyzeInterface)
  where
15

16
17
import ReadNumeric(readNat)
import Char(isSpace)
18
import Directory
19
import FlatCurry.Types(QName)
20
import Socket(Socket(..),listenOn,listenOnFresh,sClose,waitForSocketAccept)
21
22
23
import IO
import ReadShowTerm(readQTerm,showQTerm)
import System(system,sleep,setEnviron,getArgs)
24
import FileGoodies(stripSuffix,splitDirectoryBaseName)
25
26
27
28
import AnalysisCollection
import ServerFormats
import ServerFunctions(WorkerMessage(..))
import Configuration
29
30
import GenericProgInfo
import Analysis(Analysis,AOutFormat(..))
31
32
33
34
35
36
37
38
39
40
41

-- Messages to communicate with the analysis server from external programs.
data AnalysisServerMessage = 
    GetAnalysis
  | AnalyzeModule    String String String Bool
  | AnalyzeEntity  String String String String
  | StopServer
  | SetCurryPath String
  | ParseError

--- Initializations to be done when the system is started.
42
43
initializeAnalysisSystem :: IO ()
initializeAnalysisSystem = updateRCFile
44

45
--- Start the analysis server on a socket.
46
47
mainServer :: Maybe Int -> IO ()
mainServer mbport = do
48
  putStrLn "Start Server"
49
50
51
  (port1,socket1) <- maybe listenOnFresh
                           (\p -> listenOn p >>= \s -> return (p,s))
                           mbport
52
53
54
55
56
57
58
59
  putStrLn ("Server Port: "++show port1)
  storeServerPortNumber port1
  getDefaultPath >>= setEnviron "CURRYPATH" 
  numworkers <- numberOfWorkers
  if numworkers>0
   then do
    serveraddress <- getServerAddress
    (workerport,workersocket) <- listenOnFresh
60
    debugMessage 2 ("SERVER: port to workers: "++show workerport)
61
    handles <- startWorkers numworkers workersocket serveraddress workerport []
62
    serverLoop socket1 handles
63
64
    sClose workersocket
   else
65
    serverLoop socket1 []
66
67


68
69
70
71
72
73
74
75
76
77
78
--- Run the analysis system and show the analysis results in standard textual
--- representation.
--- The third argument is a flag indicating whether the
--- (re-)analysis should be enforced.
--- Note that, before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
analyzeModuleAsText :: String -> String -> Bool -> IO String
analyzeModuleAsText ananame mname enforce =
  analyzeModule ananame (stripSuffix mname) enforce AText >>=
             return . formatResult mname "Text" Nothing True

79
80
81
82
83
--- Run the analysis system to show the analysis results in the BrowserGUI.
--- Note that, before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
analyzeModuleForBrowser :: String -> String -> AOutFormat -> IO [(QName,String)]
analyzeModuleForBrowser ananame moduleName aoutformat =
84
  analyzeModule ananame moduleName False aoutformat >>=
85
86
87
88
89
90
91
92
93
94
95
    return . either pinfo2list (const [])
 where
   pinfo2list pinfo = let (pubinfo,privinfo) = progInfo2Lists pinfo
                       in pubinfo++privinfo

--- Run the analysis system to show the analysis result of a single function
--- in the BrowserGUI.
--- Note that before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
analyzeFunctionForBrowser :: String -> QName -> AOutFormat -> IO String
analyzeFunctionForBrowser ananame qn@(mname,_) aoutformat = do
96
  analyzeModule ananame mname False aoutformat >>=
97
    return . either (maybe "" id . lookupProgInfo qn) (const "")
98

99
--- Analyze a complete module for a given analysis result format.
100
101
--- The third argument is a flag indicating whether the
--- (re-)analysis should be enforced.
102
103
--- Note that before its first use, the analysis system must be initialized
--- by 'initializeAnalysisSystem'.
104
analyzeModule :: String -> String -> Bool -> AOutFormat
105
              -> IO (Either (ProgInfo String) String)
106
analyzeModule ananame moduleName enforce aoutformat = do
107
108
109
110
  let (mdir,mname) = splitDirectoryBaseName moduleName
  getDefaultPath >>= setEnviron "CURRYPATH"
  curdir <- getCurrentDirectory
  unless (mdir==".") $ setCurrentDirectory mdir
111
  numworkers <- numberOfWorkers
112
113
114
115
116
117
  aresult <-
   if numworkers>0
     then do
      serveraddress <- getServerAddress
      (port,socket) <- listenOnFresh
      handles <- startWorkers numworkers socket serveraddress port []
118
      result <- runAnalysisWithWorkers ananame aoutformat enforce handles mname
119
120
121
      stopWorkers handles
      sClose socket
      return result
122
     else runAnalysisWithWorkers ananame aoutformat enforce [] mname
123
124
125
  setCurrentDirectory curdir
  return aresult

126
127
128
129
130
131
--- Start the analysis system with a particular analysis.
--- The analysis must be a registered one if workers are used.
--- If it is a combined analysis, the base analysis must be also
--- a registered one.
analyzeGeneric :: Analysis a -> String -> IO (Either (ProgInfo a) String)
analyzeGeneric analysis moduleName = do
132
  initializeAnalysisSystem
133
  let (mdir,mname) = splitDirectoryBaseName moduleName
134
  getDefaultPath >>= setEnviron "CURRYPATH" 
135
136
  curdir <- getCurrentDirectory
  unless (mdir==".") $ setCurrentDirectory mdir
137
  numworkers <- numberOfWorkers
138
139
140
141
142
143
  aresult <-
    if numworkers>0
     then do
      serveraddress <- getServerAddress
      (port,socket) <- listenOnFresh
      handles <- startWorkers numworkers socket serveraddress port []
144
      result <- analyzeMain analysis mname handles False True
145
146
147
148
      stopWorkers handles
      sClose socket
      return result
     else
149
      analyzeMain analysis mname [] False True
150
151
152
  setCurrentDirectory curdir
  return aresult
 
153
154
155
156
157
158
159
160
161
162
--- Start the analysis system with a given analysis to compute properties
--- of a module interface.
--- The analysis must be a registered one if workers are used.
--- If it is a combined analysis, the base analysis must be also
--- a registered one.
analyzePublic :: Analysis a -> String -> IO (Either (ProgInfo a) String)
analyzePublic analysis moduleName =
  analyzeGeneric analysis moduleName
  >>= return . either (Left . publicProgInfo) Right

163
164
165
166
167
168
--- Start the analysis system with a given analysis to compute properties
--- of a module interface.
--- The analysis must be a registered one if workers are used.
--- If it is a combined analysis, the base analysis must be also
--- a registered one.
analyzeInterface :: Analysis a -> String -> IO (Either [(QName,a)] String)
169
analyzeInterface analysis moduleName =
170
  analyzeGeneric analysis moduleName
171
  >>= return . either (Left . publicListFromProgInfo) Right
172
173
174
175
176
177
178

--------------------------------------------------------------------------
-- start a number of workers at server start
startWorkers:: Int -> Socket -> String -> Int -> [Handle] -> IO [Handle]
startWorkers number workersocket serveraddress workerport handles = do
  if number>0
    then do
179
      debugMessage 4 ("Number:"++(show number))
180
181
      let command = baseDir++"/cass_worker "++serveraddress++" "
                                            ++(show workerport)++" &"
182
      debugMessage 4 ("system command: "++command)
183
      system command
184
      debugMessage 4 ("Wait for socket accept for client "++show number)
185
      connection <- waitForSocketAccept workersocket waitTime
186
      debugMessage 4 ("Socket accept for client "++show number)
187
188
189
190
191
192
193
194
195
196
      case connection of
        Just (_,handle) -> do
          startWorkers (number-1) workersocket serveraddress workerport
                       (handle:handles)
        Nothing -> do
          putStrLn ("startWorkers: connection error worker "++(show number))
          startWorkers (number-1) workersocket serveraddress workerport handles
    else return handles

-- stop all workers at server stop
Michael Hanus 's avatar
Michael Hanus committed
197
stopWorkers :: [Handle] -> IO ()
198
199
200
201
202
203
204
205
stopWorkers [] = done
stopWorkers (handle:whandles) = do
  hPutStrLn handle (showQTerm StopWorker)
  hClose handle
  stopWorkers whandles

--------------------------------------------------------------------------
-- server loop to answer analysis requests over network
Michael Hanus 's avatar
Michael Hanus committed
206
serverLoop :: Socket -> [Handle] -> IO ()
207
serverLoop socket1 whandles = do
208
  --debugMessage 3 "SERVER: serverLoop"
209
210
  connection <- waitForSocketAccept socket1 waitTime
  case connection of 
211
212
213
    Just (_,handle) -> serverLoopOnHandle socket1 whandles handle
    Nothing -> do
      putStrLn "serverLoop: connection error: time out in waitForSocketAccept"
214
      sleep 1
215
216
217
218
219
220
221
222
223
224
225
226
227
      serverLoop socket1 whandles

--- Reads a line from an input handle and returns it.
hGetLineUntilEOF  :: Handle -> IO String
hGetLineUntilEOF h = do
  eof <- hIsEOF h
  if eof
   then return ""
   else do c <- hGetChar h
           if c=='\n' then return ""
                      else do cs <- hGetLineUntilEOF h
                              return (c:cs)

Michael Hanus 's avatar
Michael Hanus committed
228
serverLoopOnHandle :: Socket -> [Handle] -> Handle -> IO ()
229
230
231
232
serverLoopOnHandle socket1 whandles handle = do
  eof <- hIsEOF handle
  if eof
   then do hClose handle
233
           debugMessage 2 "SERVER connection: eof"
234
235
236
           serverLoop socket1 whandles
   else do
     string <- hGetLineUntilEOF handle
237
     debugMessage 2 ("SERVER got message: "++string)
238
     let force = False
239
240
241
242
243
244
245
246
     case parseServerMessage string of
       ParseError -> do
         sendServerError handle ("Illegal message received: "++string)
         serverLoopOnHandle socket1 whandles handle
       GetAnalysis -> do
         sendServerResult handle showAnalysisNamesAndFormats
         serverLoopOnHandle socket1 whandles handle
       AnalyzeModule ananame outForm modname public ->
247
         catch (runAnalysisWithWorkers ananame AText force whandles modname >>=
248
249
250
251
                return . formatResult modname outForm Nothing public >>=
                sendResult)
               sendAnalysisError
       AnalyzeEntity ananame outForm modname functionName ->
252
         catch (runAnalysisWithWorkers ananame AText force whandles modname >>=
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
                return . formatResult modname outForm
                                      (Just functionName) False >>= sendResult)
               sendAnalysisError
       SetCurryPath path -> do
         setEnviron "CURRYPATH" path
         changeWorkerPath path whandles
         sendServerResult handle ""
         serverLoopOnHandle socket1 whandles handle
       StopServer -> do
         stopWorkers whandles
         sendServerResult handle ""
         hClose handle
         sClose socket1
         putStrLn "Stop Server"
         removeServerPortNumber
268
 where
269
  sendResult resultstring = do
270
    debugMessage 4 ("formatted result:\n"++resultstring)
271
272
    sendServerResult handle resultstring
    serverLoopOnHandle socket1 whandles handle
273

274
275
276
  sendAnalysisError err = do
    sendServerError handle ("ERROR in analysis server: "++showError err)
    serverLoopOnHandle socket1 whandles handle
277
278

-- Send a server result in the format "ok <n>\n<result text>" where <n>
279
-- is the number of lines of the <result text>.
Michael Hanus 's avatar
Michael Hanus committed
280
sendServerResult :: Handle -> String -> IO ()
281
282
283
284
285
286
sendServerResult handle resultstring = do
  let resultlines = lines resultstring
  hPutStrLn handle ("ok " ++ show (length resultlines))
  hPutStr handle (unlines resultlines)
  hFlush handle

287
-- Send a server error in the format "error <error message>\n".
Michael Hanus 's avatar
Michael Hanus committed
288
sendServerError :: Handle -> String -> IO ()
289
sendServerError handle errstring = do
290
  debugMessage 1 errstring
291
292
293
  hPutStrLn handle ("error "++errstring)
  hFlush handle

294
295
296
-- Inform the worker threads about a given changed library search path
changeWorkerPath :: String -> [Handle] -> IO ()
changeWorkerPath _ [] = done
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
changeWorkerPath path (handle:whandles) = do
  hPutStrLn handle (showQTerm (ChangePath path))
  changeWorkerPath path whandles

-- parse incoming message for type of request
parseServerMessage :: String -> AnalysisServerMessage
parseServerMessage message = case words message of
  [] -> ParseError
  w:ws -> case w of 
    "GetAnalysis" -> GetAnalysis
    "AnalyzeModule" -> case ws of 
      s1:s2:s3:[] -> checkFormat s2 $ AnalyzeModule s1 s2 s3 False
    "AnalyzeInterface" -> case ws of 
      s1:s2:s3:[] -> checkFormat s2 $ AnalyzeModule s1 s2 s3 True
      _ -> ParseError
    "AnalyzeFunction" -> case ws of
      s1:s2:s3:s4:[] -> checkFormat s2 $ AnalyzeEntity s1 s2 s3 s4
      _ -> ParseError
    "AnalyzeTypeConstructor" -> case ws of
      s1:s2:s3:s4:[] -> checkFormat s2 $ AnalyzeEntity s1 s2 s3 s4
      _ -> ParseError
    "AnalyzeDataConstructor" -> case ws of
      s1:s2:s3:s4:[] -> checkFormat s2 $ AnalyzeEntity s1 s2 s3 s4
      _ -> ParseError  
    "SetCurryPath" -> case ws of
      s:[] -> SetCurryPath s
      _ -> ParseError
    "StopServer" -> StopServer
    _ -> ParseError 
 where
  checkFormat fmt msg = if fmt `elem` serverFormats then msg else ParseError

--- Show all analysis names and formats.
showAnalysisNamesAndFormats :: String
showAnalysisNamesAndFormats =
  unlines (concatMap (\an -> map ((an++" ")++) serverFormats)
333
                     registeredAnalysisNames)
334