<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML ><HEAD ><TITLE >ioctls: Not writing a new system call</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Unreliable Guide To Hacking The Linux Kernel" HREF="book1.html"><LINK REL="PREVIOUS" TITLE="Some Basic Rules" HREF="c84.html"><LINK REL="NEXT" TITLE="Recipes for Deadlock" HREF="c127.html"></HEAD ><BODY CLASS="CHAPTER" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >Unreliable Guide To Hacking The Linux Kernel</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="c84.html" ACCESSKEY="P" ><<< Previous</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="c127.html" ACCESSKEY="N" >Next >>></A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><DIV CLASS="CHAPTER" ><H1 ><A NAME="IOCTLS" ></A >ioctls: Not writing a new system call</H1 ><P > A system call generally looks like this </P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" ><TR ><TD ><PRE CLASS="PROGRAMLISTING" >asmlinkage int sys_mycall(int arg) { return 0; } </PRE ></TD ></TR ></TABLE ><P > First, in most cases you don't want to create a new system call. You create a character device and implement an appropriate ioctl for it. This is much more flexible than system calls, doesn't have to be entered in every architecture's <TT CLASS="FILENAME" >include/asm/unistd.h</TT > and <TT CLASS="FILENAME" >arch/kernel/entry.S</TT > file, and is much more likely to be accepted by Linus. </P ><P > If all your routine does is read or write some parameter, consider implementing a <TT CLASS="FUNCTION" >sysctl</TT > interface instead. </P ><P > Inside the ioctl you're in user context to a process. When a error occurs you return a negated errno (see <TT CLASS="FILENAME" >include/linux/errno.h</TT >), otherwise you return <SPAN CLASS="RETURNVALUE" >0</SPAN >. </P ><P > After you slept you should check if a signal occurred: the Unix/Linux way of handling signals is to temporarily exit the system call with the <TT CLASS="CONSTANT" >-ERESTARTSYS</TT > error. The system call entry code will switch back to user context, process the signal handler and then your system call will be restarted (unless the user disabled that). So you should be prepared to process the restart, e.g. if you're in the middle of manipulating some data structure. </P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" ><TR ><TD ><PRE CLASS="PROGRAMLISTING" >if (signal_pending()) return -ERESTARTSYS; </PRE ></TD ></TR ></TABLE ><P > If you're doing longer computations: first think userspace. If you <I CLASS="EMPHASIS" >really</I > want to do it in kernel you should regularly check if you need to give up the CPU (remember there is cooperative multitasking per CPU). Idiom: </P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" ><TR ><TD ><PRE CLASS="PROGRAMLISTING" >if (current->need_resched) schedule(); /* Will sleep */ </PRE ></TD ></TR ></TABLE ><P > A short note on interface design: the UNIX system call motto is "Provide mechanism not policy". </P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="c84.html" ACCESSKEY="P" ><<< Previous</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="book1.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="c127.html" ACCESSKEY="N" >Next >>></A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >Some Basic Rules</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" > </TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >Recipes for Deadlock</TD ></TR ></TABLE ></DIV ></BODY ></HTML >