Hooks útiles de FreeRTOS y un watchdog por software

Mucho, si no es que casi todo el trabajo que hacemos, lo llevamos a cabo dentro de tareas e interrupciones, en lo que le llamaríamos la capa de usuario. Sin embargo, FreeRTOS nos ofrece la posiblidad de hacer cosas simples como si nuestro código fuese parte de él, ejecutándose en la capa del sistema operativo.

Imagina que debes implementar un LED que parpadée a intervalos regulares para indicarte que el sistema está “vivo” (a esta actividad le llamamos heartbeat, o en español, latido del corazón). Si el LED no parpadea, o dejó de hacerlo después de un tiempo, significa que algo malo pasó dentro del sistema. Para implementarlo puedes hacerlo de dos formas con lo que conocemos hasta el momento:

  1. Una tarea dedicada al heartbeat, o
  2. Un software timer con una callback que lleve a cabo el latido del corazón.

Ambas soluciones tienen el problema del alto consumo de recursos para una tarea tan simple. ¿Qué podríamos hacer? Qué tal que le decimos al sistema operativo que él mismo mande llamar a nuestra función heartbeat. ¡Excelente!

FreeRTOS nos provee dos maneras de hacerlo:

  • Que FreeRTOS llame a nuestra función heartbeat() cada vez que el sistema esté desocupado, o
  • Que FreeRTOS llame a nuestra función heartbeat() en cada tick del sistema.

Cuál escoger depende totalmente de la aplicación que estés escribiendo, y por supuesto que puedes implementar muchas cosas diferentes a un heartbeat.

Con este par de mecanismos no tendrás que crear tareas extra o usar a los software timers para algo tan sencillo. Eso sí, el código de heartbeat(), o cualquier otro que inyectes a FreeRTOS, tiene que ser simple y no debería llamar a ninguna función bloqueante.

Una aplicación muy útil que podemos inyectar al sistema para que se ejecute cada vez que el sistema está desocupado es la de un watchdog por software. Un watchdog se encarga de supervisar al sistema; si una tarea crítica deja de responder, entonces el sistema completo es reiniciado.

En la lección de hoy vamos a recordar qué son las callbacks, cómo usarlas en cada tick del sistema o cada vez que éste tenga tiempo libre, y cómo implementar un watchdog por software básico.

Tabla de contenidos

¿Qué es y qué necesito?

Callbacks

Una función callback es una función tuya que se la pasas a una función de un sistema independiente (o aparte del tuyo) como parte de una lista de argumentos. Esta función del sistema entonces ejecuta tu función:

int fn( int v );
void funcion_del_sistema( int a, int (*pf)(int) )
{
	pf( a );
}


int callback( int v )
{
	return v+1;
}

int main()
{
	funcion_del_sistema( 5, callback );
}

La función funcion_del_sistema() no es tuya, es parte de un sistema más grande, por ejemplo, FreeRTOS o un administrador de ventanas en un sistema gráfico. Pero tú le pasas código tuyo inyectándole la función callback() la cual sí es tuya (le puse ese nombre para que la identificaras). La función funcion_del_sistema() la recibe como parte de sus argumentos y le da el nombre de pf(). Cuando funcion_del_sistema() se encuentra pf( a ) manda llamar a callback( 5 ). Esta es una forma de extender la funcionalidad de un sistema sin modificar su código fuente.

Para que las callbacks funcionen sus firmas deben de corresponder. Por ejemplo, la función funcion_del_sistema() puede recibir cualquier función que devuelva un entero y reciba un sólo argumento y éste sea entero, y sería un error de compilación si le quieres pasar una función que devuelve un float o que recibe dos argumentos, etc.

Hooks

Una función hook (en español, ancla) sirve para lo mismo que una callback, extender la funcionalidad del sistema, pero se implementa diferente. Una función del sistema espera que exista una cierta función y la manda llamar; esto es, no se inyecta:

int hook( int );
void funcion_del_sistema( int a )
{
	hook( a );
}


int hook( int v )
{
	return v+1;
}

int main()
{
	funcion_del_sistema( 5 );
}

Para que este mecanismo funcione debes nombrar a la hook exactamente como el sistema lo espera, y además debe estar visible a la hora de compilar. Del código anterior podrás ver que la función del sistema otra_fun ya no tiene el parámetro para recibir una función, y que dentro manda llamar a una función con un nombre particular, en este ejemplo, hook(). Por lo tanto tú debes escribir una función con la misma firma y el mismo nombre, y además, como mencioné, tu función deberá estar visible al compilador.

Lo que vamos a ver hoy requiere de funciones hook.

Idle task

La idle task (se pronuncia más o menos, [áidel task]) es una función que crea FreeRTOS de manera automática con la prioridad más baja (¿recuerdas la constante tskIDLE_PRIORITY que usamos en la creación de tareas?) y que se ejecuta únicamente cuando no hay tareas de mayor prioridad activas. Esto es, en FreeRTOS siempre habrá una tarea ejecutándose cuando todas las demás estén bloqueadas.

Un uso que FreeRTOS le da a esta tarea, que ya había mencionado en otra lección, es devolver la memoria indicada por una llamada a la función free() en algunos de los esquemas de memoria dinámica (heap_2.c, heap_4.c, y heap_5.c). De manera conveniente FreeRTOS abrió una puerta para que nosotros los programadores tengamos la posibilidad de ejecutar código cada vez que la idle task se ejecuta.

RECUERDA: Tu código debe ser simple y no debe bloquear a la idle task. Así mismo toma en cuenta que esta tarea podría no ejecutarse contínuamente, ya que si la carga de trabajo es alta, entonces ésta, y en consecuencia tu código, se estará ejecutando esporádicamente.

Idle hook

La idle task siempre está en estado Ready (y cuando hay tiempo en el sistema pasa al estado Running), ya sea que se ejecute o no periódicamente. Para que tú inyectes tu código debes realizar cuatro cosas:

1. En el archivo FreeRTOSConfig.h asegúrate que la constante configUSE_IDLE_HOOK está puesta a 1:

#define configUSE_IDLE_HOOK 1

2. (Opcional) La idle task es a final de cuentas una tarea, por lo cual requiere de una pila. El tamaño mínimo de ésta ya viene especificado, pero si tu código necesitase más memoria, entonces debes aumentar su tamaño. En el mismo archivo FreeRTOSConfig.h puedes modificar su valor:

#define configIDLE_STACK_SIZE ( ( UBaseType_t ) 192 )
#define configIDLE_TASK_NAME  "IDLE" // por si quisieras cambiarle el nombre

3. La hook de la idle task se llama vApplicationIdleHook(). Ésta la puedes colocar donde quieras; en el proyecto Molcajete decidí poner todas las hooks en un mismo lugar (aunque puede ser diferente, por supuesto). Abre el archivo hooks.cpp (revisa la lección anterior para más detalles) y ubica a la función:

#if configUSE_IDLE_HOOK == 1
void vApplicationIdleHook()
{

}
#endif

Puedes escribir el código que quieres inyectar a la idle task directamente en esta función, o puedes hacerlo modular (indirecto, por si después necesitas agregar más funcionalidades sin ensuciar al código fuente). Para el ejemplo que veremos más adelante, un heartbeat(), utilizaremos la forma indirecta, es más limpia y el compilador se encarga de la optimización. De esta forma nuestra función vApplicationIdleHook() nos queda como:

#if configUSE_IDLE_HOOK == 1
void vApplicationIdleHook( void )
{
   void heartbeat_idle_hook();
   heartbeat_idle_hook();
}
#endif

4. Cuando activas la inyección de código en la idle task FreeRTOS espera una función vApplicationIdleHook(), la cual acabamos de escribir, pero así como está en este momento no hace nada, falta la función heartbeat_idle_hook() (o como gustes llamarle). Ésta es una función nuestra y la escribiremos en nuestro sketch (o donde nosotros querramos si estamos compilando desde la consola). La implementación completa está más adelante en el ejemplo, pero por el momento veamos su esqueleto para platicar un par de cosas interesantes:

// en un sketch o archivo fuente nuestro:

#ifdef __cplusplus
extern "C"{
#endif
void heartbeat_idle_hook()
{
   taskENTER_CRITICAL();
   {
      // tu código aquí
   }
   taskEXIT_CRITICAL();
}
#ifdef __cplusplus
}
#endif

1. La constante __cplusplus le dice al compilador que las funciones marcadas dentro de extern "C"{ ... } deben ser tratadas como funciones de C, no de C++ (recuerda que los sketches se compilan con C++). El compilador de C++ le cambia el nombre a las funciones para poder implementar cosas muy padres, como la sobrecarga de funciones, pero C no tiene idea de eso. Si la función heartbeat_idle_hook() no estuviera dentro de la sección extern "C"{ ... }, entonces su nombre podría ser algo tan raro como __vjgd74_heartbeat_idle_hook(). C++ sabe de este nombre porque él se lo puso, pero cuando mezclas C++ y C, éste último espera (de hecho es FreeRTOS quien espera) a la función heartbeat_idle_hook(), y aunque pareciera que sí existe, para el compilador de C no es así.

2. Tu código debe estar encerrado en una sección crítica (aplica sólo para micros de 8 bits):

taskENTER_CRITICAL();
{
   // tu código aquí
}
taskEXIT_CRITICAL();

Normalmente esto no es necesario (por “normalmente” hay que entender microcontroladores de 16 o 32 bits), pero de no hacerlo así el programa compilará pero no funcionará correctamente (le pasó al primo de un amigo y casi se vuelve loco). El problema es que en el código del heartbeat() que está más adelante utilizaremos aritmética de 16 bits, pero el ATmega328 es de 8 bits, y la atomicidad de las operaciones no está garantizada en un ambiente multitarea. El problema que tuve es el siguiente: cuando hacía restas (substracciones) sin región crítica obtuve resultados erróneos e inverosímiles, tales como: 1-0=65535 ó 0-0=65535. En un micro de 8 bits las operaciones y asignaciones de 16 y 32 bits ocupan varias instrucciones que deben ser ejecutadas de manera atómica (sin interrupciones), así que para asegurar dicha atomicidad encerré todo el código que involucra aritmética de 16 bits (el tipo TickType_t es de 16 bits) dentro de una región crítica.

RECUERDA: Las regiones críticas se deben ejecutar lo más rápido posible porque has desactivado a las interrupciones.

Tick del sistema

FreeRTOS utiliza un timer del microcontrolador para realizar cambios de contexto (cambiar entre tareas) periódicos. Los detalles de cuál timer y cuál configuración no son importantes en este momento; lo que sí es digno de anotarse es la frecuencia:

// en el archivo FreeRTOSConfig.h:
#define configTICK_RATE_HZ ( ( portTickType ) 1000 )

Esto significa que el planificador de tareas de FreeRTOS es llamado 1000 veces por segundo (la frecuencia), o lo que es lo mismo, una vez cada 1ms (el periodo). Aunque hemos estado utilizando este valor a lo largo del curso, no siempre tiene porqué ser tan rápido; quizás alguna aplicación requiera algo más lento, como 100 ó 10 veces por segundo.

Lo que verdaderamente nos interesa en este instante es que, así como le hicimos con la idle task, también podemos inyectar código en la función de FreeRTOS que es ejecutada en cada tick (con estos valores, cada 1ms).

RECUERDA: Tu código debe ser simple y no debe bloquear al tick. El tick NO es una tarea, es una función del sistema operativo que es llamada cada vez que el tiempo del timer correspondiente expiró, y desde el punto de vista del nivel sistema operativo utiliza la pila verdadera del chip.

Tick hook

Para que inyectes tu código debes realizar tres cosas (aplica la misma teoría de la idle hook, por lo cual no la repetiré a menos que se presenta alguna particularidad):

1. En el archivo FreeRTOSConfig.h asegúrate que la constante configUSE_TICK_HOOK está puesta a 1:

#define configUSE_TICK_HOOK 1

2. La hook del tick hook se llama vApplicationTickHook(). Ésta la puedes colocar donde quieras; en el proyecto Molcajete decidí poner todas las hooks en un mismo lugar (aunque puede ser diferente, por supuesto). Abre el archivo hooks.cpp (revisa la lección anterior para más detalles) y ubica a la función:

#if configUSE_TICK_HOOK == 1
void vApplicationTickHook( void )
{

}
#endif

Puedes escribir el código que quieres inyectar al tick directamente en esta función, o puedes hacerlo modular (indirecto, por si después necesitas agregar más funcionalidades sin ensuciar al código fuente). Para el ejemplo que veremos más adelante, un heartbeat(), utilizaremos la forma indirecta, es más limpia y el compilador se encarga de la optimización. De esta forma nuestra función vApplicationTickHook() nos queda como:

#if configUSE_TICK_HOOK == 1
void vApplicationTickHook( void )
{
   void heartbeat_tick_hook();
   heartbeat_tick_hook();
}
#endif

3. Cuando activas la inyección de código en el tick hook, FreeRTOS espera una función vApplicationTickHook(), la cual acabamos de escribir, pero así como está en este momento no hace nada, falta la función heartbeat_tick_hook() (o como gustes llamarle). Ésta es una función nuestra y la escribiremos en nuestro sketch (o donde nosotros querramos si estamos compilando desde la consola). La implementación completa está más adelante en el ejemplo, pero por el momento veamos su esqueleto:

// en un sketch o archivo fuente nuestro:

#ifdef __cplusplus
extern "C"{
#endif
void heartbeat_tick_hook()
{
   taskENTER_CRITICAL();
   {
      // tu código aquí
   }
   taskEXIT_CRITICAL();
}
#ifdef __cplusplus
}
#endif

Watchdog

En los sistemas embebidos un watchdog (“supervisor” en español) es un contador hacia abajo independiente, que cuando llega a cero envía una señal de reset al procesador. Para evitarlo el programa debe estar constantemente alimentándolo (o como la mayoría de textos dice, “pateándolo“, del inglés “kicking the dog“). “Alimentar” significa escribir en unos registros especiales unos valores especiales, y también viene del inglés, feed the dog, otra expresón común con los supervisores. Mientras el programa se ejecuta correctamente, el supervisor es alimentado antes de que la cuenta llegue a cero; pero si el programa se pierde, y puede perderse por muchas razones, entonces ya no lo alimentará dejando que la cuenta llegue a cero, y por lo tanto, reiniciará al sistema.

Aunque cada procesador implementa sus propias formas de inicializar y alimentar al supervisor (sin olvidar que existen supervisores externos), el centro de la discusión no es saber cuándo alimentarlo (obviamente antes de que la cuenta llegue a cero), sino bajo cuáles condiciones debe ser alimentado.

Es decir, no se trata nada más de alimentarlo por alimentarlo, sino hacerlo cuando estemos seguros de que el sistema funciona correctamente. Si detectamos una anomalía, entonces no lo alimentamos, ponemos al sistema en modo seguro, y dejamos que el supervisor reinicie al sistema. Estos pasos son fundamentales en sistemas multitarea, como los que estamos desarrollando: si una tarea crítica falla, de las múltiples que podemos llegar a tener, entonces el sistema debe ser reiniciado.

¿Qué tiene que ver un supervisor con las hooks de FreeRTOS? Te lo responderé de la siguiente manera:

Jamás alimentes al supervisor desde una tarea/interrupción periódica.

Los gurús de los sistemas embebidos

Lo más fácil es alimentar al supervisor desde una interrupción periódica. El problema es que si el programa falla, lo más seguro es que la interrupción continúe, por lo tanto, el sistema no se reiniciará (este tipo de cosas también le han pasado al primo de un amigo).

Nosotros vamos a usar el hook de la idle task para implementar a nuestro supervisor por software. Esta tarea no es ni de cerca periódica, lo cual la convierte en una candidata excelente para esta actividad (y aunque podríamos escribir una tarea de baja prioridad para nuestro supervisor, ya tenemos a la hook, ¡aprovechémosla!). En términos generales, si otorgamos a las tareas críticas una prioridad alta, y alguna de éstas se cuelga, entonces la idle task no se ejecutará, y por lo tanto, tampoco nuestro supervisor por software, y como la alimentación del supervisor por hardware es responsabilidad de ésta, entonces no lo alimentará y el sistema se reiniciará.

¿Porqué no usar la tick hook? Por lo que acabo de mencionar. Al final de cuentas la tick hook no solamente es periódica, sino que funciona por fuera del ámbito de nuestras tareas de usuario, por lo cual, si una tarea se cuelga, el tick siempre seguirá funcionando, dando al traste con la idea principal de los supervisores.

Deadline

Los sistemas embebidos de tiempo real deben realizar su trabajo a tiempo, antes de que sea demasiado tarde: el sistema de frenos de un auto debe activar las bolsas de aire antes de un cierto tiempo (tiempo contabilizado después de haber recibido la señal de impacto), ya que de no hacerlo, el conductor podrá sufrir graves daños. Al tiempo entre que la señal se genera y el sistema responde le llamamos el deadline (o tiempo límite). Existen hard deadlines, como el ejemplo de las bolsas de aire, y también existen soft deadlines, donde pasarse un poco no tiene consecuencias fatales.

Te comento esto porque el ejemplo que veremos no sólo verifica que las tareas no se cuelguen, sino que además reiniciará al sistema si uno o más deadlines no se cumplen.

Implementación del supervisor por software

Hay muchas formas de implementar al supervisor por software (en inglés, “software watchdog“), y la que te mostraré en los ejemplos es una adaptación de una que encontré en:

[LEWIS02] D.W. Lewis. Fundamentals of embedded software. Prentice Hall, USA: 2002.

La idea es la siguiente: tendrás una lista de tareas críticas (no todas las tareas son o deberían ser críticas). Cada tarea tendrá 3 atributos: busy: Bool; failed: Bool; deadline: UINT; last: UINT. busy indica si la tarea está ocupada o no; failed significa si la tarea perdió el deadline (se pasó) o no; deadline guarda el tiempo máximo en el que la tarea debe responder; last indica el tiempo en el que tarea inició su proceso. Al inicio las banderas se ponen a false y estableces el deadline. Cuando un evento se presenta y dispara la ejecución de una tarea, busy se pone a true y guardar la marca de tiempo en last. Cuando la tarea finaliza la bandera failed se pone a true si el deadline se perdió (la tarea se tardó más), e incondicionalmente pone busy a false. El siguiente pseudocódigo muestra la forma general de este método:

// Tarea productora del evento
last[ TASK ] = current_time()
busy[ TASK ] = True
SemaphoreGive(...)


// Tarea consumidora del evento
while( True )
{
	SemaphoreTake(...)

	/* hace lo que tiene que hacer ... */

	if current_time() - last[ TASK ]  > deadline[ TASK ] {
		failed[ TASK ] = True
	}

	busy = False
}

// Software watchdog
Idle_hook()
{
	now = current_time()

	for i = 0; i < MAX_TASKS; ++i {

		if  failed[ i ] == True { break }
		// la tarea perdió su deadline
		
		if busy[ i ] == True && now - last[ i ] > dealine[ i ] { break }
		// ¡ la tarea se perdió por completo !
	}

	if i == MAX_TASKS { feed_the_dog() }
	else { clean_and_reset() }
}

Implementación del watchdog por hardware

El micro ATmega328 incluye un watchdog, pero no lo vamos a usar; en su lugar utilizaremos uno externo. Pero si no tienes uno o no quieres construir uno, entonces puedes usar el interno (aquí está una explicación superficial (en inglés) de cómo usar a este watchdog interno). Ahora que si quieres construir uno, aquí (en mi blog alternativo) podrás encontrar información sobre cómo construir uno con el chip 555. De hecho, la explicación la tuve que sacar de aquí porque la lección se estaba haciendo demasiado larga. Ya sea que visites mi otro blog, o no, aquí te dejo el diagrama del watchdog basado en el 555:

Ejemplos

Ejemplo 1: Heartbeat en la idle hook con tiempo simétrico

Este primer ejemplo, y el más sencillo, muestra cómo implementar un heartbeat() utilizando la hook de la idle task. Como no debemos usar funciones bloqueantes en las hooks (vTaskDelay(), por ejemplo), estaremos calculando diferencias de tiempos.

El tiempo es simétrico porque es el mismo tanto para el LED encendido como apagado. La función xTaskGetTickCount() devuelve el número de ticks transcurridos desde el último reinicio del programa. Nota que el único lugar donde utilizamos la macro de conversión pdMS_TO_TICKS() fue en la constante que establece el intervalo de tiempo; fuera de eso, el resto del código trabaja en término de ticks y no de milisegundos.

#include <FreeRTOS.h>
#include <task.h>

#define PROGRAM_NAME "hooks_1.ino"

#define TIME_INTERVAL pdMS_TO_TICKS( 500 )
// el LED parpadea cada 500ms

#ifdef __cplusplus
extern "C"{
#endif
void heartbeat_idle_hook()
{
   static bool led_state = false;
   static TickType_t last_time = 0;

   TickType_t current;
   TickType_t elapsed_time;

   taskENTER_CRITICAL();
   {
      current = xTaskGetTickCount(); 
      elapsed_time = current - last_time;

      if( elapsed_time >= TIME_INTERVAL ){

         last_time = current;

         digitalWrite( 13, led_state );
         led_state = !led_state;
      }
   }
   taskEXIT_CRITICAL();
}
#ifdef __cplusplus
}
#endif

void a_task( void* pvParameters )
{
    while( 1 )
    {
        vTaskDelay( pdMS_TO_TICKS( 497 ) );
        Serial.println( "Ok" );
    }
}

void setup()
{
   Serial.begin( 115200 );
   Serial.println( PROGRAM_NAME );

   pinMode( 13, OUTPUT );
   // lo vamos a usar en la hook de la idle task

   xTaskCreate( a_task, "TSK1", 128, NULL, tskIDLE_PRIORITY + 1, NULL );
   // establecemos que esta tarea tenga mayor prioridad que la idle task

   vTaskStartScheduler();

}

void loop() {}

La función xTaskGetTickCount() devuelve un valor de 16 bits para el ATmega328; esto implica que el contador interno de ticks de FreeRTOS pasa de 65535 a 0 (le decimos rollover) cada 65.535 segundos (cada minuto, aprox). Haber utilizado diferencias de tiempo como en la expresión: elapsed_time = current - last_time nos permite obtener siempre resultados correctos que permiten que el programa funcione de manera continua a pesar de los constantes rollovers.

Las variables led_state y last_time son ser estáticas porque deben mantener su valor entre llamadas.

El archivo hooks.cpp, incluyendo nada más el código de la idle hook queda así:

#include <Arduino.h>
#include <FreeRTOS.h>
#include <task.h>

#ifdef __cplusplus
extern "C"{
#endif

#if configUSE_MALLOC_FAILED_HOOK == 1
void vApplicationMallocFailedHook()
{
}
#endif

#if configCHECK_FOR_STACK_OVERFLOW > 0
void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName )
{
}
#endif

#if configUSE_IDLE_HOOK == 1
void vApplicationIdleHook()
{
   void heartbeat_idle_hook();
   heartbeat_idle_hook();
}
#endif

#if configUSE_TICK_HOOK == 1
void vApplicationTickHook( void )
{
}
#endif

#if configUSE_DAEMON_TASK_STARTUP_HOOK == 1
void vApplicationDaemonTaskStartupHook( void )
{
}
#endif

#ifdef __cplusplus
}
#endif

Ejemplo 2: Heartbeat en la idle hook con tiempo asimétrico

Este ejemplo es un poquito más complejo que el anterior y lo puedes utilizar si no quieres un tiempo simétrico, o si tu aplicación necesita intervalos asimétricos. La diferencia principal está en que utiliza la variable led_state como parte de una pequeña máquina de estados. El resto del código es idéntico al ejemplo anterior.

#include <FreeRTOS.h>
#include <task.h>

#define PROGRAM_NAME "hooks_2.ino"

#define TIME_ON  pdMS_TO_TICKS( 250 )
#define TIME_OFF pdMS_TO_TICKS( 750 )

#ifdef __cplusplus
extern "C"{
#endif
void heartbeat_idle_hook()
{
   static bool led_state = false;
   static TickType_t last_time = 0;

   TickType_t current;
   TickType_t elapsed_time;

   taskENTER_CRITICAL();
   {
      current = xTaskGetTickCount(); 
      elapsed_time = current - last_time;

      if( led_state == false && elapsed_time >= TIME_OFF ){

         digitalWrite( 13, HIGH );
         led_state = true;
         last_time = current;

      } else if( led_state == true && elapsed_time >= TIME_ON ){

         digitalWrite( 13, LOW );
         led_state = false;
         last_time = current;

      } else{  // siempre debemos completar el if-else if-else:
         ; 
      }
   }
   taskEXIT_CRITICAL();
}
#ifdef __cplusplus
}
#endif

void a_task( void* pvParameters )
{
    while( 1 )
    {
        vTaskDelay( pdMS_TO_TICKS( 497 ) );
        Serial.println( "Ok" );
    }
}

void setup()
{
   Serial.begin( 115200 );
   Serial.println( PROGRAM_NAME );

   pinMode( 13, OUTPUT );
   // lo vamos a usar en la hook de la idle task

   xTaskCreate( a_task, "TSK1", 128, NULL, tskIDLE_PRIORITY + 1, NULL );
   // establecemos que esta tarea tenga mayor prioridad que la idle task

   vTaskStartScheduler();
}

void loop() {}

Ejemplo 3: Heartbeat en la tick hook con tiempo asimétrico

En este tercer ejemplo vamos a implementar el heartbeat() con tiempos asimétricos utilizando la tick hook. A diferencia de lo que hicimos en la idle hook, donde teníamos que utilizar diferencias de tiempos porque no sabíamos cada cuándo se activaría la tarea, en este caso solamente vamos a “contar” ticks, ya que esta hook se llama 1 vez en cada tick:

#include <FreeRTOS.h>
#include <task.h>

#define PROGRAM_NAME "hooks_3.ino"

#define TIME_ON  pdMS_TO_TICKS( 100 )
#define TIME_OFF pdMS_TO_TICKS( 900 )

#ifdef __cplusplus
extern "C"{
#endif
void heartbeat_tick_hook()
{
   static bool led_state = false;
   static uint16_t ticks = TIME_OFF;

   taskENTER_CRITICAL();
   {
      --ticks;
      if( ticks == 0 ){

         digitalWrite( 13, led_state );
         led_state = !led_state;

         ticks = led_state == false ? TIME_ON : TIME_OFF;
      }
   }
   taskEXIT_CRITICAL();
}
#ifdef __cplusplus
}
#endif

void a_task( void* pvParameters )
{
    while( 1 )
    {
        vTaskDelay( pdMS_TO_TICKS( 497 ) );
        Serial.println( "Ok" );
    }
}

void setup()
{
   Serial.begin( 115200 );
   Serial.println( PROGRAM_NAME );

   pinMode( 13, OUTPUT );
   // lo vamos a usar en la hook del tick system


   xTaskCreate( a_task, "TSK1", 128, NULL, tskIDLE_PRIORITY, NULL );
   // no importa la prioridad

   vTaskStartScheduler();
}

void loop() {}

Antes de ejecutar este programa asegúrate que en el archivo hooks.cpp tienes las siguientes líneas de código (no pongo el contenido completo de este archivo para no alargar la lección):

#if configUSE_TICK_HOOK == 1
void vApplicationTickHook( void )
{
   void heartbeat_tick_hook();
   heartbeat_tick_hook();
}
#endif

Ejemplo 4: Supervisor por software basado en la idle hook y el chip 555

Este ejemplo es una implementación del supervisor por software que mencioné anteriormente. Tiene 4 tareas, 3 de ellas críticas (la task_3() no es crítica).

Agrupé en una structura los parámetros necesarios para el supervisor, en lugar de mantenerlos sueltos, y declaré un arreglo para 3 tareas críticas:

struct Watchdog
{
   bool       busy{ false };
   bool       failed{ false };
   TickType_t deadline{ 0 };
   TickType_t last_time{ 0 };

   // podríamos agregar un ID que nos ayude a identificar la tarea que falló
};

// No todas las tareas deben ser supervisadas:
#define MAX_TASKS 3
Watchdog tasks[ MAX_TASKS ];

El código del supervisor es el siguiente. Un ciclo recorre la lista de tareas críticas y en cuanto una de ellas se cuelgue o el deadline no se haya cumplido, sale y ejecuta la función clean_and_reset(); en caso de no encontrar problemas, llama a la función feed_the_dog():

void watchdog_idle_hook()
{
   TickType_t now;
   uint8_t i;

   // las secciones críticas se necesitan cuando un micro de 8 bits debe hacer
   // operaciones o asignaciones de 16 o 32 bits en un ambiente multitarea

   taskENTER_CRITICAL();
   {
      now = xTaskGetTickCount();

      for( i = 0; i < MAX_TASKS; ++i ){

         if( tasks[ i ].failed == true ) break;
         // la tarea perdió el deadline (se tardó más de lo debido)

         TickType_t diff = now - tasks[ i ].last_time;
         if( tasks[ i ].busy == true && diff > tasks[ i ].deadline ) break;
         // la tarea se perdió
      }

      if( i == MAX_TASKS ) feed_the_dog();
      // ninguna tarea se colgó y todos los deadlines se cumplieron

      else clean_and_reset();
      // una o más tareas se colgaron, o uno o más deadlines no se cumplieron
   }
   taskEXIT_CRITICAL();
}

La función para alimentar al supervisor externo es feed_the_dog(), la cual envía un pulso negativo (ALTO-BAJO-ALTO) de 100 microsegundos antes de que el tiempo expire. Escogí el pin D4 de Arduino:

void feed_the_dog()
{
   // alimentamos al perro guardián:

   digitalWrite( 4, LOW );
   delayMicroseconds( 100 );
   digitalWrite( 4, HIGH );
}

Sin mayor problema podrías adaptarla para que alimentes al watchdog interno, si es que decidiste utilizarlo.

La función clean_and_reset() es llamada cuando el sistema falló. Ésta forza un reinicio, pero no sin antes poner al sistema a un estado seguro, y avisar de alguna forma, que algo salió mal:

void clean_and_reset()
{
   // pone el sistema a un estado seguro


   Serial.println( "***" );
   // avisamos con un texto, un LED, un timestamp, etc.


   // obligamos a un watchdog reset:
   vTaskSuspendAll();
   taskDISABLE_INTERRUPTS();
   while( 1 )
      ;
}

El esqueleto de una tarea crítica en este programa es:

void critical_task( void* pvParameters )
{
   tasks[ 0 ].deadline = TIME_LIMIT;
   // el deadline es estático

   // inicializa lo relacionado con la tarea...

   while( 1 )
   {
      tasks[ TASK ].busy = true;
      tasks[ TASK ].last_time = xTaskGetTickCount();


      // --- Empieza el proceso:

      // aquí va el proceso crítico...

      // --- Finalizó el proceso


      TickType_t diff = xTaskGetTickCount() - tasks[ TASK ].last_time;
      if( diff > tasks[ TASK ].deadline ) tasks[ TASK ].failed = true;

      tasks[ TASK ].busy = false;
   }
}

Finalmente, actualiza el código del archivo hooks.cpp para que la idle hook mande llamar al supervisor:

#if configUSE_IDLE_HOOK == 1
void vApplicationIdleHook()
{
   void watchdog_idle_hook();
   watchdog_idle_hook();
}
#endif

(No olvides poner la constante configUSE_IDLE_HOOK a 1 en el archivo FreeRTOSConfig.h)

Ya tenemos todos los elementos para poder ver al ejemplo completo:

  • La task_1 hace parpadear a un LED a una razón que se va incrementendo en cada paso lo que hace que a larga el programa falle.
  • La task_2 imprime su nombre en la consola serial. No falla.
  • Las tareas task_3 y task_4 trabajan de manera coordinada; la primera hace las veces de generadora de eventos, mientras que la segunda los consume. Este par de tareas podrían hacer que el sistema falle.

Por supuesto las tareas las diseñé así para que el programa falle bajo condiciones controladas.

#include <FreeRTOS.h>
#include <task.h>

#define PROGRAM_NAME "hooks_4.ino"

#define TIME_LIMIT_1 pdMS_TO_TICKS( 500 )
#define TIME_LIMIT_2 pdMS_TO_TICKS( 500 )
#define TIME_LIMIT_3 pdMS_TO_TICKS( 500 )


struct Watchdog
{
   bool       busy{ false };
   bool       failed{ false };
   TickType_t deadline{ 0 };
   TickType_t last_time{ 0 };

   // podríamos agregar un ID que nos ayude a identificar la tarea que falló
};


// No todas las tareas deben ser supervisadas:
#define MAX_TASKS 3
Watchdog tasks[ MAX_TASKS ];


TaskHandle_t consumer_handler = NULL;
// lo necesita una de las tareas (la productora)


#ifdef __cplusplus
extern "C"{
#endif

void feed_the_dog()
{
   // alimentamos al perro guardián:

   digitalWrite( 4, LOW );
   delayMicroseconds( 100 );
   digitalWrite( 4, HIGH );
}

void clean_and_reset()
{
   // pone el sistema a un estado seguro


   Serial.println( "***" );
   // avisamos con un texto, un LED, un timestamp, etc.


   // obligamos a un watchdog reset:
   vTaskSuspendAll();
   taskDISABLE_INTERRUPTS();
   while( 1 )
      ;
}

//----------------------------------------------------------------------
//                     watchdog_idle_hook()
//----------------------------------------------------------------------
void watchdog_idle_hook()
{
   TickType_t now;
   uint8_t i;

   // las secciones críticas se necesitan cuando un micro de 8 bits debe hacer
   // operaciones o asignaciones de 16 o 32 bits en un ambiente multitarea

   taskENTER_CRITICAL();
   {
      now = xTaskGetTickCount();

      for( i = 0; i < MAX_TASKS; ++i ){

         if( tasks[ i ].failed == true ) break;
         // la tarea perdió el deadline (se tardó más de lo debido)


         TickType_t diff = xTaskGetTickCount() - tasks[ i ].last_time;
         if( tasks[ i ].busy == true && diff > tasks[ i ].deadline ) break;
         // la tarea se perdió

      }

      if( i == MAX_TASKS ) feed_the_dog();
      else clean_and_reset();
   }
   taskEXIT_CRITICAL();
}
#ifdef __cplusplus
}
#endif


//----------------------------------------------------------------------
//                          task_1()
//----------------------------------------------------------------------
void task_1( void* pvParameters )
{
   tasks[ 0 ].deadline = TIME_LIMIT_1;
   // el deadline es estático

   pinMode( 2, OUTPUT );
   // un led en D2

   bool led_state = false;

   uint16_t excess_time = pdMS_TO_TICKS( 50 );

   while( 1 )
   {

      tasks[ 0 ].busy = true;
      tasks[ 0 ].last_time = xTaskGetTickCount();


      // --- Empieza el proceso:

      vTaskDelay( excess_time );

      digitalWrite( 2, led_state );
      led_state = !led_state;

      Serial.println( pcTaskGetName( NULL ) );
      // hacemos tiempo calculando el nombre en lugar de usar texto estático

      // --- Finalizó el proceso


      TickType_t diff = xTaskGetTickCount() - tasks[ 0 ].last_time;
      if( diff > tasks[ 0 ].deadline ) tasks[ 0 ].failed = true;

      tasks[ 0 ].busy = false;


      excess_time += pdMS_TO_TICKS( 5 );
   }
}

//----------------------------------------------------------------------
//                          task_2()
//----------------------------------------------------------------------
void task_2( void* pvParameters )
{
   tasks[ 1 ].busy = false;
   tasks[ 1 ].failed = false;
   tasks[ 1 ].deadline = TIME_LIMIT_2;

   while( 1 )
   {
      tasks[ 1 ].busy = true;
      tasks[ 1 ].last_time = xTaskGetTickCount();


      // --- Empieza el proceso:

      vTaskDelay( pdMS_TO_TICKS( 93 ) );

      Serial.println( pcTaskGetName( NULL ) );

      // --- Finalizó el proceso


      TickType_t diff = xTaskGetTickCount() - tasks[ 1 ].last_time;
      if( diff > tasks[ 1 ].deadline ) tasks[ 1 ].failed = true;
      tasks[ 1 ].busy = false;
   }
}

//----------------------------------------------------------------------
//                          task_3()
//----------------------------------------------------------------------
void task_3( void* pvParameters )
{
   configASSERT( consumer_handler );

   // las inicializamos aquí porque la tarea productora tiene mayor prioridad que la consumidora:
   tasks[ 2 ].busy = false;
   tasks[ 2 ].failed = false;
   tasks[ 2 ].deadline = TIME_LIMIT_3;


   TickType_t last_wake_time = xTaskGetTickCount();

   uint16_t excess_time = 0;

   while( 1 )
   {
      vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( 111 + excess_time  ) );

      // actualizamos los atributos ANTES de dar el aviso:
      tasks[ 2 ].busy = true;
      tasks[ 2 ].last_time = xTaskGetTickCount();

      digitalWrite( 13, HIGH );

      xTaskNotifyGive( consumer_handler );
      // avisamos

      Serial.println( pcTaskGetName( NULL ) );

      excess_time += 10;
   }
}

//----------------------------------------------------------------------
//                          task_4()
//----------------------------------------------------------------------
void task_4( void* pvParameters )
{
   while( 1 )
   {
      // --- Empieza el proceso:

      // los atributos fueron establecidos en el productor antes de dar el aviso

      ulTaskNotifyTake( pdTRUE, portMAX_DELAY );

      Serial.println( pcTaskGetName( NULL ) );

      digitalWrite( 13, LOW );

      // --- Finalizó el proceso


      TickType_t diff = xTaskGetTickCount() - tasks[ 2 ].last_time;
      if( diff > tasks[ 2 ].deadline ) tasks[ 2 ].failed = true;

      tasks[ 2 ].busy = false;
   }
}

//----------------------------------------------------------------------
//                         setup()
//----------------------------------------------------------------------
void setup()
{
   Serial.begin( 115200 );
   Serial.println( PROGRAM_NAME );

   pinMode( 13, OUTPUT );

   pinMode( 4, OUTPUT );
   digitalWrite( 4, HIGH );

   xTaskCreate( task_1, "TSK1", 128, NULL, tskIDLE_PRIORITY + 0, NULL );
   // requiere supervisión, podría fallar

   xTaskCreate( task_2, "TSK2", 128, NULL, tskIDLE_PRIORITY + 1, NULL );
   // requiere supervisión, pero nunca falla

   xTaskCreate( task_3, "TSK3", 128, NULL, tskIDLE_PRIORITY + 2, NULL );
   // productor (no requiere supervisión)

   xTaskCreate( task_4, "TSK4", 128, NULL, tskIDLE_PRIORITY + 1, &consumer_handler );
   // consumidor (requiere supervisión)


   feed_the_dog();

   vTaskStartScheduler();
}

void loop() {}

¿Qué sigue?

Hoy vimos 3 temas importantes: 2 sobre cómo inyectar código nuestro al sistema operativo, y otro sobre cómo implementar y utilizar un supervisor por software utilizando un watchdog externo.

Tú podrías utilizar ya sea un watchdog externo propiamente dicho, o el interno al ATmega328.

RECUERDA: No utilices funciones bloqueantes dentro de las hooks de FreeRTOS.

RECUERDA: Nunca alimentes al watchdog desde una tarea o interrupción periódica.

RECUERDA: Revisa que el sistema está en perfectas condiciones antes de alimentar al supervisor.

Índice del curso

Espero que esta lección haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Administración de la memoria

No podíamos terminar este curso sin mencionar brevemente la forma en que FreeRTOS administra la memoria. De ésta tenemos dos tipos, la memoria dinámica y la memoria estática, siendo la primera la que más problemas da. La memoria dinámica es memoria RAM que le pedimos al sistema operativo cuando el programa ya está ejecutándose. En programas de computadora esta es una actividad que realizamos todo el tiempo, sin apenas darnos cuenta. Aunque lenguajes como C/C++ nos obligan a devolver manualmente la memoria que hayamos pedido, hay otros más “pesados” (en términos de recursos y tiempo de procesamiento) que devuelven la memoria por nosotros, y además pareciera, en cualquier caso, que la memoria RAM nunca se termina. Y somos felices.

Sin embargo, los sistemas embebidos son arena de otro costal. La memoria RAM está severamente limitada y raras veces podemos darnos el lujo de pedir y devolver memoria en tiempo de ejecución. Y aunque tuviéramos la posibilidad de hacerlo debemos preguntarnos si eso es realmente lo que queremos.

La memoria dinámica tiene varios problemas que se amplifican en nuestros sistemas con recursos limitados:

  • Las llamadas a la función malloc() no son deterministas; esto es, mientras que una llamada puede tomar 300 microsegundos, otra podría tomar 5 milisegundos, y luego otra 1 milisegundo.
  • La función malloc() no es re-entrante. Esto es, la función no está diseñada para ser accesada por dos o más tareas al mismo tiempo en un programa concurrente, con lo cual el sistema podría corromperse. Este problema se podría resolver desactivando las interrupciones o al sistema operativo mientras malloc() se está ejecutando. El problema es que en algunos casos la búsqueda de un bloque de memoria contiguo puede tardar mucho.
  • La memoria se fragmenta. Cuando tu programa inicia toda la memoria es contigua, pero cada vez que la pides y la devuelves se van creando huecos, y podría llegar a ser que tengas, digamos, 100 bloques no contiguos (es decir, con huecos entre uno y otro) de 16 bytes (por dar un número) cada uno. En total tienes 1600 bytes NO contiguos. ¿Qué sucedería si haces una petición de 20 bytes? La llamada a malloc() va a fallar porque en el escenario propuesto no hay ningún bloque contiguo de al menos 20 bytes. “Oye, pero tengo 1600 bytes, ¿cómo es eso posible?”. Bueno, la memoria se fragmentó.
  • Fugas de memoria. Las funciones que piden memoria, deben devolverla (en los casos más clásicos. Cuando veamos los diferentes esquemas de FreeRTOS retomaré este punto), ¿y qué pasa si la devuelves? Ese bloque de memoria queda marcado como “en uso”, por lo que aunque ya no la estés utilizando, a los ojos del sistema operativo sí lo estás haciendo. La consecuencia es que nadie más, durante la vida del programa, podrá usar esa memoria.
  • FreeRTOS no devuelve la memoria inmediatamente. Uno pensaría que cuando llamas a la función free() la memoria se devuelve al momento y queda lista para volver a ser utilizada. Bueno, esto no es del todo cierto. FreeRTOS devuelve la memoria cuando tiene un poco de tiempo para hacerlo. Esto significa que si la carga de trabajo de tu aplicación es alta y FreeRTOS no se hace de tiempo, entonces esa memoria que devolviste… realmente no ha sido devuelta. Y lo peor de todo es que el escenario no es determinista (otra vez) por lo que repetir el incidente para investigarlo será casi imposible.
  • ¿Cuánta memoria es suficiente?. La memoria dinámica se toma de una región llamada heap, y tú estableces el tamaño (en bytes) de esa región. En los ejemplos que hemos estado viendo el heap está establecido como 1500 bytes, de los 2048 que tiene el ATmega328. ¿1500 es mucho o poco? ¿Porqué no los 2048? ¿Porqué no 1024? ¿Qué sucede con los bytes que no usemos del heap? FreeRTOS proporciona herramientas para determinar si 1500 bytes es mucho o poco, lo cual es tema de esta lección.

Durante mucho tiempo la creación dinámica de objetos fue la única disponible en FreeRTOS, y no fue sino hasta la versión 9.0.0 que se introdujo la creación estática de objetos. Y antes de ella siempre me había preguntado porqué no estaba “de fábrica”, ya que yo conocía de los problemas de la memoria dinámica. De hecho, los gurús de los sistemas embebidos advierten sobre su utilización y aconsejan no usarla. Afortunadamente me leyeron la mente e introdujeron el concepto a FreeRTOS.

Ahora que si a pesar de los problemas descritos, quieres seguir utilizando la creación dinámica de objetos, o estás trabajando sobre un proyecto que ya la usa (ya me pasó), o tu aplicación a mano los necesita, sí o sí, entonces lo mejor es que conozcas cómo se comporta y se administra la memoria para que no te lleves (desagradables) sorpresas.

En esta lección vamos a platicar sobre algunos conceptos importantes relacionados con la memoria, y de herramientas de FreeRTOS que nos permitirán determinar los tamaños óptimos para el heap y las pilas de las tareas, para intentar disminuir los problemas que se nos presenten.

Tabla de contenidos

¿Qué es y qué necesito?

Vamos a platicar sobre dos problemas que se nos presentan en el desarrollo de programas con FreeRTOS (y en general, con cualquier sistema operativo):

  • Desboardamiento del heap: un heap demasiado grande equivale a desperdicio de memoria, y uno demasiado pequeño equivale a problemas.
  • Desbordamiento de la pila. Igual que el anterior, pero con la pila de cada tarea.

Y también sobre algunas herramientas que FreeRTOS ofrece para afinar sus respectivos tamaños.

Heap

¿De dónde sale la memoria para la creación dinámica de objetos? La memoria es tomada de un área conocida como el heap (se pronuncia más o menos [jép]. En español es montón). En FreeRTOS es un arreglo cuyo tamaño tú defines en el archivo FreeRTOSConfig.h:

#define configTOTAL_HEAP_SIZE (( UBaseType_t )( 1500 ))

(Para el ATmega328 el tipo UBaseType_t está difinido como unsigned char. Para más detalles revisa el archivo portmacro.h.)

Aunque el ATmega328 tiene 2048 bytes de RAM, no es recomendable usar toda para el heap, ya que cuando declaras variables globales, o usas funciones antes de iniciar al sistema operativo, o usas interrupciones, necesitarás memoria que no es parte del heap.

Como mencioné en la introducción, ¿1500 bytes es mucho o poco? ¿Y si tengo dos tareas nada más, cada una con una pila de 256 bytes, qué sucede con la memoria no utilizada del heap? Hacer a ésta área de memoria muy grande o muy chica tiene sus consecuencias. Si la haces muy grande y no la utilizas toda, entonces estarás desperdiciando valiosa memoria (la RAM no se da en los árboles); pero si la haces muy chica, entonces se terminará antes de lo esperado y no podrás crear más objetos dinámicos mientras el programa se está ejecutando (tiempo de ejecución, le decimos). Los objetos estáticos no tienen esta disyuntiva: si eventualmente se termina la memoria lo sabrás cuando estés compilando el programa (tiempo de compilación) y sabrás qué hacer antes de instalar tu aplicación en la copa de un árbol; en el caso de que se agote la memoria en tiempo de ejecución, entonces tendrás que subir a la copa del árbol a presionar el botón de reset.

En FreeRTOS es posible que una tarea cree a otra tarea (u objetos dinámicos), pero lo más recomendable, en la medida de los posible, es crear TODOS los objetos dinámicos al inicio del programa, y probar que realmente se hayan creado, y no sólo suponerlo. Además, tampoco deberías destruirlos (es decir, devolver su memoria). Este escenario nos hace pensar en utilizar, mejor, objetos estáticos.

En algunas aplicaciones podría ser prohibitivo o inconveniente, desde muchos ángulos, probar el valor valor devuelto por la función xTaskCreate() de todas las tareas que hayas creado. Para estos casos puedes indicarle a FreeRTOS que te avise cuando una llamada a malloc() falle, es decir, cuando malloc() no haya encontrado la memoria contigua requerida.

Primero deberás decirle a FreeRTOS que quieres el aviso. Para ello debes poner a 1 la constante configUSE_MALLOC_FAILED_HOOK en el archivo FreeRTOSConfig.h:

#define configUSE_MALLOC_FAILED_HOOK 1

Luego debes escribir una función callback (también conocidas como hooks) que será llamada por FreeRTOS. Una función callback o hook es una función que tú escribes, pero que el programa (en este caso FreeRTOS) utilizará como si fuera parte de él, sin ser parte de él. También le llamamos inyección de dependencias. Anteriormente en el curso ya hemos usado varias callbacks, así que el término no te debería ser desconocido. La función callback que deberás escribir es la siguiente:

Dentro de ella tú estableces qué hacer en caso de que la memoria del heap se haya agotado, y todo dependerá de la aplicación que estés escribiendo. Las acciones podrían ir desde activar un LED de error, o escribir un mensaje en la consola, o algo más drástico como resetear al sistema. Ten en cuenta que esta función la utilizarías mientras el programa está en desarrollo o pruebas y es para que te des cuenta si el tamaño de heap debe ser incrementado.

En el Ejemplo 1 que veremos más adelante está una posible implementación. Para que este mecanismo funcione asegúrate de crear todos los objetos dinámicos, directa o indirectamente, que tu programa va a necesitar.

Desbordamiento de la pila

Cuando creas tareas debes especificar la cantidad de memoria para su pila. La pila es una estructura de datos dinámica (en el sentido de que su contenido está cambiando continuamente) que almacena las variables declaradas en la tarea, así como los argumentos que envías a funciones y los valores que éstas pudieran devolver. Si tu tarea, o las funciones a las que llama, declaran muchas variables (o unas pocas pero del tipo arreglo), o las llamadas a las funciones son muy profundas, corres el riesgo de que la pila se desborde por tener un tamaño insuficiente. El desbordamiento de la pila es cuando se rebasa el tamaño máximo de la misma, por las razones que mencioné. ¿Cuál es el tamaño ideal para una pila? Es difícil decirlo; esta es una tarea que involucra la experiencia y el sentido común. FreeRTOS propone un tamaño mínimo para la pila para cada procesador. En el caso del ATmega328 es:

#define configMINIMAL_STACK_SIZE ( ( UBaseType_t ) 85 )

Y de ahí para arriba. Pero ¿cuánto es suficiente? Afortunadamente FreeRTOS incluye herramientas que nos permitirán verificar si la pila se ha desbordado, y en caso afirmativo, afinar su tamaño. Debes activar esta herramienta antes de usarla, estableciendo un valor 1 ó 2 en el archivo FreeRTOSConfig.h:

/*
 * 0: Deshabilitada
 * 1: Precisa
 * 2: Más precisa
 */
#define configCHECK_FOR_STACK_OVERFLOW 1

Cuando este mecanismo detecte un desbordamiento de la pila mandará llamar una función hook llamada vApplicationStackOverflowHook():

Los argumentos xTask y pcTaskName contienen cada uno, de manera respectiva, el handler y el nombre de la tarea que hizo que llegaras ahí.

(Nota: Por algún desfase entre el código y la documentación, el tipo del parámetro pcTaskName se muesra como signed char*, sin embargo el compilador lo rechazará; en su lugar usa char* únicamente, como lo he hecho en los ejemplos más adelante.)

En caso de un problema con la pila FreeRTOS buscará la función vApplicationStackOverflowHook() en tu proyecto y llevará a cabo lo que ahí indiques.

¿Qué hay de los valores 1 y 2 de la constante configCHECK_FOR_STACK_OVERFLOW? En realidad son dos métodos para la detección de los desbordamientos.

Método 1

configCHECK_FOR_STACK_OVERFLOW es puesta a 1. FreeRTOS observará, en cada cambio de contexto, si la pila no ha sido desbordada. En caso de desbordamiento llamará a la función hook vApplicationStackOverflowHook().

Método 2

configCHECK_FOR_STACK_OVERFLOW es puesta a 2. FreeRTOS llenará la pila con un valor conocido cuando la tarea sea creada. Posteriormente, en cada cambio de contexto observará los últimos 16 bytes de la pila para ver si cambiaron con respecto al valor inicial. Este método es más lento, pero te avisará antes de un posible desbordamiento. El aviso viene en forma de una llamada a la función hook vApplicationStackOverflowHook(). Esta funcionalidad se presta para ser utilizada con un depurador por hardware.

Ambos métodos introducen más carga de trabajo al sistema, por lo que deberías utilizarlas solamente mientras desarrollas la aplicación, o en la etapa de pruebas. Además, no tiene sentido continuar un programa si su pila se ha desbordado, so pena de muchos problemas.

FreeRTOS indica que no existe una garantía de capturar todos los desbordamientos, y es lógico. Pero tú puedes ayudarlo haciendo que tu programa recorra todos los caminos posibles en la lógica de tu aplicación. Imagina que uno de estos caminos manda llamar a funciones que ocupan mucha memoria, pero asumes que “en la vida real” la condición para tomar ese camino “nunca” se dará. Resulta que como la vida real es caprichosa (“Si puede suceder, entonces sucederá“) un día se le ocurrirá tomar ese camino y la pila se desbordará (ya cuando tu aplicación ha sido distribuída y el dispositivo ha sido instalado en la copa de un árbol en medio de la selva). Moraleja:

Si programas un camino crítico en tu programa, entonces haz pruebas que lo recorran.

Antes de terminar esta sección sobre conceptos veamos las diferentes opciones que FreeRTOS ofrece para las funciones malloc()/free().

Implementaciones de malloc

FreeRTOS incluye 5 implementaciones de malloc(), cada una con características y potencias diferentes, dentro de archivos con el nombre heap_x.c (donde la x va desde 1 hasta 5):

  1. heap_1.c. Es la implementación más simple y no permite devolver la memoria (la función free() no está definida). Su uso no es recomendado debido a que la creación estática de objetos la vino a substituir.
  2. heap_2.c. Igual que heap_1.c, pero permite devolver la memoria, sin juntar los fragmentos, cuyo resultado es memoria fragmentada.
  3. heap_3.c. Utiliza las funciones malloc() y free() de tu compilador/plataforma. Por ejemplo, en el caso del ATmega328 esta implementación simplemente manda llamar a dichas funciones que ya vienen incluídas en el compilador avr-gcc. NOTA: El projecto Molcajete utiliza este esquema; pero si tú quisieras usar algún otro, simplemente descárgalo y cópialo en el directorio /src de FreeRTOS. (Por favor lee la nota NOTA IMPORTANTE al final del primer ejemplo.)
  4. heap_4.c. Igual que heap_2.c, pero junta los fragmentos. Por supuesto es más lenta, pero la memoria no se fragmenta. FreeRTOS recomienda utilizar este esquema en lugar de heap_2.c para programas nuevos.
  5. heap_5.c. Igual que heap_4.c, pero permite distribuir el heap entre diferentes regiones de RAM. Algunos microcontroladores modernos y potentes incluyen no una región de RAM, sino varias no contiguas. Este esquema aprovecha todas las regiones, y obviamente es el más complicado de todos.

Recuerda: Solamente un esquema de los 5 mencionados debe estar activo a un mismo tiempo, de lo contrario el programa no compilará (por duplicidad de símbolos).

Función uxTaskGetStackHighWaterMark()

Si quieres saber cuánta memoria queda en la pila de una tarea debes utilizar la función uxTaskGetStackHighWaterMark():

Esta función devuelve el número de elementos aún no utilizados (words o bytes, depende de la definición de UBaseType_t) desde que la tarea indicada por el argumento xTask inició. Puedes usar el valor NULL para referirte a la propia tarea que hizo la llamada. En los ejemplos más adelante veremos su uso.

Configuración

Antes de ver los ejemplos de esta sección debes de saber que la forma de construir (compilar) sketches es un tanto especial cuando integras código de terceros, tal como FreeRTOS, y las cosas no siempre funcionan como uno esperaría. Y este es el caso de las funciones hook que te he platicado.

Idealmente deberías escribir el código de la hook en el mismo sketch de tu aplicación, pero no funciona. Por esta razón creé originalmente un archivo especial hooks.c en el directorio /src de FreeRTOS del proyecto Molcajete. Pero este tiene un problema, ¡es un archivo de lenguaje C, no de C++!. Esto significa que en dicho archivo no podrás usar objetos de C++, como por ejemplo Serial.println(), ya que en C no existen objetos. Pero si utilizaras funciones como digitalWrite() no tendrías inconvenientes. Sin embargo, para efectos de depuración de los programas es mejor contar con una salida de texto.

Por ello deberás realizar los siguientes 3 simples pasos antes de probar los ejemplos de la siguiene sección:

  1. Ubica (pero no lo abras, no es necesario) al archivo hooks.c, el cual está en /tu/ruta/de/instalación/de/molcajete/arduino-1.8.13/libraries/FreeRTOS/src.
  2. Cámbiale el nombre a hooks.c.txt. Este paso es para que no lo borres y para que el compilador no lo considere en el proceso de compilación. Por supuesto que también puedes borrarlo con toda seguridad.
  3. En ese mismo directorio crea un nuevo archivo hooks.cpp con el siguiente contenido (copia y pega para evitar errores de dedo):
#include <Arduino.h>
#include <FreeRTOS.h>
#include <task.h>

#ifdef __cplusplus
extern "C"{
#endif


#if configUSE_MALLOC_FAILED_HOOK == 1
void vApplicationMallocFailedHook()
{
}
#endif

#if configCHECK_FOR_STACK_OVERFLOW > 0
void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName )
{
}
#endif

#if configUSE_IDLE_HOOK == 1
void vApplicationIdleHook()
{
}
#endif

#if configUSE_TICK_HOOK == 1
void vApplicationTickHook( void )
{
}
#endif

#ifdef __cplusplus
}
#endif

En este archivo he concentrado todas las hooks que FreeRTOS pudiera llegar a necesitar; para la lección de hoy solamente utilizaremos las primeras dos.

Ejemplos

Los ejemplos a continuación los vas a estar trabajando con tres archivos abiertos: hooks.cpp (para que escribas el código de tus hooks), FreeRTOSConfig.h (para jugar con las constantes), y los archivos de tus sketches.

Ejemplo 1: Terminándonos el heap

(* Nota importante al final del ejemplo.)

En este ejemplo vamos a pedir más memoria de la que establecimos para el heap y veremos si la función vApplicationMallocFailedHook() se manda llamar. Recuerda que estas herramientas son para cuando estás desarrollando o probando tus aplicaciones, no son para código de producción (es decir, el código que ejecuta tu aplicación ya en campo).

Abre el archivo hooks.cpp y modifica la función vApplicationMallocFailedHook() con el siguiente contenido:

void vApplicationMallocFailedHook()
{
   Serial.println( "ERR: Se agotó el heap. El programa se detiene." );

   while( 1 )
      ;
}

El ciclo infinito while( 1 ); es para que el programa no continúe. Si esta función se llega a llamar es porque debes aumentar el heap o afinar el tamaño de la pila de cada tarea. Que el programa continue no tendría sentido.

Es importante que en este tipo de funciones no utilices funciones bloqueantes (xTaskDelay(), temporizadores, xQueueReceive(), etc) dado que tu programa está en una situación crítica; sin embargo sí que podrás utilizar algunas funciones de FreeRTOS que devuelven valores sin bloquearse (es decir, que regresan inmediatamente), o funciones de Arduino que no sean bloqueantes, como digitalWrite(), por ejemplo.

Luego escribe un sketch con el siguiente contenido:

#include <FreeRTOS.h>
#include <task.h>

// No olvides poner configUSE_MALLOC_FAILED_HOOK a 1 en el archivo FreeRTOSConfig.h

#define PROGRAM_NAME "mem_mang_1.ino"


void led_task( void* pvParameters )
{
    uint8_t pin = (uint8_t) pvParameters;

    pinMode( pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( pin, HIGH );
        vTaskDelay( pdMS_TO_TICKS( 497 ) );
        digitalWrite( pin, LOW );
        vTaskDelay( pdMS_TO_TICKS( 497 ) );
    }
}

void setup()
{
   Serial.begin( 115200 );
   Serial.println( PROGRAM_NAME );


   xTaskCreate( led_task, "LD1", 256, (void*) 13, tskIDLE_PRIORITY, NULL );
   Serial.println( "La tarea 1 se creó ..." );

   xTaskCreate( led_task, "LD2", 256, (void*) 12, tskIDLE_PRIORITY, NULL );
   Serial.println( "La tarea 2 se creó ..." );

   xTaskCreate( led_task, "LD3", 256, (void*) 11, tskIDLE_PRIORITY, NULL );
   Serial.println( "La tarea 3 se creó ..." );

   xTaskCreate( led_task, "LD4", 256, (void*) 10, tskIDLE_PRIORITY, NULL );
   Serial.println( "La tarea 4 se creó ..." );


   vTaskStartScheduler();
}

void loop() {}

Este programa intentará crear 4 tareas (reutilizando el código de una misma, aunque eso es lo de menos en el ejemplo), cada una pidiendo 256 words, es decir, 512 bytes para cada pila. Este ejemplo lo voy a ejecutar utilizando la implementación heap_3.c, y para ésta el valor de la constante configTOTAL_HEAP_SIZE no es tomado en cuenta, por lo que su valor es irrelevante (el porqué usé el esquema heap_3.c lo explico en la nota al final del ejemplo).

#define configTOTAL_HEAP_SIZE (( UBaseType_t )( 1500 )) // Irrelevante para heap_3.c

La salida de este programa es:

En este ejemplo nosotros sabemos dónde y porqué se agotó el heap y porqué el programa se detuvo, dado que ese es el objetivo del ejemplo; sin embargo, en un escenario real donde crees objetos dinámicos de forma dispersa será difícil determinar, con el método Serial.println(), dónde fue el punto exacto donde el programa falló. Para determinarlo deberás utilizar un depurador por hardware, tal como el AVR Dragon (para el chip ATmega328). Microcontroladores más modernos usan depuradores más potentes, o las tarjetas donde vienen montados (las conocidas como tarjetas de desarrollo o de evaluación) integran el soporte para la depuración por hardware.

Parte de mi colección de tarjetas de desarrollo. Puedes ver que algunas integran al depurador por hardware en la misma tarjeta, mientras que en otras conecté depuradores externos (ambos del tipo JTAG). Desafortunadamente es muy complicado depurar por hardware al ATmega328 en Linux.

*NOTA IMPORTANTE: En esta lección hablé sobre creación dinámica de tareas, y en la del día de hoy hablé de las diferentes implementaciones para las funciones malloc() y free(), y durante todo el curso he estado utilizando la versión heap_3.c, la cual como ya dije, utiliza las implementaciones de dichas funciones que vienen con el compilador avr-gcc. ¿Y qué sucede con las otras? NO FUNCIONAN con el micro/compilador ATmega328/avr-gcc. Así de simple, y por lo tanto, si no tienes una razón de peso para no utilizar el esquema heap_3.c, entonces quédate con él, o mejor aún, descarta el uso de objetos dinámicos y usa nada más objetos estáticos.

Lo anterior te lo he comentado por dos cosas:

  1. Para que no te lleves sorpresas desagradables si utilizas un esquema diferente a heap_3.c.
  2. Porque FreeRTOS incluye una función, xPortGetFreeHeapSize(), que te devuelve el número de palabras (que no de bytes) que quedan libres en el heap. Sin embargo, el esquema heap_3.c no es parte de FreeRTOS y por eso la función no es implementada. No obstante, ahí queda la información para cuando uses un microcontrolador y compilador diferente. Dicha función la puedes utilizar para afinar el tamaño del heap en una aplicación dada.

Ejemplo 2: Desbordando la pila

Para este y el siguiente ejemplo fue complicado encontrar ejemplos simples que desbordaran a la pila; lo mejor que encontré fue utilizar funciones recursivas (una función recursiva es aquella que se llama a sí misma de manera controlada). Y aún así no me fue posible ver la llamada a la función hook vApplicationStackOverflowHook() (de alguna manera el código generado esta súperoptimizado). Sin embargo, ya tienes los elementos para supervisar los problemas con la pila.

La función hook, en el archivo hooks.cpp, quedó así:

#if configCHECK_FOR_STACK_OVERFLOW > 0
void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName )
{
   Serial.print( "ERR: Desbordamiento de pila para la tarea: " );
   Serial.println( pcTaskName );

   vTaskSuspendAll();
   taskDISABLE_INTERRUPTS();

   while( 1 )
      ;
}
#endif

La función vTaskSuspendAll() suspende al planificador, esto es, ya no habrá cambios de contexto; para restaurar al planificador usa xTaskResumeAll(). Ambas funciones devuelven void y no reciben argumentos. La función vTaskSuspenAll() no detiene las interrupciones, para ello es necesario que llames a taskDISABLE_INTERRUPTS(); para reactivarlas usa taskENABLE_INTERRUPTS(). La documentación oficial menciona que este par de funciones deberían ser substituídas por taskENTER_CRITICAL() y taskEXIT_CRITICAL() (ambas funciones también devuelven void y no reciben argumentos), pero el contexto en que estoy usando me da para usar las funciones que te mencioné (y además internamente son diferentes). Puedes usar vTaskSuspendAll() y taskDISABLE_INTERRUPTS() en el Ejemplo 1.

El programa de prueba es:

#include <FreeRTOS.h>
#include <task.h>

// No olvides poner configCHECK_FOR_STACK_OVERFLOW a 1 o 2 en el archivo FreeRTOSConfig.h

#define PROGRAM_NAME "mem_mang_2.ino"


void led_task( void* pvParameters )
{
    uint8_t pin = (uint8_t) pvParameters;
    pinMode( pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( pin, HIGH );
        vTaskDelay( pdMS_TO_TICKS( 200 ) );
        digitalWrite( pin, LOW );
        vTaskDelay( pdMS_TO_TICKS( 200 ) );
    }
}

void recursive( int val )
{
   if( val > 0 ){
      Serial.print( "Val = " );
      Serial.println( val );
      recursive( val - 1 );
   } else{
      return;
   }
}

void other_task( void* pvParameters )
{
   Serial.println( "Antes del desbordamiento ..." );

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 497 ) );
      recursive( 5000 );
   }
}

void setup()
{
   Serial.begin( 115200 );
   Serial.println( PROGRAM_NAME );

   xTaskCreate( led_task, "LED", 128, (void*) 13, tskIDLE_PRIORITY, NULL );
   xTaskCreate( other_task, "OTHR", 128, NULL, tskIDLE_PRIORITY, NULL );

   vTaskStartScheduler();
}

void loop() {}

Al igual que en el ejemplo anterior, no olvides que lo que estamos haciendo es para descubrir problemas con la pila ANTES de que instales tu aplicación en la copa de un árbol muy alto en una selva. Una vez que has determinado que no hay problemas con las pilas, entonces deberías desactivar tanto su verificación como la del heap.

En una situación crítica donde la pila se desbordó quizás sea mejor idea mantener el código de vApplicationStackOverflowHook() lo más simple posible. Serial.print() está lejos de ser simple; en su lugar puedes activar un LED (si tu hardware y aplicación lo permiten):

#if configCHECK_FOR_STACK_OVERFLOW > 0
void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName )
{
   digitalWrite( 2, HIGH );

   vTaskSuspendAll();
   taskDISABLE_INTERRUPTS();

   while( 1 )
      ;
}
#endif

Para que funcione debes configurarlo en la función setup():

void setup()
{
   pinMode( 2, OUTPUT );
   digitalWrite( 2, LOW );

   // más código
}

Este ejemplo no tiene imagen de la salida de una ejecución porque fue difícil obtener algo

Ejemplo 3: Verificando la memoria disponible en la pila con uxTaskGetStackHighWaterMark()

Mencioné que la función uxTaskGetStackHighWaterMark() devuelve el número de elementos restantes de la pila que no han sido usados. En este ejemplo imprimiremos dichos valores, que para el ATmega328 el valor devuelto estará en bytes.

#include <FreeRTOS.h>
#include <task.h>

// No olvides poner configCHECK_FOR_STACK_OVERFLOW a 1 o 2 en el archivo FreeRTOSConfig.h

#define PROGRAM_NAME "mem_mang_3.ino"

void led_task( void* pvParameters )
{
    uint8_t pin = (uint8_t) pvParameters;

    pinMode( pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( pin, HIGH );
        vTaskDelay( pdMS_TO_TICKS( 200 ) );
        digitalWrite( pin, LOW );
        vTaskDelay( pdMS_TO_TICKS( 200 ) );
    }
}

void recursive( int val )
{
   uint8_t arr[ val ];

   UBaseType_t high_watermark = uxTaskGetStackHighWaterMark( NULL );
   Serial.print( "Memoria restante: " );
   Serial.println( high_watermark );

   if( val > 0 ){
      Serial.print( "Val = " );
      Serial.println( val );

      vTaskDelay( pdMS_TO_TICKS( 50 ) );

      recursive( val - 1 );
   } else{
      return;
   }
}

void other_task( void* pvParameters )
{

   UBaseType_t high_watermark = uxTaskGetStackHighWaterMark( NULL );
   Serial.println( "Memoria antes del desbordamiento ..." );
   Serial.println( high_watermark );

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 497 ) );

      recursive( 30 );

      Serial.print( "MEMORIA RESTANTE: " );
      high_watermark = uxTaskGetStackHighWaterMark( NULL );
      Serial.println( high_watermark );
   }
}

void setup()
{
   // para stackOverflow:
   pinMode( 2, OUTPUT );
   digitalWrite( 2, LOW );

   Serial.begin( 115200 );
   Serial.println( PROGRAM_NAME );

   xTaskCreate( led_task, "LED", 128, (void*) 13, tskIDLE_PRIORITY, NULL );
   xTaskCreate( other_task, "OTHR", 128, NULL, tskIDLE_PRIORITY, NULL );

   vTaskStartScheduler();
}

void loop() {}

La salida de este programa cuando configCHECK_FOR_STACK_OVERFLOW es 1 es la siguiente:

Observa que a pesar de que la cantidad de memoria restante es cero, al menos entró dos veces más a la función recursiva. Y aunque la impresión serial ya no continuó, el programa hizo cosas raras, y muy importante, no llamó a la función vApplicationStackOverflowHook(); el programa pareció haberse perdido. Es natural, ya que el desbordamiento de una pila tiene consecuencias desastrosas.

Veamos la salida de este programa cuando configCHECK_FOR_STACK_OVERFLOW es 2:

Aquí puedes ver que el programa se detuvo antes de que la memoria de la pila llegara 0, y aunque no se ve, sí entró a la función vApplicationStackOverflowHook(). Ya te decía que la función Serial.print() no es exactamente simplona, por lo cual no aparece el mensaje de error; sin embargo, en su lugar sí que el LED asociado a D2 se activó, y a diferencia de la ejecución anterior, el programa efectivamente se detuvo y dejó de hacer cosas raras. La hook que utilicé para este ejemplo es:

#if configCHECK_FOR_STACK_OVERFLOW > 0
void vApplicationStackOverflowHook( TaskHandle_t xTask, char *pcTaskName )
{
   Serial.print( "ERR: Desbordamiento de pila para la tarea: " );
   Serial.println( pcTaskName );

   digitalWrite( 2, HIGH );

   vTaskSuspendAll();
   taskDISABLE_INTERRUPTS();

   while( 1 )
      ;
}
#endif

¿Qué sigue?

Hoy vimos un tema algo delicado, importante y muy técnico relacionado con los sistemas operativos: la administración de la memoria. Vimos conceptos y herramientas que nos permiten identificar mientras desarrollamos o probamos la aplicación posibles desbordamientos del heap o de las pilas. También vimos que de las 5 implementaciones de malloc() que FreeRTOS incluye, debemos usar heap_3.c para el ATmega328.

RECUERDA: Siempre que te sea posible evita el uso de memoria dinámica y prefiere en su lugar la memoria estática.

RECUERDA: Si te vez utilizando la implementación heap_1.c, entonces puedes considerar usar memoria estática.

RECUERDA: Si estás desarrollando para el ATmega328 utiliza la implementación heap_3.c.

RECUERDA: Prefiere la implementación heap_4.c en lugar de la heap_2.c (en plataformas que no tengan problemas con ellas.

RECUERDA: FreeRTOS no devuelve inmediatamente la memoria cuando llamas a free(). FreeRTOS espera a que haya tiempo libre en el sistema para devolverla (a través de la tarea interna Idle_task).

RECUERDA: Cuando utilices configCHECK_FOR_STACK_OVERFLOW para atrapar los desbordamientos de las pilas prefiere el Método 2 (valor 2); ya vimos que es más seguro.

RECUERDA: Las herramientas para atrapar los desbordamientos del heap y de las pilas deberías utilizarlos únicamente mientras estás desarrollando tu aplicación. Puedes auxiliarte con la compilación condicional para eliminarla en código de producción.

Índice del curso

Espero que esta entrada haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Colas

Hasta el momento en este curso hemos visto tres formas de comunicación inter-tareas:

  1. Con notificaciones directas a la tarea.
  2. Con flujos.
  3. Con mensajes.

Y nos queda una por explorar: las colas. Este fue el primer mecanismo que implementó FreeRTOS para pasar grandes cantidades de datos entre tareas o entre interrupciones y tareas.

La diferencia entre los 3 mecanismos listados y las colas es que éstas puedes ser escritas y leídas por dos o más tareas. Además, la escritura y lectura se realiza estrictamente elemento por elemento.

Aunque históricamente las colas fueron el primer mecanismo para la comunicación inter-tareas, con el paso del tiempo, la retroalimentación de los usuarios de FreeRTOS, y la evolución de éste, los administradores del proyecto se dieron cuenta que podían implementar un mecanismo más ligero para pasar datos de una tarea a otra, ya que casi todo el tiempo esta es la forma de trabajar.

Pero eso no quiere decir que las colas sean obsoletas o que deban ser descartadas; todo lo contrario. En algún momento te verás en la necesidad de utilizarlas. En la sección de ejemplos vamos a ver una tarea que la hace de “controlador” o “concentrador”, mientras que dos tareas “producen” datos.

Aunque en el Arduino UNO no es posible lo siguiente, piensa en una interfaz gráfica. En éstas diversos periféricos generan eventos: una pantalla touch, algún botón o teclado físico, sensores de posición, temporizadores internos, puerto serial, etc. Todas estos eventos se guardan en una cola de eventos conforme van llegando. El “controlador” de la interfaz gráfica va despachando evento por evento, desde el más antiguo al más reciente (siempre en este orden).

Además, debes saber que las colas son la estructura de datos subyacente para otros mecanismos de FreeRTOS, como los semáforos (y su API primitiva) y los temporizadores por software.

Tabla de contenidos

¿Qué es y qué necesito?

Una cola (queue, en inglés, y pronunciada como [kiú]) es una estructura de datos con las siguientes características:

  • Es lineal. Es decir, todos los elementos, excepto el primero y el último, tienen un antecesor y un predecesor.
  • Se escribe por un extremo de la cola, y se lee por el extremo opuesto. Esto logra que el elemento que llegó primero sea el primero en ser atendido (al contrario de las pilas, donde el último elemento en llegar es el primero en ser atendido). Las colas también son conocidas como estructuras FIFO (first in, first out, primero en llegar, primero en salir).
  • El acceso a los elementos de enmedio, es decir, que no sean los extremos, está prohibido.
  • Aunque las colas son un tipo especial de listas, en las colas no se puede buscar un elemento ni se puede ordenar.

Las colas tienen dos operaciones básicas, más una auxiliar (muy útil), cuyos nombres varían de autor a autor, pero que significan lo mismo:

  • Insertar en la cola: Insert(), Insertar(), InsertFront(), Enqueue(), Push(), Send().
  • Extraer de la cola: Remove(), Remover(), RemoveBack(), Retrieve(), Dequeue(), Pop(), Receive().
  • Observar el elemento en el frente de la cola. Observar(), Peek().

(Los términos en negrita corresponden a los nombres que utiliza FreeRTOS para las respectivas operaciones, aunque yo en mis clases de Estructuras de Datos uso Enqueue(), Dequeue() y Peek(), pero como este es un curso de FreeRTOS, entonces utilizaré sus nombres para evitar confusiones.)

RECUERDA: Insertamos en la parte trasera (rear, back, tail) de la cola, y extraemos del frente (front, head) de la misma.

Al igual que con los mensajes, la operación Send() copia los datos en la cola, y Receive() copia los datos desde la cola. Si de plano es prohibitivo realizar las copias dado que cada dato sea muy grande, entonces puedes crear una cola de apuntadores (o referencias) y mantener los datos en búferes externos.

Para que puedas utilizar las colas en tus programas asegúrate incluir al encabezado #include <queue.h> en cada uno de ellos. Recuerda también que si vas a crear las colas con memoria dinámica, entonces deberás poner a 1 la constante configSUPPORT_DYNAMIC_ALLOCATION; y si vas a crear las colas con memoria estática, entonces deberás poner a 1 la constante configSUPPORT_STATIC_ALLOCATION, ambas en el archivo FreeRTOSConfig.h:

#define configSUPPORT_STATIC_ALLOCATION  1
#define configSUPPORT_DYNAMIC_ALLOCATION 1

Para facilitar el uso de las colas en nuestros programas escribí 4 constantes simbólicas, las cuales vamos a utilizar en los ejemplos de esta lección. De éstas tú estableces las dos primeras; las últimas 2 se calculan de manera automática. Por supuesto que puedes escribir directamente los valores donde sea necesario, pero en mi experiencia es preferible hacerlo de esta manera:

#define QUEUE_ELEMS ( 8 )

Es el número de elementos (no de bytes) de la cola.

#define QUEUE_TYPE uint16_t

Aquí estableces el tipo de dato del o de los elementos que va a guardar la cola. En este ejemplo se trata de variables uint16_t, pero podrían ser también de otros tipos básicos o tipos compuestos, como lo verás en los ejemplos.

#define QUEUE_TYPE_SIZE ( sizeof( QUEUE_TYPE ) )

Calcula el tamaño del tipo en bytes. No deberías manipularlo directamente.

#define QUEUE_BUFFER_SIZE ( ( QUEUE_ELEMS ) * ( QUEUE_TYPE_SIZE ) )

Calcula el número de bytes que necesita el búfer subyacente de la cola. No deberías manipularlo directamente.

Desarrollo

Las colas necesitan un búfer de datos interno, es decir, un lugar dónde guardar cada elemento. Este búfer es un arreglo de elementos uint8_t de tamaño ( QUEUE_ELEMS x QUEUE_TYPE_SIZE ) que estableces cuando creas a los objetos. Cuando utilizas creación dinámica de objetos este arreglo se crea de manera automática dentro de la función xQueueCreate(), por lo cual no debes preocuparte de nada (en apariencia. Siempre que te sea posible utiliza la creación estática de objetos, es más segura); mientras que si usas la creación estática de objetos, tú eres responsable de pasarle dicho arreglo a la función xQueueCreateStatic(). A continuación veremos ambas formas.

(Para conocer o recordar la diferencia y la configuración entre objetos dinámicos y estáticos, te recomiendo leer esta lección y esta otra lecciónrespectivamente. Aunque ambas hablan sobre tareas, la teoría aplica para cualquier tipo de objeto.)

CREACIÓN DINÁMICA

La función para crear mensajes dinámicos es:

uxQueueLength. Es el número máximo de elementos (no de bytes) que la cola almacenará. Puedes utilizar el valor QUEUE_ELEMS del que hablé hace un momento.

uxItemSize. Es el número de bytes que requiere un elemento. Puedes utilizar el valor QUEUE_TYPE_SIZE del que hablé hace un momento.

Valor devuelto. Si hubo memoria suficiente para crear la cola, entonces la función devuelve el handler; en caso contrario (no hubo memoria suficiente) devuelve NULL. Este handler lo debes de guardar, tanto para que el resto de funciones de flujos sepan sobre cuál van a operar, como para probar que efectivamente fue creado.

Por ejemplo, para crear una cola 10 elementos de tipo uint16_t, utilizando las constantes simbólicas anteriores, tendrías lo siguiente:

#include <FreeRTOS.h>
#include <task.h>
#include <queue.h>

QueueHandle_t g_queue_handler = NULL;
// el handler debe ser global

#define QUEUE_ELEMS ( 10 )
#define QUEUE_TYPE uint16_t
#define QUEUE_TYPE_SIZE ( sizeof( QUEUE_TYPE ) )

void setup()
{
   // código ...

   g_queue_handler = xQueueCreate( QUEUE_ELEMS, QUEUE_TYPE_SIZE );

   configASSERT( g_queue_handler );
   // Error creando a la cola

   // más código ...
}

El handler, g_queue_buffer, es global porque debe ser visible tanto en la tarea productora como en la consumidora.

La creación dinámica de objetos no asegura que los objetos se creen, principalmente por escasez de memoria RAM. Por eso siempre deberías preguntar si el objeto realmente fue creado, y aunque existen diversas maneras de hacerlo, en este ejemplo escogí la macro configASSERT() que es una versión propia de la conocida assert() de C (en el archivo FreeRTOSConfig.h podrás ver la implementación que utilicé para el projecto Molcajete). Por supuesto que puedes usar al condicional if y tratar de recuperarte sin terminar el programa de manera abrupta.

Creación estática

Ahora veamos cómo crear a un mensaje de manera estática. Como es usual, esta forma de creación de objetos necesita más pasos, pero es mucho más segura ya que los objetos siempre serán creados.

uxQueueLength. Es el número máximo de elementos (no de bytes) que la cola almacenará. Puedes utilizar el valor QUEUE_ELEMS del que hablé hace un momento.

uxItemSize. Es el número de bytes que requiere un elemento. Puedes utilizar el valor QUEUE_TYPE_SIZE del que hablé hace un momento.

pucQueueStorageBuffer. Es el búfer interno de la cola donde se guardarán los datos, y es un arreglo de tamaño ( uxQueueLength * uxItemSize ) bytes de elementos de tipo uint8_t. Este arreglo deberá existir a lo largo del programa, por lo cual deberás crearlo de manera global al programa, o estática a la función donde fue llamada xQueueCreateStatic().

pxQueueBuffer. Esta es la variable que guarda el estado de la cola. Al igual que el parámetro pucQueueStorageBuffer, deberá existir a lo largo del programa.

Valor devuelto. El handler al mensaje. La creación estática de objetos nunca falla, a menos que el arreglo o la variable de estado sean NULL, cosa que tal vez nunca suceda.

Un ejemplo de su uso es:

#include <FreeRTOS.h>
#include <task.h>
#include <queue.h>

QueueHandle_t g_queue_handler = NULL;
// el handler debe ser global

#define QUEUE_ELEMS ( 10 )
#define QUEUE_TYPE uint16_t
#define QUEUE_TYPE_SIZE ( sizeof( QUEUE_TYPE ) )

void setup()
{
   // código ...

   static uint8_t       queue_buffer_array[ QUEUE_BUFFER_SIZE ];
   static StaticQueue_t queue_buffer_struct;

   g_queue_handler = xQueueCreateStatic( 
         QUEUE_ELEMS, 
         QUEUE_TYPE_SIZE,
         queue_buffer_array,
         &queue_buffer_struct );


   // más código ...
}

En este ejemplo marqué a las variables queue_buffer_array y queue_buffer_struct como static; esto para que perduren durante todo el programa, pero que a la vez sean invisibles al resto de funciones. Una alternativa es que las declares globales, aunque entre menos variables globales tengas en tus programas, mejor. Sin embargo el handler, g_message_buffer, sí que debe ser global porque tanto la tarea productora como la consumidora deben tener acceso a él. Este es un ejemplo de las veces en que sí son necesarias las variables globales. El prefijo g_ nos recuerda que es una variable global y que debemos tener mucho cuidado con ella.

Escribiendo y leyendo hacia y desde la cola

Una vez que la cola fue creada ya puedes utilizarla escribiendo en y leyendo desde ella. Cuando escribes a la cola lo haces elemento por elemento (y por copia, no lo olvides); estos elementos son variables de tipos básicos o tipos compuestos. En el Ejemplo 2 más adelante utilizaremos estos últimos.

La función para escribir en la cola es:

xQueue. Es el handler a la cola.

pvItemToQueue. Es un apuntador al dato que quieres escribir. Éste debe ser promocionado a void* (apuntador a void). Esta función escribe en la parte trasera de la cola.

xTicksToWait. Si no hay espacio disponible en la cola para copiar un nuevo elemento, entonces la tarea productora (la que llama a esta función) entrará al estado Blocked por el tiempo determinado en este parámetro. Si el tiempo expira la tarea pasará al estado Ready. El tiempo de espera está en ticks y puedes usar la macro pdMS_TO_TICKS() para convertir milisegundos a ticks. Así mismo, si escribes 0 la función regresa inmediatamente, y si escribes portMAX_DELAY el tiempo de espera es infinito (siempre y cuando la constante simbólica INCLUDE_vTaskSuspend esté a 1).

Valor devuelto. Si el elemento se copió a la cola, entonces la función devuelve pdTRUE; en caso contrario devolverá errQUEUE_FULL.

Para leer un elemento desde la cola hacia el búfer de tu programa usamos la función xQueueReceive():

xQueue. Es el handler a la cola.

pvBuffer. Es un apuntador a la variable donde quieres guardar el elemento. Esta función lee del frente de la cola.

xTicksToWait. Si la cola está vacía, entonces no hay nada qué leer, por lo tanto la tarea consumidora (la que llama a esta función) entrará al estado Blocked por el tiempo determinado en este parámetro. Si el tiempo expira la tarea pasará al estado Ready. El tiempo de espera está en ticks y puedes usar la macro pdMS_TO_TICKS() para convertir milisegundos a ticks. Así mismo, si escribes 0 la función regresa inmediatamente, y si escribes portMAX_DELAY el tiempo de espera es infinito (siempre y cuando la constante simbólica INCLUDE_vTaskSuspend esté a 1).

Valor devuelto. Si el elemento se leyó de la cola, entonces la función devuelve pdTRUE; en caso contrario devolverá pdFALSE. (Esta es una inconsistencia en la documentación oficial de FreeRTOS, ya que si xQueueSend() devuelve el valor errQUEUE_FULL en caso de que la cola esté llena, entonces xQueueReceive() debería devolver errQUEUE_EMPTY cuando la cola esté vacía, la cual ¡sí existe! y además tiene el mismo valor que pdFALSE. En lo que obtengo una respuesta por parte de FreeRTOS usemos pdFALSE, o haz que tus condicionales se prueben contra pdTRUE.)

Ejemplos

Una vez que tenemos claro el concepto de cola, su uso es bastante simple. Vamos a ver 4 ejemplos que mostrarán diversos aspectos de la utilización de las colas:

  1. Creación dinámica de una cola de tipo simple. Una tarea produce y una tarea consume.
  2. Creación estática de una cola de tipo simple. Dos tareas producen y una tarea consume.
  3. Creación estática de una cola de tipo compuesto. Dos tareas producen y una tarea consume.
  4. Creación estática de una cola de tipo compuesto. Dos tareas producen y una tarea consume. El handler es pasado en el parámetro pvParameters.

Ejemplo 1: Creación dinámica de una cola de tipo simple

Este primer ejemplo la cola es creada de manera dinámica y la tarea productora (la cual es una nada más) escribe en bloques de QUEUE_ELEMS elementos, y la tarea consumidora los consume tan pronto como es posible. El uso del ciclo for no es necesario, todo depende de la fuente de datos que desees transmitir, pero para este ejemplo se me hizo conveniente simular la llegada de n elementos y luego hacer una pausa, y repetir el procedimiento:

#define PROGRAM_NAME "queues_1.ino"

#include <FreeRTOS.h>
#include <task.h>
#include <queue.h>


QueueHandle_t g_queue_handler = NULL;
// el handler debe ser global


#define QUEUE_ELEMS ( 10 )
// ¿Cuántos elementos tendrá la cola?

#define QUEUE_TYPE uint16_t
// ¿De qué tipo es el búfer?

#define QUEUE_TYPE_SIZE ( sizeof( QUEUE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo QUEUE_TYPE?


void producer_task( void* pvParameters )
{
   QUEUE_TYPE data = 10;

   while( 1 )
   {
      for( uint8_t i = 0; i < QUEUE_ELEMS; ++i ){
         if( xQueueSend( g_queue_handler, (void*) &data, pdMS_TO_TICKS( 100 ) ) != errQUEUE_FULL ){

            data += 10;

            vTaskDelay( pdMS_TO_TICKS( 10 ) );
            // simulamos un retardo entre escritura y escritura
         } 
         else{ // timeout:
            Serial.println( "TO(W)" );
         }
      }

      vTaskDelay( pdMS_TO_TICKS( 500 ) );
   }
}

void consumer_task( void* pvParameters )
{
   while( 1 )
   {
      QUEUE_TYPE data;

      while( xQueueReceive( g_queue_handler, &data, pdMS_TO_TICKS( 500 ) ) != errQUEUE_FULL ){
         Serial.println( data );
      }
   }
}

void setup()
{
   xTaskCreate( producer_task, "PROD", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );

   g_queue_handler = xQueueCreate( QUEUE_ELEMS, QUEUE_TYPE_SIZE );

   configASSERT( g_queue_handler );
   // Error creando a la cola

   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( PROGRAM_NAME );

   vTaskStartScheduler();
}

void loop() {}

De este ejemplo nota que utilicé las constantes simbólicas que describí hace un momento, y que la variable que deseas copiar a la cola debe ser promocionada a void*, como también ya lo había mencionado:

xQueueSend( g_queue_handler, (void*) &data, pdMS_TO_TICKS( 100 ) )

Así mismo, antes de salir de la función setup() he agregado una función que imprime el nombre del programa. Esto no es necesario, pero como para este curso he creado muchos programas, nunca estoy seguro cuál es el último que subí a mis tarjetas.

La salida de este programa es:

Ejemplo 2: Creación estática de una cola de tipo simple

En este ejemplo vamos a crear una cola de un tipo básico de manera estática. Además, dos tareas van a escribir en ella, y una tarea leerá de ella. Una tarea productora escribirá valores múltiplo de 10, mientras que la otra escribirá valores múltiplo de 7, y cuando llegue al valor arbitrario 350 (no tiene nada de especial), volverá a 0. Esto lo hice así para distinguir en la salida cuál tarea productora escribió cuál valor.

En los retardos notarás valores raros que realmente son números primos. Los utilicé para que no hubiera relación entre las diferentes temporizaciones tratando de simular un ambiente real. Debido a los diferentes tiempos de escritura y lectura la cola se llenará y presentarán los mensajes: TO(P2), el cual significa timeout en el productor 2; o el mensaje TO(P1), el cual significa timeout en el productor 1 (en ambos casos significa que la cola estaba llena y no pudieron escribir en ella).

Finalmente agregué una constante, USER_DBG, que permite habilitar (en diferentes grados) o deshabilitar información de depuración. Por supuesto que esto no sería necesario en un programa real (¿o tal vez sí?) pero como estamos experimentando es interesante saber lo que sucede en el programa.

#define PROGRAM_NAME "queues_2.ino"

#include <FreeRTOS.h>
#include <task.h>
#include <queue.h>


QueueHandle_t g_queue_handler = NULL;


#define QUEUE_ELEMS ( 10 )
// ¿Cuántos elementos tendrá la cola?

#define QUEUE_TYPE uint16_t
// ¿De qué tipo es el búfer?

#define QUEUE_TYPE_SIZE ( sizeof( QUEUE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo QUEUE_TYPE?

#define QUEUE_BUFFER_SIZE ( ( QUEUE_ELEMS ) * ( QUEUE_TYPE_SIZE ) )
// ¿Cuántos bytes tiene el búfer subyacente?


#define USER_DBG 1
// Para habilitar/deshabilitar información de depuración:
// 0: Deshabilitada
// 1: Información básica
// 2: Más información, pero puede hacer que el sistema falle (debido a Serial.print())



void producer1_task( void* pvParameters )
{
   QUEUE_TYPE data = 10;

   while( 1 )
   {

#if USER_DBG > 1
      Serial.print( "TX1: " ); Serial.println( data );
#endif  

      if( xQueueSend( g_queue_handler, (void*) &data, pdMS_TO_TICKS( 100 ) ) == pdFALSE ){
         Serial.println( "TO(P1)" );
      } else{
         data += 10;
         if( data > 1000 ) data = 10;
      }

      vTaskDelay( pdMS_TO_TICKS( 439 ) );
   }
}

void producer2_task( void* pvParameters )
{
   QUEUE_TYPE data = 0;

   while( 1 )

   {
#if USER_DBG > 1
      Serial.print( "TX2: " ); Serial.println( data );
#endif  

      if( xQueueSend( g_queue_handler, (void*) &data, pdMS_TO_TICKS( 100 ) ) != errQUEUE_FULL ){

         data += 7;
         if( data > 350 ) data = 0;

      } 
      else{ //timeout:
         Serial.println( "TO(P2)" );
      }

      vTaskDelay( pdMS_TO_TICKS( 397 ) );
   }
}

void consumer_task( void* pvParameters )
{
   TickType_t last_wake_time = xTaskGetTickCount();

   while( 1 )
   {
      QUEUE_TYPE data;

      vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( 311 ) );

      if( xQueueReceive( g_queue_handler, &data, pdMS_TO_TICKS( 509 ) ) == pdTRUE ){

#if USER_DBG > 0
         Serial.print( "RX: " ); Serial.println( data );
#endif  

#if USER_DBG > 1
         Serial.print( "SA: " ); Serial.println( uxQueueSpacesAvailable( g_queue_handler ) );
#endif  

      } else{ //timeout:
         Serial.println( "TO(R) " );
      }
   }
}

void setup()
{
   xTaskCreate( producer1_task, "PRD1", 128, NULL, tskIDLE_PRIORITY + 1, NULL );
   xTaskCreate( producer2_task, "PRD2", 128, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128, NULL, tskIDLE_PRIORITY, NULL );


   static uint8_t queue_buffer_array[ QUEUE_BUFFER_SIZE ];
   // búfer subyacente de la cola

   static StaticQueue_t queue_buffer_struct;
   // variable de estado de la cola

   g_queue_handler = xQueueCreateStatic( 
         QUEUE_ELEMS, 
         QUEUE_TYPE_SIZE,
         queue_buffer_array,
         &queue_buffer_struct );


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( PROGRAM_NAME );


   vTaskStartScheduler();
}

void loop() {}

La salida de este programa con USER_DBG puesta a 1 es:

Ejemplo 3: Creación estática de una cola de tipo compuesto

En ocasiones tendremos que transferir datos compuestos debido a que así está diseñado el sistema (no todo en la vida son tipos simples), o porque, como mencioné en la introducción, necesitamos saber quién escribió qué. En el ejemplo que dí sobre un controlador para una interfaz gráfica, el “controlador” debe conocer qué periférico generó el evento. Pero dado que el tipo de la cola es fijo debemos idear una manera de homogenizar la información; esto es, que cada periférico escriba información del mismo tipo.

El ejemplo que doy a continuación es una versión alterna y completa, pero simple, de un ejemplo que FreeRTOS ha incluído en su documentación oficial para encarar dicho problema.

Lo primero que vas a notar es la enumeración Event, la cual indica la fuente generó la información. Después viene el tipo compuesto, Data, que encapsula la fuente generadora y el dato generado:

typedef enum Event
{
   Sensor1,
   Sensor2,
} Event;

typedef struct Data
{
   Event    evt;
   uint16_t value;
} Data;

Luego cada una de las dos tareas que incluí en el ejemplo se identifican de manera permanente en el campo .evt de una variable data del tipo Data, dado que lo único que va a cambiar mientras el programa se esté ejecutando es el valor escrito en el campo .value de dicha variable (que hace las veces de búfer). Una tarea productora toma valores de temperatura, mientras que otra genera una secuencia numérica, y a diferencia de lo que hemos venido haciendo, ésta se puede bloquear (entrar al estado Blocked) por tiempo indefinido (solamente como ejemplo, en la vida real deberías evitar esta situación).

Finalmente, la tarea consumidora, que hace las veces de “controlador”, implementa un switch sobre el campo .evt para determinar de dónde provienen los datos y proceder de manera correcta.

#define PROGRAM_NAME "queues_3.ino"

#include <FreeRTOS.h>
#include <task.h>
#include <queue.h>

typedef enum Event
{
   Sensor1,
   Sensor2,
} Event;

typedef struct Data
{
   Event    evt;
   uint16_t value;
} Data;

QueueHandle_t g_queue_handler = NULL;


#define QUEUE_ELEMS ( 5 )
// ¿Cuántos elementos tendrá la cola?

#define QUEUE_TYPE Data
// ¿De qué tipo es el búfer?

#define QUEUE_TYPE_SIZE ( sizeof( QUEUE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo QUEUE_TYPE?

#define QUEUE_BUFFER_SIZE ( ( QUEUE_ELEMS ) * ( QUEUE_TYPE_SIZE ) )
// ¿Cuántos bytes ocupa el búfer subyacente?


#define USER_DBG 1

void sensor1_task( void* pvParameters )
{
   QUEUE_TYPE data = { .evt = Sensor1, .value = 0 };

   while( 1 )
   {
      data.value = analogRead( A0 ) & 0x03FF;
      // sensor de temperatura LM35
      
      if( xQueueSend( g_queue_handler, (void*) &data, pdMS_TO_TICKS( 100 ) ) == errQUEUE_FULL ){
         Serial.println( "TO(S1)" );
      }

      vTaskDelay( pdMS_TO_TICKS( 457 ) );
   }
}

void sensor2_task( void* pvParameters )
{
   QUEUE_TYPE data = { .evt = Sensor2, .value = 0 };

   while( 1 )
   {
      xQueueSend( g_queue_handler, (void*) &data, portMAX_DELAY );

      data.value += 10;
      if( data.value > 500 ) data.value = 0;

      vTaskDelay( pdMS_TO_TICKS( 397 ) );
   }
}

void controller_task( void* pvParameters )
{
   TickType_t last_wake_time = xTaskGetTickCount();

   while( 1 )
   {
      QUEUE_TYPE data;

      vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( 257 ) );

      if( xQueueReceive( g_queue_handler, &data, pdMS_TO_TICKS( 509 ) ) == pdTRUE ){

         switch( data.evt )
         {
         case Sensor1:
            Serial.print( "SENSOR1: " );
            Serial.println( data.value );
         break;

         case Sensor2:
            Serial.print( "SENSOR2: " );
            Serial.println( data.value );
         break;

         default:
            Serial.println( "ERR" );
         break;
         }

      } else{ //timeout:
         Serial.println( "TO(R) " );
      }
   }
}

void setup()
{
   xTaskCreate( sensor1_task, "SNS1", 128, NULL, tskIDLE_PRIORITY + 1, NULL );
   xTaskCreate( sensor2_task, "SNS2", 128, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( controller_task, "CTRL", 128, NULL, tskIDLE_PRIORITY, NULL );


   static uint8_t       queue_buffer_array[ QUEUE_BUFFER_SIZE ];
   static StaticQueue_t queue_buffer_struct;

   g_queue_handler = xQueueCreateStatic( 
         QUEUE_ELEMS, 
         QUEUE_TYPE_SIZE,
         queue_buffer_array,
         &queue_buffer_struct );


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( PROGRAM_NAME );


   vTaskStartScheduler();
}

void loop() {}

La salida de este programa es:

En el ejemplo anterior escribí el valor en bruto entregado por el sensor de temperatura LM35, que al momento de ejecutar el programa reportaba valores alrededor de 52-53. Pero si quisieras ver el valor correspondiente a la temperatura podrías modificar el case de Sensor1:

case Sensor1:
  Serial.print( "SENSOR1: " );
  Serial.println( (float) (data.value*500.0/1024.0) );
break;

(En esta entrada mi blog alternativo describí las diferentes partes de la fórmula, por si te interesa conocerlas.)

La salida del programa ya con la temperatura en grados centígrados es:

Ejemplo 4: Creación estática de una cola de tipo compuesto. El handler es pasado en el parámetro pvParameters.

NOTA: La siguiente solución no funciona cuando uno de los productores o uno de los consumidores es una interrupción, ya que la única forma de que ésta tenga acceso al handler es haciéndolo global.

En todos los ejemplos vistos el handler a la cola fue declarado como global y cualquier tarea podría escribir hacia o leer desde ella. En muchas situaciones esto quizás no sea importante, pero en otras sería mejor restringir qué tareas tienen acceso a la cola.

Ya en la lección sobre Semáforos Mutex exploramos cómo limitar el acceso a un monitor solamente por las tareas interesadas. Aquella vez usamos, y hoy lo volveremos a hacer, el parámetro pvParameters (que cada tarea incluye) para pasarle el handler. De esta manera solamente las tareas involucradas podrán accesar a la cola. Así mismo, el handler a la misma deja de ser global (entre menos globales mejor) ya que la declararemos static en la función setup().

En principio esta modificación es sencilla, pero el demonio está en los detalles, y como siempre sucede en C/C++, el demonio se presenta en forma de apuntador. Voy a diseccionar el código para intentar explicar el procedimiento; al final de la sección estará el programa completo. ¡No parpadees!

En la función setup() declaramos como static el handler a la cola. Luego le pasamos a las funciones de creación de tareas la dirección del handler promocionada a void*. (El handler ya es un apuntador, así que estamos pasando la dirección del apuntador.)

void setup()
{
   static QueueHandle_t queue_handler;
   // este es el handler (internamente es un apuntador)

   xTaskCreate( 
      sensor1_task, 
      "SNS1", 
      128, 
      (void*) &queue_handler, // aquí pasamos la dirección del handler
      tskIDLE_PRIORITY + 1, 
      NULL );

   xTaskCreate( sensor2_task, "SNS2", 128, (void*) &queue_handler, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( controller_task, "CTRL", 128, (void*) &queue_handler, tskIDLE_PRIORITY, NULL );

   // más código ...
}

Después, en cada tarea que deba recibir al handler de la cola debemos crear una variable que guarde la dirección del handler. Finalmente tenemos que desreferenciar dicha variable para accesar al handler propiamente dicho:

void sensor1_task( void* pvParameters )
{
   QueueHandle_t* queue = (QueueHandle_t*) pvParameters;
   // queue guarda la dirección del handler

   while( 1 )
   {
      if( xQueueSend( 
           *queue,        // desreferenciamos la variable queue para obtener el handler
           (void*) &data, 
           pdMS_TO_TICKS( 100 ) ) == pdFALSE ){
         
           // más código ...
      }
      // más código ...
   }
}

¡Wow, esos apuntadores que nos vuelven locos! A continuación te presento el programa completo:

#define PROGRAM_NAME "queues_4.ino"

#include <FreeRTOS.h>
#include <task.h>
#include <queue.h>

typedef enum Event
{
   Sensor1,
   Sensor2,
} Event;

typedef struct Data
{
   Event    evt;
   uint16_t value;
} Data;


#define QUEUE_ELEMS ( 5 )
// ¿Cuántos elementos tendrá la cola?

#define QUEUE_TYPE Data
// ¿De qué tipo es el búfer?

#define QUEUE_TYPE_SIZE ( sizeof( QUEUE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo QUEUE_TYPE?

#define QUEUE_BUFFER_SIZE ( ( QUEUE_ELEMS ) * ( QUEUE_TYPE_SIZE ) )
// ¿Cuántos bytes el búfer subyacente?


void sensor1_task( void* pvParameters )
{
   QueueHandle_t* queue = (QueueHandle_t*) pvParameters;

   QUEUE_TYPE data = { .evt = Sensor1, .value = 0 };

   while( 1 )
   {
      data.value = analogRead( A0 ) & 0x03FF;
      // sensor de temperatura LM35
      
      if( xQueueSend( *queue, (void*) &data, pdMS_TO_TICKS( 100 ) ) == pdFALSE ){
         Serial.println( "TO(S1)" );
      }

      vTaskDelay( pdMS_TO_TICKS( 457 ) );
   }
}

void sensor2_task( void* pvParameters )
{
   QueueHandle_t* queue = (QueueHandle_t*) pvParameters;

   QUEUE_TYPE data = { .evt = Sensor2, .value = 0 };

   while( 1 )
   {
      xQueueSend( *queue, (void*) &data, portMAX_DELAY );

      data.value += 10;
      if( data.value > 500 ) data.value = 0;

      vTaskDelay( pdMS_TO_TICKS( 397 ) );
   }
}

void controller_task( void* pvParameters )
{
   QueueHandle_t* queue = (QueueHandle_t*) pvParameters;

   TickType_t last_wake_time = xTaskGetTickCount();

   while( 1 )
   {
      vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( 257 ) );

      QUEUE_TYPE peek;
      if( xQueuePeek( *queue, &peek, 0 ) == pdFALSE ){
         Serial.println( "NO EVENTS" );
      } else{
         Serial.print( "NEXT EVENT: " );
         Serial.println( peek.evt );
      }

      QUEUE_TYPE data;

      if( xQueueReceive( *queue, &data, pdMS_TO_TICKS( 509 ) ) == pdTRUE ){

         switch( data.evt )
         {
         case Sensor1:
            Serial.println( (float) ( data.value*500.0/1024.0) );
         break;

         case Sensor2:
            Serial.println( data.value );
         break;

         default:
            Serial.println( "ERR" );
         break;
         }

      } else{ //timeout:
         Serial.println( "TO(R) " );
      }
   }
}

void setup()
{
   static QueueHandle_t queue_handler;

   xTaskCreate( sensor1_task, "SNS1", 128, (void*) &queue_handler, tskIDLE_PRIORITY + 1, NULL );
   xTaskCreate( sensor2_task, "SNS2", 128, (void*) &queue_handler, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( controller_task, "CTRL", 128, (void*) &queue_handler, tskIDLE_PRIORITY, NULL );


   static uint8_t       queue_buffer_array[ QUEUE_BUFFER_SIZE ];
   static StaticQueue_t queue_buffer_struct;

   queue_handler = xQueueCreateStatic( 
         QUEUE_ELEMS, 
         QUEUE_TYPE_SIZE,
         queue_buffer_array,
         &queue_buffer_struct );


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( PROGRAM_NAME );


   vTaskStartScheduler();
}

void loop() {}

La función controller_task() usa una operación muy importante de las colas que mencioné en la introducción, la operación xQueuePeek(), la cual no habíamos utilizado hasta ahora, cuya función es devolver la copia del elemento al frente de la cola, pero sin extraerlo. No era necesaria en el ejemplo, pero quise que vieras su utilización.

La salida del programa es:

Otras funciones

La API de colas es muy grande (la puedes revisar aquí), por lo que sólo te voy a platicar de algunas funciones que pudieran ser importantes.

Colas e interrupciones

Como ya es costumbre en FreeRTOS, debes tener mucho cuidado con las funciones que llames desde dentro de una interrupción. Cuando se dé el caso asegúrate que las funciones sean thread-safe, es decir, aquellas que terminan en FromISR. Las versiones thread-safe de las funciones que hemos vistos hasta el momento son:

BaseType_t xQueueSendFromISR(    QueueHandle_t xQueue, const void *pvItemToQueue, BaseType_t *pxHigherPriorityTaskWoken );
BaseType_t xQueueReceiveFromISR( QueueHandle_t xQueue, void *pvBuffer, BaseType_t *pxHigherPriorityTaskWoken );
BaseType_t xQueuePeekFromISR(    QueueHandle_t xQueue, void *pvBuffer );

Los primeros dos argumentos son idénticos a sus contrapartes; el último, pxHigherPriorityTaskWoken, indica si una tarea de mayor prioridad a la que está ejecutándose salió del estado Blocked cuando la respectiva función fue llamada y, en consecuencia, debe ser ejecutada a continuación.

Nota que ninguna de estas funciones incluye al parámetro de tiempo de espera, xTicksToWait, ya que no tiene sentido (y jamás debería suceder) que una tarea se bloquee dentro de una interrupción.

En esta lección podrás ver cómo se utiliza el parámetro pxHigherPriorityTaskWoken en una interrupción. No creo que tengas problemas en adaptar el ejemplo para usar colas.

Funciones para ver o alterar el estado de la cola

A veces es necesario preguntar por la cantidad de elementos que aún pueden ser insertados en la cola, o por la cantidad de elementos actualmente en la cola. FreeRTOS proporciona sendas funciones:

UBaseType_t uxQueueSpacesAvailable( QueueHandle_t xQueue );
// devuelve el número de elementos que aún pueden ser insertados

UBaseType_t uxQueueMessagesWaiting( QueueHandle_t xQueue );
// devuelve el número de elementos actualmente en la cola

UBaseType_t uxQueueMessagesWaitingFromISR( QueueHandle_t xQueue );
// es la versión thread-safe de uxQueueMessagesWaiting

IMPORTANTE: Nunca uses uxQueueMessagesWaiting() ni uxQueueSpacesAvailable() en situaciones como la siguiente, porque el programa no funcionará (ya le pasó al primo de un amigo. Aquí la discusión completa):

while( 1 )
{
  if( uxQueueMessagesWaiting( queue_handler ) > 0 ){
      // aquí consumes los datos
  } 
  // El programa llega aquí si no hay elementos en la cola, pero el proceso puede ser tan
  // rápido que no "preste" la CPU y el programa se quede colgado, dado que dentro de
  // uxQueueMessagesWaiting() las interrupciones se desactivan y reactivan (en ese orden)
}

En su lugar agrega un else que llame a una función bloqueante:

while( 1 )
{
  if( uxQueueMessagesWaiting( queue_handler ) > 0 ){
      // aquí consumes los datos
  } 
  else {
     vTaskDelay( 1 ); // o cualquier otra función que se bloquée
  }
}

Cuando necesites “limpiar” la cola, sin necesidad de destruirla y volverla a crear, puedes usar a la función xQueueReset:

BaseType_t xQueueReset( QueueHandle_t xQueue );
// siempre devuelve pdTRUE. Pone a su estado original a la cola

FreeRTOS incluye un par de funciones que deben ser usadas dentro de interrupciones para preguntar si una cola está llena o vacía:

BaseType_t xQueueIsQueueFullFromISR( const QueueHandle_t xQueue );
// devuelve pdTRUE si la cola está llena; o pdFALSE en caso contrario

BaseType_t xQueueIsQueueEmptyFromISR( const QueueHandle_t xQueue );
// devuelve pdTRUE si la cola está vacía; o pdFALSE en caso contrario

NOTA: De manera extraña no existen las contrapartes de estas funciones que se puedan usar en tareas regulares.

¿Qué sigue?

Hoy vimos el 4to mecanismo que FreeRTOS incluye para llevar a cabo la comunicación inter-tareas, la cual es una actividad fundamental en cualquier programa secuencial o concurrente.

Estudiamos las funciones más importantes de la API de las colas; sin embargo, siempre podrás estudiar por tu cuenta aquellas que no vimos.

RECUERDA: Utiliza las constantes que te di al principio de esta lección, en lugar de calcular por tu cuenta los diferentes tamaños de búferes.

RECUERDA: Siempre que te sea posible utiliza objetos estáticos.

RECUERDA: Si vas a llamar a una función de FreeRTOS desde una interrupción, verifica que ésta sea la versión thread safe, es decir, tenga terminación FromISR.

RECUERDA: Las colas se utilizan cuando en la transferencia de datos intervienen dos o más productores, o dos o más consumidores. Si la transferencia se va a llevar uno-a-uno, entonces podrías usar las versiones “ligeras”, como los mensajes.

Índice del curso

Espero que esta entrada haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Semáforos Mutex

Nuestros sistemas embebidos tienen un conjunto limitado de recursos, ya sean internos (UART, SPI, I2C, USB, ADC, DAC, áreas de memoria (búfers), etc), o externos (LCD, teclado, etc). En programas secuenciales (mono-tarea o de tarea única) prácticamente no existe ningún peligro de que una función que escribe en la UART sea interrumpido por otro; lo normal es que una función escriba (o lea) de la UART de principio a fin. Después, otra función, que en la lógica del programa va después, podrá utilizar a la UART de manera segura.

Sin embargo, la programación concurrente o multi-tarea trae consigo una serie de problemas de los cuales debemos estar conscientes y conocer las diferentes técnicas que existen para resolverlos. Uno de estos problemas tiene que ver con los recursos compartidos. Un recurso compartido es un recurso (como los mencionados) que puede ser utilizado por diversas partes del programa y es en lo que vamos a concentrarnos en esta lección.

Otros problemas asociados con la programación concurrente son: deadlocks (bloqueo mutuo), starvation (inanición), y priority inversion (inversión de prioridad). Ninguno es bueno.

Un problema que se presenta en los programas concurrentes es la competencia entre tareas por un mismo recurso compartido (race condition, en inglés, y condición de carrera, en español). Esto es, mientras una tarea de baja prioridad está utilizando un recurso (la impresión a través de la UART, por ejemplo) el sistema operativo decide que es momento de darle la CPU a una tarea de más alta prioridad, y esta otra tarea también utiliza a la UART imprimiendo sus propios mensajes. Cuando termina le devuelve la CPU a la tarea que había interrumpido para que continúe. La salida de un programa de esta naturaleza se ve así:

La tarea de baja prioridad imprime el texto: “abcd...789“; mientras que la tarea de alta prioridad imprime: “HOLA ... mundo“. Nota la mezcla de los textos. Lo mismo podría suceder con una pantalla LCD (ya me pasó), o con las conversiones del ADC, o con la transmisión de datos por SPI o I2C.

La impresión de texto mezclado puede llegar a ser hasta curiosa; sin embargo, el problema podría ser más grave. Por ejemplo, el convertidor ADC del ATmega328 corrompe las lecturas si a la mitad de una conversión inicias otra (ya me pasó, también). El ADC es un sólo módulo con 6 canales. Si tienes dos o más tareas realizando lecturas independientes en dos o más canales diferentes, entonces corres el peligro de obtener lecturas erróneas, y por lo tanto, nada fiables. Una solución es tener un concentrador para el ADC (le decimos “proxy” en el argót), o utilizar un mutex, lo cual, además de ser más fácil, es el tema de la lección de hoy.

A modo de anécdota te platico sobre uno de mis diseños, la tarjeta tipo PLC UB-PLR328. Cuando la estaba programando enfrenté el siguiente reto, al cual quizás tú también ya te enfrentaste: utilizar I2C para controlar diversos dispositivos. En particular la UB-PLR328 utiliza el canal I2C para 3 cosas: leer la hora de un reloj/calendario MCP79410, escribir a un LCD vía un PCF8574, y leer de un teclado vía otro PCF8574 (aquí puedes ver un video donde muestro los 3 elementos trabajando). Si suponemos que el acceso a cada uno de estos dispositivos es secuencial en un programa mono-tarea, entonces no tendremos preocupaciones mayores, quizás un poco con la lectura y decodificación del teclado. Sin embargo, en un programa multi-tarea sí que debemos preocuparnos y extremar precauciones, ¿qué tal si mientras una tarea quiere leer la hora, otra tarea quiere decodificar al teclado, y otra escribir al LCD? Continúa leyendo para que veas cómo podemos resolver esta situación utilizando mutex‘es.

Una forma de atacar este problema es con la exclusión mutua: evitar que una tarea accese a un recurso compartido mientras éste está siendo utilizado. Para implementar la exclusión mutua usamos semáforos mutex (le estaré diciendo “el mutex” a partir de ahora). El nombre mutex viene del inglés MUTual EXclusion. Los mutex son semáforos binarios con un par de características interesantes que ya veremos más adelante. El funcionamiento de la exclusión mutua es que mientras una tarea posea al mutex ninguna otra tarea podrá accesar al recurso compartido. Una vez que la tarea que tenía al mutex lo devuelve, entonces la otra tarea que esperaba por él lo obtendrá y podrá accesar al recurso. Hoy vamos a estudiar los mutex y las funciones de semáforos de FreeRTOS.

Además, y como agradecimiento a tu apoyo para la realización de este curso, vamos a estudiar brevemente a los monitores, los cuales son una versión de alto nivel para implementar la exclusión mutua. Veremos sus características y su implementación como clases de C++.

Tabla de contenidos

¿Qué es y qué necesito?

Exclusión mutua y semáforos mutex

La exclusión mutua se implementa a partir de identificar las secciones críticas del programa; esto es, encontrar los lugares donde, para el problema que nos concierne, están ubicados los accesos al recurso compartido y convertirlas en operaciones atómicas (operaciones que no pueden ser interrumpidas hasta terminar). Para el ejemplo de la UART (y el servicio asociado Serial.print() de Arduino) el pseudocódigo de una sección crítica se vería así:

Tarea()
{
   While( 1 )
   {
      // código ...

      critical_section_enter()       // entramos a la sección crítica
      Serial.println( "Hola mundo" ) // usamos al recurso como una operación atómica
      critical_section_exit()        // salimos de la sección crítica

      // ... más código
   }
}

La entrada y salida de una sección crítica puede ser implementada de diversas formas, incluyendo desactivar las interrupciones mientras el recurso es utilizado. Afortunadamente nosotros no debemos hacer eso; en su lugar utilizaremos semáforos mutex.

Un semáforo mutex es un semáforo binario con dos características especiales:

  1. El mutex puede heredar prioridades de manera temporal. Digamos que una tarea de baja prioridad, TL, posee al mutex, y mientras esto sucede una tarea de mayor prioridad, TH, desea adquirlo. Bajo estas condiciones el sistema operativo eleva la prioridad de TL al mismo nivel que TH de manera temporal. De esta forma se asegura hasta cierto punto, que TL devolverá el mutex lo más pronto posible para que TH lo utilice. Cuando TL devuelve el mutex su prioridad es restablecida. Los semáforos binarios no tienen esta característica.
  2. El mutex debe ser devuelto. La tarea que posee al mutex debe devolverlo tan pronto como termine su trabajo para que otras tareas lo puedan obtener, y en consecuencia, accesar al recurso. No es un requisito que los semáforos deban ser devueltos, de hecho, casi nunca se hace.

RECUERDA: Mientras un semáforo binario se utiliza para sincronización y señalización (por ejemplo, una ISR lo da de manera constante, mientras que una tarea lo obtiene también de manera constante), los mutex’es se utilizan para proteger recursos compartidos de ser accesados por dos o más tareas al mismo tiempo.

El pseudocódigo anterior, utilizando mutex’es, nos quedaría así:

Tarea()
{
   While( 1 )
   {
      // código ...

      take( mutex )                  // obtiene al mutex
      Serial.println( "Hola mundo" ) // usa al recurso
      give( mutex )                  // devuelve al mutex
      
      // ... más código
   }
}

Si el mutex no estuviera disponible cuando se hace la llamada take(), entonces el sistema operativo manda a la tarea al estado Blocked y la inserta en una cola de espera. Cuando el recurso es liberado a través de la llamada a give(), entonces el sistema operativo saca de la cola de espera a la tarea que más tiempo ha estado esperando por el recurso.

Un poco más adelante veremos las funciones de FreeRTOS para semáforos mutex. A continuación abordaré brevemente el tema de los monitores, los cuales harán a nuestros programas más seguros.

Monitores

Un monitor es un tipo abstracto que encapsula al recurso y al mutex, y expone las únicas operaciones que pueden ser realizadas sobre el recurso.

En la descripción dada sobre mutex’es, y en general, sobre semáforos, notarás que estos no tienen dueño ni control sobre quién lo da y quién lo obtiene. Este es un problema “normal” con los semáforos: cualquier tarea podría obtenerlo y no devolverlo, o utilizarlo sobre un recurso diferente para el que fue creado.

Una forma de enfrentar estos problemas es encapsulando en una misma entidad (tipo abstracto, clase) al mutex junto con el recurso, y exponer un conjunto básico de operaciones que serán las únicas que podrán accesar al recurso. De esta forma sería muy difícil utilizar de manera incorrecta al recurso, o aplicarle el mutex a un recurso diferente.

En los ejemplos de mutex’es que veremos más adelante el recurso a proteger es la impresión serial a través de la función Serial.print(), y podremos usar a esta función de todas las maneras posibles que necesitemos. Pero cuando implementemos al monitor solamente dos operaciones estarán disponibles: escribir una cadena de texto completa, y escribir una cadena de texto completa caracter por caracter. El cliente del monitor no puede hacer nada más, dado que esas son las únicas operaciones expuestas, y siempre operarán sobre el mismo recurso. Por otro lado, podría ser que el cliente ni siquiera se entere que dentro del monitor existe un mutex (ventajas de los tipos abstractos); o podría suceder que el cliente vea al monitor como si fuese el propio recurso (esto sería lo más deseable). Aunque más adelante veremos a detalle la implementación del monitor, te quiero presentar las únicas dos operaciones que decidí sobre el recurso serial:

class Monitor
{
private:

   // declaración del mutex y el recurso
   
public:

   // aquí va el constructor

   // estas son las únicas operaciones permitidas sobre el recurso:

   bool PrintAll(      const char* text );
   bool PrintOneByOne( const char* text, uint8_t len );
};

Mutex’es de FreeRTOS

Para usar mutex’es necesitas utilizar las primitivas de FreeRTOS de semáforos. En lecciones anteriores vimos cómo implementar semáforos binarios y semáforos contadores con un mecanismo nuevo y de bajo consumo de recursos de FreeRTOS: las notificaciones directas a la tarea. Sin embargo, por las características especiales ya mencionadas de los mutex’es sólo hay una forma de implementación en FreeRTOS y es utilizando su API primitiva de semáforos. Para ello tienes que activar esta funcionalidad en el archivo FreeRTOSConfig.h:

#define configUSE_MUTEXES 1

Y también tienes que incluir en tus códigos fuente el archivo de encabezado #include <semphr.h>. Como dato interesante debes tener en cuenta que las primitivas de semáforos de FreeRTOS utilizan colas, por lo cual el tamaño de los programas puede crecer un poco.

Desarrollo

Para usar mutex’es debes crearlos, y como siempre, hay dos formas de hacerlo, de manera dinámica y de manera estática. Si no recuerdas la diferencia entre una y otra, sus ventajas y desventajas, entonces puedes revisar esta lección y esta otra. Comencemos con la primera ya que es la más fácil:

Creación dinámica de mutex’es

Esta función no tiene argumentos.

Valor devuelto: Handler al semáforo recién creado. Antes de usarlo deberías verificar que realmente se creó. (NOTA: Aunque las funciones para manipular los mutex son las mismas que las de los semáforos binarios y contadores de la API primitiva de semáforos, cuida de no mezclarlos.)

Para crear un mutex dinámico puedes hacer lo siguiente:

#include <FreeRTOS.h>
#include <task.h>
#include <semphr.h>

SemaphoreHandle_t g_mutex = NULL;
// debe ser global

void setup()
{
   // código ...

   g_mutex = xSemaphoreCreateMutex();

   configASSERT( g_mutex );
   // error creando al mutex

   // ... más código
}

Creación estática de mutex’es

pxMutexBuffer. Puntero a una variable StaticSemaphore_t que mantendrá el estado del semáforo. Esta variable deberá existir durante toda la vida del programa, por lo cual deberás crearla de manera global o estática a la función donde fue llamada xSemaphoreCreateMutexStatic().

Valor devuelto: Handler al semáforo recién creado. Los objetos estáticos siempre son creados. (NOTA: Aunque las funciones para manipular los mutex son las mismas que las de los semáforos binarios y contadores de la API primitiva de semáforos, cuida de no mezclarlos.)

Para crear un mutex estático puedes hacer lo siguiente:

#include <FreeRTOS.h>
#include <task.h>
#include <semphr.h>

SemaphoreHandle_t g_mutex = NULL;
// debe ser global

void setup()
{
   // código ...

   static StaticSemaphore_t* mutex_buffer;
   // variable de estado del mutex
   
   g_mutex = xSemaphoreCreateMutexStatic( &mutex_buffer );

   // la creación estática nunca falla

   // ... más código
}

En este ejemplo, como en muchos otros donde creamos objetos estáticos, las variables de estado y los arreglos necesarios los hemos creado marcándolos como static. Gracias a esto la variable mutex_buffer existirá durante todo el programa, y al mismo tiempo estará oculta al resto de las funciones. Por supuesto que podrías declararla global (como con g_mutex), pero entre menos variables globales tengas, mejor. g_mutex debe ser global porque tiene que ser accesada por varias tareas; la variable de estado mutex_buffer, no. (En el Ejemplo 4 veremos una forma para que g_mutex deje de ser global, ya sea que uses monitores o no.)

Dando y obteniendo al mutex

Una vez que el mutex ha sido creado lo podemos utilizar con las funciones para darlo y obtenerlo, xSemaphoreGive() y xSemaphoreTake(), respectivamente.

xSemaphore. Handler del mutex.

xTicksToWait. Tiempo de espera, en ticks, para obtener el mutex. Para convertir milisegundos a ticks puedes utilizar la macro pdMS_TO_TICKS(). Para no esperar puedes escribir 0; para un tiempo de espera infinito escribe portMAX_DELAY (asegúrate que la constante INCLUDE_vTaskSuspend, en el archivo FreeRTOSConfig.h, está puesta a 1).

xSemaphore. Handler del mutex.

Valor devuelto. pdTRUE si el mutex fue devuelto; pdFALSE si el mutex no pudo ser devuelto. Esto podría suceder porque el mutex no fue obtenido de manera correcta en primer lugar.

Ejemplos

Vamos a ver 4 ejemplos. Los primeros dos tratan sobre la creación y uso de los mutex “en crudo” (uno con memoria dinámica y otro con memoria estática). El tercer ejemplo muestra la implementación simple, pero efectiva, de un monitor. El cuarto ejemplo es una versión mejorada y más segura del tercer ejemplo.

Ejemplo 1: Mutex dinámico

Veamos un ejemplo completo con mutex dinámico. El programa trata de lo siguiente: el recurso a proteger es la transmisión al puerto serial a través de la función Serial.print(). Hay dos tareas, una con prioridad más alta que la otra (a_task y another_task, respectivamente), y ambas imprimen una cadena larga. A la tarea con baja prioridad le puse un truco para que se tomara mucho tiempo en escribir y pudiera ser interrumpida a la mitad por la tarea con más prioridad.

Al programa le agregué un mecanismo para activar/desactivar el mutex. En un programa normal esto no es necesario, ni deseable, pero lo hice para que puedas ver los resultados con y sin mutex.

#include <FreeRTOS.h>
#include <task.h>
#include <semphr.h>


SemaphoreHandle_t g_mutex = NULL;
// debe ser global


#define MUTEX_EN 0
// Habilita/deshabilita al mutex
// 0: Deshabilitado
// 1: Habilitado

void a_task( void* pvParameters )
{
   char str[66] = "HOLA MUNDO hola mundo HOLA MUNDO hola mundo HOLA MUNDO hola mundo";

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 50 ) );

#if MUTEX_EN == 1
      if( xSemaphoreTake( g_mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){
      // toma el mutex; si no está disponible, entonces la tarea se va al estado Blocked
#endif
        
         Serial.println( str );

#if MUTEX_EN == 1
         xSemaphoreGive( g_mutex );
         // devuelve el mutex

      } else{ // timeover:
         Serial.println( "MTX(W)" );
      }
#endif
   }
}

void another_task( void* pvParameters )
{
   char str[63] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 47 ) );

#if MUTEX_EN == 1 // Con mutex:

      if( xSemaphoreTake( g_mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){
      // toma el mutex; si no está disponible, entonces la tarea se va al estado Blocked

         for( uint8_t i = 0; i < 62; ++i ){
            Serial.print( str[ i ] );
            vTaskDelay( pdMS_TO_TICKS( 1 ) );
         }
         Serial.println( "" );


         xSemaphoreGive( g_mutex );
         // devuelve el mutex

      } else{ // timeover:
         Serial.println( "MTX(R)" );
      }

#else            // Sin mutex:

      for( uint8_t i = 0; i < 62; ++i ){
         Serial.print( str[ i ] );
         vTaskDelay( pdMS_TO_TICKS( 1 ) );
      }
      Serial.println( "" );

#endif
   }
}

void setup()
{
   xTaskCreate( a_task, "PROD", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( another_task, "CONS", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );

   g_mutex = xSemaphoreCreateMutex();

   configASSERT( g_mutex );
   // error creando al mutex


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( "\n*** RESET ***" );

   vTaskStartScheduler();
}

void loop() {}

RECUERDA: Cuando la tarea termina con el recurso DEBE devolver al mutex. En las líneas 31 y 61 ambas tareas lo devuelven.

Podrás notar diferencias en la forma de activar/desactivar el mutex en cada una de las tareas. En la primera lo hice de tal modo que el código no se repitiera, mientras que en la segunda repetí el código. Lo hice así para que conozcas ambas formas; aunque en la segunda es más claro el uso del mutex, entre menos código copies y pegues, mejor.

La salida de este programa SIN mutex es así:

Programa sin mutex. La salidas de cada tarea se mezclan.

La salida de este programa CON mutex es así:

Programa con mutex. Cada tarea imprime correctamente.

Ejemplo 2: Mutex estático

Este ejemplo es casi idéntico al anterior, tanto que no lo voy a repetir, solamente voy a poner el código de la función setup() que es donde se crea al mutex estático. Todo lo demás se mantiene sin cambios:

void setup()
{
   xTaskCreate( a_task, "1T", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( another_task, "2T", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );


   static StaticSemaphore_t mutex_buffer;
   // variable de estado del mutex
   
   g_mutex = xSemaphoreCreateMutexStatic( &mutex_buffer );

    // la creación estática nunca falla


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( "\n*** RESET ***" );

   vTaskStartScheduler();
}

Ejemplo 3: Monitor

En este ejemplo vamos a ver una versión simple, pero funcional y efectiva, de un monitor. El recurso a proteger sigue siendo la salida serial, y el monitor está implementado como un tipo abstracto a través de una clase de C++. Ambos, el mutex y el recurso deben ser variables miembro de la clase, sin embargo, para este ejemplo particular el recurso que estamos protegiendo está declarado a nivel global dentro de la arquitectura de Arduino, por lo cual no aparece declarado en la clase, pero en cualquier otro caso el recurso debería ser declarado como variable miembro de la clase que implementa al monitor, y de ser necesario, inicializarlo en el constructor:

class Monitor
{
private:
   SemaphoreHandle_t mutex{ NULL };

   // Resource resource;
   // aquí iría la declaración del recurso, pero Serial.print() es global al
   // sistema, así que sólo supondremos que lo hacemos

public:
   Monitor();

   bool PrintAll( const char* text );
   bool PrintOneByOne( const char* text, uint8_t len );
};

El monitor expone dos operaciones: PrintAll() y PrintOneByOne(). Estas son las únicas operaciones que se pueden realizar sobre el recurso. Además, por supuesto, está el constructor:

Monitor::Monitor()
{
   this->mutex = xSemaphoreCreateMutex();

   // deberíamos verificar que el mutex fue creado ... o mejor aún, crearlo de
   // manera estática

   // si el recurso necesita ser creado o inicializado, aquí lo haríamos
}

bool Monitor::PrintAll( const char* text )
{
   bool retVal{ false };

   if( xSemaphoreTake( this->mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){

      Serial.println( text );
      // recurso compartido: imprime el texto en una sola pasada

      xSemaphoreGive( this->mutex );

      retVal = true;
   } 

   return retVal;
}

bool Monitor::PrintOneByOne( const char* text, uint8_t len )
{
   bool retVal{ false };

   if( xSemaphoreTake( this->mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){

      // recurso compartido: imprime el texto caracter por caracter:
      for( uint8_t i = 0; i < len; ++i ){
         Serial.print( text[ i ] );
         vTaskDelay( pdMS_TO_TICKS( 1 ) );
      }
      Serial.println( "" );

      xSemaphoreGive( this->mutex );

      retVal = true;
   }

   return retVal;
}

Ambas operaciones devuelven un booleano para indicar si la operación se llevó a cabo (true), o si el tiempo expiró y el mutex no pudo ser adquirido (false). El tratamiento de esta última situación se maneja por fuera de la clase. En un sistema con más recursos las operaciones podrían lanzar una excepción (throw) y la tarea llamadora capturarla (catch) e intentar recuperarse.

Nota la simplicidad y seguridad para utilizar el recurso a través del monitor:

void a_task( void* pvParameters )
{
   char str[66] = "HOLA MUNDO hola mundo HOLA MUNDO hola mundo HOLA MUNDO hola mundo";

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 50 ) );

      if( monitor.PrintAll( str ) == false ){ // time over:
         Serial.println( "TO:1" );
      }
   }
}

A continuación tenemos el ejemplo completo:

#include <FreeRTOS.h>
#include <task.h>
#include <semphr.h>

/*
 * El mutex queda encapsula en la clase y el recurso sólo puede ser utilizado
 * por las operaciones definidas
 */
class Monitor
{
private:
   SemaphoreHandle_t mutex{ NULL };

   // aquí iría la declaración del recurso, pero Serial.print() es global al
   // sistema, así que sólo supondremos que lo hacemos

public:
   Monitor();

   bool PrintAll( const char* text );
   bool PrintOneByOne( const char* text, uint8_t len );
};

Monitor::Monitor()
{
   this->mutex = xSemaphoreCreateMutex();

   // deberíamos verificar que el mutex fue creado ... o mejor aún, crearlo de
   // manera estática

}

bool Monitor::PrintAll( const char* text )
{
   bool retVal{ false };

   if( xSemaphoreTake( this->mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){

      Serial.println( text );

      xSemaphoreGive( this->mutex );

      retVal = true;
   } 

   return retVal;
}

bool Monitor::PrintOneByOne( const char* text, uint8_t len )
{
   bool retVal{ false };

   if( xSemaphoreTake( this->mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){

      for( uint8_t i = 0; i < len; ++i ){
         Serial.print( text[ i ] );
         vTaskDelay( pdMS_TO_TICKS( 1 ) );
      }
      Serial.println( "" );

      xSemaphoreGive( this->mutex );

      retVal = true;
   }

   return retVal;
}

Monitor monitor;
// el monitor es global para que las tareas tengan acceso a él. Una manera más
// segura es crearlo en setup() (marcado como static) y pasárselo a las tareas
// que van a ocupar el recurso en su parámetro pvParameters


void a_task( void* pvParameters )
{
   char str[66] = "HOLA MUNDO hola mundo HOLA MUNDO hola mundo HOLA MUNDO hola mundo";

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 50 ) );

      if( monitor.PrintAll( str ) == false ){ // time over:
         Serial.println( "TO:1" );
      }
   }
}

void another_task( void* pvParameters )
{
   char str[63] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 47 ) );

      if( monitor.PrintOneByOne( str, 62 ) == false ){ // time over:
         Serial.println( "TO:2" );
      }
   }
}

void setup()
{
   xTaskCreate( a_task, "1T", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( another_task, "2T", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );

   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( "\n*** RESET ***" );

   vTaskStartScheduler();
}

void loop() {}

Ejemplo 4: Monitor mejorado

El siguiente programa incluye algunas mejoras con respecto del Ejemplo 3:

  • El mutex es creado de manera estática con xSemaphoreCreateMutexStatic().
  • El monitor deja de ser global; ahora se declara como static en la función setup() y se le pasa a las tareas que van a utilizar al recurso compartido a través del argumento pvParameters.

Los objetos estáticos son mejores que los dinámicos porque siempre se crean, así que no hay necesidad de preocuparse por ello, ni ninguna razón para liarse con memoria dinámica. Por otro lado, en el Ejemplo 3 el monitor puede ser utilizado por cualquier tarea; en la versión que estoy a punto de mostrarte solamente las tareas que reciban al monitor podrán utilizarlo. Con esto agregamos un escalón más en la seguridad y fiabilidad de nuestros programas.

Como ya hemos visto todo lo que necesitamos para implementar al monitor en la forma que he descrito, vámonos directamente al código:

#include <FreeRTOS.h>
#include <task.h>
#include <semphr.h>

/*
 * El mutex queda encapsula en la clase y el recurso sólo puede ser utilizado
 * por las operaciones definidas
 */
class Monitor
{
private:
   SemaphoreHandle_t mutex{ NULL };

   // aquí iría la declaración del recurso, pero Serial.print() es global al
   // sistema, así que sólo supondremos que lo hacemos

   StaticSemaphore_t mutex_buffer;
   // variable de estado del mutex. Se usa únicamente en la función
   // xSemaphoreCreateMutexStatic()

public:
   Monitor();

   bool PrintAll( const char* text );
   bool PrintOneByOne( const char* text, uint8_t len );
};

Monitor::Monitor()
{
   this->mutex = xSemaphoreCreateMutexStatic( &this->mutex_buffer );
   // los objetos estáticos siempre se crean
}

bool Monitor::PrintAll( const char* text )
{
   bool retVal{ false };

   if( xSemaphoreTake( this->mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){

      Serial.println( text );

      xSemaphoreGive( this->mutex );

      retVal = true;
   } 

   return retVal;
}

bool Monitor::PrintOneByOne( const char* text, uint8_t len )
{
   bool retVal{ false };

   if( xSemaphoreTake( this->mutex, pdMS_TO_TICKS( 100 ) ) != pdFALSE ){

      for( uint8_t i = 0; i < len; ++i ){
         Serial.print( text[ i ] );
         vTaskDelay( pdMS_TO_TICKS( 1 ) );
      }
      Serial.println( "" );


      xSemaphoreGive( this->mutex );

      retVal = true;
   }

   return retVal;
}

void a_task( void* pvParameters )
{
   Monitor* monitor = (Monitor*) pvParameters;
   // aceptamos al monitor

   char str[66] = "HOLA MUNDO hola mundo HOLA MUNDO hola mundo HOLA MUNDO hola mundo";

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 50 ) );

      if( monitor->PrintAll( str ) == false ){ // time over:
         Serial.println( "TO:1" );
      }
   }
}

void another_task( void* pvParameters )
{
   Monitor* monitor = (Monitor*) pvParameters;
   // aceptamos al monitor

   char str[63] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 47 ) );

      if( monitor->PrintOneByOne( str, 62 ) == false ){ // time over:
         Serial.println( "TO:2" );
      }
   }
}

void setup()
{
   static Monitor monitor;
   // el monitor es local a setup(), pero 'static' logra que exista durante todo el programa, 
   // y al mismo tiempo nadie fuera de esta función lo verá

   xTaskCreate( a_task, "1T", 128 * 3, (void*) &monitor, tskIDLE_PRIORITY + 1, NULL );
   // solamente las tareas que reciban al monitor podrán utilizarlo

   xTaskCreate( another_task, "2T", 128 * 3, (void*) &monitor, tskIDLE_PRIORITY, NULL );
   // solamente las tareas que reciban al monitor podrán utilizarlo

   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( "\n*** RESET ***" );

   vTaskStartScheduler();
}

void loop() {}

NOTA: El mecanismo anterior funciona de maravilla cuando son tareas las que están involucradas con el recurso; pero si se tratase de una interrupción quien fuera el productor o consumidor, entonces esta solución (hacer static al monitor) no funciona, ya que no existe modo de pasárselo a la interrupción. En tal caso el monitor debe ser global. Sin embargo, como verás a continuación, FreeRTOS recomienda no usar mutex’es dentro de interrupciones.

Otras funciones

Mutex’es e interrupciones

A pesar de que la API primitiva de semáforos incluye funciones espejo para ser utilizadas desde dentro de interrupciones (ISR’s) FreeRTOS recomienda no utilizar mutex’es dentro de ISR’s. Esto debido a dos cosas: la posible elevación temporal de la prioridad de la tarea que posee al mutex sólo tiene sentido a nivel de tarea, y una ISR no debería bloquearse esperando obtener al mutex. Por esta razón no mencionaré dichas funciones espejo.

Verificando si el mutex está disponible o no

En los ejemplos vistos hemos tratado de obtener directamente al mutex, y de no estar disponible, entonces la tarea se va al estado Blocked. Sin embargo, en algunas situaciones primero querremos saber si está disponible, y en caso negativo continuar sin tomarlo evitando que la tarea se bloquée. Para preguntar si el mutex está disponible puedes utilizar la función uxSemaphoreGetCount():

xSemaphore. Handler del mutex.

Valor devuelto. 1 si el mutex está disponible, y 0 si no lo está.

Preguntando cuál tarea posee al mutex

La función uxSemaphoreGetCount() te dice si el mutex está disponible o no, pero no te dice quién lo tiene; la función xSemaphoreGetMutexHolder() te indica cuál tarea lo posee. El valor devuelto por esta función está un poco enredado, así que intentaré explicarlo lo más simple posible:

xMutex. Handler del mutex del cual estamos preguntando.

Valor devuelto. Esta función puede devolver dos valores:
1. El handler de la tarea que lo posee, si es que alguna tarea lo posee, es decir, no está disponible.
2. NULL en cualquiera de los siguientes dos casos:
2.1 El semáforo indicado en xMutex no es un semáforo mutex, o
2.2 El mutex está disponible, y por lo tanto, ninguna tarea lo posee.

Suponiendo que no has mezclado diferentes tipos de semáforos, entonces bastaría con asumir que el valor NULL significa que ninguna tarea lo posee.

¿Qué sigue?

Hoy mencionamos los diversos problemas que enfrentamos cuando programamos de manera concurrente, y el problema que atacamos fue el de las condiciones de carrera, es decir del acceso por dos o más tareas a un mismo recurso compartido al mismo tiempo. Vimos que una solución es tratar al recurso como una sección crítica y limitar el acceso esta sección con un semáforo de exclusión mutua, o mutex.

Así mismo, llevamos el concepto de mutex un paso adelante con los monitores. Un monitor encapsula al mutex y al recurso compartido, y solamente permite que el cliente accese a éste a través de un conjunto mínimo de operaciones, evitando que se utilice mal o sobre un recurso diferente.

Índice del curso

Espero que esta entrada haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Comunicación inter-tareas (II): Mensajes (message buffers)

En la lección anterior estudiamos un mecanismo para pasar secuencias de bytes entre tareas, o de una interrupción a una tarea. Prácticamente todos los protocolos de comunicaciones son orientados al byte, lo que pone de manifiesto la importancia de este tipos de xxx.

Sin embargo, en casi todas nuestras aplicaciones vamos a necesitar transferir información de datos de tipos simples (int, float, etc) y de datos compuestos (struct), ya sea en forma de una variable o de un arreglo. Para estas ocasiones FreeRTOS incluyó los mensajes, cuya filosofía es la misma que la de los flujos, con la diferencia de que podrás transferir información de cualquier tipo, y no sólo bytes (por byte debemos entender: char, unsigned char, uint8_t, int8_t).

En la lección del día de hoy vamos a estudiar los mensajes explicando sus detalles y viendo 4 ejemplos representativos de su utilización.

Tabla de contenidos

¿Qué es y qué necesito?

Los mensajes (message buffers, en FreeRTOS) son un mecanismo que está basado en los flujos y que sirve para transferir información compleja (más de un byte), ya sea de tipos básicos del lenguaje C o de tipos compuestos.

Aunque similiares, los mensajes tienen diferencias importantes con respecto a los flujos. Una de éstas, y la más importante, es con respecto a la integridad de la información. Con los flujos puedes leer los bytes que tú quieras, pero esto no funciona con tipos diferentes a los bytes. Imagina que quieres usar un flujo para transmitir un entero de 32 bits (el cual requiere 4 bytes), pero a la hora de leer la información lees nada más 3 bytes. Esto es claramente un error que debemos evitar (pero que nos podría pasar), y los mensajes ya lo toman en cuenta; de hecho, en los mensajes no existe el punto de disparo (trigger point).

En uno de los ejemplos de la lección anterior la tarea consumidora escribía bytes individuales, y una vez que se alcanzaba un determinado número de ellos, la tarea consumidora era despertada y consumía todos. Bueno, esto no lo puedes hacer con los mensajes, afortunadamente. Esto es, si utilizando mensajes quieres recibir un arreglo de ints, entonces la tarea productora debe enviar un arreglo de ints con el mismo número de elementos. Si quieres transferir un dato de tipo float, entonces la tarea consumidora transmitiría exactamente 4 bytes y la tarea consumidora tomará exactamente los 4 bytes. Y esto es bueno.

Para que puedas utilizar los mensajes en tus programas asegúrate que el archivo stream_buffer.c sea parte del proceso de compilación. Este archivo ya está incluído cuando descargas FreeRTOS, y en consecuencia, en el proyecto Molcajete también está donde debe de estar, por lo que no debes procuparte por ello. Así mismo, en cada archivo fuente donde uses a los mensajes deberás agregar el encabezado #include <message_buffer.h>.

(Los mensajes están basados en los flujos, por lo que no existe un archivo message_buffer.c, pero lo que sí existe es el archivo de encabezado message_buffer.h.)

También es necesario que la constante INCLUDE_xTaskGetCurrentTaskHandle esté puesta a 1 (en el archivo de configuración FreeRTOSConfig.h):

#define INCLUDE_xTaskGetCurrentTaskHandle 1

Antes de ver las funciones de la API de los mensajes debes tener en cuenta en todo momento la integridad de la información, y para esto FreeRTOS impone unas reglas a los tamaños de los búferes de datos que vamos a utilizar; si estableces un búfer al que le falte un byte de lo que FreeRTOS espera, entonces no habrá transferencia de datos. Y eso es bueno. Los tamaños de los búferes se obtienen a partir de fórmulas simples, pero que hay que seguir al pie de la letra, ya que tienen que ver con la cantidad de elementos que quieres escribir/leer y con el tamaño en bytes de cada elemento. Si los calculas más pequeños de lo que tienen que ser, entonces no habrá transferencia de datos.

Para facilitar el uso de los mensajes en nuestros programas escribí 5 constantes numéricas, las cuales vamos a utilizar en los ejemplos de esta lección. De éstas tú estableces las dos primeras ; las últimas 3 se calculan de manera automática.

#define MESSAGE_ELEMS ( 8 )

Es el número de elementos (no de bytes) que deseas escribir/leer. Esta constante la debes utilizar en ambas funciones xMessageBufferSend() y xMessageBufferReceive() (las cuales explicaré más adelante). El número de elementos puede ir desde 1.

#define MESSAGE_TYPE float

Aquí estableces el tipo de dato del o de los elementos que deseas transmitir. En este ejemplo se trata de variables float, pero pueden ser de tipo compuesto, como lo verás en los ejemplos.

#define MESSAGE_TYPE_SIZE ( sizeof( MESSAGE_TYPE ) )

Calcula el tamaño del arreglo interno subyacente al mensaje. Esta constante la utilizarás en las funciones de creación del mensaje. Más adelante explicaré la fórmula. No deberías manipularlo directamente.

#define MESSAGE_SIZE ( MESSAGE_ELEMS ) * ( MESSAGE_TYPE_SIZE )

Calcula el número de bytes que necesita una transferencia. No deberías manipularlo directamente.

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + 4 )

Calcula el número de bytes que necesita un elemento de tipo MESSAGE_TYPE. No deberías manipularlo directamente.

La constante MESSAGE_BUFFER_SIZE requiere su propia explicación. El “manual” (es decir, la documentación oficial) dice que FreeRTOS agrega a la secuencia a transferir el número de bytes del mensaje. Esto es, si tu transferencia es de 100 bytes, entonces se transmitirán 104 bytes (ahorita explico el ‘4’). El problema es el siguiente: imagina que vas a transferir un arreglo de 5 elementos, donde cada elemento ocupa 20 bytes. Y si tú estableces que MESSAGE_BUFFER_SIZE sea de 100 bytes, entonces solamente podrás transferir, en una pasada, 4 de los 5 elementos, y siempre quedarán 16 bytes inutilizables. La solución es establecer MESSAGE_BUFFER_SIZE a 5*20+4=104 (bytes). Con esto aseguras transferir los 5 elementos en una pasada.

¿Y de dónde salió ese ‘4’? El “manual” dice que el número de bytes agregados, esos que guardan el tamaño del mensaje, deben ser equivalentes al número de bytes que ocuparía una variable del tipo size_t (éste es un alias para unsigned int), y la fórmula quedaría así:

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + sizeof( size_t ) )

El propio manual explica que un valor común para size_t es de 32 bits, o 4 bytes, lo cual es cierto para la mayoría de sistemas, pero no para el compilador GCC-AVR utilizado por Arduino. En esta plataforma, por lo menos para el chip ATmega328, ¡size_t es de 2 bytes! Y por supuesto, aunque los programas compilarían, no funcionarían como deben (ya le pasó al primo de un amigo). Por lo tanto, en lugar de utilizar size_t en la fórmula me ví obligado a escribir el valor 4. En otras plataformas no debería existir ese problema.

Desarrollo

Los mensajes necesitan un búfer de datos interno, es decir, un lugar dónde guardar cada byte. Este búfer es un arreglo de elementos uint8_t de tamaño MESSAGE_BUFFER_SIZE cuando creas a los objetos. Cuando utilizas creación dinámica de objetos este arreglo se crea de manera automática dentro de la función xMessageBufferCreate(), por lo cual no debes preocuparte de nada (en apariencia. Siempre que te sea posible utiliza la creación estática de objetos, es más segura); mientras que si usas la creación estática de objetos, tú eres responsable de pasarle dicho arreglo a la función xMessageBufferCreateStatic(). A continuación veremos ambas formas.

(Para conocer o recordar la diferencia y la configuración entre objetos dinámicos y estáticos, te recomiendo leer esta lección y esta otra lección, respectivamente. Aunque ambas hablan sobre tareas, la teoría aplica para cualquier tipo de objeto.)

Creación dinámica

La función para crear mensajes dinámicos es:

xBufferSizeBytes. Es el número máximo de bytes que el búfer puede alojar. Para realizar transferencias completas en una sola pasada recuerda agregar size_t bytes extras, es decir, sizeof( size_t ) bytes. Puedes utilizar el valor MESSAGE_BUFFER_SIZE del que hablé hace un momento.

Valor devuelto. Si hubo memoria suficiente para crear al mensaje, entonces la función devuelve el handler; en caso contrario (no hubo memoria suficiente) devuelve NULL. Este handler lo debes de guardar, tanto para que el resto de funciones de flujos sepan sobre cuál van a operar, como para probar que efectivamente fue creado.

Nota que esta función, a diferencia de la función xStreamBufferCreate(), no incluye al parámetro para el punto de disparo, xTriggerLevelBytes.

Por ejemplo, si en tu programa quisieras transferir un arreglo de 8 valores float, entonces tendrías lo siguiente:

#include <FreeRTOS.h>
#include <task.h>
#include <message_buffer.h>

MessageBufferHandle_t g_message_buffer = NULL;
// el handler debe ser global

#define MESSAGE_ELEMS ( 8 )
#define MESSAGE_TYPE float
#define MESSAGE_TYPE_SIZE ( sizeof( MESSAGE_TYPE ) )

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + sizeof( size_t ) )
// forma general que NO funciona para el ATmega328, pero en el ejemplo
// completo dado más adelante, ya lo arreglamos

#define MESSAGE_SIZE ( MESSAGE_ELEMS ) * ( MESSAGE_TYPE_SIZE )

void setup()
{
   // código ...

   g_message_buffer = xMessageBufferCreate( MESSAGE_BUFFER_SIZE );

   configASSERT( g_message_buffer );
   // Error creando al mensaje

   // más código ...
}

El handler, g_message_buffer, es global porque debe ser visible tanto en la tarea productora como en la consumidora.

La creación dinámica de objetos no asegura que los objetos se creen, principalmente por escasez de memoria RAM. Por eso siempre deberías preguntar si el objeto realmente fue creado, y aunque existen diversas maneras de hacerlo, en este ejemplo escogí la macro configASSERT() que es una versión propia de la conocida assert() de C (en el archivo FreeRTOSConfig.h podrás ver la implementación que utilicé para el projecto Molcajete). Por supuesto que puedes usar al condicional if y tratar de recuperarte sin terminar el programa de manera abrupta.

Creación estática

Ahora veamos cómo crear a un mensaje de manera estática. Como es usual, esta forma de creación de objetos necesita más pasos, pero es mucho más segura ya que los objetos siempre serán creados.

xBufferSizeBytes. Es el número máximo de bytes que el búfer puede alojar. Para realizar transferencias completas en una sola pasada recuerda agregar size_t bytes extras, es decir, sizeof( size_t ) bytes. Puedes utilizar el valor MESSAGE_BUFFER_SIZE del que hablé hace un momento.

pucMessageBufferStorageArea. Es el búfer interno del mensaje donde se guardarán los datos, y no es otra cosa que un arreglo de elementos de tipo uint8_t de tamaño al menos xBufferSizeBytes + 1. Este arreglo deberá existir a lo largo del programa, por lo cual deberás crearlo de manera global o estática a la función donde fue llamada xMessageBufferCreateStatic().

pxStaticMessageBuffer. Esta es la variable que guarda el estado del mensaje, es decir, la estructura de datos que maneja al mensaje (el mensaje es algo más que un simple arreglo). Al igual que el parámetro pucMessageBufferStorageArea, deberá existir a lo largo del programa.

Valor devuelto. El handler al mensaje. La creación estática de objetos nunca falla, a menos que el arreglo o la variable de estado sean NULL, cosa que tal vez nunca suceda.

#include <FreeRTOS.h>
#include <task.h>
#include <message_buffer.h>

MessageBufferHandle_t g_message_buffer = NULL;
// el handler debe ser global

#define MESSAGE_ELEMS ( 8 )
#define MESSAGE_TYPE float
#define MESSAGE_TYPE_SIZE ( sizeof( MESSAGE_TYPE ) )

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + sizeof( size_t ) )
// forma general que NO funciona para el ATmega328, pero en el ejemplo
// completo dado más adelante, ya lo arreglamos

#define MESSAGE_SIZE ( MESSAGE_ELEMS ) * ( MESSAGE_TYPE_SIZE )

void setup()
{
   // código

   static uint8_t message_buffer_array[ MESSAGE_BUFFER_SIZE + 1 ];
   // arreglo subyacente para el búfer interno

   static StaticMessageBuffer_t message_buffer_struct;
   // variable de estado que mantiene a la estructura del mensaje

   g_message_buffer =              // handler (debe ser global)
   xMessageBufferCreateStatic( 
         MESSAGE_BUFFER_SIZE,      // tamaño del búfer interno
         message_buffer_array,     // arreglo subyacente que hace las veces de búfer interno
         &message_buffer_struct ); // variable de estado

   // los objetos estáticos siempre se crean, así que no hay necesidad de
   // preguntar si el mensaje fue creado o no

   // más código ...
}

El tamaño del arreglo subyacente (message_buffer_array[]), es decir, el búfer donde se guardan los datos, debe ser un byte más grande que el establecido en el argumento xBufferSizeBytes. En este ejemplo marqué a las variables message_buffer_array y message_buffer_struct como static; esto para que perduren durante todo el programa, pero que a la vez sean invisibles al resto de funciones. Una alternativa es que las declares globales, aunque entre menos variables globales tengas en tus programas, mejor. Sin embargo el handler, g_message_buffer, sí que debe ser global porque tanto la tarea productora como la consumidora deben tener acceso a él. Este es un ejemplo de las veces en que sí son necesarias las variables globales. El prefijo g_ nos recuerda que es una variable global y que debemos tener mucho cuidado con ella.

Escribiendo y leyendo al mensaje

Una vez que el mensaje ha sido creado ya podemos utilizarlo escribiendo en y leyendo desde él. Los datos que deseas transmitir se deben encontrar en un búfer de tu aplicación, y dependiendo de lo que desees transmitir este búfer puede ser un arreglo o una variable, ya sean tipos básicos o tipos compuestos. En los ejemplos que veremos utilizamos ambas para que veas cómo se utilizan.

La función para escribir en el mensaje es:

xMessageBuffer. Es el handler del mensaje en el que queremos escribir.

pvTxData. Es un apuntador al búfer que queremos transmitir. Dicho búfer lo deberás promocionar a void*. Es importante que recuerdes que los elementos de este búfer son copiados al mensaje.

xDataLengthBytes. Es la cantidad máxima de bytes que deseas escribir al mensaje en una sola llamada. El número lo obtienes de multiplicar el número de elementos por el tamaño en bytes que ocupa cada elemento. Puedes utilizar el valor MESSAGE_SIZE del que hablé hace un momento.

xTicksToWait. Si no hay espacio disponible para una nueva copia de xDataLengthBytes bytes en el mensaje, entonces la tarea productora (la que llama a esta función) entrará al estado Blocked por el tiempo determinado en este parámetro. Si el tiempo expira la tarea pasará al estado Ready. El tiempo de espera está en ticks y puedes usar la macro pdMS_TO_TICKS() para convertir milisegundos a ticks. Así mismo, si escribes 0 la función regresa inmediatamente, y si escribes portMAX_DELAY el tiempo de espera es infinito (siempre y cuando la constante simbólica INCLUDE_vTaskSuspend esté a 1).

Valor devuelto. Esta función devuelve el número de bytes escritos al mensaje. Para asegurarte de mantener la integridad de la información, siempre deberías verificar este valor. En los ejemplos te muestro cómo hacerlo.

La función para leer desde el mensaje es:

xMessageBuffer. Es el handler del mensaje del que queremos leer.

pvRxData. Es un apuntador al búfer en el que los datos leídos se van a guardar. Dicho búfer lo deberás promocionar a void*. Es importante que recuerdes que los elementos de este búfer son copiados desde el mensaje al búfer.

xBufferLengthBytes. Es la cantidad máxima de bytes que deseas leer desde el mensaje en una sola llamada. El número lo obtienes de multiplicar el número de elementos por el tamaño en bytes que ocupa cada elemento. Puedes utilizar el valor MESSAGE_SIZE del que hablé hace un momento.

xTicksToWait. Es el tiempo de espera máximo que la tarea consumidora estará en el estado Blocked mientras arriban bytes a partir de que el búfer estuviera vacío. El tiempo de espera está en ticks y puedes usar la macro pdMS_TO_TICKS() para convertir milisegundos a ticks. Así mismo, si escribes 0 la función regresa inmediatamente, y si escribes portMAX_DELAY el tiempo de espera es infinito (siempre y cuando la constante simbólica INCLUDE_vTaskSuspend esté a 1).

Valor devuelto. Esta función devuelve el número de bytes leídos desde el flujo. Para asegurarte de mantener la integridad de la información, siempre deberías verificar este valor. En los ejemplos te muestro cómo hacerlo.

Ejemplos

Dada la importancia de transferir información de tipos básicos y compuestos creí conveniente realizar 4 ejemplos que muestran las diferentes formas en que podemos usar a los mensajes en nuestros programas:

  1. Transfiere un arreglo de valores float. El mensaje se crea de forma dinámica.
  2. Transfiere un valor float. El mensaje se crea de forma estática.
  3. Transfiere un arreglo de variables compuestas. El mensaje se crea de forma estática.
  4. Transfiere una variable compuesta. El mensaje se crea de forma estática.

Para los ejemplos 3 y 4 tomé como plantilla al ejemplo 2, de ahí que los 3 ejemplos (2, 3 y 4) utilicé la creación estática de mensajes. Sin embargo, con lo visto en el ejemplo 1 podrás crear mensajes dinámicos sin ningún inconveniente.

Nota cómo, cuándo y dónde utilicé las constantes simbólicas que vimos hace un momento. Utilizarlas te facilitará la programación y te ahorrará los problemas que yo enfrenté. En particular las funciones xStreamBufferSend() y xStreamBufferReceive() utilizan al mismo valor MESSAGE_SIZE para indicar el número de bytes que se escriben y se leen.

Hace un rato mencioné que la fórmula general para obtener el tamaño del búfer interno del mensaje es:

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + sizeof( size_t ) )

Pero para el caso del ATmega328, utilizando al compilador GCC-AVR, en todos los ejemplos la he modificado a:

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + 4 )

Si tu compilador te entrega como resultado de sizeof( size_t ) el valor 4, entonces utiliza la fórmula general (para que no te involucres con magic numbers).

En las funciones de creación de las tareas notarás que utilicé como tamaño de pila el valor 128*3:

void setup()
{
   xTaskCreate( producer_task, "PROD", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );
   xTaskCreate( consumer_task, "CONS", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );
   // ...
}

En lecciones anteriores estuve usando el valor 128, porque a los más declarábamos una o dos variables dentro de las tareas. Sin embargo, en esta lección (y en la anterior) hemos estado declarando arreglos de valores dentro de las tareas, y la memoria para estos arreglos es tomada de la pila de la tarea, por lo cual el tamaño de la pila debe considerarlos. Quizás exageré en un valor tan grande, pero tú siempre podrás calcularlo de acuerdo a las necesidades de tus aplicaciones.

En la lección anterior ya había advertido de lo miserable que se comportan las funciones Serial.print() y similares en programas concurrentes. Por supuesto que este triste comportamiento también aparece con los mensajes. Por eso notarás que en los ejemplos agregué información de depuración que puede ser habilitada o deshabilitada a tu gusto, estableciendo un valor conveniente en la constante USER_DBG:

#define USER_DBG 1
// Para habilitar/deshabilitar información de depuración:
// 0: Deshabilitada
// 1: Información básica
// 2: Más información, pero puede hacer que el sistema falle (debido a Serial.print())

Ejemplo 1: Transfiere un arreglo de valores float. El mensaje se crea de forma dinámica.

Este ejemplo muestra cómo transferir un arreglo de valores float. Puedes modificarlo para usarlo con valores enteros, int, o reales dobles, double.

Así mismo, y como ya había mencionado, deberías de verificar que el número de bytes transmitidos efectivamente es el mismo que tú especificaste:

if( bytes_sent != MESSAGE_SIZE ){ // timeout:
   Serial.print( "TO(W): " );
} 

Obviamente debes hacer la misma prueba del lado de la función consumidora:

if( received_bytes < MESSAGE_SIZE ) { // timeover:
   Serial.println( "TO(R)" );
} 

El ejemplo completo es el siguiente:

#include <FreeRTOS.h>
#include <task.h>
#include <message_buffer.h>


MessageBufferHandle_t g_message_buffer = NULL;


#define MESSAGE_ELEMS ( 8 )
// ¿Cuántos elementos tendrá el búfer de mensajes del USUARIO?

#define MESSAGE_TYPE float
// ¿De qué tipo es el búfer de mensajes?

#define MESSAGE_TYPE_SIZE ( sizeof( MESSAGE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo MESSAGE_TYPE?

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + 4 )
// ¿Cuántos bytes ocupa el búfer INTERNO de mensajes?

#define MESSAGE_SIZE ( MESSAGE_ELEMS ) * ( MESSAGE_TYPE_SIZE )
// ¿Cuántos bytes ocupa el stream de mensajes que se transmitirá/recibirá?


#define USER_DBG 1
// Para habilitar/deshabilitar información de depuración:
// 0: Deshabilitada
// 1: Información básica
// 2: Más información, pero puede hacer que el sistema falle (debido a Serial.print())


void producer_task( void* pvParameters )
{
   MESSAGE_TYPE out_buffer[ MESSAGE_ELEMS ];

   uint8_t index = 0;

   float data = 0.5;

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 500 ) );

      for( uint8_t i = 0; i < MESSAGE_ELEMS; ++i ){
         
         out_buffer[ i ] = data;

         data += 0.5;

      }

      size_t bytes_sent = 
         xMessageBufferSend( 
            g_message_buffer,
            (void*) out_buffer,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 50 ) );

#if USER_DBG > 0
      Serial.print( "ENVIADOS: " );
      Serial.println( bytes_sent );
#endif

      if( bytes_sent != MESSAGE_SIZE ){ // timeout:
         Serial.print( "TO(W): " );
      } 
   }
}

void consumer_task( void* pvParameters )
{
   MESSAGE_TYPE in_buffer[ MESSAGE_ELEMS ];

   while( 1 )
   {
      size_t received_bytes = 
         xMessageBufferReceive(
            g_message_buffer,
            (void*) in_buffer,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 1000 ) );

#if USER_DBG > 0
      Serial.print( "RECIBIDOS: " );
      Serial.println( received_bytes );
#endif

      if( received_bytes < MESSAGE_SIZE ) { // timeover:
         Serial.println( "TO(R)" );
      } 

#if USER_DBG > 1
      else{
         for( size_t i = 0; i < received_bytes; ++i ){
            Serial.println( in_buffer[ i ] );
         }
      }
#endif
   }
}


void setup()
{
   xTaskCreate( producer_task, "PROD", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );

   g_message_buffer = xMessageBufferCreate( MESSAGE_BUFFER_SIZE );

   configASSERT( g_message_buffer );
   // Error creando al flujo

   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   vTaskStartScheduler();
}

void loop() {}

Una salida de este programa con la constante USER_DBG puesta a 1 es:

Ejemplo 2: Transfiere un valor float. El mensaje se crea de forma estática

Este ejemplo muestra cómo transferir un sólo valor float. Puedes modificarlo para usarlo con valores enteros, int, o reales dobles, double. Presta especial atención a la constante MESSAGE_ELEMS la cual está puesta a 1, ya que es éste el número de elementos que queremos transferir. Así mismo, como no tenemos necesidad de declarar un arreglo, pasaremos a las funciones de escritura/lectura la dirección de una variable float, la cual hace las veces de búfer (sí, una simple variable puede ser un búfer, todo depende del contexto).

#include <FreeRTOS.h>
#include <task.h>
#include <message_buffer.h>


MessageBufferHandle_t g_message_buffer = NULL;

#define MESSAGE_ELEMS ( 1 )
// ¿Cuántos elementos tendrá el búfer de mensajes del USUARIO?

#define MESSAGE_TYPE float
// ¿De qué tipo es el búfer de mensajes?

#define MESSAGE_TYPE_SIZE ( sizeof( MESSAGE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo MESSAGE_TYPE?

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + 4 )
// ¿Cuántos bytes ocupa el búfer INTERNO de mensajes?

#define MESSAGE_SIZE ( MESSAGE_ELEMS ) * ( MESSAGE_TYPE_SIZE )
// ¿Cuántos bytes ocupa el stream de mensajes que se transmitirá/recibirá?


#define USER_DBG 2
// Para habilitar/deshabilitar información de depuración:
// 0: Deshabilitada
// 1: Información básica
// 2: Más información, pero puede hacer que el sistema falle (debido a Serial.print())


void producer_task( void* pvParameters )
{
   float data = 0.0;

   while( 1 )
   {

      vTaskDelay( pdMS_TO_TICKS( 500 ) );
      data += 0.5;

      size_t bytes_sent = 
         xMessageBufferSend( 
            g_message_buffer,
            (void*) &data,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 50 ) );

#if USER_DBG > 0
      Serial.print( "ENVIADOS: " );
      Serial.println( bytes_sent );
#endif

      if( bytes_sent != MESSAGE_SIZE ){ // timeout:
         Serial.print( "TO(W): " );
      } 
   }
}

void consumer_task( void* pvParameters )
{
   float data = 0.0;

   while( 1 )
   {
      size_t received_bytes = 
         xMessageBufferReceive(
            g_message_buffer,
            (void*) &data,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 1000 ) );

#if USER_DBG > 0
      Serial.print( "RECIBIDOS: " );
      Serial.println( received_bytes );
#endif

      if( received_bytes < MESSAGE_SIZE ) { // timeover:
         Serial.println( "TO(R)" );
      } 

#if USER_DBG > 1
      else{
         Serial.print( "DATA: " );
         Serial.println( data );
      }
#endif
   }
}

void setup()
{
   xTaskCreate( producer_task, "PROD", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );


   static uint8_t message_buffer_array[ MESSAGE_BUFFER_SIZE + 1 ];
   // arreglo subyacente para el búfer interno

   static StaticMessageBuffer_t message_buffer_struct;
   // variable de estado que mantiene a la estructura del mensaje

   g_message_buffer = 
   xMessageBufferCreateStatic( 
         MESSAGE_BUFFER_SIZE,
         message_buffer_array,
         &message_buffer_struct );


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   vTaskStartScheduler();
}

void loop() {}

La salida de este programa, con la constante USER_DBG puesta a 2 para imprimir el valor transferido, ya que la carga de Serial.print() no es tan alta (es sólo un valor float), es:

Ejemplo 3:Transfiere un arreglo de variables compuestas. El mensaje se crea de forma estática

Aunque es muy útil transferir variables o arreglos de tipos básicos, es igual de útil transferir información más compleja. En este ejemplo (y en el siguiente) tendremos un tipo compuesto Message (tú puedes darle el nombre que mejor se adapte en tu aplicación):

typedef struct Message_t
{
   uint16_t cont;
   float temp;
} Message;

La idea de este tipo compuesto es tener dos variables de diferentes tipos lógicamente relacionadas bajo un mismo nombre (lo cual coincide con la definición de estructura en C). El campo cont simplemente es un contador ascendente, mientras que el campo temp es la temperatura ambiente (a través de un sensor LM35). El ejemplo transferirá un arreglo de 4 elementos de tipo Message.

Nota que la constante MESSAGE_TYPE ahora está puesta al nombre que le dimos a la estructura, es decir:

#define MESSAGE_TYPE Message

El ejemplo completo es:

#include <FreeRTOS.h>
#include <task.h>
#include <message_buffer.h>


MessageBufferHandle_t g_message_buffer = NULL;

typedef struct Message_t
{
   uint16_t cont;
   float temp;
} Message;


#define MESSAGE_ELEMS ( 4 )
// ¿Cuántos elementos tendrá el búfer de mensajes del USUARIO?

#define MESSAGE_TYPE Message
// ¿De qué tipo es el búfer de mensajes?

#define MESSAGE_TYPE_SIZE ( sizeof( MESSAGE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo MESSAGE_TYPE?

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + 4 )
// ¿Cuántos bytes ocupa el búfer INTERNO de mensajes?

#define MESSAGE_SIZE ( MESSAGE_ELEMS ) * ( MESSAGE_TYPE_SIZE )
// ¿Cuántos bytes ocupa el stream de mensajes que se transmitirá/recibirá?


#define USER_DBG 1
// Para habilitar/deshabilitar información de depuración:
// 0: Deshabilitada
// 1: Información básica
// 2: Más información, pero puede hacer que el sistema falle (debido a Serial.print())



void producer_task( void* pvParameters )
{
   Message data_tx[ MESSAGE_ELEMS ] = { 0 };

   while( 1 )
   {
      for( size_t i = 0; i < MESSAGE_ELEMS; ++i ){

         vTaskDelay( pdMS_TO_TICKS( 100 ) );

         data_tx[ i ].cont++;
         data_tx[ i ].temp = ( analogRead( A0 ) * 5.0 * 100.0 ) / 1024.0;
      }

      size_t bytes_sent = 
         xMessageBufferSend( 
            g_message_buffer,
            (void*) data_tx,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 50 ) );

#if USER_DBG > 0
      Serial.print( "ENVIADOS: " );
      Serial.println( bytes_sent );
#endif

      if( bytes_sent != MESSAGE_SIZE ){ // timeout:
         Serial.print( "TO(W): " );
      } 
   }
}

void consumer_task( void* pvParameters )
{
   Message data_rx[ MESSAGE_ELEMS ] = { 0 };

   while( 1 )
   {
      size_t received_bytes = 
         xMessageBufferReceive(
            g_message_buffer,
            (void*) data_rx,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 1000 ) );

#if USER_DBG > 0
      Serial.print( "RECIBIDOS: " );
      Serial.println( received_bytes );
#endif

      if( received_bytes < MESSAGE_SIZE ) { // timeover:
         Serial.println( "TO(R)" );
      } 

#if USER_DBG > 1
      else{
         for( size_t i = 0; i < MESSAGE_ELEMS; ++i ){

            Serial.print( "CONT: " );
            Serial.print( data_rx[ i ].cont );

            if( data_rx[ i ].temp > 23.0 ){
               Serial.print( ", TEMP: " );
               Serial.print( data_rx[ i ].temp );
            }
            Serial.print( "\n" );
         }
      }
#endif
   }
}


void setup()
{
   xTaskCreate( producer_task, "PROD", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );


   static uint8_t message_buffer_array[ MESSAGE_BUFFER_SIZE + 1 ];
   // arreglo subyacente para el búfer interno

   static StaticMessageBuffer_t message_buffer_struct;
   // variable de estado que mantiene a la estructura del mensaje


   g_message_buffer = 
   xMessageBufferCreateStatic( 
         MESSAGE_BUFFER_SIZE,
         message_buffer_array,
         &message_buffer_struct );


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( "\nRESET" );

   vTaskStartScheduler();
}

void loop() {}

La salida de este programa con la constante USER_DBG puesta a 1 es:

Ejemplo 4: Transfiere una variable compuesta. El mensaje se crea de forma estática

Este último ejemplo muestra cómo transferir una variable simple de tipo Message. Las tareas productora y consumidora declaran sendas variables del tipo mencionado, mientras que la constante MESSAGE_ELEMS toma el valor 1:

#define MESSAGE_ELEMS ( 1 )

void producer_task( void* pvParameters )
{
   Message data_tx = { 0 };
   // ...
}

void consumer_task( void* pvParameters )
{
   Message data_rx = { 0 };
   // ...
}

El ejemplo completo es:

#include <FreeRTOS.h>
#include <task.h>
#include <message_buffer.h>


MessageBufferHandle_t g_message_buffer = NULL;

typedef struct Message_t
{
   uint16_t cont;
   float temp;
} Message;


#define MESSAGE_ELEMS ( 1 )
// ¿Cuántos elementos tendrá el búfer de mensajes del USUARIO?

#define MESSAGE_TYPE Message
// ¿De qué tipo es el búfer de mensajes?

#define MESSAGE_TYPE_SIZE ( sizeof( MESSAGE_TYPE ) )
// ¿Cuántos bytes ocupa una variable de tipo MESSAGE_TYPE?

#define MESSAGE_BUFFER_SIZE ( ( MESSAGE_ELEMS * MESSAGE_TYPE_SIZE ) + 4 )
// ¿Cuántos bytes ocupa el búfer INTERNO de mensajes?

#define MESSAGE_SIZE ( MESSAGE_ELEMS ) * ( MESSAGE_TYPE_SIZE )
// ¿Cuántos bytes ocupa el stream de mensajes que se transmitirá/recibirá?


#define USER_DBG 1
// Para habilitar/deshabilitar información de depuración:
// 0: Deshabilitada
// 1: Información básica
// 2: Más información, pero puede hacer que el sistema falle (debido a Serial.print())


void producer_task( void* pvParameters )
{
   Message data_tx = { 0 };

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 500 ) );

      data_tx.cont++;
      data_tx.temp = ( analogRead( A0 ) * 5.0 * 100.0 ) / 1024.0;

      size_t bytes_sent = 
         xMessageBufferSend( 
            g_message_buffer,
            (void*) &data_tx,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 50 ) );

#if USER_DBG > 0
      Serial.print( "ENVIADOS: " );
      Serial.println( bytes_sent );
#endif

      if( bytes_sent != MESSAGE_SIZE ){ // timeout:
         Serial.print( "TO(W): " );
      } 
   }
}

void consumer_task( void* pvParameters )
{
   Message data_rx = { 0 };

   while( 1 )
   {
      size_t received_bytes = 
         xMessageBufferReceive(
            g_message_buffer,
            (void*) &data_rx,
            MESSAGE_SIZE,
            pdMS_TO_TICKS( 1000 ) );

#if USER_DBG > 0
      Serial.print( "RECIBIDOS: " );
      Serial.println( received_bytes );
#endif

      if( received_bytes < MESSAGE_SIZE ) { // timeover:
         Serial.println( "TO(R)" );
      } 

#if USER_DBG > 1
      else{
         Serial.print( "CONT: " );
         Serial.print( data_rx.cont );
         Serial.print( ", TEMP: " );
         Serial.println( data_rx.temp );
      }
#endif
   }
}


void setup()
{
   xTaskCreate( producer_task, "PROD", 128 * 3, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128 * 3, NULL, tskIDLE_PRIORITY, NULL );


   static uint8_t message_buffer_array[ MESSAGE_BUFFER_SIZE + 1 ];
   // arreglo subyacente para el búfer interno

   static StaticMessageBuffer_t message_buffer_struct;
   // variable de estado que mantiene a la estructura del mensaje

   g_message_buffer = 
   xMessageBufferCreateStatic( 
         MESSAGE_BUFFER_SIZE,
         message_buffer_array,
         &message_buffer_struct );


   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );

   Serial.println( "\nRESET" );

   vTaskStartScheduler();
}

void loop() {}

La salida de este programa con la constante USER_DBG puesta a 1 es:

Otras funciones de la API

Hemos estudiado apenas las funciones más útiles de la API, sin embargo quedan algunas que es importante que las conozcas (aquí podrás ver la API completa).

ESCRITURA Y LECTURA DESDE INTERRUPCIONES

En lecciones anteriores hablé de funciones espejo que deben ser utilizadas cuando son llamadas desde dentro de una interrupción (ISR); a este tipo de funciones FreeRTOS le llama interrupt safe version. Los mensajes tienen dos:

Los tres primeros parámetros y el valor devuelto son lo mismo que sus contrapartes. Pero observa dos diferencias fundamentales:

  • No tienen al parámetro xTicksToWait; esto es así porque una ISR no debe bloquearse jamás.
  • Las funciones ponen a pdTRUE el parámetro pxHigherPriorityTaskWoken si la llamada a éstas implica que una tarea de alta prioridad pasó del estado Blocked al estado Ready y es necesario hacer un cambio de contexto, es decir, pasarla al estado Run.

El siguiente fragmento muestra su posible uso (no lo probé, pero así se usa):

void producer_ISR()
{
   isr_ack();
   // "reconocemos" la interrupción (ack -> acknowledge)


   BaseType_t pxHigherPriorityTaskWoken = pdFALSE;
   // siempre debe ser inicializada a pdFALSE

   static uint32_t data = 0;

   size_t bytes_sent = 
     xMessageBufferSendFromISR( 
        g_message_buffer,
        (void*) &data,
        MESSAGE_SIZE,
        &pxHigherPriorityTaskWoken );

   ++data;
   // simulamos la información

   if( bytes_sent != MESSAGE_SIZE ){
      // no hubo espacio en el flujo
   }

   if( pxHigherPriorityTaskWoken != pdFALSE ) taskYIELD;
   // cambio de contexto opcional, pero recomendable
}

FUNCIONES AUXILIARES

La API de los mensajes incluye una serie de funciones para preguntar o alterar el estado del flujo:

  • BaseType_t xMessageBufferIsEmpty( MessageBufferHandle_t xMessageBuffer ). Devuelve pdTRUE si el mensaje indicado en xMessageBuffer está vacío, o pdFALSE en caso contrario.
  • BaseType_t xMessageBufferIsFull( MessageBufferHandle_t xMessageBuffer ). Devuelve pdTRUE si el mensaje indicado en xMessageBuffer está lleno, o pdFALSE en caso contrario.
  • size_t xMessageBufferBytesAvailable( MessageBufferHandle_t xMessageBuffer ). Devuelve el número de elementos actualmente en el mensaje indicado por xMessageBuffer que se pueden leer.
  • size_t xMessageBufferSpacesAvailable( MessageBufferHandle_t xMessageBuffer ). Devuelve el número de elementos libres en el mensaje indicado por xMessageBuffer, es decir, cuánto espacio queda libre.
  • BaseType_t xMessageBufferReset( MessageBufferHandle_t xMessageBuffer ). Pone a su estado inicial al mensaje indicado por xMessageBuffer.

¿Qué sigue?

Transferir información de una tarea a otra, o de una interrupción a una tarea, es una actividad muy común y muy importante en nuestros sistemas embebidos. En la lección de hoy vimos cómo transferir datos de tipos simples (diferentes de bytes) y de tipos compuestos utilizando el mecanismo de FreeRTOS, mensajes (en su nomenclatura oficial, message buffers). Los mensajes están basados en los flujos, pero salvaguardan la integridad de la información evitando que leas 3 bytes de un entero de 32 bits, o 1 byte de un número real de 4 bytes.

RECUERDA: Utiliza las constantes que te di al principio de esta lección, en lugar de calcular por tu cuenta los diferentes tamaños de búferes y bytes a transferir.

RECUERDA: Siempre que te sea posible utiliza objetos estáticos.

RECUERDA: Si vas a llamar a una función de FreeRTOS desde una interrupción, verifica que ésta sea interrupt safe version, es decir, tenga terminación FromISR.

RECUERDA: Los mensajes se utilizan para transferir todos los tipos básicos de C y tipos compuestos. Si tu intención es transferir bytes sin ningún formato, ni inicio ni fin, entonces deberías utilizar los flujos.

En la siguiente lección estudiaremos los semáforos mutex, los cuales nos pueden ayudar a que un recurso no sea accesado por más de una tarea al mismo tiempo.

(En esta página encontrarás información de suma importancia sobre los flujos, mensajes y notificaciones. Deberías leerla en cuanto te sea posible.)

Índice del curso

Espero que esta entrada haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Semáforos con notificaciones

En la programación concurrente, la que hemos estado realizando con FreeRTOS, es difícil, si no imposible, determinar a priori cuándo se va a ejecutar una tarea; peor aun cuando la ejecución de una tarea depende de otra. Para sincronizar tareas utilizamos semáforos binarios. Un semáforo binario tiene solamente dos posibles valores, 0 y 1. El valor 0 puede significar que el evento esperado no ha sucedido, mientras que el valor 1 puede significar que el evento ya sucedió y que podemos seguir adelante.

Por otro lado a veces una tarea tiene que contar eventos (personas, vueltas, autos, etc) y emitir un aviso a otra tarea cuando se llegue a un límite predefinido, o ir procesando uno a uno. En estos casos utilizamos semáforos contadores, los cuales son mucho mejores que una variable entera contadora. Así mismo, los semáforos contadores los podemos utilizar también para administrar los limitados recursos de nuestros sistemas.

Además de los semáforos binarios y contadores, existe una tercer clase de semáforos, los mutex (del inglés, mutual exclusion, y en español, exclusion mutua). Este tipo de semáforos asegura, hasta cierto punto, que un recurso solamente puede ser accesado por una tarea a la vez. Imagina que tienes dos o más tareas, donde cada una utiliza al convertidor ADC. El ADC de los procesadores es uno solo con varios canales. Y resulta que, al menos en el procesador ATmega328, si inicias una conversión mientras otra está en proceso, ambas se corrompen. ¿Qué hacer para asegurarse que nada más una tarea accesa al ADC a la vez? Un semáforo mutex. Una primer tarea obtiene el mutex, usa al ADC, y luego devuelve el mutex para que otra tarea lo use.

En FreeRTOS hay dos formas de implementar a los semáforos binarios y contadores: utilizando las notificaciones directas a la tarea (direct to task notifications) o utilizando primitivas del sistema operativo para semáforos (aquí puedes ver la API de estas primitivas). La diferencia es que estás últimas consumen más recursos (aunque pueden notificar a más de una tarea), y el propio creador de FreeRTOS recomienda las notificaciones directas en lugar de las primitivas para la mayoría de casos (mientras que para casos extremos recomienda usar dichas primitivas). En esta lección veremos semáforos binarios y contadores a través de las notificaciones.

Los semáforos mutex son más complejos, por lo que la única forma de implementarlos es a través de las primitivas de FreeRTOS, lo cual requeriría de su propia lección, y por eso no los trataremos en la lección de hoy.

En esta lección y en esta ya traté ampliamente el tema de las notificaciones directas a la tarea, y aunque en la lección de hoy los semáforos binarios y contadores están basadas en éstas, afortunadamente no debemos meternos en sus detalles, ya que las funciones para usar semáforos se encargan de ellos.

Tabla de contenidos

¿Qué es y qué necesito?

Los semáforos son mecanismos de sincronización, conteo y exclusión mutua internos a los sistemas operativos concurrentes (o multitarea). Los semáforos operan sobre dos premisas, ser dados y ser obtenidos (en inglés, given y taken, respectivamente). La tarea que quiere avisar que el evento se produjo da al (u otorga el) semáforo, mientras que la tarea que está a la espera de él lo obtiene. (A la tarea que lo da le estaré llamando “la tarea productora“, mientras que a la tarea que lo obtiene le llamaré “la tarea consumidora“). En la literatura encontrarás diferentes denominaciones para las operaciones de dar y obtener (Given/Taken, P/V, Signal/Wait, etc) pero la semántica es la misma; voy a usar los términos given y taken porque son los utilizados por FreeRTOS.

Un semáforo binario puede ser dado una vez, y obtenido una vez, mientras que un semáforo contador puede ser dado varias veces y obtenido una o varias veces. El semáforo binario es un caso especial del semáforo contador; siendo que la cuenta máxima del semáforo binario es uno. El semáforo mutex es un semáforo binario, pero con características extras, como la capacidad de elevar (de forma temportal) la prioridad de la tarea que lo obtiene.

Los semáforos basados en notificaciones directas no necesitan ser inicializados ni destruídos, ya que cada tarea incluye un campo de 32 bits que se usa para llevar la cuenta. FreeRTOS proporciona, en su forma más básica, dos funciones para las operaciones de dar y obtener (hay más, de las cuales hablaré después porque tienen que ver con ser llamadas desde interrupciones), xTaskNotifyGive() y ulTaskNotifyTake(), respectivamente.

La función para dar el semáforo es:

xTaskToNotify. Es el handler de la tarea consumidora, es de decir, aquella tarea que está esperando por el semáforo. Una de las limitaciones de usar semáforos basados en notificaciones es que únicamente una tarea puede ser notificada. Si un mismo evento debe ser notificado a varias tareas, entonces tendrías que usar varios semáforos.

Valor devuelto. Esta función siempre devuelve el valor pdPASS.

RECUERDA QUE: la operación Give (o dar) incrementa en uno al contador del semáforo.

La función para obtener el semáforo es:

xClearCountOnExit. Cuando este parámetro vale pdFALSE la cuenta se decrementa en 1 antes de abandonar la función. Lo utilizaremos para semáforos contadores. Cuando este parámetro vale pdTRUE la cuenta se pone a 0 antes de abandonar la función. Lo utilizaremos para semáforos binarios.

xTicksToWait. Tiempo de espera, en ticks, antes de que la tarea se desbloquée; esto es, después de una llamada a esta función la tarea esperará a lo más xTicksToWait ticks en el estado Block (es decir, sin usar ciclos de CPU) antes de despertarse. Para convertir milisegundos a ticks puedes utilizar la macro pdMS_TO_TICKS(). Para no esperar puedes escribir 0; para un tiempo de espera infinito escribe portMAX_DELAY (asegúrate que la constante INCLUDE_vTaskSuspend, en el archivo FreeRTOSConfig.h, está puesta a 1).

Valor devuelto. Esta función devuelve valor de la cuenta antes de que se le aplique lo indicado por xClearCountOnExit.

RECUERDA QUE: la operación Take (u obtener) decrementa en uno al contador del semáforo o lo pone a cero (dependiendo de si xClearCountOnExit es pdFALSE o pdTRUE, respectivamente).

Semáforos binarios

Vamos a ver un ejemplo simple de semáforo binario utilizando las notificaciones directas a la tarea. La tarea productora otorga el semáforo a intervalos regulares de tiempo. En una aplicación real o más elaborada estaría avisando que una conversión está lista, o que un mensaje se recibió, o que se llegó a una cuenta de eventos externos. La siguiente línea es la que otorga al semáforo:

xTaskNotifyGive( consumer_handler );

El handler a la tarea que obtiene al semáforo debe ser global para que la tarea productora lo vea.

Por otro lado, la tarea consumidora se bloquea mientras el semáforo no le sea dado:

if( ulTaskNotifyTake( pdTRUE, pdMS_TO_TICKS( 2000 ) ) == 1 ){

    // el semáforo fue obtenido y se hace algo

} else{ 

    // el semáforo no se obtuvo después del tiempo de espera

}

Observa que: el parámetro xClearCountOnExit está a pdTRUE indicando que después de leer la cuenta, ésta será puesta a 0; y que el tiempo de espera lo pusimos a 2000 ms. Si el semáforo no fuera dado dentro de esta ventana de tiempo, entonces tomamos acciones correctivas.

/*
 * Semáforo binario
 */

#include <FreeRTOS.h>
#include <task.h>

TaskHandle_t consumer_handler = NULL;
// la tarea productora debe conocer el handler de la tarea receptora


void producer_task( void* pvParameters )
{
   TickType_t xLastWakeTime = xTaskGetTickCount();

   while( 1 )
   {
      vTaskDelayUntil( &xLastWakeTime, pdMS_TO_TICKS( 1000 ) );

      xTaskNotifyGive( consumer_handler );
   }
}

void consumer_task( void* pvParameters )
{
   while( 1 )
   {
      if( ulTaskNotifyTake( pdTRUE, pdMS_TO_TICKS( 2000 ) ) == 1 ){

         digitalWrite( 13, HIGH );
         vTaskDelay( pdMS_TO_TICKS( 250 ) );
         digitalWrite( 13, LOW );

      } else{ 
      // timeout:

         digitalWrite( 13, HIGH );

      }
   }
}

void setup()
{
   xTaskCreate( producer_task, "PROD", 128, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128, NULL, tskIDLE_PRIORITY, &consumer_handler );

   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );
   // lo usa la tarea principal

   vTaskStartScheduler();
}

void loop() {}

Semáforos contadores

La teoría detrás de los semáforos contadores indica que podemos usar a éstos para contar eventos (ir de 0 hasta un cierto número), o para contar recursos (ir de un cierto número a 0). Sin embargo, los semáforos basados en notificaciones a la tarea de FreeRTOS no poseen ninguna de estas cualidades; es decir, la única forma para saber que la cuenta llegó a un máximo establecido es que la tarea receptora lleve la cuenta por cada elemento del cual se le ha notificado, y cuando llegue al máximo, realizar lo necesario.

Por otro lado, tampoco es posible inicializar a estos semáforos en un cierto número y luego irlo decrementando por cada recurso utilizado, lo cual complica, al igual que en el escenario recién descrito, llevar la cuenta de los recursos que quedan en un sistema, ya que es el programador, y no el semáforo, quien lo debe hacer. Los propios ejemplos de FreeRTOS se adaptan a la falta de ambas cualidades que mencioné, dejando nada más una aplicación práctica para este tipo de semáforos contadores: las interrupciones diferidas.

Es de todos sabido que el código dentro de una interrupción (ISR, en inglés) debe ser lo más rápida posible. Sin embargo, algunas veces debemos realizar algún tipo de procesamiento “lento” sobre el dato o evento que originó la llamada a la ISR. Una técnica eficiente es diferir el procesamiento de la ISR pasándole la responsabilidad del procesamiento a una tarea. A eso es a lo que le decimos interrupciones diferidas, y podemos utilizar semáforos contadores para llevarla a cabo.

En el siguiente ejemplo la tarea productora genera “eventos” a dos frecuencias diferentes, una lenta y una rápida, tratando de imitar la llegada de eventos a diferentes tiempos; en cada evento otorga el semáforo. Por otro lado, la tarea consumidora “consume” (no esperábamos menos) un evento a la vez. Esos números raros que verás en el código son números primos que utilicé para que la simulación fuera más realista, evitando que hubiera alguna relación entre ellos. Los “eventos” no son otra cosa que un contador que se incrementa cada vez que el semáforo es dado, y que se decrementa cuando el semáforo es obtenido.

Vale la pena notar la diferencia en la llamada a la función ulTaskNotifyTake() en un semáforo contador contra el binario que vimos hace un momento:

if( ulTaskNotifyTake( pdFALSE, pdMS_TO_TICKS( 1901 ) ) > 0 ){ /*...*/ }

El argumento xClearCountOnExit está puesto a pdFALSE, indicando que la cuenta debe ser decrementada (en lugar de ser puesta a 0, como en los binarios), y además probamos si el valor devuelto es mayor que 0. Si es mayor a 0 quiere decir que hay “eventos” que deben ser procesados.

/*
 * Semáforo contador
 */

#include <FreeRTOS.h>
#include <task.h>

TaskHandle_t consumer_handler = NULL;

uint16_t g_token = 0;
// contador de "eventos"


void producer_task( void* pvParameters )
{
   TickType_t xLastWakeTime = xTaskGetTickCount();

   bool rate = true;
   uint8_t cont = 3;
   TickType_t frequency = 347;

   while( 1 )
   {
      vTaskDelayUntil( &xLastWakeTime, pdMS_TO_TICKS( frequency ) );

      ++g_token;
      xTaskNotifyGive( consumer_handler );


      --cont;
      if( cont == 0 ){

         if( rate == true ){    // lento:
            rate = false;
            cont = 5;
            frequency = 1451;
         } else{                // rápido:
            rate = true;
            cont = 3;
            frequency = 347;
         }
      }

      Serial.print( "TOKEN(G): " );
      Serial.println( g_token );
   }
}

void consumer_task( void* pvParameters )
{
   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 907 ) );
      // hacemos tiempo para que se nos acumulen las notificaciones

      if( ulTaskNotifyTake( pdFALSE, pdMS_TO_TICKS( 1901 ) ) > 0 ){

         --g_token;
         Serial.print( "TOKEN(T): " );
         Serial.println( g_token );

      } else{ 
      // timeout:

         Serial.println( "TIMEOVER" );

      }
   }
}

void setup()
{
   xTaskCreate( producer_task, "PROD", 128, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( consumer_task, "CONS", 128, NULL, tskIDLE_PRIORITY, &consumer_handler );

   pinMode( 13, OUTPUT );

   Serial.begin( 115200 );
   // lo usa la tarea principal

   vTaskStartScheduler();
}

void loop() {}

Una salida parcial del programa anterior es:

TOKEN(G) significa: semáforo dado; TOKEN(T) significa: semáforo obtenido. La cifra es el número de notificaciones pendientes.

Semáforos y las interrupciones

Si hay un lugar en el que seguramente vamos a querer usar semáforos es dentro de las interrupciones (ISRs), ya sea por diseño o porque utilizamos el mecanismo que describí hace un momento: las interrupciones diferidas. En cualquier caso necesitaremos otorgar el semáforo (binario o contador) desde dentro de la ISR, pero no puedes usar a la función xTaskNotifyGive(), ya que las llamadas a las funciones de FreeRTOS desde dentro de una ISR tienen un comportamiento diferente a cuando son llamadas desde funciones regulares.

FreeRTOS incluye muchas funciones espejo que deben ser utilizadas desde dentro de las ISRs; para el caso que nos ocupa esta función es vTaskNotifyGiveFromISR():

xTaskToNotify. Es el handler de la tarea consumidora, es de decir, aquella tarea que está esperando por el semáforo. Una de las limitaciones de usar semáforos basados en notificaciones es que únicamente una tarea puede ser notificada. Si un mismo evento debe ser notificado a varias tareas, entonces tendrías que usar varios semáforos.

pxHigherPriorityTaskWoken. Esta función pondrá este parámetro a pdTRUE si la llamada saca del estado Block (es decir, despierta) a una tarea que estuviera esperando por la notificación, y que además dicha tarea tuviera una prioridad mayor que la tarea que actualmente se estuviera ejecutando. Si este es el caso, entonces tú como programador podrías llevar a cabo un cambio de contexto (en inglés, context switch) para que la tarea con mayor prioridad se ejecute saliendo de la ISR. No es obligatorio realizar el cambio de contexto, pero de lo contrario, de haber despertado a una tarea con mayor prioridad ésta deberá esperar hasta un nuevo cambio de contexto del sistema operativo (por ejemplo, en el siguiente tick) o que alguna tarea devuelva voluntariamente la CPU (a través de la macro taskYIELD()).

Valor devuelto. A diferencia de su función espejo, ésta no devuelve nada.

El acceso a las interrupciones en Arduino es algo complicado, así que en lugar de usar una ISR real, simplemente vamos a simular una, y aunque no podremos probarla, espero que te quede claro el uso de esta función.

void producer_ISR()
{
   isr_ack();
   // "reconocemos" la interrupción (ack -> acknowledge)


   BaseType_t pxHigherPriorityTaskWoken = pdFALSE;

   xTaskNotifyGiveFromISR( consumer_handler, &pxHigherPriorityTaskWoken );

   if( pxHigherPriorityTaskWoken != pdFALSE ) taskYIELD;
   // cambio de contexto opcional, pero recomendable
}

Puedes usar con toda seguridadLa función ulTaskNotifyTake() tanto en funciones regulares como en ISRs.

¿Qué sigue?

En la lección de hoy hemos visto cómo utilizar las notificaciones directas a la tarea como semáforos. Vimos ejemplos de semáforos binarios y contadores, y cómo otorgar al semáforo desde dentro de una ISR.

A diferencia de los semáforos propiamente dichos, hacerlo de esta manera ahorra muchos recursos, pero como nada es gratis en la vida, existen compromisos. Uno de los principales es que solamente una tarea puede ser notificada. Los semáforos “reales” (es decir, aquellos incluídos como tal en FreeRTOS) pueden notificar a varias tareas. Así mismo, este mecanismo no permite iniciar en un valor diferente de 0, ni establecer una cuenta máxima. Sin embargo, el abanico de aplicaciones donde pueden ser usados hace que valga la pena conocerlos. En una lección posterior veremos los semáforos “reales” de FreeRTOS.

Finalmente, ten en cuenta que los semáforos no son la panacea de la programación concurrente, ya que traen asociados sus propios problemas; sin embargo, enlistar éstos y buscar las posibles soluciones va más allá del ámbito de esta lección, y quizás merezcan la suya propia. La buena noticia es que muchos de los objetos de FreeRTOS para pasar información (notificaciones, colas, mensajes, flujos) incluyen mecanismos de sincronización (“despiertan” o sacan del estado Block a las tareas consumidoras) que hace que utilizar semáforos “en bruto” sea el plan B.

Índice del curso

Espero que esta entrada haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Notificaciones (II)

En la lección anterior vimos la forma de pasar un dato de hasta 32 bits utilizando las notificaciones directas a las tareas que FreeRTOS provée como un mecanismo incorporado “de fábrica” (todas las tareas incluyen un campo de 32 bits). En la lección de hoy veremos cómo utilizar este mismo mecanismo pero para pasar notificaciones (banderas, avisos) de una tarea a otra.

Tabla de contenidos

¿Qué es y qué necesito?

Este tipo de notificaciones son a nivel de bit; un bit puesto a 1 podría indicar que un sensor se activó, o que una lectura del ADC ya está lista para ser leída, o que un botón se presionó. La tarea productora pondría uno o varios bits a 1 y después la tarea receptora, esperará por el evento, liberando la CPU hasta que le lleguen una o varias notificaciones.

El caso más simple es el de las notificaciones de un sólo bit: la conversión terminó, llegó un byte por el puerto serial (sólo avisa que el byte llegó, no el valor propio de la información), un botón fue presionado (no el valor del botón presionado).

Casos más complejos podrían ser que, además de indicar que el eventó sucedió, pasar la información relacionada a éste. En el ejemplo de una conversión podemos pasar, además, el canal del ADC y el valor de la lectura. En el caso del byte del puerto serial podemos pasar, también, el valor del byte. Y finalmente, para el ejemplo del botón podemos indicar el botón que fue presionado. En todos y cada uno de estos escenarios estaremos utilizando el campo de 32 bits asociado a las notificaciones.

Operaciones a nivel de bit

Máscaras de bits

Antes de entrar en los detalles para usar las notificaciones debemos recordar las máscaras de bits, o simplemente máscaras. Una máscara es una secuencia de bits que indican cuáles bits nos interesan y cuáles no tienen importancia. Para la siguiente explicación usaremos 8 bits, por simplicidad, pero la idea se traslada directamente a los 32 bits disponibles.

Entonces, tenemos 8 bits cuyas posiciones van de la 0 a la 7, contando de derecha a izquierda:

dibujo

Y supongamos que de estos bits nos interesan aquellos en las posiciones 1, 3 y 6. Por lo tanto, debemos descartar los bits en las posiciones 0, 2, 4, 5, 7. Para esto deberemos crear una máscara con 1s en los bits que nos interesan, y con 0s en los bits que no:

dibujo

Este valor lo podemos expresar ya sea en binario o en hexadecimal, siendo esta última la manera más común

#define MASK 0x4A

Una vez que tenemos a la máscara debemos aplicársela al dato del cual queremos discriminar los bits, es decir, quedarnos con los bits que nos interesan. Para ello utilizaremos la operación AND a nivel de bit de C, &. Digamos que nuestro dato tiene el valor 0xFD (en binario, 1111 1101), entonces, de forma gráfica, la aplicación de la máscara es así:

Y en código en C nos queda así:

uint8_t dato = 0xFD;
uint8_t res = dato & MASK; // res <- 0x48

El resultado es 0x48 (en binario, 0100 1000). Esto significa que de nuestro dato el bit 1 vale 0, el bit 3 vale 1, y el bit 6 vale 1. Ya dependerá de nuestra aplicación qué haremos con esta información, lo cual por supuesto estará en los ejemplos que veremos más adelante.

(Si quieres profundizar en las operaciones a nivel de bit, de las cuales hay muchas, puedes ir aquí; y para revisar las operaciones a nivel de bit en C, puedes ir aquí (en inglés)).

Notificaciones de 1 bit

El caso más simple es cuando tienes una sola notificación, la cual puedes codificar con un sólo bit. Si el bit está a 0, el evento no ha sucedido, y si el bit está a 1, entonces el eventó sucedió.

También tenemos el caso en que metemos varios bits independientes en el mismo campo de 32 bits. Esto es útil cuando una misma tarea debe notificar a otra tarea de diversas situaciones, donde cada situación requiere un bit. En el ejemplo a continuación utilizaremos varios bits individuales.

NOTA: Las notificaciones de un sólo bit se parecen más a un mecanismo de sincronización llamado semáforo binario. Éstos no incluyen ningún tipo de información, solamente avisan que un evento sucedió (o que no ha sucedido). Por lo tanto, y como el propio FreeRTOS lo menciona, una forma rápida y barata de implementar semáforos binarios es a través de las notificaciones. Debo señalar, sin embargo, que FreeRTOS incluye semáforos (binarios y contadores) con más características (entre otras, un productor puede notificar a varios receptores), pero que, naturalmente, consumen más recursos.

Ejemplo

En este ejemplo haremos lecturas analógicas para la temperatura ambiente (utilizando al sensor LM35), y avisaremos a la tarea receptora si la temperatura cae en uno de 4 estados: menor a 17 grados centígrados, entre 17 y 24.99 grados, entre 25 y 28.99 grados, y mayor o igual a 29 grados. Cada estado está representado por un bit. Escogí los bits 0-3 del campo de notificación, pero por supuesto tú puedes utilizar la distribución que desees:

#include <FreeRTOS.h>
#include <task.h>

TaskHandle_t consumidor_h;

void Productor1_task( void* pvParameters )
{
   TickType_t last_wake_time = xTaskGetTickCount();

   while( 1 )
   {
      vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( pdMS_TO_TICKS( 1000 ) ) );

      float temp = ( analogRead( A0 ) * 5.0 * 100.0 ) / 1024;

      uint32_t flags = 0;

      if( temp < 17.0 ) flags = 0x00000001;
      else if( temp < 25.0 ) flags = 0x00000002;
      else if( temp < 29.0 ) flags = 0x00000004;
      else flags = 0x00000008;

      xTaskNotify( consumidor_h, flags, eSetValueWithOverwrite );
   }
}

void Consumidor_task( void* pvParameters )
{
   while( 1 )
   {
      uint32_t res;

      if( xTaskNotifyWait( 0xfffffff0, 0xffffffff, &res, pdMS_TO_TICKS( 2000 ) ) != pdFALSE ){

         if( res & 0x01 ){
            Serial.println( "Hace un poco de frío.\n" );
         } else if( res & 0x02 ){
            Serial.println( "El tiempo es agradable." );
         } else if( res & 0x04 ){
            Serial.println( "Hace algo de calor." );
         } else{
            Serial.println( "Hace mucho calor." );
         }

      } else{
         Serial.println( "ERR: No se recibió la notificación." );
      }
   }
}

void setup()
{
   Serial.begin( 115200 );

   xTaskCreate( Productor1_task, "PRD1", 256, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( Consumidor_task, "CONS", 256, NULL, tskIDLE_PRIORITY, &consumidor_h );

   vTaskStartScheduler();
}

void loop() 
{
}

En la tarea consumidora, Consumidor_task(), podrás notar 2 cosas en la llamada a la función xTaskNotifyWait():

  • Utilicé las máscaras de entrada y salida (primero y segundo parámetro, respectivamente) para el campo de notificaciones.
  • Establecí un tiempo de guarda de 2000 ms.

Recordemos la firma de dicha función:

El parámetro ulBitsToClearOnEntry es una máscara que pone a 0 los bits indicados del campo de notificación cuando se entra a la función. Lo podemos utilizar para descartar los bits que no nos interesen. Un bit a 1 significa que el bit en esa posición del campo de notificaciones será puesto a 0. En el ejemplo observarás que descarté los bits 4-31, ya que en la tarea productora solamente utilicé del 0-3.

El parámetro ulBitsToClearOnExit es una máscara que pone a 0 los bits indicados del campo de notificación cuando se sale de la función. Lo podemos utilizar para avisar que ya leímos el campo de notificación. Recuerda que la función xTaskNotify() tiene un parámetro de control, eAction (de tipo eNotifyAction), con el cual la tarea productora podría fallar si pretendieras escribir una nueva notificación sin que la tarea consumida haya leído la anterior (cuando eAction es eSetValueWithoutOverwrite). En el ejemplo establecí que los 32 bits se pusieran a 0 a la salida de la función.

Finalmente, establecí un tiempo de guarda de 2000 ms. La tarea productora realiza una lectura cada 1000 ms, pero si por alguna razón no hiciera la notificación dentro de esa ventana de 2000 ms, entonces la tarea consumidora imprimiría un mensaje de error.

A continuación tienes un fragmento de la salida de este ejemplo:

Ejercicio: Comenta la línea

xTaskNotify( consumidor_h, flags, eSetValueWithOverwrite );

en la tarea productora y observa el resultado.

Codificando bits y datos

Otra cosa interesante que podemos hacer con el campo de notificaciones es codificar en el mismo tanto datos como bits. Al ejemplo anterior podríamos agregarle que, además de indicar con bits el rango de temperatura, notifique la temperatura (para esto deberemos haremos algunos cambios en el código).

Para lograr lo anterior necesitaremos revisar dos cosas antes: poner bits a 1 y desplazamientos.

Poniendo bits a 1

En la sección anterior vimos cómo poner a 0 bits de una máscara usando al operador a nivel de bits de C ‘and’, &. Lo que necesitamos ahora es poner bits a 1; para ello necesitamos al operador ‘or’ a nivel de bits de C, | (una barra). Requeriremos una máscara que indique los bits a poner a 1, y por supuesto el dato (variable) en el cual pondremos a 1 dichos bits.

Por ejemplo, supón que nuestro dato tiene el valor 0x28 y queremos poner sus bits en las posiciones 0, 1, 4, 5 a 1. Entonces creamos una máscara con 1’s en dichas posiciones, y 0’s en el resto: 0x33 (en binario 0011 0011). Después de aplicarle esta máscara a nuestro dato, éste queda con el valor 0x3B:

Los bits que en el dato original ya estaban a 1 y le tocó ponerse a 1, no cambian de valor. Así mismo, los bits que tenían 1 y le aplicas un 0, quedan con 1; es decir, una máscara OR con 0 no afecta el valor del bit.

La operación anterior en C queda como

uint8_t dato = 0x28;
uint8_t res = dato | 0x33; // res <- 0x3B

Desplazando bits

La siguiente operación a nivel de bit es el desplazamiento: mover uno o más bits una o más posiciones a la izquierda o a la derecha. C cuenta con los operadores << y >>, respectivamente. De paso debo comentar que el desplazamiento de un bit a la izquierda equivale a multiplicar al dato por 2; mientras que el desplazamiento de un bit a la derecha equivale a dividir al dato por 2. Dos desplazamientos a la derecha es como multiplicar por 4, y así sucesivamente.

Por ejemplo, si tienes el dato 0x03 (en decimal, 3) y lo desplazas 3 bits a la izquierda, tendrás al final el valor 0x18 (en decimal, 24). Desplazar 3 bits a la izquierda es como multiplicar 2^3=8, y 3*8=24:

La operación anterior en C queda así:

uint8_t dato = 0x03;
uint8_t res = dato << 3; res <- 0x18

Es muy común que el desplazamiento se haga sobre el propio dato; es decir, lo aplicas al dato y lo guardas en el propio dato. Esta operación en C queda así:

uint8_t dato = 0x03; // 0000 0011

dato <<= 3; // dato <- 0x18, es decir, 0001 1000

// la operación "larga" es: dato = dato << 3;

dato >>= 1; // dato <- 0x0C, es decir, 0000 1100, en decimal, 12

Ejemplo

Ahora sí, equipados con las herramientas adecuadas es momento de ver cómo podemos codificar en el campo de notificaciones tanto datos como bits. El ejemplo consta de realizar lecturas en 3 canales del convertidor ADC, una lectura por segundo. La tarea productora notificará a la tarea consumidora el canal del cuál se realizó la lectura (con bits individuales, como el ejemplo pasado) y el valor de la lectura correspondiente (sin procesar). Es decir, un canal del ADC será 0x01, otro canal será 0x02, y otro canal será 0x04. Por otro lado, el dato de 10 bits de la lectura lo insertaremos a partir del bit 16 (este valor no tiene nada de especial, solamente quise abarcar la mayor cantidad posible de bits en el campo de notificación).

NOTA: Mientras trabajaba en el siguiente ejemplo noté un error del compilador de C que Arduino utiliza (avr-gcc): Los desplazamientos a la izquierda NO FUNCIONAN con variables de más de 8 bits. Los desplazamientos a la derecha, sí. En el código notarás que realicé una multiplicación por 65536, lo cual es equivalente a un desplazamiento de 16 bits a la izquierda. Este es un problema de Arduino y su compilador, no de FreeRTOS.

(“No funcionan” significa que sí compilan, pero los resultados son incorrectos, por lo cual no son confiables y no deberías utilizarlos. Una solución es lo que yo hice, multiplicar por 2^n.)

Recuerda que debes activar el uso de las notificaciones en el archivo de configuración FreeRTOSConfig.h. Lo hicimos en el post anterior, pero en caso de que no lo hayas hecho, entra a dicho archivo y escribe la siguiente línea al final del mismo:

#define configUSE_TASK_NOTIFICATIONS 1

Veamos el ejemplo:

#include <FreeRTOS.h>
#include <task.h>

TaskHandle_t consumidor_h;

void Productor1_task( void* pvParameters )
{
   TickType_t last_wake_time = xTaskGetTickCount();

   uint8_t channel;
   uint16_t read;

   while( 1 )
   {
      for( uint8_t cont = 0; cont < 3; ++cont ){

         vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( pdMS_TO_TICKS( 1000 ) ) );

         switch( cont ){
         case 0:
            read = analogRead( A0 );
            channel = 0x01; // 1
         break;

         case 1:
            read = analogRead( A2 );
            channel = 0x02; // 10
         break;

         case 2:
            read = analogRead( A3 );
            channel = 0x04; // 100
         break;

         default:
            while( 1 );
         break;
         }

         uint32_t notif = channel | ( read * 65536 );
         // aquí realizamos la codificación de la lectura y el canal
         //
         // NOTA: El compilador avr-gcc emite código erróneo con los desplazamientos
         // a la izquierda en variables de más de 8 bits. Sin embargo, desplazar a la
         // izquierda n bits equivale a multiplicar el valor por 2^n:
         // 2^16 = 65536

         xTaskNotify( consumidor_h, notif, eSetValueWithOverwrite );

      } // for cont

   } // while 1
}

void Consumidor_task( void* pvParameters )
{
   while( 1 )
   {
      uint32_t res;

      if( xTaskNotifyWait( 0xfc00fff8, 0xffffffff, &res, pdMS_TO_TICKS( 2000 ) ) != pdFALSE ){

         uint8_t channel = res & 0x00000007;
         // aislamos y obtenemos los bits que codifican al canal del ADC

         uint16_t read = ( res & 0x03ff0000 ) >> 16;
         // aislamos y obtenemos los bits que codifican a la lectura


         if( res & 0x01 ){
            Serial.print( "A0: " );
         } else if( res & 0x02 ){
            Serial.print( "A1: " );
         } else if( res & 0x04 ){
            Serial.print( "A2: " );
         } else{
            Serial.println( "Error! " );
         }
         Serial.println( read );

      } else{
         Serial.println( "ERR: No se recibió la notificación." );
      }
   }
}

void setup()
{
   Serial.begin( 115200 );

   xTaskCreate( Productor1_task, "PRD1", 256, NULL, tskIDLE_PRIORITY + 1, NULL );

   xTaskCreate( Consumidor_task, "CONS", 256, NULL, tskIDLE_PRIORITY, &consumidor_h );

   vTaskStartScheduler();
}

void loop() 
{
}

Escogí los canales del ADC A0, A2 y A3 sólo para complicar un poco el código (están “salteados”).

Nota que en primer parámetro de la función xTaskNotifyWait(), en la función consumidora, utilicé la máscara 0xfc00fff8, la cual descarta los bits que no usamos. Te dejo de tarea que lo compruebes (recuerda que el ADC es de 10 bits y que los bits a 1 en la máscara ponen a 0 los bits del campo de notificación).

¿Qué sigue?

Hoy vimos mucha información. Comenzamos con las operaciones a nivel de bit de C, las cuales deben estar en la caja de herramientas de cualquier programador en este lenguaje; sin embargo, hice un pequeño resumen para acordarnos de los temas que utilizaríamos. Vimos también dos usos del campo de notificaciones de las tareas: bits individuales y bits individuales más datos. Mencioné además que descubrí un error (bug) en el compilador que utiliza Arduino. Finalmente, hice mención de un tema que trataremos más adelante, el de los semáforos. Sin embargo, las notificaciones directas se pueden utilizar como semáforos binarios y semáforos contadores “ligeros”, es decir, rápidos y que no consumen muchos recursos (a expensas de estar más limitados).

En la siguiente lección exploraremos el tema de los temporizadores por software. Muchas de las tareas que realizan nuestros sistemas están basadas, de una forma u otra, en temporizaciones; y FreeRTOS incluye un mecanismo que nos facilitará la vida.

Índice del curso

Espero que esta entrada haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Notificaciones (I)

Hasta hoy hemos visto ejemplos de tareas aisladas para demostrar algunos puntos. Sin embargo, las diferentes tareas de las que un sistema embebido está compuesto no trabajan en aislamiento; al contrario, todas ellas, aunque independientes, trabajan en equipo con un mismo objetivo. Para lograrlo las tareas deben pasarse información unas con otras y estar en sincronía. En esta lección veremos una primer forma de pasar información, y en un próxima trataremos el tema de la sincronización.

En FreeRTOS existen diferentes maneras para que una tarea pase información a otra, y cada una varía en su grado de complejidad:

  1. Notificaciones directas (más “fácil”, pero más limitada).
  2. Colas.
  3. Flujos y mensajes (menos “fácil” pero más poderosa y versátil).

Las notificaciones directas son la forma más fácil y rápida para pasar información. Hoy vamos a ver cómo pasar un dato de 32 bits, y en la segunda parte veremos cómo pasar y procesar banderas (conocidas también como notificaciones). En lecciones posteriores estudiaremos las restantes.

Tabla de contenidos

¿Qué es y qué necesito?

Hasta antes de la versión 10.4.0 de FreeRTOS cada tarea en FreeRTOS incluía un campo de 32 bits para ser utilizado como canal de comunicaciones o de sincronización. A partir de dicha versión se incluyó un arreglo de campos. En esta lección estudiaremos las notificaciones simples (las anteriores a la versión 10.4.0).

El nombre oficial para los campos de 32 bits es “notificaciones” y pertenecen a un mecanismo de FreeRTOS llamado notificaciones directas a las tareas (en inglés, Direct to task notifications, DtTN). Aunque este nombre evoca más sincronización que comunicaciones lo utilizaré junto con el de campos para evitar futuras confusiones. Además, ten en cuenta que las notificaciones también sirven para notificar eventos a las tareas, lo cual es tema de una siguiente lección.

La idea detrás de las notificaciones es simple: si la tarea Ta debe pasarle un dato a la tarea Tb, entonces Ta deberá escribirlo en el campo de notificación de Tb, y ésta utilizarlo. Así de fácil. El campo de datos del cual estoy hablando es un entero de 32 bits, y en éste puedes pasar valores enteros, booleanos, banderas, e inclusive, apuntadores void (para pasar información más compleja).

Toma en cuenta que este mecanismo, DtTN, sólo funciona para pasar un dato a la vez de una tarea a otra. Si tu aplicación necesita pasar una colección (lista) de resultados a una o más tareas, entonces deberás utilizar colas, flujos o mensajes, los cuales son más complejos, más lentos y consumen más recursos que las notificaciones directas.

Quizás te estés preguntando, ¿porqué no simplemente usamos variables globales ? Bueno, por tres razones:

  1. Las variables globales son malas.
  2. La tarea receptora Tb, del ejemplo anterior, puede bloquearse (es decir, pasar al estado Blocked; en términos coloquiales, irse a “dormir”) liberando la CPU hasta que reciba la notificación por parte de la tarea Ta. Cuando el dato esté listo, entonces Tb pasa al estado Ready (lista para ejecutarse).
  3. Si el dato no llega dentro de un cierto tiempo, entonces la tarea receptora Tb puede salir del estado Blocked y tomar las acciones necesarias. Esto es muy importante en sistemas embebidos seguros. Además, bajo ciertas configuraciones, existe la posibilidad de que la tarea productora Ta también tome acciones en caso de que por alguna razón la tarea Tb no pudiera accesar al dato.

Si quisieras utilizar variables globales en lugar de las notificaciones de FreeRTOS tu tarea receptora debería estar todo el tiempo despierta preguntando si ya hay un dato disponible; y como consecuencia estaría consumiendo valiosos ciclos de CPU. Y si eso no es suficiente, tendrías que agregar un temporizador para salir de la espera. Muy complicado, mejor usa las notificaciones.

Cuando la tarea emisora Ta escribe el dato en la tarea receptora Tb, la notificación (así se le llama en FreeRTOS) pasa al estado Pending (en español, pendiente) esperando a que Tb lo lea. Este estado Pending de la notificación es el que hace que Tb pase del estado Blocked a Ready. Luego, cuando Tb lo lee, entonces la notificación pasa al estado Not pending. El hecho de que el dato haya sido escrito en Tb no implica que tenga que ser leído inmediatamente, ya que podría pasar un tiempo entre una y otra cosa. Por ejemplo, supón que Tb es una tarea de baja prioridad, y después de que Ta escribió el dato, una tarea de más alta prioridad obtiene la CPU por lo cual, aunque Tb ya fue “notificada”, aún no ha podido leer el dato, sino hasta que le toque su turno.

Por otro lado, en algunas configuraciones (que veremos después) si la notificación tiene el estado Not pending (Tb no la ha leído) y la tarea emisora Ta intenta escribir un nuevo dato, entonces la llamada Ta devolverá un error. Esto sirve porque a veces no querrás sobreescribir un valor nuevo sobre uno anterior si la tarea receptora no lo ha leído.

Para empezar a mandar información entre tareas (en inglés, intertask communication) vamos a usar dos funciones: xTaskNotify() y xTaskNotifyWait(). (Aquí puedes ver el conjunto completo de funciones para notificaciones.)

xTaskNotify()

Esta es la función que la tarea productora debe utilizar para pasar el dato. Su firma es:

xTaskToNotify. En este parámetro le pasamos el handler de la tarea receptora.

¿Recuerdas que en esta lección te mencioné que varios mecanismos de FreeRTOS requieren el handler de las tareas para operar sobre ellas? Pues no hay plazo que no se cumpla. Muchas de las funciones que estudiaremos a partir de esta lección necesitan saber sobre quién van a operar, y la única forma es a través de su handler. En FreeRTOS hay dos maneras de obtenerlo:

  1. Guardándolo (en una variable global) cuando creas tareas con xTaskCreate() y xTaskCreateStatic().
  2. Utilizando a la función xTaskGetHandle(), la cual utiliza a la cadena de texto que representó el nombre de la tarea cuando la creaste (aquí puedes ver su descripción).

En esta lección utilizaremos la primer forma, tanto por simplicidad, como para que veas cómo se guarda (ya que no lo hemos hecho en ejemplos anteriores).

ulValue. Aquí escribes el valor de 32 bits que quieres pasar a la tarea receptora xTaskToNotify.

De ser necesario deberás promocionar el dato que quieres escribir al tipo uint32_t.

eAction. Este parámetro le indica a la función qué hacer con el dato de 32 bits. Para efectos de pasar un dato, el cual es el tema de esta lección, deberás escribir la constante eSetValueWithOverwrite.

En la siguiente lección, Notificaciones (II), te explicaré con detalle el resto de valores que puedes escribir en este parámetro y su significado. Por lo pronto, con lo descrito es suficiente.

Para el caso que nos ocupa, esta función siempre devolverá el valor pdPASS.

xTaskNotifyWait()

La tarea receptora deberá llamar a esta función, cuya firma es:

Como ya lo había mencionado, una vez que la tarea receptora hace la llamada pasa al estado Blocked esperando a que un dato arribe, y mientras la tarea esté en ese estado no usa ciclos de la CPU, lo cual es bueno. Esta función también tiene la ventaja de que si el dato no llega dentro de un cierto tiempo, puede salir y avisarnos para que tomemos las medidas necesarias.

En el bajo mundo de los sistemas operativos cuando una tarea se queda esperando de manera indefinida por un dato o resultado que nunca llegará le llamamos starvation (en español, inanición), y como podrás imaginar, es una muy mala situación. Afortunadamente, muchas funciones de FreeRTOS incorporan una especie de software watchdog (perro guardían) que nos ayudará a salir de dicha situación.

Si deseas utilizar esta característica asegúrate que la tarea receptora tenga una prioridad alta, ya que de no ser así, el código asociado al manejo de la inanición tardará en ejecutarse, o peor aún, nunca hacerlo.

Veamos los parámetros de la función:

ulBitsToClearOnEntry. Este parámetro indica qué bits del dato deben ponerse a cero a la entrada de la función. Es una especie de máscara para eliminar bits que no nos interesan y se utiliza cuando pasas bits en lugar de valores.

En esta lección deberás escribir el valor 0x00. Con esto le estarás diciendo que no ponga ningún bit a cero, ya que eso alteraría nuestro dato. En la segunda parte de esta lección veremos cómo se usa.

ulBitsToClearOnExit. Este parámetro indica qué bits del dato deben ponerse a cero a la salida de la función. Es una especie de máscara para eliminar bits que no nos interesan y se utiliza cuando transmites bits en lugar de valores.

En esta lección deberás escribir el valor 0x00. Con esto le estarás diciendo que no ponga ningún bit a cero a la salida. FreeRTOS hace una copia del dato antes de aplicarle la limpieza de bits, y luego devuelve dicha copia, así que por lo pronto no te preocupes. En la segunda parte de esta lección veremos cómo se usa.

pulNotificationValue. En este parámetro escribirás la dirección de la variable donde quieres guardar el dato. Recuerda que dicha variable debe ser de 32 bits, es decir, del tipo uint32_t.

xTicksToWait. En este parámetro indicas cuánto tiempo (en ticks) quieres esperar por el dato; puedes esperar el tiempo que quieras (especificándolo en milisegundos a través de la macro pdMS_TO_TICKS(), o esperar por siempre especificando el valor portMAX_DELAY.

En un sistema embebido bien hecho JAMÁS deberías especificar portMAX_DELAY.

Atte: Cualquier programador de sistemas embebidos.

Me permito ser repetitivo: para usar esta característica asegúrate que la prioridad de la tarea receptora sea igual o mayor que la productora para que cuando el tiempo expire FreeRTOS la escoja para ser ejecutada. Si tiene prioridad baja, entonces deberá esperar su turno, y quizás éste nunca llegue.

En los ejemplos a continuación veremos ambas formas.

Valor de retorno. Esta función devolverá pdPASS cuando se reciba una notificación, o si la notificación ya estaba lista cuando hiciste la llamada. Si el tiempo programado expiró, entonces devolverá pdFAIL.

Configuración

Antes de ejecutar los ejemplos a continuación asegúrate que las siguientes constantes simbólicas (en el archivo de configuración FreeRTOSConfig.h) tienen el valor mostrado:

#define configUSE_TASK_NOTIFICATIONS            1
#define configTASK_NOTIFICATION_ARRAY_ENTRIES   1 // o cualquier valor igual o mayor

Ejemplo 1

En este primer ejemplo veremos un programa simple donde una tarea produce un dato cada 1000 ms y una tarea receptora los procesa. El dato producido es el valor 1, 2, 3. La tarea receptora parpadeará ese mismo número de veces. El periodo de cada parpadeo es de 200 ms.

#include <FreeRTOS.h>
#include <task.h>

TaskHandle_t consumidor_h;
// la tarea productora necesita saber quién es el consumidor

void Productor_task( void* pvParameters )
{
    uint32_t cont = 1;
    // el valor que queremos transmitir debe ser uint32_t

    TickType_t last_wake_time = xTaskGetTickCount();

    while( 1 )
    {
        vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( 1000 ) );

        Serial.println( "P" );

        xTaskNotify( consumidor_h, cont, eSetValueWithOverwrite );

        ++cont;
        if( cont > 3 ) cont = 1;
    }
}

void Consumidor_task( void* pvParameters )
{
    pinMode( 13, OUTPUT );

    uint32_t blinks;
    // la variable donde guardamos el dato debe ser uint32_t

    while( 1 )
    {
        xTaskNotifyWait( 0x00, 0x00, &blinks, portMAX_DELAY );

        Serial.println( blinks );
        // Depuración: Imprimos el número de parpadeos

        for( uint8_t i = 0; i < blinks; ++i ){

            digitalWrite( 13, HIGH );
            vTaskDelay( pdMS_TO_TICKS( 100 ) );
            digitalWrite( 13, LOW );
            vTaskDelay( pdMS_TO_TICKS( 100 ) );
        }
    }
}

void setup()
{
    Serial.begin( 115200 );

    xTaskCreate( Productor_task, "PROD", 128, NULL, tskIDLE_PRIORITY + 1, NULL );
    // nota que la prioridad del productor es más alta que la del consumidor;
    // casi siempre será así.

    xTaskCreate( Consumidor_task, "CONS", 128, NULL, tskIDLE_PRIORITY, &consumidor_h );
    // en consumidor_h guardamos el handle de la tarea consumidora

    vTaskStartScheduler();
}

void loop() 
{
}

Nota que la tarea productora tiene prioridad más alta que la consumidora. Además, no basta con que la productora escriba el dato, también debe prestarle la CPU a la tarea receptora; esto lo logra llamando a la función vTaskDelayUntil(), aunque por supuesto puedes usar cualquier otra función que haga que la tarea productora se bloquée.

Ejemplo 2

En este ejemplo agregué elementos para que la tarea productora falle (no notifique a la tarea receptora), y para que la receptora no se quede en un ciclo infinito esperando por un dato que nunca va a llegar. Ambas tareas tienen la misma prioridad.

#include <FreeRTOS.h>
#include <task.h>

TaskHandle_t consumidor_h;
// la tarea productora necesita saber quién es el consumidor

void Productor_task( void* pvParameters )
{
    uint32_t cont = 1;

    uint8_t cont_to_fail = 10;

    TickType_t last_wake_time = xTaskGetTickCount();

    while( 1 )
    {
        vTaskDelayUntil( &last_wake_time, pdMS_TO_TICKS( 1000 ) );

        Serial.println( "P" );

        xTaskNotify( consumidor_h, cont, eSetValueWithOverwrite );

        ++cont;
        if( cont > 3 ) cont = 1;

        // hacemos que falle después de 10 ciclos
        if( --cont_to_fail == 0 ){ 

           while( 1 ) taskYIELD();
           // esta tarea entrega voluntariamente la CPU,
           // aunque la vida real no es tan bonita

        }
    }
}

void Consumidor_task( void* pvParameters )
{
    pinMode( 13, OUTPUT );

    uint32_t blinks;

    while( 1 )
    {
        if( xTaskNotifyWait( 0x00, 0x00, &blinks, pdMS_TO_TICKS( 2000 ) ) == pdPASS ){

           Serial.println( blinks );

           for( uint8_t i = 0; i < blinks; ++i ){

               digitalWrite( 13, HIGH );
               vTaskDelay( pdMS_TO_TICKS( 100 ) );
               digitalWrite( 13, LOW );
               vTaskDelay( pdMS_TO_TICKS( 100 ) );

           }
         } else{ // time-over:

            digitalWrite( 13, HIGH );

            while( 1 ){
               Serial.println( "Error" );
               vTaskDelay( pdMS_TO_TICKS( 1000 ) );
            }
         }
    }
}

void setup()
{
    Serial.begin( 115200 );

    xTaskCreate( Productor_task, "PROD", 128, NULL, tskIDLE_PRIORITY + 0, NULL );

    xTaskCreate( Consumidor_task, "CONS", 128, NULL, tskIDLE_PRIORITY, &consumidor_h );

    vTaskStartScheduler();
}

void loop() 
{
}

En la siguiente imagen podrás ver una ejecución de este programa:

¿Qué sigue?

En la lección de hoy vimos cómo utilizar un mecanismo intrínseco de FreeRTOS para comunicaciones y sincronización: las notificaciones directas a las tareas. Éste es un campo de 32 bits al cual podemos darle diversos usos. Uno de ellos ya lo discutimos, y otro uso, el de las notificaciones, lo veremos en la segunda parte.

También recalqué la idea de que las tareas no deberían quedarse esperando de manera indefinida. Muchas funciones de FreeRTOS incluyen un time-out para que la tarea receptora tome las acciones necesarias en caso de inanición (starvation). Úsalo siempre que te sea posible.

En la segunda parte de esta lección estudiaremos cómo usar este mismo mecanismo pero para enviar notificaciones (banderas, señalizaciones) como bits individuales.

(En esta página encontrarás información de suma importancia sobre los flujos, mensajes y notificaciones, aunque todavía no hayamos visto tales temas. Deberías leerla en cuanto te sea posible.)

Índice del curso

Espero que esta entrada haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Tareas periódicas

Una actividad muy común en nuestros proyectos es la programación de código que debe ejecutarse de manera periódica. FreeRTOS cuenta con dos funciones que nos permiten tener tareas periódicas: vTaskDelay() y vTaskDelayUntil().

Quizás te estés preguntando por la función delay() de Arduino, ¿no es suficiente con ella? Pues no. Esta función, como otras tantas de Arduino, son funciones bloqueantes. Esto significa que mientras se están ejecutando nadie más en el sistema (a excepción de las interrupciones) puede hacer nada; es como si el sistema se “colgara” mientras transcurre el tiempo asignado a delay(). Esta situación es inaceptable en los sistemas de tiempo real.

¿Y qué hace tan especiales a las funciones vTaskDelay() y vTaskDelayUntil()? Estas funciones, como prácticamente todas las de FreeRTOS, liberan a la CPU mientras el tiempo programado se cumple, lo cual las hace diametralmente opuestas a su contraparte de Arduino, delay(). Cuando el tiempo programado transcurrió, FreeRTOS reactiva a la tarea para que continúe con su trabajo.

Por esta razón, si estás escribiendo un sistema de tiempo real, siempre deberías utilizar a las funciones vTaskDelay() y vTaskDelayUntil() en lugar de delay().

Tabla de contenidos

¿Qué es y qué necesito?

Como mencioné en la introducción, las funciones vTaskDelay() y vTaskDelayUntil() son parte de FreeRTOS y su principal cualidad es que liberan a la CPU mientras el tiempo programado transcurre. Una vez que esto sucede la tarea se reactiva para continuar con su trabajo.

Estamos a punto de comenzar con funciones de FreeRTOS que cambian el estado de una tarea debido a alguna transición. Por ello debemos discutir de manera breve sobre los estados por los que pasa una tarea en FreeRTOS para que le saques el mayor provecho a este sistema operativo. Inmediatamente después abordaremos a las funciones vTaskDelay() y vTaskDelayUntil(), y sus diferencias.

Estados de una tarea en FreeRTOS

Una tarea en FreeRTOS puede estar en uno de cuatro estados. La siguiente imagen los ilustra, así como las transiciones entre estados:

Estados de una tarea y transiciones entre estados.

Ready (listo). En este estado la tarea no se está ejecutando (no utiliza ciclos de CPU), pero es elegible para ejecutarse. Para el caso que nos ocupa, cuando el tiempo transcurrido en las funciones vTaskDelay() o vTaskDelayUntil() ha expirado la tarea pasa a este estado para ser ejecutada en cuanto sea posible.

Running (ejecutándose). En este estado la tarea está siendo ejecutada por el procesador, y por lo tanto, está haciendo un trabajo útil.

Blocked (bloqueada). En este estado la tarea no es elegible para ser ejecutada porque está esperando que un evento (interno o externo) suceda para pasar al estado Ready, y por lo tanto, no utiliza ciclos de CPU. Cuando mandas llamar a las funciones vTaskDelay() o vTaskDelayUntil() (las que estamos viendo en esta lección) la tarea se bloquea hasta que el tiempo programado transcurra. Con otras funciones de FreeRTOS (eventos, semáforos, colas, etc) las tareas se pueden auto-desbloquear luego de transcurrido un tiempo para evitar bloqueos infinitos que afecten al sistema (yo les llamo software-watchdog).

Suspended (suspendida). En este estado la tarea no es elegible para ser ejecutada, pero a diferencia del estado Blocked, no está esperando ningún evento; es como si la tarea no existiera. Sin embargo, es posible que otra tarea puede sacarla de este estado utilizando la primitiva vTaskResume(). Cabe mencionar que una tarea puede enviarse a sí misma a este estado.

Notarás que la transición del estado Running al estado Blocked se produce cuando llamas a una función bloqueante. En el contexto de los sistemas operativos, cuando decimos que una función se bloquea nos referimos a que libera la CPU y queda a la espera de algún evento (tiempo, semáforos, notificaciones, etc) para volver al estado Ready. Por favor no confundas este término con el de la programación secuencial (la de Arduino) donde una función bloqueante significa que dicha función acapara la CPU por todo el tiempo que quiera.

vTaskDelay()

Esta función ya la hemos estado utilizando. Ahora toca analizarla con más detalle. Comencemos viendo su firma:

Esta función manda a la tarea que la invoca al estado Blocked (en términos coloquiales, la “duerme”) por el tiempo establecido en su único argumento xTicksToDelay. Como ya he mencionado, mientras la tarea esté en dicho estado no ocupa ciclos de CPU.

Toma en cuenta que esta función trabaja con ticks del sistema, pero nosotros como humanos nos entendemos más en segundos (o fracciones de éstos), por lo que deberías evitar el uso directo de ticks; es mejor convertirlos a milisegundos (ms). (En mi proyecto Molcajete establecí que cada tick equivalga a 1ms, pero tú podrías cambiarlo si lo deseas; de cualquier manera, como práctica de buena programación, siempre deberías realizar la conversión para que tu aplicación sea portable.)

Existen dos formas para convertir ticks a milisegundos: utilizando a la constante portTICK_RATE_MS, o a través de la macro pdMS_TO_TICKS:

vTaskDelay( 100 / portTICK_RATE_MS ); 
// La tarea se 'duerme' durante 100 milisegundos

vTaskDelay( pdMS_TO_TICKS( 100 ) );
// La tarea se 'duerme' durante 100 milisegundos

Ambas formas son funcionalmente equivalentes. La diferencia es que la primera, portTICK_RATE_MS, tiene limitaciones técnicas: no se puede usar con ticks más rápidos de 1ms, por ejemplo, con ticks de 500 microsegundos (us). Aunque es difícil ver al sistema operativo usando ticks a esa velocidad, no es imposible.

Otro escenario donde es conventiente que utilices a la macro pdMS_TO_TICKS() en lugar de ticks directos, es cuando el tick de tu sistema es más lento, por ejemplo 10ms o 100ms, lo cual es muy común. No siempre querrás tener trabajando al sistema operativo a full speed. Mi recomendación es que siempre uses a la macro pdMS_TO_TICKS() aunque el tick sea de 1ms.

Esta función, al igual que vTaskDelayUntil(), deben ser “activadas” en FreeRTOS antes de ser utilizadas. Busca en el archivo de configuración FreeRTOSConfig.h las siguientes líneas y asegúrate que ambas estén a 1:

#define INCLUDE_vTaskDelayUntil 1
#define INCLUDE_vTaskDelay      1

(Si no recuerdas dónde está este archivo de configuración puedes refrescar tu memoria yendo a esta lección.)

El siguiente ejemplo crea dos tareas: una hace parpadear a un LED conectado en el pin 13, y otra envía mensajes a la consola. Ambas usan a la función vTaskDelay() y a la macro pdMS_TO_TICKS():

#include <FreeRTOS.h>
#include <task.h>

void task_1( void* pvParameters )
{
   pinMode( 13, OUTPUT );

   while( 1 )
   {
      digitalWrite( 13, HIGH );

      vTaskDelay( pdMS_TO_TICKS( 100 ) );

      digitalWrite( 13, LOW );

      vTaskDelay( pdMS_TO_TICKS( 900 ) );
   }
}

void task_2( void* pvParameters )
{
   uint16_t cont = 0;

   while( 1 )
   {
      vTaskDelay( pdMS_TO_TICKS( 1500 ) );

      Serial.print( cont++ );
      Serial.println( ": Hola mundo" );
   }
}

void setup()
{
   xTaskCreate( task_1, "TSK1", 128, NULL, tskIDLE_PRIORITY, NULL );

   xTaskCreate( task_2, "TSK2", 128, NULL, tskIDLE_PRIORITY, NULL );

   Serial.begin( 115200 );

   vTaskStartScheduler();
}

void loop() 
{
}

Antes de que pasemos a ver la siguiente función siento una obsesiva necesidad de recordarte:

Usa a vTaskDelay() o vTaskDelayUntil() en lugar de la función delay() de Arduino en tus sistemas de tiempo real!.

Atte: Programadores de sistemas de tiempo real.

vTaskDelayUntil()

FreeRTOS incluye una segunda función para mandar “dormir” a las tareas (es decir, enviarlas al estado Blocked): vTaskDelayUntil(), ¿y porqué ha incluído dos? Porque vTaskDelay() es relativa: comienza a descontar el tiempo desde el momento en que es llamada, mientras que vTaskDelayUntil() es absoluta: descuenta el tiempo con respecto a un punto de referencia en el pasado.

La mejor forma de entender la diferencia es con un gráfico. Supón que necesitas que una tarea se ejecute con periodo de 10 ms (milisegundos); y que cada tarea requiere (estoy exagerando) 2 ms. La figura superior A muestra el comportamiento con vTaskDelay(), y la figura inferior B muestra el comportamiento con vTaskDelayUntil(). En A puedes ver cómo se va desplazando el momento en que la tarea se ejecuta. Este tiempo es la suma del tiempo que necesita la tarea más el del tiempo de bloqueo (12, 24, 36, …). En B la tarea siempre empieza al tiempo establecido (10, 20, 30, …) sin importar cuánto dura la ejecución de la tarea.

Y como era de esperarse, vTaskDelayUntil() es ligeramente más complicada:

Esta función requiere dos argumentos. El primero, pxPreviousWakeTime, se refiere al punto de referencia en el pasado a partir del cual comenzará la cuenta, mientras que el segundo, xTimeIncrement, es el tiempo que la tarea se bloqueará. La tarea saldrá del estado Blocked cuando un contador interno de ticks de FreeRTOS alcance la cuenta pxPreviousWakeTime + xTimeIncrement. La propia función actualiza al argumento pxPreviousWakeTime con el resultado de la operación anterior para que vuelva a ser usada como punto de referencia.

Veamos un ejemplo:

#include <FreeRTOS.h>
#include <task.h>

void led_task_1( void* pvParameters )
{
   uint8_t* pin = (uint8_t*) pvParameters;

   pinMode( *pin, OUTPUT );

   const TickType_t period_1 = pdMS_TO_TICKS( 100 );

   const TickType_t period_2 = pdMS_TO_TICKS( 200 );

   TickType_t last_wake_time = xTaskGetTickCount();

   while( 1 )
   {
      digitalWrite( *pin, HIGH );

      vTaskDelayUntil( &last_wake_time, period_1 );

      digitalWrite( *pin, LOW );

      vTaskDelayUntil( &last_wake_time, period_2 );
   }
}

void setup()
{
   static uint8_t led1 = 13;

   xTaskCreate( 
         led_task_1,
         "LD1",
         128,
         (void*) &led1,
         tskIDLE_PRIORITY,
         NULL );

   vTaskStartScheduler();
}

void loop() 
{
}
  • Líneas 10 y 12: Establecemos los periodos ON/OFF para el LED. Observa que las variables tienen el tipo TickType_t, y que estamos usando la macro de conversión pdMS_TO_TICKS().
  • Línea 14: La variable last_wake_time es el punto de referencia para mantener un tiempo absoluto. La función xTaskGetTickCount() devuelve el tiempo actual del sistema en en ticks (es decir, la cantidad de ticks transcurridos desde que el sistema se inicio).
  • Líneas 20 y 24. Usamos la función. La variable last_wake_time es actualizada dentro de vTaskDelayUntil(), por eso debemos mandar su “original” (su dirección) a través del operador referencia, &.

(Si no recuerdas cómo pasar argumentos a las tareas, líneas 6 y 36, quizás quieras visitar esta lección, Pasando argumentos a las tareas. No es requisito usar este mecanismo para utilizar a vTaskDelayUntil()).

¿Qué sigue?

En esta lección hemos visto los estados por los que pasan las tareas. También vimos las dos funciones que FreeRTOS proporciona para realizar tareas periódicas, vTaskDelay() y vTaskDelayUntil(), una relativa y otra absoluta, respectivamente. También platicamos de la importancia de utilizar funciones que liberen a la CPU cuando están esperando un evento en sistemas de tiempo real, y que funciones nativas de Arduino se “cuelgan” mientras están haciendo su trabajo.

En la siguiente lección voy a mostrarte cómo enviar notificaciones simples entre tareas.

Índice del curso

Espero que esta lección haya sido de tu interés. Si fue así podrías suscribirte a mi blog, o escríbeme a fjrg76 dot hotmail dot com, o comparte esta entrada con alguien que consideres que puede serle de ayuda.


Pasando parámetros a las tareas

En las entradas del blog correspondientes a la creación de tareas vimos que existe la posibilidad de pasar valores a la tarea que está siendo creada. Éstos podrían indicar algún parámetro de configuración, valores para algún cálculo, etc. También podemos usar este mismo mecanismo para reutilizar el código de una tarea (el cual es tema de una siguiente entrada). Y aunque es un sólo parámetro podemos pasar valores simples o compuestos. En esta entrada te voy a mostrar cómo usarlo.

Tabla de contenidos

¿Qué es y qué necesito?

Todas las tareas en FreeRTOS reciben un parámetro, el cual lo puedes usar o no, y cuyo tipo es void*. Y las funciones de creación de tareas, xTaskCreate() y xTaskCreateStatic(), incluyen un parámetro también de tipo void* para pasarle datos a la tarea, es decir, lo que tú especifiques en este parámetro le será pasado a la tarea la primera vez que se ejecute.

Recuerda que aunque las tareas se codifican como funciones, tienen un tratamiento especial por parte del sistema operativo, y la mejor manera de pasarle información (que puede ser usada dentro de la tarea antes de entrar al ciclo infinito) es a través de este parámetro. En la documentación oficial se le llama pvParameters (y si el nombre no te gusta, se lo puedes cambiar, siempre y cuando el tipo void* siga ahí. En lo personal los nombres oficiales de FreeRTOS no me gustan, pero los uso para evitar confusiones):

void una_tarea( void* pvParameters )
{
   // cuerpo de la tarea
}

void otra_tarea( void* params ) // por si no te gusta el nombre pvParameters
{
   // cuerpo de la tarea
}

Vamos a recordar la firma de la función xTaskCreate() (la explicación es idéntica para la función xTaskCreateStatic()):

Es en el 4to parámetro donde le pasas información a la tarea, void* pvParameters. Y aunque es un sólo parámetro, las tareas pueden recibir valores simples o valores compuestos. Un valor simple, por ejemplo, un entero, podría indicar el número de pin en Arduino al que está asociado el LED. Un valor compuesto es un conjunto de dos o más valores, del mismo o diferente tipo. Un par (p,t) podría indicar el pin al cual está asociado un LED, y el tiempo de parpadeo. Para cualquiera de los dos casos, valores simples o compuestos, necesitarás utilizar apuntadores void, mientras que para los valores compuestos necesitas usar estructuras de C.

Pasando valores simples a las tareas

Lo primero que vamos a hacer es pasar valores simples a las tareas, y para esto necesitamos ver lo que son los apuntadores void.

Apuntadores void

Recordemos la firma de una tarea en FreeRTOS:

void tarea( void* pvParameters );

El tipo del parámetro pvParameters es void*, ¿y esto qué significa? La respuesta corta es:

Un apuntador void apunta a cualquier cosa (tipo).

Sin embargo, debemos elaborar una respuesta larga y lo haremos comenzando por lo elemental: los apuntadores son variables que guardan direcciones de otras variables. Un apuntador “normal” sólo puede guardar direcciones de variables de su mismo tipo:

int var_int = 5;       // variable entera
int* p_int = &var_int; // el apuntador p_int sólo puede guardar direcciones de variables enteras
float var_float = 5.0;
p_int = &var_float;    // error: tipos diferentes

La magia comienza cuando declaramos que el tipo del apuntador será void:

void* p_void;

Esto le dice al compilador de C/C++ que el apuntador p_void guardará una dirección que no está asociada a ningún tipo de dato en particular; es decir, solamente está guardando una dirección. ¿Cómo es posible entonces utilizarlo con fines prácticos? Bueno, aquí viene otro concepto: moldeado, o promoción (o casting, en inglés).

Moldeado

El moldeado sirve para promocionar un tipo hacia otro tipo:

int var_int = 3;
float var_float = (float) var_int; // "convierte" el 3 en 3.0

El moldeado o promoción se lleva a cabo cuando el compilador encuentra un tipo de dato encerrado entre paréntesis, en el ejemplo: (float). La variable var_int sigue siendo entera; lo que sucedió es que a su valor asociado, el 3, le agregó el punto decimal (es un poco más complicado que eso, pero quedémonos con esa idea), y luego guardó el 3.0 en la variable var_float.

En general, si nos vemos utilizando castings en uno de nuestros programas quiere decir que algo estamos haciendo mal, pero esto no aplica con los apuntadores void, ya que es eso lo que queremos.

Una vez que vimos lo que es el moldeado, veamos cómo lo podemos aplicar para “quitarle” el tipo a una variable:

int var_int = 3;
void* p_void = var_int;             // en C (el moldeado es implícito)
void* p_void_cpp = (void*) var_int; // en C++ (el moldeado debe ser explícito)

El apuntador p_void ya guarda la dirección de la variable var_int, pero sin saber que se trata de un int. En este punto NO PODEMOS DE-REFERENCIAR al apuntador, es decir, no podemos usarlo ya que el compilador no tiene idea del tipo de dato al que apunta.

Y para que una dirección nos sea útil debe apuntar a una variable en nuestro programa. Para ello utilizaremos al moldeado en sentido contrario, es decir, pasaremos de una dirección void a una dirección del tipo original de la variable:

int var_int = 3;
void* p_void = var_int;

// más código ...

int otra_var_int = p_void;           // en C
int otra_var_int_cpp = (int) p_void; // en C++

A la variable otra_var_int le fue asignada el contenido apuntado en la dirección guardada por p_void, y desde este momento contiene el valor 3.

Ejemplo

Una vez vistos los conceptos de apuntadores void y moldeado, pongamos manos a la obra con un ejemplo simple: Vamos a crear dos tareas idénticas, donde cada una recibirá el número de pin de Arduino asociado a un LED. (En una siguiente entrada veremos cómo reutilizar el código de una tarea para no duplicar código.)

Dentro del cuerpo de cada tarea promocionaremos al parámetro pvParameters (que es del tipo apuntador a void) a un entero uint8_t:

uint8_t pin = (uint8_t) pvParameters;

Y cuando estemos creando las tareas convertiremos el número de pin a apuntador void:

xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) 13, // convertimos el entero 13 a apuntador void
      tskIDLE_PRIORITY,
      NULL );

Aquí está el ejemplo completo (en sketch):

#include <FreeRTOS.h>
#include <task.h>

void led_task_1( void* pvParameters )
{
    uint8_t pin = (uint8_t) pvParameters;

    pinMode( pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( pin, HIGH );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
   
        digitalWrite( pin, LOW );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
    }
}

void led_task_2( void* pvParameters )
{
    uint8_t pin = (uint8_t) pvParameters;

    pinMode( pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( pin, HIGH );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
   
        digitalWrite( pin, LOW );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
    }
}

void setup()
{
   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) 13,
      tskIDLE_PRIORITY,
      NULL );

   xTaskCreate( led_task_2, "LD2", 128, (void*) 12, tskIDLE_PRIORITY, NULL );

   vTaskStartScheduler();
}

void loop() 
{
   // put your main code here, to run repeatedly:
}

Hemos usado valores enteros constantes para pasar el número de pin, pero ¿podemos usar variables para lo mismo? Sí, pero es más complicado y merece su propia explicación

Usando variables para pasar valores a las tareas

¿Porqué una sección especial para este tema? ¿No es suficiente con declarar una variable y pasársela a la tarea? No y sí:

  • La respuesta es NO si tu proyecto está en un sketch, porque la cosa se complica un poco.
  • La respuesta es SÍ si estás programando desde la consola, porque las cosas son más sencillas (ya que empiezas desde la función main()).

Pero como la mayoría de personas usa sketches, entonces debo explicar la razón de porqué no es tan simple y las formas que tenemos para hacerlo.

Empezando por el principio: la variable que tiene el valor que le quieres pasar a la tarea debe existir cuando la tarea se esté ejecutando. Esto es, no basta con que la variable exista cuando estás creando a la tarea, debe seguir vigente durante el tiempo que la tarea esté activa.

El problema de los sketches son las funciones setup() y loop(), porque cuando una función alcanza la llave de cierre (ya sea porque el código llegó ahí, o porque utilizaste la instrucción return) las variables declaradas dentro de ellas dejan de existir. En los ejemplos que hemos visto hasta ahora hemos creado a las tareas dentro de setup(), pero cuando el sistema operativo inicia, esta función deja de existir, junto con las variables que hayas declarado en ella:

setup()
{
   uint8_t pin = 13; // pin es una variable local a setup()

   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) &pin, // intentamos usar la variable pin. Compila, pero NO FUNCIONA
      tskIDLE_PRIORITY,
      NULL );

   vTaskStartScheduler(); // no se ve, pero la función setup() deja de existir en este punto
}

Aunque parece que le estamos pasando el valor 13 a xTaskCreate() al momento de la creación de la tarea, esto no es así. La dirección de la variable local pin es almacenada para cuando la tarea sea ejecuta posteriormente. Y cuando esto suceda, la función setup() ya no existirá, y por lo tanto, la variable pin tampoco.

¿Qué podemos hacer? Lo fundamental es que la variable siga existiendo cuando la tarea se ejecute y tenemos cuatro formas de asegurarnos de ello:

  1. Usando variables globales, o
  2. Usando variables estáticas, o
  3. Creando variables dinámicas.

1. Usando variables globales

La forma más fácil es usando variables globales, ya que éstas existen durante toda la vida del programa. En lo personal, soy muy reacio a utilizarlas, a menos que no exista de otra:

uint8_t pin = 13; // pin es una variable global

setup()
{
   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) &pin, // intentamos usar la variable pin
      tskIDLE_PRIORITY,
      NULL );

   vTaskStartScheduler();
}

2. Usando variables estáticas

Las variables marcadas como static tienen la particularidad de que son locales a la función en la que se declararon, pero existen durante toda la vida del programa; son un híbrido entre variables locales y globales. Tienen la ventaja de que no son visibles fuera de la función donde fueron declaradas, a diferencia de las globales que son visibles desde el punto donde se declararon:

setup()
{
   static uint8_t pin = 13; // la variable pin es marcada como static

   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) &pin, // pasamos la dirección de la variable
      tskIDLE_PRIORITY,
      NULL );

   vTaskStartScheduler();
}

Por favor nota que en la línea 9 debes pasar la dirección de la variable, de ahí que esté precedida por el símbolo de referencia, &.

Pero para que esta solución funcione también deberás modificar, en la tarea, el código que lee la variable, ya que ahora es una dirección y no un valor, y por tanto, deberás de-referenciarla:

void led_task_1( void* pvParameters )
{
    uint8_t* pin = (uint8_t*) pvParameters;

    pinMode( *pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( *pin, HIGH );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
   
        digitalWrite( *pin, LOW );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
    }
}

¿Porqué funciona? Las variables locales se almacenan en la pila del programa (de cualquier programa en C), y esta zona es dinámica en el sentido de que las variables se crean y se destruyen (pero sin llamadas a malloc()) conforme se entra y se sale de las funciones. Las variables globales se guardan en una zona diferente, y esta zona es estática en el sentido de que una vez que una variable es puesta ahí, ésta existirá mientras el programa exista. El problema es que las variables globales son visibles a todas las funciones del programa. Las variables estáticas se guardan en la misma zona que las globales, pero su visibilidad está limitada a la función, y estrictamente hablando, al bloque, {}, donde fueron declaradas. Las variables dinámicas, que veremos a continuación, se almacenan en otra área de la memoria llamada el heap.

3. Creando variables dinámicas

Para este caso tendremos que crear variables dinámicas utilizando a la función pvPortMalloc(). Su existencia también será, al igual que las globales, durante todo el programa, pero con la ventaja de que no tendrán visibilidad global:

setup()
{
   uint8_t* pin = pvPortMalloc( sizeof( uint8_t ) );
   // pedimos memoria para un entero de 8 bits

   *pin = 13;
   // escribimos en la dirección apuntada por pin

   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) pin, // sin &, ya que pin es un apuntador
      tskIDLE_PRIORITY,
      NULL );

   vTaskStartScheduler();
}

Presta especial atención a la línea 13: la variable pin ya es una dirección porque fue declarada como apuntador, por lo cual no deberás escribir al operador referencia, &. ¡No culpes al mensajero! A veces el Lenguaje C es confuso.

Al igual que con las variables estáticas deberás modificar, en la tarea, el código que lee la variable, ya que ahora es una dirección y no un valor (voy a repetir el código para que quede lo más claro posible):

void led_task_1( void* pvParameters )
{
    uint8_t* pin = (uint8_t*) pvParameters;

    pinMode( *pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( *pin, HIGH );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
   
        digitalWrite( *pin, LOW );

        vTaskDelay( pdMS_TO_TICKS( 500 ) );
    }
}

NOTA: Para que esta solución funcione, el soporte para creación de objetos dinámicos debe estar activo (en el archivo FreeRTOSConfig.h):

#define configSUPPORT_DYNAMIC_ALLOCATION 1

¿Esto aplica a los proyectos en consola?

Sí. Las tres propuestas vistas funcionan para los proyectos que realices en la consola. Pero existe un pequeña ventaja: si declaras tus tareas y las variables para los parámetros dentro de la función main(), entonces no es necesario que uses al modificador static, ya que las variables declaradas dentro de esta función van a existir mientras el programa se esté ejecutando; es decir, mientras no apagues o resetees a tu circuito. Sin embargo, inclusive en este caso, lo mejor es seguir marcando las variables como static.

Pasando valores compuestos a las tareas

Aunque muchas veces es suficiente con pasar un valor simple a la tarea, en muchas otras necesitaremos pasar más de un valor, y quizas de tipos diferentes. Hace rato mencioné que en nuestro ejemplo podíamos pasar, además del pin asociado al LED, el tiempo para el parpadeo. Para pasar dos o más valores utilizarás estructuras de C.

Si quisieras pasar el número de pin, el tiempo de encendido y el tiempo de apagado, la estructura se vería así:

typedef struct
{
   uint8_t pin;
   uint16_t t_on;
   uint16_t t_off;
} Tarea1_Params;

Luego, tendrías que modificar el código de la tarea para que use los campos de la estructura. Nota que debes usar al operador flecha, ->, ya que hay que promocionar pvParameters a un apuntador de tipo Tarea1_Params:

void led_task_1( void* pvParameters )
{
    Tarea1_Params* params = (Tarea1_Params*) pvParameters;

    pinMode( params->pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( params->pin, HIGH );

        vTaskDelay( pdMS_TO_TICKS( params->t_on ) );
   
        digitalWrite( params->pin, LOW );

        vTaskDelay( pdMS_TO_TICKS( params->t_off ) );
    }
}

Finalmente, en la función donde vas a crear las tareas deberás declarar una variable estructura, ya sea que la declares global, o la marques como estática, o que la crees dinámicamente. Aunque las tres funcionan, veamos un ejemplo con una variable estática:

   static Tarea1_Params t1_params = { .pin = 13, .t_on = 100, .t_off = 900 };

   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) &t1_params, // pasamos la dirección de t1_params
      tskIDLE_PRIORITY,
      NULL );

Y un ejemplo con una variable dinámica, por si algún día se ofrece:

   Tarea1_Params* t1_params = pvPortMalloc( sizeof( Tarea1_params ) );

   t1_params->pin = 13;
   t1_params->t_on = 100;
   t1_params->t_off = 900;

   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) t1_params, // ¡ no lleva & ! t1_params ya es una dirección
      tskIDLE_PRIORITY,
      NULL );

Para terminar, y para que la idea quede clara, aquí está un ejemplo completo (usando la versión de variable estática):

// Pasando valores compuestos a una tarea

#include <FreeRTOS.h>
#include <task.h>

typedef struct
{
   uint8_t pin;
   uint16_t t_on;
   uint16_t t_off;
} Tarea1_Params;

void led_task_1( void* pvParameters )
{
    Tarea1_Params* params = (Tarea1_Params*) pvParameters;

    pinMode( params->pin, OUTPUT );

    while( 1 )
    {
        digitalWrite( params->pin, HIGH );

        vTaskDelay( pdMS_TO_TICKS( params->t_on ) );
   
        digitalWrite( params->pin, LOW );

        vTaskDelay( pdMS_TO_TICKS( params->t_off ) );
    }
}

void setup()
{
   static Tarea1_Params t1_params = { .pin = 13, .t_on = 100, .t_off = 900 };

   xTaskCreate( 
      led_task_1,
      "LD1",
      128,
      (void*) &t1_params,
      tskIDLE_PRIORITY,
      NULL );

   vTaskStartScheduler();
}

void loop() 
{
   // Nada. Todo se realiza en las tareas
}

¿Qué sigue?

Hoy hemos visto mucha información. Aunque en principio es fácil enviar parámetros a las tareas creí necesario explicar los diversos conceptos y mecanismos que intervienen, desde apuntadores void hasta variables static. Pero, una vez que pongas en práctica lo que vimos, serás capaz de pasar toda la información que tus tareas necesiten.

¿Qué sigue? Reutilizar las tareas. Mencioné que estaba repitiendo código solamente para dejar claro los puntos que estaba explicando, pero en el mundo real esa es una muy mala práctica; lo mejor es escribir el código de la tarea una vez, y después crear cuantas tareas necesites. De hecho, ese era el tema principal de esta entrada, pero descubrí que tenía que explicar muchas cosas antes de ver realmente cómo reutilizar el código, así que decidí partirlo en dos. La buena noticia es que lo que vimos hoy te sirve ya sea que reutilices el código o no, como lo vimos en los diferentes ejemplos.

En la siguiente entrada veremos el tema de cómo reutilizar el código de las tareas. Puedes estar al pendiente, o mejor aún, suscribirte al blog.

Si tienes dudas o preguntas, ¡no dudes en hacérmelas llegar!

Índice del curso