<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Implémenter keepalive sur une application tierce</title><link href="style.css" rel="stylesheet" type="text/css" /><meta content="DocBook XSL Stylesheets V1.73.2" name="generator" /><link rel="start" href="index.html" title="Guide pratique du maintien de connexion TCP" /><link rel="up" href="index.html" title="Guide pratique du maintien de connexion TCP" /><link rel="prev" href="ar01s04.html" title="Programmer des applications" /></head><body><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Implémenter keepalive sur une application tierce</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s04.html">Précédent</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> </td></tr></table><hr /></div><div class="sect1" lang="fr"><div class="titlepage"><div><div><h2 class="title"><a id="applitierce" />Implémenter keepalive sur une application tierce</h2></div></div></div><p>
Tout le monde n'est pas développeur d'application, et tout le monde ne
réécrira pas entièrement une application pour combler le manque
d'une fonctionnalité. Peut-être souhaitez vous ajouter keepalive à une
application existante, et même si son auteur n'a pas considéré cela
important, vous pensez que ce sera utile.
</p><p>
Tout d'abord, souvenez vous de ce qui a été dit précédemment à propos
des cas où keepalive est nécessaire. Ensuite vous devrez affecter les
sockets TCP orientées connexion.
</p><p>
Comme Linux ne fournit pas la possibilité d'activer le support keepalive
via le noyau (les OS de type BSD le permettent souvent), le seul moyen
est d'appeler <span class="citerefentry"><span class="refentrytitle"><code class="function">setsockopt
</code></span>(2)</span>
après la création de la socket. Il y a deux solutions:
<div class="itemizedlist"><ul><li><p>modification du code source du programme original</p></li><li><p>injection <span class="citerefentry"><span class="refentrytitle"><code class="function">setsockopt</code>
</span>(2)</span> en utilisant
la technique de préchargement de bibliothèque</p></li></ul></div>
</p><div class="sect2" lang="fr"><div class="titlepage"><div><div><h3 class="title"><a id="modifiersource" />Modifier le code source</h3></div></div></div><p>
Souvenez-vous que keepalive n'est pas orienté programme, mais orienté
socket, donc si vous avez de multiples sockets, vous pouvez gérer
keepalive séparément pour chacune d'entre elles. La première étape
consiste à comprendre ce que fait le programme, la seconde à rechercher
le code pour chaque socket dans le programme. Cela peut être fait en
utilisant <span class="citerefentry"><span class="refentrytitle"><span class="command"><strong>grep</strong></span></span>(1)</span>, comme suit:
<pre class="programlisting">
<code class="prompt"># </code><strong class="userinput"><code>grep 'socket *(' *.c</code></strong>
</pre>
</p><p>
Cela vous montrera à peu près toutes les sockets du code. L'étape
suivante consiste à choisir les bonnes : vous ciblez les sockets TCP,
donc recherchez <code class="constant">PF_INET</code> (ou <code class="constant">AF_INET</code>),
<code class="constant">SOCK_STREAM</code> et <code class="constant">IPPROTO_TCP</code> (ou
plus communément, <code class="constant">0</code>) dans les paramètres de votre
liste de sockets, et enlevez celles qui ne correspondent pas.
</p><p>
Il existe un autre moyen de créer une socket au travers de
<span class="citerefentry"><span class="refentrytitle"><code class="function">accept</code></span>(2)</span>. En ce ce cas, suivez les sockets
TCP identifiées et vérifiez si certaines sont en écoute : si c'est
le cas, gardez à l'esprit que <span class="citerefentry"><span class="refentrytitle">
<code class="function">accept</code></span>(2)</span> retourne un descripteur de socket, qui doit être ajouté
à votre liste de sockets.
</p><p>
Une fois les sockets identifiées, vous pouvez procéder aux modifications.
Le patch le plus 'fast & furious' peut consister à simplement ajouter
la fonction <span class="citerefentry"><span class="refentrytitle"><code class="function">setsockopt</code></span>(2
)</span> juste après le bloc de création de la socket.
Éventuellement, vous pouvez ajouter des appels supplémentaires pour
modifier les paramètres systèmes par défaut de keepalive. Surtout soyez
attentif au positionnement des vérifications d'erreurs et des handlers
de la fonction, peut-être en recopiant le style du code alentour. Songez
à affecter à <code class="varname">optval</code> une valeur non nulle et à
initialiser <code class="varname">optlen</code> avant d'appeler la fonction.
</p><p>
Si vous en avez le temps ou pensez que ce serait plus élégant, essayez
d'implémenter complètement le keepalive à votre programme, en incluant
une option de ligne de commande ou un paramètre de configuration pour
laisser à l'utilisateur la liberté d'utiliser ou non keepalive.
</p></div><div class="sect2" lang="fr"><div class="titlepage"><div><div><h3 class="title"><a id="libkeepalive" /><span class="application">libkeepalive</span>: préchargement de bibliothèque</h3></div></div></div><p>
Dans de nombreux cas vous n'avez pas la possibilité de modifier le code
source d'une application, ou bien lorsque vous devez activer keepalive
pour tous vos programmes, tout patcher et tout recompiler n'est pas
recommandé.
</p><p>
Le projet <span class="application">libkeepalive</span> a vu le jour pour
faciliter l'implémentation du keepalive au sein des applications
puisque le noyau Linux ne permet pas de le faire nativement
(comme le fait BSD). La page d'accueil du projet
<span class="application">libkeepalive</span> est disponible à l'adresse
<a class="ulink" href="http://libkeepalive.sourceforge.net/" target="_top">
http://libkeepalive.sourceforge.net/</a>
</p><p>
Il consiste en une bibliothèque partagée qui outrepasse l'appel système
socket de la plupart des exécutables, sans aucun besoin de les recompiler
ni de les modifier. La technique repose sur la fonctionnalité de
pré-chargement (<em class="firstterm">preloading</em>) de
<span class="citerefentry"><span class="refentrytitle"><span class="command"><strong>ld.so</strong></span></span>(8)</span>, chargeur inclus dans Linux, qui
qui permet le chargement de bibliothèques partagées avec une priorité
supérieure à la normale. Les programmes utilisent habituellement l'appel
de fonction <span class="citerefentry"><span class="refentrytitle"><code class="function">socket</code>
</span>(2)</span> situé dans la
<code class="literal">glibc</code>, librairie partagée; avec <span class="application">libkeepalive</span>
il est possible d'encapsuler la fonction <span class="citerefentry"><span class="refentrytitle">
<code class="function">setsockopt</code></span>(2)</span> juste après la création, retournant
au programme principal une socket avec keepalive déjà positionné.
En raison des mécanismes utilisés pour réaliser l'appel système,
ce procédé ne fonctionne pas lorsque la fonction socket est compilée
statiquement dans le binaire, comme dans le cas d'un programme lié par
l'option <code class="option">-static</code> de <span class="citerefentry"><span class="refentrytitle">
<span class="command"><strong>gcc</strong></span></span>(1
)</span>.
</p><p>
Après avoir téléchargé et installé <span class="application">libkeepalive</span>,
vous serez en mesure d'ajouter le support de keepalive à vos programmes
sans être <code class="literal">root</code> au préalable, simplement en
initialisant la variable d'environnement <code class="envar">LD_PRELOAD</code>
avant d'exécuter le programme. Au fait, le super utilisateur peut aussi
forcer la pré-chargement au travers d'une configuration globale, et
les utilisateurs peuvent choisir de le désactiver en positionnant
la variable d'environnement <code class="envar">KEEPALIVE</code> à <code class="constant">off</code>.
</p><p>
L'environnement est aussi utilisé pour positionner des valeurs
spécifiques pour les paramètres de keepalive, vous avez donc la
possibilité de gérer chaque programme de façon distincte,
en initialisant <code class="envar">KEEPCNT</code>, <code class="envar">KEEPIDLE</code>
et <code class="envar">KEEPINTVL</code> avant de lancer l'application.
</p><p>
Voici un exemple d'utilisation de libkeepalive :
<div class="informalexample"><pre class="programlisting">
<code class="prompt">$ </code><strong class="userinput"><code>test</code></strong>
<code class="computeroutput">SO_KEEPALIVE is OFF</code>
<code class="prompt">$ </code><strong class="userinput"><code>LD_PRELOAD=libkeepalive.so \</code></strong>
<code class="prompt">> </code><strong class="userinput"><code>KEEPCNT=20 \</code></strong>
<code class="prompt">> </code><strong class="userinput"><code>KEEPIDLE=180 \</code></strong>
<code class="prompt">> </code><strong class="userinput"><code>KEEPINTVL=60 \</code></strong>
<code class="prompt">> </code><strong class="userinput"><code>test</code></strong>
<code class="computeroutput">SO_KEEPALIVE is ON
TCP_KEEPCNT = 20
TCP_KEEPIDLE = 180
TCP_KEEPINTVL = 60</code>
</pre></div>
</p><p>
Et vous pouvez utiliser <span class="citerefentry"><span class="refentrytitle"><span class="command"><strong>strace</strong></span>
</span>(1)</span> pour comprendre
ce qui se passe:
</p><div class="informalexample"><pre class="programlisting">
<code class="prompt">$ </code><strong class="userinput"><code>strace test</code></strong>
<code class="computeroutput">execve("test", ["test"], [/* 26 vars */]) = 0
[..]
open("/lib/libc.so.6", O_RDONLY) = 3
[..]
socket(PF_INET, SOCK_STREAM, IPPROTO_TCP) = 3
getsockopt(3, SOL_SOCKET, SO_KEEPALIVE, [0], [4]) = 0
close(3) = 0
[..]
_exit(0) = ?</code>
<code class="prompt">$ </code><strong class="userinput"><code>LD_PRELOAD=libkeepalive.so \</code></strong>
<code class="prompt">> </code><strong class="userinput"><code>strace test</code></strong>
<code class="computeroutput">execve("test", ["test"], [/* 27 vars */]) = 0
[..]
open("/usr/local/lib/libkeepalive.so", O_RDONLY) = 3
[..]
open("/lib/libc.so.6", O_RDONLY) = 3
[..]
open("/lib/libdl.so.2", O_RDONLY) = 3
[..]
socket(PF_INET, SOCK_STREAM, IPPROTO_TCP) = 3
setsockopt(3, SOL_SOCKET, SO_KEEPALIVE, [1], 4) = 0
setsockopt(3, SOL_TCP, TCP_KEEPCNT, [20], 4) = 0
setsockopt(3, SOL_TCP, TCP_KEEPIDLE, [180], 4) = 0
setsockopt(3, SOL_TCP, TCP_KEEPINTVL, [60], 4) = 0
[..]
getsockopt(3, SOL_SOCKET, SO_KEEPALIVE, [1], [4]) = 0
[..]
getsockopt(3, SOL_TCP, TCP_KEEPCNT, [20], [4]) = 0
[..]
getsockopt(3, SOL_TCP, TCP_KEEPIDLE, [180], [4]) = 0
[..]
getsockopt(3, SOL_TCP, TCP_KEEPINTVL, [60], [4]) = 0
[..]
close(3) = 0
[..]
_exit(0) = ?</code>
</pre></div><p>
Pour d'autres informations, visitez la page d'accueil du projet
<span class="application">libkeepalive</span> :
<a class="ulink" href="http://libkeepalive.sourceforge.net/" target="_top">
http://libkeepalive.sourceforge.net/</a>
</p></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s04.html">Précédent</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> </td></tr><tr><td valign="top" align="left" width="40%">Programmer des applications </td><td align="center" width="20%"><a accesskey="h" href="index.html">Sommaire</a></td><td valign="top" align="right" width="40%"> </td></tr></table></div></body></html>
