b91222e0553ed7e7827e7032f38362c5ab8f2bf8
[ipc/ipcdev.git] / packages / ti / sdo / ipc / MessageQ.xs
1 /*
2  * Copyright (c) 2012-2014 Texas Instruments Incorporated - http://www.ti.com
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /*
33  *  ======== MessageQ.xs ========
34  *
35  */
37 var MultiProc  = null;
38 var NameServer = null;
39 var MessageQ   = null;
40 var GateThread = null;
41 var Settings   = null;
42 var SyncSem    = null;
44 var instCount = 0;  /* use to determine if processing last instance */
46 /*
47  *  ======== module$meta$init ========
48  */
49 function module$meta$init(name)
50 {
51     /* Only process during "cfg" phase */
52     if (xdc.om.$name != "cfg") {
53         return;
54     }
55 }
57 /*
58  *  ======== module$use ========
59  */
60 function module$use()
61 {
62     MessageQ   = this;
63     Settings   = xdc.useModule('ti.sdo.ipc.family.Settings');
64     List       = xdc.useModule("ti.sdo.utils.List");
65     MultiProc  = xdc.useModule("ti.sdo.utils.MultiProc");
66     NameServer = xdc.useModule('ti.sdo.utils.NameServer');
67     GateThread = xdc.useModule('xdc.runtime.knl.GateThread');
68     SyncSem    = xdc.useModule('ti.sysbios.syncs.SyncSem');
70     xdc.useModule('ti.sdo.ipc.interfaces.ITransport');
71     xdc.useModule('ti.sdo.ipc.interfaces.IMessageQTransport');
72     xdc.useModule('ti.sdo.ipc.interfaces.INetworkTransport');
73     xdc.useModule('ti.sdo.ipc.transports.TransportNetworkDummy');
75     /* Plug the SetupTransportProxy for the MessageQ transport */
76     if (MessageQ.SetupTransportProxy == null) {
77         try {
78             MessageQ.SetupTransportProxy =
79                 xdc.useModule(Settings.getMessageQSetupDelegate());
80         }
81         catch (e) {
82             /* Plug in the generic shared memory transport */
83             MessageQ.SetupTransportProxy =
84                 xdc.useModule('ti.sdo.ipc.transports.TransportShmSetup');
85         }
86     }
87 }
89 /*
90  *  ======== module$static$init ========
91  *  Initialize module values.
92  */
93 function module$static$init(state, mod)
94 {
95     /* initialize the NameServer param to be used now or later */
96     MessageQ.nameSrvPrms.maxRuntimeEntries = mod.maxRuntimeEntries;
97     MessageQ.nameSrvPrms.tableSection      = mod.tableSection;
98     MessageQ.nameSrvPrms.maxNameLen        = mod.maxNameLen;
100     /*
101      *  Get the current number of created static instances of this module.
102      *  Note: if user creates a static instance after this point and
103      *        expects to use NameServer, this is a problem.
104      */
105      var instCount = this.$instances.length;
107     /* create NameServer here only if no static instances are created */
108     if (instCount == 0) {
109         state.nameServer = NameServer.create("MessageQ", MessageQ.nameSrvPrms);
110     }
111     else {
112         state.nameServer = null;
113     }
115     /*
116      *  If no growth allowed, pre-allocate the max length
117      *  Also pre-allocate if numReservedEntries is not zero.
118      *  maxRuntimeEntries < numReservedEntries is caught in validate.
119      */
120     state.numQueues = this.$instances.length;
121     if (mod.maxRuntimeEntries != NameServer.ALLOWGROWTH) {
122         state.numQueues += mod.maxRuntimeEntries;
123     }
124     else if (mod.numReservedEntries != 0){
125         state.numQueues += mod.numReservedEntries;
126     }
128     state.queues.length = state.numQueues;
129     state.canFreeQueues = false;
130     state.freeHookFxn   = mod.freeHookFxn;
132     if (mod.nameTableGate == null) {
133          state.gate = null;
134     }
135     else {
136         state.gate = mod.nameTableGate;
137     }
139     var messsageQParams = new this.Params;
141     /* Initial the seqNum used for tracing */
142     state.seqNum = 0;
144     /* Set the length of the heaps array */
145     state.numHeaps = mod.numHeaps;
146     state.heaps.length = state.numHeaps;
148     /* Initialize the heaps array to null */
149     for (var i = 0; i < state.heaps.length; i++) {
150         state.heaps[i] = null;
151     }
153     /*
154      *  Sort the static heaps by heap id into the heaps array
155      */
156     for (var i = 0; i < mod.staticHeaps.length; i++) {
158         /* Make sure the id is not too big */
159         if (mod.staticHeaps[i].heapId >= state.numHeaps) {
160             MessageQ.$logError("Out of range heapId ("
161                     + mod.staticHeaps[i].heapId + "). Max heapId is "
162                     + (mod.numHeaps - 1) + " (MessageQ.numHeaps - 1).", this);
163         }
165         /* Make sure the same id is not used twice */
166         if (state.heaps[mod.staticHeaps[i].heapId] != null) {
167             MessageQ.$logError("Cannot register multiple heaps to heapId "
168                     + mod.staticHeaps[i].heapId + ".", this);
169         }
171         state.heaps[mod.staticHeaps[i].heapId] = mod.staticHeaps[i].heap;
172     }
174     /* Set the length of the transport array */
175     state.transports.length = MultiProc.numProcessors;
177     /* Initialize all the transports to null */
178     for (var i = 0; i < state.transports.length; i++) {
179         state.transports[i][0] = null;
180         state.transports[i][1] = null;
181     }
183     /*
184      *  Sort the static Transports by processor id into the
185      *  transport array
186      */
187     for (var i = 0; i < mod.staticTransports.length; i++) {
189         /* Make sure the procId is not too big */
190         if (mod.staticTransports[i].procId >= MultiProc.numProcessors) {
191             MessageQ.$logError("MessageQ Out of range procId ("
192                     + mod.staticTransports[i].procId + "). Max procId is "
193                     + (MultiProc.numProcessors) + " (MultiProc.numProcessors).",
194                     this);
195         }
197         /* Make sure the same id is not used twice */
198         if (state.transports[mod.staticTransports[i].procId] != null) {
199             MessageQ.$logError("Cannot register multiple transports to one"
200                     + " remote processor " + mod.staticTransports[i].procId
201                     + ".", this);
202         }
204         state.transports[mod.staticTransports[i].procId] =
205             mod.staticTransports[i].transport;
206     }
208     /* initialize the registered transport array */
209     for (var i = 0; i < state.regTrans.length; i++) {
210         state.regTrans[i].transport = null;
211         state.regTrans[i].type = mod.TransportType_Invalid;
212     }
215 /*
216  *  ======== registerHeapMeta ========
217  */
218 function registerHeapMeta(heap, heapId)
220     var entry = new this.HeapEntry();
221     entry.heap = heap;
222     entry.heapId = heapId;
223     this.staticHeaps.$add(entry);
226 /*
227  *  ======== registerTransportMeta ========
228  */
229 function registerTransportMeta(transport, procId, priority)
231     var entry = new this.transportEntry();
232     entry.transport = transport;
233     entry.procId    = procId;
234     this.staticTransports.$add(entry);
237 /*
238  *  ======== viewInitQueues ========
239  */
240 function viewInitQueues(view, obj)
242     var Program         = xdc.useModule('xdc.rov.Program');
243     var NameServer      = xdc.useModule('ti.sdo.utils.NameServer');
244     var SharedRegion    = xdc.useModule('ti.sdo.ipc.SharedRegion');
246     /* view.name */
247     try {
248         view.name = NameServer.getName$view("MessageQ", obj.queue);
249     }
250     catch(e) {
251         Program.displayError(view, "name",
252             "Error retrieving name from NameServer: " + e);
253     }
255     /* view.queueId */
256     view.queueId = obj.queue & 0xffff;
260 /*
261  *  ======== viewInitMessages ========
262  */
263 function viewInitMessages(view, obj)
265     var Program = xdc.useModule('xdc.rov.Program');
266     var MessageQ = xdc.useModule('ti.sdo.ipc.MessageQ');
267     var NameServer = xdc.useModule('ti.sdo.utils.NameServer');
269     print("viewInitMessages called");
271     /* view.label */
272     try {
273         view.label = NameServer.getName$view("MessageQ", obj.queue);
274     }
275     catch(e) {
276         Program.displayError(view, "label",
277             "Error retrieving name from NameServer: " + e);
278         return;
279     }
281     /* Retrieve the ROV view for the embedded high priority message list. */
282     addMsgsFromList(view, obj.highList);
284     /* Retrieve the ROV view for the embedded normal priority message list. */
285     addMsgsFromList(view, obj.normalList);
288 /*
289  *  ======== addMsgsFromList ========
290  *  Scans the provided list object and adds the messages on it to the view.
291  */
292 function addMsgsFromList(view, list)
294     var Program = xdc.useModule('xdc.rov.Program');
296     print("Calling addMsgsFromList");
298     /* Scan the list to retrieve the addresses of the messages. */
299     try {
300         var listView = Program.scanObjectView("ti.sdo.utils.List", list,
301             "Basic");
302     }
303     /* If there was a problem scanning the list, report it. */
304     catch (e) {
305         var msgView = Program.newViewStruct('ti.sdo.ipc.MessageQ', 'Messages');
306         /*
307          * If there was a problem, report it using the first field, and
308          * return.
309          */
310         Program.displayError(msgView, 'seqNum', String(e));
311         view.elements.$add(msgView);
312         return;
313     }
315     try {
316         /* Fetch each of the message headers on the list. */
317         for each (var addr in listView.elems) {
318             print("Trying to call getMsgView for 0x" + Number(addr).toString(16));
319             var msgView = getMsgView(Number(addr));
321             view.elements.$add(msgView);
322         }
323     }
324     catch (e) {
325         /*
326          * If there were any problems retrieving the view, add an element
327          * to report the error.
328          */
329         var msgView = Program.newViewStruct('ti.sdo.ipc.MessageQ', 'Messages');
330         Program.displayError(msgView, 'seqNum', String(e));
331         view.elements.$add(msgView);
332     }
335 /*
336  *  ======== getMsgView ========
337  *  Returns a view structure representing the message at the given address.
338  */
339 function getMsgView(addr)
341     var Program = xdc.useModule('xdc.rov.Program');
342     var MessageQ = xdc.useModule('ti.sdo.ipc.MessageQ');
344     print("getting message view: 0x" + Number(addr).toString(16));
346     /* Create a new message view to populate. */
347     var msgView = Program.newViewStruct('ti.sdo.ipc.MessageQ', 'Messages');
349     /* Fetch the message header from the given address. */
350     try {
351         var msgHeader = Program.fetchStruct(MessageQ.MsgHeader$fetchDesc,
352                                             Number(addr));
353     }
354     catch (e) {
355         /*
356          * If there was a problem, report it using the first field, and
357          * return the view.
358          */
359         Program.displayError(msgView, 'seqNum', String(e));
360         return (msgView);
361     }
363     /* Display the messages sequence number and size. */
364     msgView.seqNum = msgHeader.seqNum;
365     msgView.msgSize = msgHeader.msgSize;
367     /* The flags field contains the message priority. */
368     var priority = msgHeader.flags & MessageQ.PRIORITYMASK;
369     getPriority(msgView, priority);
371     /* The flags field also contains the trace enabled bit. */
372     msgView.traceEnabled = msgHeader.flags & MessageQ.TRACEMASK;
374     /* The flags field also contains the version bits. */
375     msgView.version = (msgHeader.flags & MessageQ.VERSIONMASK) >> 13;
377     /* Display the message ID set by the user. */
378     msgView.msgId = msgHeader.msgId;
380     /*
381      * Scan in the MultiProc view so we have the mapping from processor id
382      * to processor name.
383      */
384     try {
385         var multiProcView = Program.scanModuleView('ti.sdo.utils.MultiProc',
386                                                    'Module');
387     }
388     catch (e) {
389         /*
390          * If there was a problem scanning the MultiProc view, display the
391          * error, but keep processing anyway.
392          */
393         Program.displayError(msgView, 'srcProc', String(e));
394     }
396     /* Lookup the names of the destination, reply, and source processors. */
397     msgView.srcProc = multiProcView.nameList[msgHeader.srcProc];
399     /* If a reply queue hasn't been specified, display "N/A" */
400     if (msgHeader.replyId == 0xFFFF) {
401         msgView.replyProc = "N/A";
402         msgView.replyId = "N/A";
403     }
404     /* Otherwise display the reply queue. */
405     else {
406         msgView.replyProc = multiProcView.nameList[msgHeader.replyProc];
407         // TODO - Should this display the name of the MessageQ?
408         msgView.replyId = String(msgHeader.replyId);
409     }
411     /* Display the heap that the message was allocated from. */
412     msgView.heap = getHeapNameFromId(msgHeader.heapId);
414     return (msgView);
417 /*
418  *  ======== getPriority ========
419  *  Fills in the message views 'priority' field given the priority value.
420  */
421 function getPriority(msgView, priority)
423     var MessageQ = xdc.useModule('ti.sdo.ipc.MessageQ');
424     var Program = xdc.useModule('xdc.rov.Program');
426     switch (priority) {
427         case MessageQ.NORMALPRI:
428             msgView.priority = "(" + MessageQ.NORMALPRI + ") Normal";
429             break;
430         case MessageQ.HIGHPRI:
431             msgView.priority = "(" + MessageQ.HIGHPRI + ") High";
432             break;
433         case MessageQ.RESERVEDPRI:
434             msgView.priority = "(" + MessageQ.RESERVEDPRI + ") Reserved";
435             break;
436         case MessageQ.URGENTPRI:
437             msgView.priority = "(" + MessageQ.URGENTPRI + ") Urgent";
438             break;
439         default:
440             Program.displayError(msgView, 'priority',
441                                  'Message has invalid priority: ' + priority);
442     }
445 /*
446  *  ======== getHeapNameFromId ========
447  *  This function takes the heap Id from a message (the heap ids are assigned
448  *  by MessageQ) and retrieves a name for the heap.
449  */
450 function getHeapNameFromId(heapId)
452     var Program = xdc.useModule('xdc.rov.Program');
454     /* The module state contains the list of heaps. */
455     var modView = Program.scanModuleView('ti.sdo.ipc.MessageQ', 'Module');
457     /* Get the string representation of the address. */
458     if ((heapId == -1) || (heapId == 65535)) {
459         var heapAddr = "[static]";
460     }
461     else {
462         var heapAddr = String(modView.heaps[heapId]);
463     }
465     return (heapId + " (" + heapAddr + ")");
468 /*
469  *  ======== viewInitModule ========
470  */
471 function viewInitModule(view, mod)
473     var Program = xdc.useModule('xdc.rov.Program');
475     /* Scan in the array of heaps. */
476     try {
477         view.heaps = Program.fetchArray(mod.heaps$fetchDesc, mod.heaps,
478                                           mod.numHeaps);
479     }
480     catch (e) {
481         Program.displayError(view, 'heaps', "Problem retrieving array of " +
482                              "heaps: " + e);
483     }
485     /* Display the handle to the module's gate. */
486     view.gate = mod.gate;
488     /*
489      * Display the module's sequence number, which is the next value
490      * that will be used.
491      */
492     view.nextSeqNum = mod.seqNum;
494     /* Display the freeHookFxn if there is one. */
495     if (Number(mod.freeHookFxn) != 0 ) {
496         view.freeHookFxn = Program.lookupFuncName(Number(mod.freeHookFxn));
497     }
500 function module$validate()
502     if ((MessageQ.maxRuntimeEntries != NameServer.ALLOWGROWTH) &&
503         (MessageQ.maxRuntimeEntries < MessageQ.numReservedEntries)) {
504         MessageQ.$logFatal(
505             "If MessageQ.maxRuntimeEntries is not NameServer.ALLOWGROWTH, " +
506             "it cannot be less than MessageQ.numReservedEntries.",
507             MessageQ);
508     }