Implémenter keepalive sur une application tierce

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.

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.

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 setsockopt (2) après la création de la socket. Il y a deux solutions:

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 grep(1), comme suit:

  # grep 'socket *(' *.c
      

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 PF_INET (ou AF_INET), SOCK_STREAM et IPPROTO_TCP (ou plus communément, 0) dans les paramètres de votre liste de sockets, et enlevez celles qui ne correspondent pas.

Il existe un autre moyen de créer une socket au travers de accept(2). 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 accept(2) retourne un descripteur de socket, qui doit être ajouté à votre liste de sockets.

Une fois les sockets identifiées, vous pouvez procéder aux modifications. Le patch le plus 'fast & furious' peut consister à simplement ajouter la fonction setsockopt(2 ) 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 à optval une valeur non nulle et à initialiser optlen avant d'appeler la fonction.

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.

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é.

Le projet libkeepalive 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 libkeepalive est disponible à l'adresse http://libkeepalive.sourceforge.net/

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 (preloading) de ld.so(8), 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 socket (2) situé dans la glibc, librairie partagée; avec libkeepalive il est possible d'encapsuler la fonction setsockopt(2) 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 -static de gcc(1 ).

Après avoir téléchargé et installé libkeepalive, vous serez en mesure d'ajouter le support de keepalive à vos programmes sans être root au préalable, simplement en initialisant la variable d'environnement LD_PRELOAD 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 KEEPALIVE à off.

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 KEEPCNT, KEEPIDLE et KEEPINTVL avant de lancer l'application.

Voici un exemple d'utilisation de libkeepalive :

  $ test
  SO_KEEPALIVE is OFF

  $ LD_PRELOAD=libkeepalive.so \
  > KEEPCNT=20 \
  > KEEPIDLE=180 \
  > KEEPINTVL=60 \
  > test
  SO_KEEPALIVE is ON
  TCP_KEEPCNT   = 20
  TCP_KEEPIDLE  = 180
  TCP_KEEPINTVL = 60
      

Et vous pouvez utiliser strace (1) pour comprendre ce qui se passe:

  $ strace test
  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)                                = ?

  $ LD_PRELOAD=libkeepalive.so \
  > strace test
  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)                                = ?
    

Pour d'autres informations, visitez la page d'accueil du projet libkeepalive : http://libkeepalive.sourceforge.net/