summaryrefslogtreecommitdiff
path: root/nuttx/sched/sched_setparam.c
blob: a1e5af97f002c8e9cb40dbadd51c4dbae99a6125 (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
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
/************************************************************
 * sched_setparam.c
 *
 *   Copyright (C) 2007 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
 *
 * 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 Gregory Nutt 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 <sys/types.h>
#include <sched.h>
#include <nuttx/arch.h>
#include <nuttx/os_external.h>
#include "os_internal.h"

/************************************************************
 * Definitions
 ************************************************************/

/************************************************************
 * Private Type Declarations
 ************************************************************/

/************************************************************
 * Global Variables
 ************************************************************/

/************************************************************
 * Private Variables
 ************************************************************/

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

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

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

/************************************************************
 * Name:  sched_setparam
 *
 * Description:
 *   This function sets the priority of a specified task.
 *
 *   NOTE: Setting a task's priority to the same value has the
 *   similar effect to sched_yield() -- The task will be moved to
 *   after all other tasks with the same priority.
 *
 * Inputs:
 *   pid - the task ID of the task to reprioritize.  If pid is
 *     zero, the priority of the calling task is changed.
 *   param - A structure whose member sched_priority is the integer
 *      priority.  The range of valid priority numbers is from
 *      SCHED_PRIORITY_MIN through SCHED_PRIORITY_MAX.
 *
 * Return Value:
 *    OK if successful, otherwise ERROR.  This function can
 *    fail for the following reasons:
 *
 *    (1) parm is NULL or parm->sched_priority is out of
 *        range.
 *    (2) pid does not correspond to any task.
 *
 *    (errno is not set).
 *
 * Assumptions:
 *
 ************************************************************/

int sched_setparam(pid_t pid, const struct sched_param *param)
{
  _TCB      *rtcb;
  _TCB      *tcb;
  tstate_t   task_state;
  irqstate_t saved_state;
  int        sched_priority = param->sched_priority;
  int        ret = 0;

  /* Verify that the requested priority is in the valid range */

  if (!param ||
      param->sched_priority < SCHED_PRIORITY_MIN || 
      param->sched_priority > SCHED_PRIORITY_MAX)
    {
      return ERROR;
    }

  /* Prohibit modifications to the head of the ready-to-run task
   * list while adjusting the priority
   */

  sched_lock();

  /* Check if the task to reprioritize is the calling task */

  rtcb = (_TCB*)g_readytorun.head;
  if (pid == 0 || pid == rtcb->pid)
    {
      tcb = rtcb;
    }

  /* The pid is not the calling task, we will have to search for it */

  else
    {
      tcb = sched_gettcb(pid);
      if (!tcb)
        {
          /* No task with this pid was found */

          sched_unlock();
          return ERROR;
        }
    }

  /* We need to assure that there there is no interrupt activity while
   * performing the following.
   */

  saved_state = irqsave();

  /* There are four cases that must be considered: */

  task_state = tcb->task_state;
  switch (task_state)
    {
       /* CASE 1. The task is running or ready-to-run and a context switch
        * may be caused by the re-prioritization 
        */

       case TSTATE_TASK_RUNNING:

         /* A context switch will occur if the new priority of the running
          * task becomes less than OR EQUAL TO the next highest priority
          * ready to run task.
          */

         if (sched_priority <= tcb->flink->sched_priority)
           {
             /* A context switch will occur. */

             up_reprioritize_rtr(tcb, (ubyte)sched_priority);
           }

         /* Otherwise, we can just change priority since it has no effect */

         else
           {
             /* Change the task priority */

             tcb->sched_priority = (ubyte)sched_priority;
           }
         break;

       /* CASE 2. The task is running or ready-to-run and a context switch
        * may be caused by the re-prioritization
        */

       case TSTATE_TASK_READYTORUN:

         /* A context switch will occur if the new priority of the ready-to
          * run task is (strictly) greater than the current running task 
          */

         if (sched_priority > rtcb->sched_priority)
           {
             /* A context switch will occur. */

             up_reprioritize_rtr(tcb, (ubyte)sched_priority);
           }

         /* Otherwise, we can just change priority and re-schedule (since it
          * have no other effect).
          */

         else
           {
             /* Remove the TCB from the ready-to-run task list */

             ASSERT(!sched_removereadytorun(tcb));

             /* Change the task priority */

             tcb->sched_priority = (ubyte)sched_priority;

             /* Put it back into the ready-to-run task list */

             ASSERT(!sched_addreadytorun(tcb));
           }
         break;

       /* CASE 3. The task is not in the ready to run list.  Changing its
        * Priority cannot effect the currently executing task.
        */

     default:
        /* CASE 3a. The task resides in a prioritized list. */

        if (g_tasklisttable[task_state].prioritized)
          {
            /* Remove the TCB from the prioritized task list */

            dq_rem((dq_entry_t*)tcb, g_tasklisttable[task_state].list);

            /* Change the task priority */

            tcb->sched_priority = (ubyte)sched_priority;

            /* Put it back into the prioritized list at the correct
             * position
             */

            sched_addprioritized(tcb, g_tasklisttable[task_state].list);
          }

        /* CASE 3b. The task resides in a non-prioritized list. */

        else
          {
            /* Just change the task's priority */

            tcb->sched_priority = (ubyte)sched_priority;
          }
        break;
    }

  irqrestore(saved_state);
  sched_unlock();
  return ret;
}