Lab 1: C y CGDB

Este es el primer laboratorio de C que vamos a tener. El objetivo es aprender a compilar y ejecutar un programa escrito en C utilizando el compilador de gcc, además examinaremos diferentes tipos de control de flujo, utilizarán un depurador (gdb/cgdb) para arreglar un programa con algunos errores y ganarán más confianza al trabajar un poco con punteros.

Visiten este link. Aquí encontrarán todos los archivos necesarios para completar este lab. En esta página, encontrarán un botón que dice "Accept assignment". Al presionar este botón, se creará automáticamente un repositorio en Github llamado www.github.com/cc3-an/2024-lab-01-c-y-cgdb-<USUARIO> Noten que el "dueño" de este repositorio es un usuario llamado cc3-an, y el usuario de ustedes es únicamente el sufijo del nombre del repo. De esta forma, nos encargamos de tener acceso siempre a su código, en caso existan copias o cualquier otro tipo de trampa. Sepan de una vez que, si encontramos plagio o cualquier otro tipo de trampa en sus laboratorios, su nota será AUTOMÁTICAMENTE 0, sin posibilidad de cambiarla. De repetirse nuevamente este acontecimiento, el staff del curso organizará una reunión con ustedes y sus directores de carrera para contarles lo ocurrido y sancionarlos conforme al reglamento de la universidad.

Después de realizar esto, en la máquina virtual (o sus propias computadoras) abran una terminal en el directorio que prefieran, y ejecuten el siguiente comando:

git clone https://github.com/cc3-an/2024-lab-01-c-y-cgdb-<USUARIO>

Esto descargará en el directorio que escogieron todos los archivos base para este laboratorio. Un clone solo lo hacemos la primera vez que vamos a bajar el codigo de un repositorio a nuestra maquina. Nunca bajen el zip que Github les ofrece, por favor, eso solo nos va a causar problemas.

Recuerden que es necesario que hayan leído el tutorial de git y GitHub que se encuentra en la página del curso.

En este laboratorio, estaremos usando el programa gcc para compilar programas en c. La manera más sencilla de ejecutar gcc es la siguiente:

gcc programa.c

Esto compila el archivo program.c y crea un archivo ejecutable llamado a.out. Si tienen experiencia en Java, pueden más o menos considerar a gcc como el equivalente en C de javac. Este archivo se puede ejecutar con el siguiente comando:

./a.out

El archivo ejecutable es a.out, así que, ¿qué es eso de punto y diagonal? La respuesta: cuando quieren ejecutar un ejecutable, es necesario preponer una ruta de archivo para distinguirlo de un comando como python (no se utiliza ./python). El punto se refiere al "directorio actual". De paso, dos puntos (..) se referirían al directorio que está un nivel arriba.

gcc tiene varias opciones (o argumentos) de línea de comandos, los cuales les recomendamos explorar. En este laboratorio, vamos a estar usando solamente -o, que se usa para especificar el nombre del ejecutable que gcc genera. Usando -o, se puede compilar programa.c para producir un archivo ejecutable llamado programa, y ejecutarlo. Eso nos sirve si no queremos que todos nuestros archivos ejecutables se llamen a.out.

gcc -o programa programa.c
./programa

En este ejercicio, veremos un ejemplo de definiciones macro de preprocesador. Las macros pueden ser un tema complicado, pero en general, la forma en que funcionan es que, antes de que un archivo en C es compilado, las constantes macro son reemplazadas exactamente por el valor al que se refieren. En este ejercicio, estaremos usando macros exclusivamente como constantes globales. Aquí definimos CONSTANT_NAME como un literal_value (una literal entera). Noten que solo hay 1 espacio separando el nombre del valor.

#define CONSTANT_NAME LITERAL_VALUE

Ahora, vean el código en eccentric.c (en el repositorio). Noten los cuatro diferentes ejemplos de control básico de flujo. (¿Cuáles son?) Compilen y ejecuten el programa para ver lo que hace. Jueguen con las constantes de las cuatro macros: v0 a v3. Vean cómo cambiar cada uno de estos cambia el output del programa. Su tarea: Modificando sólo estos cuatro valores, hagan que el programa produzca el siguiente mensaje:

gcc -o eccentric eccentric.c
./eccentric

Berkeley eccentrics:
====================
Happy Happy Happy
Yoshua

Go BEARS!

Hay múltiples combinaciones de valores en las macros que consiguen este resultado, El reto para ustedes en este ejercicio es: Consideren el mínimo número de distintos valores que las constantes v0 a v3 puedan tener que aún den el mismo resultado correcto. Como ejemplo, el máximo teórico es cuatro (cuando todos los valores en esas constantes son diferentes uno de otro).

Cuando ya hayan logrado esto, pueden actualizar el archivo en su repositorio en Github, de esta manera:

git add eccentric.c
git commit -m "Ejercicio 1 terminado"
git push -u origin main

Este párrafo es para los estudiantes que no están familiarizados con los debuggers. Un debugger, como sugiere el nombre, es un programa específicamente diseñado para ayudarlos a encontrar bugs, o errores lógicos, u otros errores en el código (nota: si quieren saber por qué se les llama bugs a los errores, vean aquí). Distintos debuggers tienen distintas características, pero es normal que todos los debuggers sean capaces de hacer las siguientes cosas:

1. Poner un breakpoint en el programa. Un Breakpoint es una línea específica en su código en donde quisieran que se detenga la ejecución del programa, para que puedan ver lo que está pasando alrededor.
2. Ejecución por Steps (línea a línea) por el programa. El código siempre se ejecuta línea a línea, pero pasa muy rápido como para que sepamos qué línea produce algún error. Ser capaces de ejecutar línea a línea el programa les permite observar exactamente qué esta causando un bug en el programa. Para este ejercicio, necesitarán la GDB reference card. GDB quiere decir "GNU De-Bugger". Compilen hello.c con la bandera "-g":

gcc -g -o hello hello.c

Esto hará que gcc guarde información en el archivo ejecutable para que gdb lo interprete. Ahora ejecuten el debugger, (c)gdb:

cgdb hello

Vean lo que hace este comando. Están ejecutando el programa cgdb en el ejecutable hello generado por gcc. No intenten ejecutar cgdb en el archivo fuente en hello.c! Eso no va a funcionar. Si cgdb no funciona, gdb se puede usar para completar los ejercicios (utilicen gdb hello). Su tarea: ejecuten el programa varias veces haciendo esto:

1. Poniendo un breakpoint en el main.
2. Usando el comando run de gdb.
3. Utilizando el comando single-step de gdb.

Escriban help adentro de gdb para averiguar cómo hacer estas cosas, o usen la reference card.

Si encuentran un mensaje de error que dice: printf.c: No such file or directory. Probablemente entraron a una función printf. Si siguen ejecutando paso a paso, pareciera que nunca avanzaran en el código. CGDB está dando el error porque no tienen el archivo en el que se define la función printf. Esto es algo molesto, y para librarse de esto, usen el comando finish para ejecutar el programa hasta que termine la función printf. Y la próxima vez, utilicen el comando next para saltar sobre la linea que usa printf.

Nota: CGDB vs GDB.

En este ejercicio, usamos cgdb para depurar nuestros programas. cgdb es idéntico a gdb, excepto que tiene unas características extra que hacen más cómodo el trabajo. Todos los comandos de la hoja de referencia funcionan también en gdb. En cgdb, pueden presionar ESC para ir a la ventana del código (arriba), y usar i para regresar a la ventana de comandos (abajo), similar a vim. La ventana de comandos es donde se introducen los comandos de gdb.

Para este ejercicio, encontrarán un archivo de texto llamado ex2.txt, con el siguiente formato:

1:
2:
3:
4:
5:
6:
7:
8:
9:

Aquí tendrán que responder las siguientes preguntas de opción múltiple (no tengan miedo de probar las opciones en CGDB antes de responder, ¡lo recomendamos!) con el siguiente formato (tienen que cambiar la letra en el ejemplo por la letra de la respuesta que ustedes consideren correcta):

1:e
2:f
3:g
4:h
5:i
6:j
7:k
8:l
9:m

Preguntas

1. ¿Cómo se le dan argumentos desde la línea de comandos a un programa al utilizar gdb?

• a. args arglist
• b. run arglist
• c. gdb args
• d. Ninguna de las anteriores

2. ¿Cómo se añade un breakpoint que sólo ocurre cuando se cumplen ciertas condiciones (por ejemplo, ciertas variables alcanzan cierto valor)?

• a. expr cond
• b. cond break expr
• c. break ... if expr
• d. Ninguna de las anteriores

3. ¿Con qué comando se ejecuta la siguiente línea del código en C después de parar en un breakpoint?

• a. run
• b. s
• c. c
• d. n

4. Si la siguiente línea de código es una llamada a función, ¿se ejecutaría toda la función si se utiliza el comando de la pregunta #3? (si no, es momento de cambiarla!). ¿Cómo se le indica a gdb, que quieren debuggear el código adentro de la función? (Si tuvieron que cambiar la respuesta #3, esa respuesta muy probablemente aplica aquí)

• a. run
• b. s
• c. c
• d. n

5. ¿Cómo se reanuda la ejecución del programa después de parar en un breakpoint?

• a. run
• b. s
• c. c
• d. n

6. ¿Cómo podemos ver el valor de una variable (o expresión) en gdb?

• a. display expr
• b. signal expr
• c. print expr
• d. next expr

7. ¿Qué comando de gdb se usa para desplegar el valor de una variable después de cada paso?

• a. display expr
• b. signal expr
• c. print expr
• d. next expr

8. ¿Cómo se imprime una lista de todas las variables y su valor en la función actual?

• a. display all
• b. display
• c. print all
• d. info locals

9. ¿Cómo salimos de gdb?

• a. end
• b. quit
• c. exit
• d. finish

Después de responder estas preguntas, no olviden hacer el commit y push de este archivo hacia Github:

git add ex2.txt
git commit -m "Ejercicio 2 terminado"
git push -u origin main

Ahora, usarán su nuevo conocimiento para depurar un pequeño programa. Vean el programa ll_equal.c. Compilen y ejecuten el programa, y analicen un poco lo que hace. Así como está, producirá un resultado como el siguiente:

gcc -g -o ll_equal ll_equal.c
./ll_equal

equal test 1 result = 1
Segmentation fault

Averigüen qué produce el segmentation fault (falla de segmentación).

Ejecuten gdb en el programa, siguiendo las instrucciones aprendidas en los ejercicios anteriores. Les recomendamos añadir un breakpoint en la función ll_equal(). Cuando el debugger pare en el breakpoint, ejecuten paso a paso el programa, para que puedan descifrar qué es lo que provoca el error.

Pista: Analicen el valor de los punteros a y b en la función (¡despliéguenlos!). ¿Están siempre apuntando a la dirección correcta?

Pista 2: Vean el código fuente en main para ver la estructura de los nodos y ver exactamente qué está pasando como argumento a ll_equal.

Después de corregir el problema, compilen nuevamente y ejecuten el código. ¿Notan la diferencia?

Al finalizar, no olviden subir el archivo modificado a su repositorio remoto:

git add ll_equal.c
git commit -m "Ejercicio 3 terminado"
git push -u origin main

Veamos qué pasa cuando, a un programa que requiere interacción del usuario, lo ejecutamos con gdb. Primero, ejecuten el programa en interactive_hello.c para hablar con un programa muy amigable :).

gcc -g -o int_hello interactive_hello.c
./int_hello

Ahora, traten de depurarlo (aunque no haya ningún problema realmente):

cgdb int_hello

¿Qué pasa cuando intentar ejecutar el programa hasta el final? Vamos a aprender acerca de una herramienta que nos ayudará a evitar este problema. El propósito de este ejercicio es que no tengan miedo de usar un debugger incluso cuando el programa requiera de interacción con el usuario.

Resulta que es posible enviar texto a stdin, el flujo de datos que es leído por la función fgets en este programa, con unos caracteres especiales desde la línea de comandos. Echen un vistazo a la "redirección" en esta página, y vean si pueden descifrar cómo enviar texto al programa sin escribirlo textualmente mientras el programa está en ejecución (lo cual, como ya saben, no funciona bien en CGDB).

Pueden ver esta discusión de stackoverflow para más inspiración.

(Pista 1: ¡Si están creando un archivo de texto que contiene su input, van bien!)

(pista 2: Recuerden que es posible ejecutar programas con argumentos (incluyendo símbolos de redirección) desde CGDB!

Esperamos que hayan comprendido cómo utilizar redirección y cómo es que esto les ayuda a evitar varios problemas al usar CGDB. ¡Nunca tengan miedo de usar un debugger! Tal vez no es muy agradable visualmente, pero siempre estará para ayudarlos.

Este ejercicio no vale puntos :-) pero es importante conocer sobre estas cosas para que puedan utilizarlo en el futuro (los siguientes laboratorios y proyectos podrían necesitar de este conocimiento)

En llcycle.c, completen la función ll_has_cycle(), de modo que implemente el siguiente algoritmo para comprobar si una linked list simple tiene un ciclo:

1. Comiencen con dos punteros apuntando al principio de la lista. Llamaremos al primero tortoise (tortuga) y al segundo hare (liebre).
2. Avancen el puntero hare dos nodos hacia adelante. Si no se puede debido a punteros null, hemos llegado al final de la lista. Por lo tanto, la lista no tiene un ciclo.
3. Ahora, avancen tortoise un nodo. (Revisar si llega a ser un puntero nulo es innecesario. ¿Por qué?)
4. Si la tortuga y la liebre apuntan al mismo nodo, la lista es cíclica. Si no, regresen al paso 2.

Después de implementar correctamente la función ll_has_cycle(), el programa que se obtiene después de compilar ll_cycle.c mostrará si el resultado de su función está correcto, conforme a lo que esperaba como salida.

Pista: Hay dos formas comunes en que los estudiantes resuelven esta función, y la diferencia principal está en la forma en que deciden codificar el criterio de cómo finalizar. Si lo hacen de una forma, tendrían que tomar en cuenta un caso especial en el principio. Si lo hacen de otra forma, tendrían que tener unas pruebas extra de NULL, lo cual esta bien también. Les decimos esto para que no se preocupen de la "limpieza" de su código, si no les ayuda, simplemente ignoren esta pista. El punto de este ejercicio es asegurarse de que entiendan como usar punteros.

Aquí hay un Artículo del algoritmo y por qué funciona. No se preocupen de entender completamente todo (no hay examen de esto).

A propósito, los punteros se llaman tortoise y hare porque el puntero "tortoise (tortuga)" se incrementa lentamente (como una tortuga, que se mueve muy lento) y el puntero "hare (liebre)" se incrementa rápidamente (más rápido que una tortuga, como una liebre, o conejo, que se mueve muy rápido).

Al finalizar, compilen y ejecuten el archivo, y verifiquen que el resultado de su código, el cual debería ser más o menos igual a este:

gcc -g -o ll_cycle ll_cycle.c
./ll_cycle

Checking first list for cycles. There should be none, ll_has_cycle says it has no cycle
Checking second list for cycles. There should be a cycle, ll_has_cycle says it has a cycle
Checking third list for cycles. There should be a cycle, ll_has_cycle says it has a cycle
Checking fourth list for cycles. There should be a cycle, ll_has_cycle says it has a cycle
Checking fifth list for cycles. There should be none, ll_has_cycle says it has no cycle
Checking length-zero list for cycles. There should be none, ll_has_cycle says it has no cycle

Si su código presenta errores, entonces ya son capaces de utilizar CGDB para poder encontrarlos y corregirlos. Finalmente, pueden subir el archivo a github:

git add ll_cycle.c
git commit -m "LAB01 terminado"
git push -u origin main

Para finalizar, la fábula de la tortuga y la liebre es relevante siempre, especialmente en este curso. Escribir sus programas en C a paso lento pero seguro (ayudándose de programas como CGDB) es lo que les hará ganar la carrera.

Por favor subir el link de su repositorio al GES. Siempre es necesario que suban su repositorio al GES, incluso si no completaron todos los ejercicios, de lo contrario la nota será de 0 puntos automáticamente.

Tienen más de una semana para completar el laboratorio, es decir, el link para subir el link al GES estará habilitado hasta el 13 de Febrero del 2024 a las 11:55 PM.

La calificación de este laboratorio será de 0 a 100 puntos, donde 100 puntos es la calificación máxima. La calificación se basará en la cantidad de ejercicios completados. Si tienen alguna duda sobre la calificación, por favor envíen un correo a los auxiliares o por medio de los canales correspondientes.