Changes in kernel/generic/include/context.h [b1c21c2:716fb9d] in mainline

File:

• kernel/generic/include/context.h (modified) (2 diffs)

kernel/generic/include/context.h

@@ -51 +51 @@
 /** Save register context.
  *
- * Save the current register context (including stack pointer) to a context
- * structure. A subsequent call to context_restore() will return to the same
+ * Save current register context (including stack pointers)
+ * to context structure.
+ *
+ * Note that call to context_restore() will return at the same
  * address as the corresponding call to context_save().
  *
- * Note that context_save_arch() must reuse the stack frame of the function
- * which called context_save(). We guarantee this by:
+ * This MUST be a macro, gcc -O0 does not inline functions even
+ * if they are marked inline and context_save_arch must be called
+ * from level <= that when context_restore is called.
  *
- *   a) implementing context_save_arch() in assembly so that it does not create
- *      its own stack frame, and by
- *   b) defining context_save() as a macro because the inline keyword is just a
- *      hint for the compiler, not a real constraint; the application of a macro
- *      will definitely not create a stack frame either.
+ * @param c Context structure.
  *
- * To imagine what could happen if there were some extra stack frames created
- * either by context_save() or context_save_arch(), we need to realize that the
- * sp saved in the contex_t structure points to the current stack frame as it
- * existed when context_save_arch() was executing. After the return from
- * context_save_arch() and context_save(), any extra stack frames created by
- * these functions will be destroyed and their contents sooner or later
- * overwritten by functions called next. Any attempt to restore to a context
- * saved like that would therefore lead to a disaster.
- *
- * @param c             Context structure.
- *
- * @return              context_save() returns 1, context_restore() returns 0.
+ * @return context_save() returns 1, context_restore() returns 0.
  */
 #define context_save(c)   context_save_arch(c)
@@ -81 +69 @@
 /** Restore register context.
  *
- * Restore a previously saved register context (including stack pointer) from
- * a context structure.
+ * Restore previously saved register context (including stack pointers)
+ * from context structure.
  *
- * Note that this function does not normally return.  Instead, it returns to the
- * same address as the corresponding call to context_save(), the only difference
- * being return value.
+ * Note that this function does not normally return.
+ * Instead, it returns at the same address as the
+ * corresponding call to context_save(), the only
+ * difference being return value.
  *
- * @param c             Context structure.
+ * @param c Context structure.
  */
 static inline void context_restore(context_t *c)