summaryrefslogtreecommitdiff
path: root/apps/builtin/exec_builtin.c
blob: dc363023009e33e4f006b33a65e1dd4b3dcebc54 (plain) (blame)
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
/****************************************************************************
 * apps/builtin/exec_builtin.c
 *
 *   Copyright (C) 2011 Uros Platise. All rights reserved.
 *   Author: Uros Platise <uros.platise@isotel.eu>
 *
 * With updates, modifications, and general maintenance by:
 *
 *   Copyright (C) 2012 Gregory Nutt.  All rights reserved.
 *   Auther: Gregory Nutt <gnutt@nuttx.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>
#include <apps/apps.h>
#include <sched.h>

#include <string.h>
#include <errno.h>

#include "builtin.h"

/****************************************************************************
 * Private Types
 ****************************************************************************/

/****************************************************************************
 * Private Function Prototypes
 ****************************************************************************/

/****************************************************************************
 * Private Data
 ****************************************************************************/

/****************************************************************************
 * Private Functions
 ****************************************************************************/

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: builtin_getname
 *
 * Description:
 *   Return the name of the application at index in the table of builtin
 *   applications.
 *
 ****************************************************************************/

const char *builtin_getname(int index)
{
  if (index < 0 || index >= number_builtins())
   {
     return NULL;
   }
    
  return builtins[index].name;
}
 
/****************************************************************************
 * Name: builtin_isavail
 *
 * Description:
 *   Return the index into the table of applications for the applicaiton with
 *   the name 'appname'.
 *
 ****************************************************************************/

int builtin_isavail(FAR const char *appname)
{
  int i;
    
  for (i = 0; builtins[i].name; i++) 
    {
      if (!strcmp(builtins[i].name, appname))
        {
          return i;
        }
    }

  set_errno(ENOENT);
  return ERROR;
}
 
/****************************************************************************
 * Name: builtin_isavail
 *
 * Description:
 *   Execute the application with name 'appname', providing the arguments
 *   in the argv[] array.
 *
 * Returned Value:
 *   On success, the task ID of the builtin application is returned.  On
 *   failure, -1 (ERROR) is returned an the errno value is set appropriately.
 *
 ****************************************************************************/

int exec_builtin(FAR const char *appname, FAR const char **argv)
{
  pid_t pid;
  int index;

  /* Verify that an application with this name exists */

  index = builtin_isavail(appname);
  if (index >= 0)
    {
      /* Disable pre-emption.  This means that although we start the builtin
       * application here, it will not actually run until pre-emption is
       * re-enabled below.
       */

      sched_lock();

      /* Start the builtin application task */

      pid = TASK_CREATE(builtins[index].name, builtins[index].priority, 
                        builtins[index].stacksize, builtins[index].main, 
                        (argv) ? &argv[1] : (const char **)NULL);

      /* If robin robin scheduling is enabled, then set the scheduling policy
       * of the new task to SCHED_RR before it has a chance to run.
       */

#if CONFIG_RR_INTERVAL > 0
      if (pid > 0)
        {
          struct sched_param param;

          /* Pre-emption is disabled so the task creation and the
           * following operation will be atomic.  The priority of the
           * new task cannot yet have changed from its initial value.
           */

          param.sched_priority = builtins[index].priority;
          sched_setscheduler(pid, SCHED_RR, &param);
        }
#endif
      /* Now let the builtin application run */

      sched_unlock();

      /* Return the task ID of the new task if the task was sucessfully
       * started.  Otherwise, pid will be ERROR (and the errno value will
       * be set appropriately).
       */

      return pid;
    }

  /* Return ERROR with errno set appropriately */

  return ERROR;
}